openapi: 3.2.0 info: title: OPERA Cloud Configuration Channel API description: APIs to cater for Channel Management functionality in OPERA Cloud.

Channel Management allows a property to configure and administer channels such as OTAs, and web channels, covering functionality such as channel configuration, availability, inventory and restrictions.

Compatible with OPERA Cloud release 26.2.0.0.

This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.

version: 26.2.0.0 termsOfService: https://www.oracle.com/legal/terms.html contact: email: hospitality_apis_ww_grp@oracle.com license: name: UPL url: https://opensource.org/licenses/upl servers: - url: /chl/v1 tags: - name: Channel description: The Channel APIs allows you to view, configure and manage the mappings for your channel rate codes, negotiated rates, room types, global descriptions, letters, credit card types and channel codes. paths: /channels: get: summary: Gets list of channels description: Use this API to get list of channels from OPERA.

OperationId:getChannels

operationId: getChannels deprecated: true parameters: - name: inactive in: query required: false description: Indicates whether searching for active or inactive codes. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: channelCode in: query required: false description: External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type. schema: type: string - name: systemType in: query required: false description: External system type to be searched. Possible values are CHANNEL, OXI, etc. schema: type: string - name: systemSubType in: query required: false description: External system sub type to be searched. Possible values are GDS, WEB, etc. schema: type: string - name: systemRateType in: query required: false description: External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc. schema: type: string - name: includeInactive in: query required: false description: Flag whether to include inactive channel or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching channels. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channels' '204': description: Channels not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel put: summary: Update channel configuration description: Use this API to update channel configuration

OperationId:putChannels

operationId: putChannels deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channels' description: Request object for changing details of channels. required: true post: summary: Adds new channel description: Use this API to add new channel code in OPERA

OperationId:postChannels

operationId: postChannels deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channels' description: Request object for creating channels. required: true /channels/account/contracts: delete: summary: Deletes channel account contracts. description: This API deletes channel account contracts.

OperationId:deleteChannelAccountContracts

operationId: deleteChannelAccountContracts deprecated: true parameters: - 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. schema: type: string - name: idExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: type in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: id1 in: query 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. required: false style: form explode: true schema: type: array items: type: string - name: idExtension1 in: query description: Additional identifying value assigned by the creating system. required: false style: form explode: true schema: type: array items: type: integer - name: idContext1 in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: type1 in: query description: A reference to the type of object defined by the UniqueID element. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/account/contracts/copy: put: summary: Creates copy of channel account contracts description: This API creates copy of channel account contracts.

OperationId:copyChannelAccountContracts

operationId: copyChannelAccountContracts deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object of the Channel account contract copy request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelAccountContractsDetailsCopy' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelAccountContractsCopy' description: Request object to copy the channel account contract and create a new contract. required: true /channels/accounts: get: summary: This API retrieves channel accounts. description: This API retrieves channel accounts.

OperationId:getChannelAccounts

operationId: getChannelAccounts deprecated: true parameters: - name: excludeInactive in: query required: false description: Indicator that tells whether to include inactive channel accounts or not. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: hotelId in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: accountType in: query required: false description: Represents channel account TEMPLATE type. schema: type: string enum: - Property - Chain - Dealer - Subsidiary - Routing - Template uniqueItems: true - name: accountName in: query required: false description: Account Name for which details need to be fetched. schema: type: string - name: accountCode in: query required: false description: Account Code/No for which details need to be fetched. schema: type: string - name: contractExpInDays in: query required: false description: To fetch channel accounts which expires in no., of days. schema: type: integer - name: attributeName in: query required: false style: form explode: true schema: type: array items: type: string - name: orderType in: query required: false style: form explode: true schema: type: array items: type: string enum: - Asc - Desc uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object of the Channel accounts fetch request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelAccountsSummary' '204': description: ChannelAccounts not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel post: summary: Adds channel accounts. description: This API adds channel accounts.

OperationId:postChannelAccounts

operationId: postChannelAccounts deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelAccounts' description: Request object to create the channel accounts. required: true put: summary: Updates channel accounts description: Use this API to update existing channel account for a given OPERA profile id

OperationId:putChannelAccounts

operationId: putChannelAccounts deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelAccountsToChange' description: Channel account information to create a new channel account. required: true /channels/accounts/{accountProfileId}: get: summary: Gets channel accounts description: Use this API to get existing channel account for a given OPERA profile id.

OperationId:getChannelAccount

operationId: getChannelAccount deprecated: true parameters: - name: accountProfileId in: path required: true description: Unique ID that identifies an account profile. schema: type: string maxLength: 2000 minLength: 1 - name: markAsRecentlyAccessed in: query required: false description: Providing this flag marks the billing account as recently accessed. schema: type: boolean - name: fetchInstructions in: query description: Channel account indicators information. required: false style: form explode: true schema: type: array items: type: string enum: - PrimaryDetails - Communication - Contact - Notes - Contracts - Statements - Indicators uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object of the Channel account fetch request. Contains detailed information for the channel account. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelAccount' '204': description: ChannelAccount not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/accounts/{accountProfileId}/contracts: put: summary: Updates channel account contracts for given profile Id. description: Use this API to update existing cannel account contract for a given OPERA profile id

OperationId:putChannelAccountContracts

operationId: putChannelAccountContracts deprecated: true parameters: - name: accountProfileId in: path required: true description: Unique ID that identifies an account profile. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelAccountContracts' description: Request object to change the channel account contracts. required: true post: summary: Adds channel account contracts for given profile Id. description: This API adds channel account contracts for given profile Id.

OperationId:postChannelAccountContracts

operationId: postChannelAccountContracts deprecated: true parameters: - name: accountProfileId in: path required: true description: Unique ID that identifies an account profile. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelAccountContracts' description: Request object to create the channel account contracts. required: true /channels/accounts/{accountProfileId}/contracts/{contractId}: get: summary: Gets channel account contracts for given profile Id. description: Use this API to get existing cannel account contract for a given OPERA profile id.

OperationId:getChannelAccountContractElements

operationId: getChannelAccountContractElements deprecated: true parameters: - name: contractId in: path required: true description: Contract Id. schema: type: string maxLength: 2000 minLength: 1 - name: accountProfileId in: path required: true description: Unique ID that identifies an account profile. schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: attributeName in: query required: false style: form explode: true schema: type: array items: type: string - name: orderType in: query required: false style: form explode: true schema: type: array items: type: string enum: - Asc - Desc uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object of the channel account contract elements fetch request. Contains detailed information for the channel contract elements. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelAccountContractElements' '204': description: ChannelAccountContractElements not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/amenities: post: summary: Adds channel amenities configuration description: Use this API to add channel amenities mapping

OperationId:postAmenitiesMapping

operationId: postAmenitiesMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/amenities' description: Request object for creating new external system amenities. required: true put: summary: Updates channel amenities configuration description: Use this API to update channel amenities mapping

OperationId:putAmenitiesMapping

operationId: putAmenitiesMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/amenities' description: Request object for changing external system amenities. required: true delete: summary: Deletes channel amenities configuration description: Use this API to delete channel amenities mapping

OperationId:deleteAmenitiesMapping

operationId: deleteAmenitiesMapping deprecated: true parameters: - name: inactive in: query required: false description: Indicates whether code is inactive or not. schema: type: boolean - name: systemCode in: query required: false description: External system code such as TRAVELOCITY, EXPEDIA, etc. schema: type: string - name: systemSubType in: query required: false description: External system subtype such as GDS, WEB, etc. schema: type: string - name: systemType in: query required: false description: External system type such as CHANNEL, OXI, etc. schema: type: string - name: systemName in: query required: false description: External system name. schema: type: string - name: websiteURL in: query required: false description: Cannel Website URL schema: type: string - name: iconURL in: query required: false description: Channel Icon URL schema: type: string - name: localSystemCode in: query description: Code used inside the OPERA System required: false style: form explode: true schema: type: array items: type: string - name: externalSystemCode in: query description: Code used in the External System required: false style: form explode: true schema: type: array items: type: string - name: description in: query description: Detailed Description of the given entity. required: false style: form explode: true schema: type: array items: type: string - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - name: amenityGroup in: query description: User defined logical group name for the amenities. required: false style: form explode: true schema: type: array items: type: string enum: - PropertyFeatures - RoomFeatures - ProductsFeatures - BedCodes uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/amenities/mapping: get: summary: Gets channel amenities configuration description: Use this API to get channel amenities mapping.

OperationId:getAmenitiesMapping

operationId: getAmenitiesMapping deprecated: true parameters: - name: inactive in: query required: false description: Indicates whether searching for active or inactive codes. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: systemCode in: query required: false description: External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type. schema: type: string - name: systemType in: query required: false description: External system type to be searched. Possible values are CHANNEL, OXI, etc. schema: type: string - name: systemSubType in: query required: false description: External system sub type to be searched. Possible values are GDS, WEB, etc. schema: type: string - name: systemRateType in: query required: false description: External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc. schema: type: string - name: localSystemCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching external system amenities. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/amenitiesMapping' '204': description: AmenitiesMapping not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/availability/publish: put: summary: Publishes channel availability. description: This API changes publishes channel availability.

OperationId:publishChannelAvailability

operationId: publishChannelAvailability deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelAvailability' description: Request object for publishing rate availability to channels. required: true /channels/billingStatements: get: summary: Retrieves channel billing statements. description: This API retrieves channel billing statements.

OperationId:getChannelBillingStatements

operationId: getChannelBillingStatements deprecated: true parameters: - name: includeLocked in: query required: false description: Indicates whether search results should include locked statements or not. By default, locked statements will be included. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: statementId 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. schema: type: string - name: statementIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: beginDate in: query required: false description: Begin date of the statement. schema: type: string format: date - name: endDate in: query required: false description: End date of the statement. schema: type: string format: date - name: profileId in: query 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. required: false style: form explode: true schema: type: array items: type: string - name: profileIdType in: query description: A reference to the type of object defined by the UniqueID element. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object of the channel billing statements fetch request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelBillingStatementSummaries' '204': description: ChannelBillingStatements not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel post: summary: Adds channel billing statements. description: This API adds channel billing statements.

OperationId:postChannelBillingStatements

operationId: postChannelBillingStatements deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelBillingStatements' description: Request object to create channel billing statements. required: true put: summary: Updates channel billing statement details description: Use this API to update channels billing statements for a given OPERA statement id

OperationId:putChannelBillingStatements

operationId: putChannelBillingStatements deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelBillingStatements' description: Request object to Change channel billing statements. required: true delete: summary: Deletes channel billing statements. description: This API deletes channel billing statements.

OperationId:deleteChannelBillingStatements

operationId: deleteChannelBillingStatements deprecated: true parameters: - name: id in: query 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. required: false style: form explode: true schema: type: array items: type: string - name: idExtension in: query description: Additional identifying value assigned by the creating system. required: false style: form explode: true schema: type: array items: type: integer - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: type in: query description: A reference to the type of object defined by the UniqueID element. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/billingStatements/generate: post: summary: This API generates channel billing statements. description: This API generates channel billing statements.

OperationId:generateChannelBillingStatements

operationId: generateChannelBillingStatements deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelBillingStatements' description: Request object to Generate channel billing statements. required: true /channels/billingStatements/{statementId}: get: summary: Retrieves channel billing statement for a given statement Id description: This API retrieves channel billing statement for a given statement Id.

OperationId:getChannelBillingStatement

operationId: getChannelBillingStatement deprecated: true parameters: - name: statementId in: path required: true description: Statement Id. schema: type: string maxLength: 2000 minLength: 1 - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string default: OPERA - name: idType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string default: Statement - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object of the channel billing statement fetch request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelBillingStatement' '204': description: ChannelBillingStatement not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/billingStatements/{statementId}/details: get: summary: Retrieves channel billing statement details for a given statement Id description: This API retrieves channel billing statement details for a given statement Id.

OperationId:getChannelBillingStatementDetails

operationId: getChannelBillingStatementDetails deprecated: true parameters: - name: statementId in: path required: true description: Statement Id. schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: contractId 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. schema: type: string - name: contractIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: attributeName in: query required: false style: form explode: true schema: type: array items: type: string - name: orderType in: query required: false style: form explode: true schema: type: array items: type: string enum: - Asc - Desc uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object of the channel account statement details fetch request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelBillingStatementDetails' '204': description: ChannelBillingStatementDetails not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/billingStatements/{statementId}/statistics: get: summary: Retrieves billing statement details statistics. description: This API retrieves billing statement details statistics.

OperationId:getStatementDetailsStatistics

operationId: getStatementDetailsStatistics deprecated: true parameters: - name: statementId in: path required: true description: Statement Id. schema: type: string maxLength: 2000 minLength: 1 - name: contractId 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. schema: type: string - name: contractIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: fetchInstructions in: query description: Type for statement details statistics instructions that can be used in requests for partial operations. required: false style: form explode: true schema: type: array items: type: string enum: - ByResort - ByChannel - ByChannelType - ByFeeType uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object of the channel account statement details statistics fetch request. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/statementDetailsStatistics' '204': description: StatementDetailsStatistics not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/cardType/mappings: get: summary: Gets channel credit card mapping for a hotel description: Use this API to get channel mapping for OPERA credit cards to channel for a given hotel id.

OperationId:getChannelCardTypeMappings

operationId: getChannelCardTypeMappings deprecated: true parameters: - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: bookingChannelCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: cardTypes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: channelCardTypes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicates whether search includes inactive mapping. schema: type: boolean - name: fetchUnmapped in: query required: false description: Indicates whether unmapped channel-hotel card types should be fetched. schema: type: boolean - name: fetchMapped in: query required: false description: Indicates whether mapped channel-hotel card types should be fetched. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching channel-hotel card type mappings. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelCardTypeMappingDetails' '204': description: ChannelCardTypeMappings not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/cardTypes: post: summary: Adds channel credit card mapping description: Use this API to add channel mapping for OPERA Credit cards

OperationId:postCreditCardsMapping

operationId: postCreditCardsMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/creditCards' description: Request object for creating external system credit cards. required: true put: summary: Updates channel credit card mapping description: Use this API to update channel credit card code mapping to OPERA credit card code

OperationId:putCreditCardsMapping

operationId: putCreditCardsMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/creditCards' description: Request object for changing existing external system credit cards. required: true delete: summary: Deletes channel credit card mapping description: Use this API to delete channel credit card code mapping to OPERA credit card code.

OperationId:deleteCreditCardsMapping

operationId: deleteCreditCardsMapping deprecated: true parameters: - name: inactive in: query required: false description: Indicates whether code is inactive or not. schema: type: boolean - name: systemCode in: query required: false description: External system code such as TRAVELOCITY, EXPEDIA, etc. schema: type: string - name: systemSubType in: query required: false description: External system subtype such as GDS, WEB, etc. schema: type: string - name: systemType in: query required: false description: External system type such as CHANNEL, OXI, etc. schema: type: string - name: systemName in: query required: false description: External system name. schema: type: string - name: websiteURL in: query required: false description: Cannel Website URL schema: type: string - name: iconURL in: query required: false description: Channel Icon URL schema: type: string - name: localSystemCode in: query description: Code used inside the OPERA System required: false style: form explode: true schema: type: array items: type: string - name: externalSystemCode in: query description: Code used in the External System required: false style: form explode: true schema: type: array items: type: string - name: description in: query description: Detailed Description of the given entity. required: false style: form explode: true schema: type: array items: type: string - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/cardTypes/mapping: get: summary: Gets channel credit card mapping description: Use this API to get channel credit card code mapping to OPERA credit card code.

OperationId:getCreditCardsMapping

operationId: getCreditCardsMapping deprecated: true parameters: - name: inactive in: query required: false description: Indicates whether searching for active or inactive codes. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: systemCode in: query required: false description: External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type. schema: type: string - name: systemType in: query required: false description: External system type to be searched. Possible values are CHANNEL, OXI, etc. schema: type: string - name: systemSubType in: query required: false description: External system sub type to be searched. Possible values are GDS, WEB, etc. schema: type: string - name: systemRateType in: query required: false description: External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc. schema: type: string - name: localSystemCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicates whether to include inactive guarantees or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching external system credit cards. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/creditCardsMapping' '204': description: CreditCardsMapping not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/confirmationLetters: get: summary: Gets channel property confirmation letter mapping description: Use this API to get channel property confirmation letter configuration

OperationId:getChannelHotelLetters

operationId: getChannelHotelLetters deprecated: true parameters: - name: channelCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: language in: query required: false description: Language code associated with the hotel letters. schema: type: string - name: letterType in: query required: false description: Represents Inquiry Letter Type. schema: type: string enum: - Confirmation - Cancellation - BanquetEventOrder - Contract - Inquiry uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object after fetch Hotel Letters associated with the Booking Channels content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/fetchedChannelHotelLetters' '204': description: ChannelHotelLetters not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel post: summary: Adds channel property confirmation letter mapping description: Use this API to add channel property confirmation letter configuration

OperationId:postChannelHotelLetters

operationId: postChannelHotelLetters deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelHotelLettersToBeCreated' description: Request object to create new Hotel Letters associated with the Channels required: true put: summary: Updates channel property confirmation letter mapping description: Use this API to update channel property confirmation letter configuration

OperationId:putChannelHotelLetters

operationId: putChannelHotelLetters deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelHotelLettersToBeChanged' description: Request object to update existing Hotel Letters associated with the Booking Channels required: true delete: summary: Deletes channel property confirmation letter mapping description: Use this API to delete channel property confirmation letter configuration.

OperationId:deleteChannelHotelLetters

operationId: deleteChannelHotelLetters deprecated: true parameters: - name: code in: query required: false description: Code. schema: type: string - name: description in: query required: false description: description. schema: type: string - name: hotelId in: query description: Hotel code which the hotel letters belong to. required: false style: form explode: true schema: type: array items: type: string - name: code1 in: query required: false description: Code. schema: type: string - name: description1 in: query required: false description: description. schema: type: string - name: letterType in: query description: Represents Inquiry Letter Type. required: false style: form explode: true schema: type: array items: type: string enum: - Confirmation - Cancellation - BanquetEventOrder - Contract - Inquiry uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/currencies: post: summary: Adds channel currency code mapping description: Use this API to add channel currency code mapping to OPERA currency codes.

OperationId:postCurrenciesMapping

operationId: postCurrenciesMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/currencies' description: Request object for creating external system currencies. required: true put: summary: Updates channel currency code mapping description: Use this API to update channel mapping to OPERA currency codes

OperationId:putCurrenciesMapping

operationId: putCurrenciesMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/currencies' description: Request object for changing existing external system currencies. required: true delete: summary: Deletes channel currency code mapping description: Use this API to delete channel mapping to OPERA currency codes.

OperationId:deleteCurrenciesMapping

operationId: deleteCurrenciesMapping deprecated: true parameters: - name: inactive in: query required: false description: Indicates whether code is inactive or not. schema: type: boolean - name: systemCode in: query required: false description: External system code such as TRAVELOCITY, EXPEDIA, etc. schema: type: string - name: systemSubType in: query required: false description: External system subtype such as GDS, WEB, etc. schema: type: string - name: systemType in: query required: false description: External system type such as CHANNEL, OXI, etc. schema: type: string - name: systemName in: query required: false description: External system name. schema: type: string - name: websiteURL in: query required: false description: Cannel Website URL schema: type: string - name: iconURL in: query required: false description: Channel Icon URL schema: type: string - name: localSystemCode in: query description: Code used inside the OPERA System required: false style: form explode: true schema: type: array items: type: string - name: externalSystemCode in: query description: Code used in the External System required: false style: form explode: true schema: type: array items: type: string - name: description in: query description: Detailed Description of the given entity. required: false style: form explode: true schema: type: array items: type: string - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - name: lanyonDecimalPosition in: query description: Number of decimal positions used by the currency. required: false style: form explode: true schema: type: array items: type: integer - name: channelDecimalPosition in: query description: Number of decimal positions used by the currency as per the channel. required: false style: form explode: true schema: type: array items: type: integer - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/currencies/mapping: get: summary: Gets channel currency code mapping description: Use this API to update channel mapping to OPERA currency codes.

OperationId:getCurrenciesMapping

operationId: getCurrenciesMapping deprecated: true parameters: - name: inactive in: query required: false description: Indicates whether searching for active or inactive codes. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: systemCode in: query required: false description: External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type. schema: type: string - name: systemType in: query required: false description: External system type to be searched. Possible values are CHANNEL, OXI, etc. schema: type: string - name: systemSubType in: query required: false description: External system sub type to be searched. Possible values are GDS, WEB, etc. schema: type: string - name: systemRateType in: query required: false description: External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc. schema: type: string - name: localSystemCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicates whether to include inactive guarantees or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching external system currencies. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/currenciesMapping' '204': description: CurrenciesMapping not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/distributionTemplates: get: summary: Retrieves distribution templates description: This API retrieves distribution templates.

OperationId:getDistributionTemplates

operationId: getDistributionTemplates deprecated: true parameters: - name: isChain in: query required: false description: Filter chain level distribution templates by chain. schema: type: boolean default: 'false' - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: codes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: types in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicates whether search includes inactive distribution templates. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching distribution templates based on search criteria. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/distributionTemplates' '204': description: DistributionTemplates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel post: summary: Adds rate templates configurations description: Use this API to add a distribution rate template.

OperationId:postDistributionTemplates

operationId: postDistributionTemplates deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/distributionTemplates' description: Request object for creating chain or property level distribution templates. required: true put: summary: Updates rate templates configurations description: Use this API to update existing distribution rate template

OperationId:putDistributionTemplates

operationId: putDistributionTemplates deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/distributionTemplates' description: Request object for modifying chain or property level distribution templates. required: true delete: summary: Deletes rate templates configurations description: Use this API to delete existing distribution rate template.

OperationId:deleteDistributionTemplates

operationId: deleteDistributionTemplates deprecated: true parameters: - name: codes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: code in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - name: hotelId in: query description: Hotel where the code is configured. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/errorCodes: delete: summary: Deletes channel error codes description: Use this API to delete channel error code mapping configurations.

OperationId:deleteChannelErrors

operationId: deleteChannelErrors deprecated: true parameters: - name: bookingChannelCode in: query description: Booking channel code of error. required: false style: form explode: true schema: type: array items: type: string - name: error in: query description: Code of error. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/guarantees: post: summary: Adds channel guarantee code mapping description: Use this API to add channel's guarantee codes mapping to OPERA guarantee codes.

OperationId:postGuaranteesMapping

operationId: postGuaranteesMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guarantees' description: Request object for creating new external system guarantees. required: true put: summary: Updates channel guarantee code mapping description: Use this API to update channel's guarantee codes mapping to OPERA guarantee codes

OperationId:putGuaranteesMapping

operationId: putGuaranteesMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guarantees' description: Request object for changing external system guarantees. required: true delete: summary: Deletes channel guarantee code mapping description: Use this API to delete channel's guarantee codes mapping to OPERA guarantee codes.

OperationId:deleteGuaranteesMapping

operationId: deleteGuaranteesMapping deprecated: true parameters: - name: inactive in: query required: false description: Indicates whether code is inactive or not. schema: type: boolean - name: systemCode in: query required: false description: External system code such as TRAVELOCITY, EXPEDIA, etc. schema: type: string - name: systemSubType in: query required: false description: External system subtype such as GDS, WEB, etc. schema: type: string - name: systemType in: query required: false description: External system type such as CHANNEL, OXI, etc. schema: type: string - name: systemName in: query required: false description: External system name. schema: type: string - name: websiteURL in: query required: false description: Cannel Website URL schema: type: string - name: iconURL in: query required: false description: Channel Icon URL schema: type: string - name: localSystemCode in: query description: Code used inside the OPERA System required: false style: form explode: true schema: type: array items: type: string - name: externalSystemCode in: query description: Code used in the External System required: false style: form explode: true schema: type: array items: type: string - name: description in: query description: Detailed Description of the given entity. required: false style: form explode: true schema: type: array items: type: string - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - name: requirementCode in: query description: Requirement code of guarantee. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/guarantees/mapping: get: summary: Gets channel guarantee code mapping for a hotel description: Use this API to get channel guarantee code mapping to OPERA guarantee code for a given hotel.

OperationId:getGuaranteesMapping

operationId: getGuaranteesMapping deprecated: true parameters: - name: inactive in: query required: false description: Indicates whether searching for active or inactive codes. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: systemCode in: query required: false description: External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type. schema: type: string - name: systemType in: query required: false description: External system type to be searched. Possible values are CHANNEL, OXI, etc. schema: type: string - name: systemSubType in: query required: false description: External system sub type to be searched. Possible values are GDS, WEB, etc. schema: type: string - name: systemRateType in: query required: false description: External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc. schema: type: string - name: localSystemCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicates whether to include inactive guarantees or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching external system guarantees. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/guaranteesMapping' '204': description: GuaranteesMapping not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/hotels: post: summary: Adds channel hotel mapping description: Use this API to add channel mapping to OPERA hotel id including channel hotel code, room sell limit per reservation, city code, end date.

OperationId:postHotelsMapping

operationId: postHotelsMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/properties' description: Request object for creating external system properties. required: true put: summary: Updates channel hotel mapping description: Use this API to update channel mapping to OPERA hotel id including channel hotel code, room sell limit per reservation, city code, end date

OperationId:putHotelsMapping

operationId: putHotelsMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/properties' description: Request object for changing existing external system properties. required: true delete: summary: Deletes channel hotel mapping description: Use this API to delete channel mapping to OPERA hotel id including channel hotel code, room sell limit per reservation, city code, end date.

OperationId:deleteHotelsMapping

operationId: deleteHotelsMapping deprecated: true parameters: - name: inactive in: query required: false description: Indicates whether code is inactive or not. schema: type: boolean - name: systemCode in: query required: false description: External system code such as TRAVELOCITY, EXPEDIA, etc. schema: type: string - name: systemSubType in: query required: false description: External system subtype such as GDS, WEB, etc. schema: type: string - name: systemType in: query required: false description: External system type such as CHANNEL, OXI, etc. schema: type: string - name: systemName in: query required: false description: External system name. schema: type: string - name: websiteURL in: query required: false description: Cannel Website URL schema: type: string - name: iconURL in: query required: false description: Channel Icon URL schema: type: string - name: localSystemCode in: query description: Code used inside the OPERA System required: false style: form explode: true schema: type: array items: type: string - name: externalSystemCode in: query description: Code used in the External System required: false style: form explode: true schema: type: array items: type: string - name: description in: query description: Detailed Description of the given entity. required: false style: form explode: true schema: type: array items: type: string - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - name: city in: query description: City code of the channel hotel. required: false style: form explode: true schema: type: array items: type: string - name: roomLimit in: query description: Maximum room limit for the channel hotel reservation. required: false style: form explode: true schema: type: array items: type: integer - name: bookingLimit in: query description: Booking limit used by ADS interface for booking limit upload. Available if channel type is ADS and ADS ARI is enabled. required: false style: form explode: true schema: type: array items: type: integer - name: hotelChainId in: query description: Hotel chain ID of channel-hotel mapping. Only available for UA channel. It may not be modified if in myfidelio environment, and user is for a specific hotel. required: false style: form explode: true schema: type: array items: type: string - name: chainCode in: query description: Chain code for the channel-hotel mapping. required: false style: form explode: true schema: type: array items: type: string - name: prevailingRates in: query description: Prevailing rates flag of channel-hotel mapping. Available if PREVAILING_RATE_BY_LOS parameter is on. required: false style: form explode: true schema: type: array items: type: boolean - name: aRIEnabled in: query description: ADS ARI enabled flag of channel-hotel mapping. Available only if channel type is ADS. required: false style: form explode: true schema: type: array items: type: boolean - name: addOnLicense in: query description: External system Add-on license. This is mandatory when Channel Type is ADS. required: false style: form explode: true schema: type: array items: type: string - name: available in: query required: false description: Flag indicating if channel resort mapping is available. schema: type: boolean - name: defaultRateCode in: query required: false description: Default rate code to be used to calculate the total revenue. schema: type: string - name: defaultRateCode1 in: query description: Default rate code of channel hotel. required: false style: form explode: true schema: type: array items: type: string - name: lowRevenueThreshold in: query description: Low revenue threshold. required: false style: form explode: true schema: type: array items: type: integer - name: highRevenueThreshold in: query description: High revenue threshold. required: false style: form explode: true schema: type: array items: type: integer - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/hotels/mapping: get: summary: Gets channel hotel mapping description: Use this API to get channel mapping to OPERA hotel id including channel hotel code, room sell limit per reservation, city code, end date.

OperationId:getHotelsMapping

operationId: getHotelsMapping deprecated: true parameters: - name: inactive in: query required: false description: Indicates whether searching for active or inactive codes. schema: type: boolean - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: systemCode in: query required: false description: External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type. schema: type: string - name: systemType in: query required: false description: External system type to be searched. Possible values are CHANNEL, OXI, etc. schema: type: string - name: systemSubType in: query required: false description: External system sub type to be searched. Possible values are GDS, WEB, etc. schema: type: string - name: systemRateType in: query required: false description: External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc. schema: type: string - name: localSystemCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicates whether to include inactive guarantees or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching external system properties. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/propertiesMapping' '204': description: HotelsMapping not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/marketingText: get: summary: Gets channel marketing messages description: Use this API to get channel mapping for marketing messages.

OperationId:getChannelMarketingText

operationId: getChannelMarketingText deprecated: true parameters: - name: transactionType in: query required: false schema: type: string - name: policyType in: query required: false schema: type: string - name: policyDetail in: query required: false schema: type: string - name: beginDate in: query required: false schema: type: string format: date - name: filterHotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: bookingChannelCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionTypes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: policyTypesPolicyType in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: policyDetailPolicyDetail in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: showGlobal in: query required: false schema: type: boolean - name: includeInactive in: query required: false description: Include or not include inactive channel marketing text. schema: type: boolean - name: fetchInstructions in: query description: Simple type for channel fetch instruction. required: false style: form explode: true schema: type: array items: type: string enum: - Marketingtext - Amenity - Carrier - Currency - Error - Guarantee - Ratecategory uniqueItems: true - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: channelCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching channel marketing texts. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelMarketingTextsInfo' '204': description: ChannelMarketingText not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel post: summary: Adds channel marketing messages description: Use this API to add channel mapping for marketing messages

OperationId:postChannelMarketingText

operationId: postChannelMarketingText deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelMarketingText' description: Request object for creating channel marketing texts. required: true put: summary: Updates channel marketing messages description: Use this API to update channel mapping for marketing messages

OperationId:putChannelMarketingText

operationId: putChannelMarketingText deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelMarketingTextToChange' description: Request object for changing channel marketing texts. required: true delete: summary: Deletes channel marketing messages description: Use this API to delete channel mapping for marketing messages.

OperationId:deleteChannelMarketingText

operationId: deleteChannelMarketingText deprecated: true parameters: - name: beginDate in: query required: false style: form explode: true schema: type: array items: type: string format: date - name: bookingChannelCode in: query description: The code that identifies a Booking Channel. required: false style: form explode: true schema: type: array items: type: string - name: endDate in: query required: false style: form explode: true schema: type: array items: type: string format: date - name: globalTextYN in: query required: false style: form explode: true schema: type: array items: type: boolean - name: hotelId in: query description: The code that identifies a Hotel. required: false style: form explode: true schema: type: array items: type: string - name: marketingText in: query required: false style: form explode: true schema: type: array items: type: string - name: policyDetail in: query required: false style: form explode: true schema: type: array items: type: string - name: policyType in: query required: false style: form explode: true schema: type: array items: type: string - name: transactionType in: query required: false style: form explode: true schema: type: array items: type: string - name: newHotelId in: query required: false style: form explode: true schema: type: array items: type: string - name: newTransactionType in: query required: false style: form explode: true schema: type: array items: type: string - name: newPolicyType in: query required: false style: form explode: true schema: type: array items: type: string - name: newPolicyDetail in: query required: false style: form explode: true schema: type: array items: type: string - name: newBeginDate in: query required: false style: form explode: true schema: type: array items: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/marketingText/copy: post: summary: Allows to copy marketing message to another channel and hotel description: Use this API to copy one channel's mapping for marketing messages to another channel and hotel mapping.

OperationId:copyChannelMarketingText

operationId: copyChannelMarketingText deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelMarketingTextCopy' description: Request object to copy channel marketing texts. required: true /channels/negotiatedRates: post: summary: Adds channel negotiate rate description: Use this API to add channel's negotiated rate code mapping with an OPERA profile for a given hotel id

OperationId:postChannelNegotiatedRate

operationId: postChannelNegotiatedRate deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelNegotiatedRates' description: Request object for creating Negotiated channel rates. required: true put: summary: Updates channel negotiate rate description: Use this API to update channel's negotiated rate code mapping including negotiated profile, negotiate rate access code, start date, end date, and sequence.

OperationId:putChannelNegotiatedRate

operationId: putChannelNegotiatedRate deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelNegotiatedRates' description: Request object for changing Negotiated channel rates. required: true delete: summary: Deletes channel negotiate rate description: Use this API to update channel's negotiated rate code mapping including negotiated profile, negotiate rate access code, start date, end date, and sequence.

OperationId:deleteChannelNegotiatedRate

operationId: deleteChannelNegotiatedRate deprecated: true parameters: - name: bookingChannelCode in: query required: false description: Booking Channel Code. schema: type: string - name: channelRatePlanCode in: query required: false description: Channel Room Type. schema: type: string - name: hotelId in: query required: false description: Hotel Code. schema: type: string - name: id in: query 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. required: false style: form explode: true schema: type: array items: type: string - name: idContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: type in: query description: A reference to the type of object defined by the UniqueID element. required: false style: form explode: true schema: type: array items: type: string - name: externalSystem in: query required: false description: When name type is external, indicates the external system the name belongs to. schema: type: string - name: language in: query required: false description: Language code associated with an alternate name. schema: type: string - name: nameType in: query required: false description: Person's name in an external system. schema: type: string enum: - Primary - Alternate - Incognito - External - Phonetic uniqueItems: true - name: namePrefix in: query required: false description: Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) schema: type: string - name: givenName in: query required: false description: Given name, first name or names. schema: type: string - name: middleName in: query required: false description: The middle name of the person name. schema: type: string - name: surname in: query required: false 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. schema: type: string - name: nameSuffix in: query required: false description: Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) schema: type: string - name: nameTitle in: query required: false description: Degree or honors (e.g., Ph.D., M.D.) schema: type: string - name: nameTitleSuffix in: query required: false description: Title Suffix. Must be populated if ADVANCED_TITLE is on. schema: type: integer - name: envelopeGreeting in: query required: false description: Envelope Greeting of the profile schema: type: string - name: salutation in: query required: false description: Salutation of the profile schema: type: string - name: accessCode in: query required: false style: form explode: true schema: type: array items: type: string - name: end in: query description: The ending value of the date range. required: false style: form explode: true schema: type: array items: type: string format: date - name: start in: query description: The starting value of the date range. required: false style: form explode: true schema: type: array items: type: string format: date - name: newAccessCode in: query required: false schema: type: string - name: channelRatePlanCodeOrder in: query required: false schema: type: integer - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel get: summary: Gets channel negotiate rate description: Use this API to update channel's negotiated rate code mapping including negotiated profile, negotiate rate access code, start date, end date, and sequence.

OperationId:getChannelNegotiatedRate

operationId: getChannelNegotiatedRate deprecated: true parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: hotelId in: query required: false schema: type: string - name: bookingChannelCode in: query required: false schema: type: string - name: channelRatePlanCode in: query required: false schema: type: string - name: accessCode in: query required: false schema: type: string - name: uniqueId in: query 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. required: false style: form explode: true schema: type: array items: type: string - name: uniqueIdType in: query required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Negotiated channel rates. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelNegotiatedRateDetails' '204': description: ChannelNegotiatedRate not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/rateCategories: delete: summary: Deletes given channel's rate categories description: Use this API to delete channel rate categories for a given channel.

OperationId:deleteChannelRateCategories

operationId: deleteChannelRateCategories deprecated: true parameters: - name: bookingChannelCodes in: query description: Booking channel code of rate category. required: true style: form explode: true schema: type: array items: type: string - name: rateCategories in: query description: Code of rate category. required: true style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/rateLevels: delete: summary: Deletes channel rate level description: Use this API to delete channel rate level code's description.

OperationId:deleteChannelRateLevels

operationId: deleteChannelRateLevels deprecated: true parameters: - name: bookingChannelCodes in: query description: Booking channel code of rate level. required: true style: form explode: true schema: type: array items: type: string - name: rateLevels in: query description: Code of rate level. required: true style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/rates: get: summary: Gets channel property rate mapping description: Use this API to get channel property rate mapping including channel rate code, start date, end date, rate level, channel rate description.

OperationId:getChannelRateMapping

operationId: getChannelRateMapping deprecated: true parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: hotelId in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: channelCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: ratePlanCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: channelRatePlanCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: ratePlanCategories in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: channelRatePlanCategories in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeUnmappedRatePlans in: query required: false description: Flag whether to include unmapped rate codes. schema: type: boolean - name: onlyUnmappedRatePlans in: query required: false description: Flag whether to include unmapped rate codes only. schema: type: boolean - name: includeInactiveMappings in: query required: false description: Flag whether to include inactive mappings. schema: type: boolean - name: onlyNegotiatedRates in: query required: false description: Flag whether to include negotiated rate mappings only. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching hotel-channel rate code mappings given search criteria including hotel codes, booking channel codes, rate codes, channel rate codes, etc. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelRateMappings' '204': description: ChannelRateMapping not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel post: summary: Adds channel property rate mapping description: Use this API to add channel property rate mapping with OPERA hotel rate

OperationId:postChannelRateMapping

operationId: postChannelRateMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRateMapping' description: Request object for creating channel rate mappings. required: true put: summary: Updates channel property rate mapping description: Use this API to update channel property rate mapping including channel rate code, start date, end date, rate level, channel rate description.

OperationId:putChannelRateMapping

operationId: putChannelRateMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRateMapping' description: Request object for changing channel rate mappings. required: true delete: summary: Deletes channel property rate mapping description: Use this API to delete channel property rate mapping including channel rate code, start date, end date, rate level, channel rate description.

OperationId:deleteChannelRateMapping

operationId: deleteChannelRateMapping deprecated: true parameters: - name: bookingChannelCode in: query description: Booking Channel Code. required: false style: form explode: true schema: type: array items: type: string - name: channelRatePlanCode in: query description: Channel Room Type. required: false style: form explode: true schema: type: array items: type: string - name: hasChannelNegotiatedRates in: query description: True if the mapping has channel negotiated rates, otherwise false. required: false style: form explode: true schema: type: array items: type: boolean - name: hasNegotiatedRates in: query description: True if this channel rate plan code has negotiated rates, otherwise false required: false style: form explode: true schema: type: array items: type: boolean - name: hotelId in: query description: Hotel Code. required: false style: form explode: true schema: type: array items: type: string - name: ratePlanCode in: query description: Room Type. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/rates/globalDescriptions: get: summary: Gets global rate descriptions description: Use this API to get global rate description for given hotel id.

OperationId:getChannelRatesGlobalDescriptions

operationId: getChannelRatesGlobalDescriptions deprecated: true parameters: - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: ratePlanCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomTypes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: globalDescriptionType in: query required: false description: Either Room Type or Rate Plan Code schema: type: string enum: - RoomType - RatePlan uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object after fetch Global Descriptions of the GDS Channels content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelGlobalDescriptions' '204': description: ChannelRatesGlobalDescriptions not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel post: summary: Adds global room descriptions description: Use this API to adds global room description for given hotel id and room type code

OperationId:postChannelRatesGlobalDescriptions

operationId: postChannelRatesGlobalDescriptions deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelGlobalDescriptions' description: Request object to create new Global Descriptions of the GDS Channels required: true put: summary: Updates global rate descriptions description: Use this API to update global rate description for given hotel id and rate code

OperationId:putChannelRatesGlobalDescriptions

operationId: putChannelRatesGlobalDescriptions deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelGlobalDescriptions' description: Request object to update existing Global Descriptions of the GDS Channels required: true delete: summary: Deletes global rate descriptions description: Use this API to delete global rate description for given hotel id and rate code.

OperationId:deleteChannelRatesGlobalDescriptions

operationId: deleteChannelRatesGlobalDescriptions deprecated: true parameters: - name: hotelId in: query description: Property mapping with Rate plan code or Room type required: false style: form explode: true schema: type: array items: type: string - name: code in: query required: false description: Code. schema: type: string - name: description in: query required: false description: description. schema: type: string - name: code1 in: query required: false description: Code. schema: type: string - name: description1 in: query required: false description: description. schema: type: string - name: globalDescType in: query description: Either Room Type or Rate Plan Code required: false style: form explode: true schema: type: array items: type: string enum: - RoomType - RatePlan uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/rates/roomSequence: put: summary: Updates channel property rateroom sequence description: Use this API to update sequence for given channel property rate room mapping

OperationId:putChannelRateRoomSeq

operationId: putChannelRateRoomSeq deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRateRoomSequence' description: Request object for changing sequence for channel rate rooms. required: true /channels/restrictions/publish: put: summary: Publishes channel restrictions description: This API changes the channel restrictions.

OperationId:publishChannelRestrictions

operationId: publishChannelRestrictions deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRestrictions' description: Request object for publishing rate restrictions to channels. required: true /channels/roomTypes: delete: summary: Delete channel configuration description: Use this API to delete channel configuration.

OperationId:deleteChannelRoomTypes

operationId: deleteChannelRoomTypes deprecated: true parameters: - name: bookingChannelCodes in: query description: Booking channel code of room type. required: true style: form explode: true schema: type: array items: type: string - name: roomTypes in: query description: Code of room type. required: true style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/rooms: post: summary: Adds channel property room mapping description: Use this API to add channel room mapping to OPERA hotel's room.

OperationId:postChannelRoomMapping

operationId: postChannelRoomMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRoomMappings' description: Request object for Channel Room Mapping creation. required: true put: summary: Updates channel room configuration description: Use this API to update channel room description

OperationId:manageChannelRoomMapping

operationId: manageChannelRoomMapping deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRoomMappings' description: Request object to create, edit or delete channel room type mapping. required: true /channels/rooms/globalDescription: put: summary: Update global descriptions for a room description: Use this API to update OPERA room's global description for global distribution type channels

OperationId:putRoomDescription

operationId: putRoomDescription deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelGlobalDescription' description: Request object for changing Room Mapping description. required: true /channels/rooms/globalDescriptions: get: summary: Gets global room descriptions description: Use this API to get global room description for given hotel id and room type code.

OperationId:getChannelRoomsGlobalDescriptions

operationId: getChannelRoomsGlobalDescriptions deprecated: true parameters: - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: ratePlanCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomTypes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: globalDescriptionType in: query required: false description: Either Room Type or Rate Plan Code schema: type: string enum: - RoomType - RatePlan uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object after fetch Global Descriptions of the GDS Channels content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelGlobalDescriptions' '204': description: ChannelRoomsGlobalDescriptions not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel post: summary: Adds global rate descriptions description: Use this API to add global rate description for given hotel id and rate code

OperationId:postChannelRoomsGlobalDescriptions

operationId: postChannelRoomsGlobalDescriptions deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelGlobalDescriptions' description: Request object to create new Global Descriptions of the GDS Channels required: true put: summary: Updates global room descriptions description: Use this API to update global room description for given hotel id and room type code

OperationId:putChannelRoomsGlobalDescriptions

operationId: putChannelRoomsGlobalDescriptions deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelGlobalDescriptions' description: Request object to update existing Global Descriptions of the GDS Channels required: true delete: summary: Deletes global room descriptions description: Use this API to delete global room description for given hotel id and room type code.

OperationId:deleteChannelRoomsGlobalDescriptions

operationId: deleteChannelRoomsGlobalDescriptions deprecated: true parameters: - name: hotelId in: query description: Property mapping with Rate plan code or Room type required: false style: form explode: true schema: type: array items: type: string - name: code in: query required: false description: Code. schema: type: string - name: description in: query required: false description: description. schema: type: string - name: code1 in: query required: false description: Code. schema: type: string - name: description1 in: query required: false description: description. schema: type: string - name: globalDescType in: query description: Either Room Type or Rate Plan Code required: false style: form explode: true schema: type: array items: type: string enum: - RoomType - RatePlan uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/subChannels: delete: summary: Deletes sub channel configuration description: Use this API to delete sub-channel (carrier) configuration for a given channel code.

OperationId:deleteChannelCarriers

operationId: deleteChannelCarriers deprecated: true parameters: - name: bookingChannelCodes in: query description: Booking channel code of carrier. required: true style: form explode: true schema: type: array items: type: string - name: carriers in: query description: Code of carrier. required: true style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/{channelCode}: get: summary: Gets channel detail description: This API retrieves channel information for the given channel code.

OperationId:getChannel

operationId: getChannel deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: includeInactive in: query description: Indicates whether fetch should include inactive codes or not. required: false style: form explode: true schema: type: array items: type: boolean - name: fetchInstructions in: query description: Simple type for external system instructions that can be used in requests for partial operations. required: false style: form explode: true schema: type: array items: type: string enum: - RateLevel - Error - RoomType - Carrier - RateCategory uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching details of channel. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channel' '204': description: Channel not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/{channelCode}/errorCodes: put: summary: Updates channel error codes description: Use this API to update channel error code mapping configurations

OperationId:putChannelErrors

operationId: putChannelErrors deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelErrors' description: Request object for changing details of channel errors. required: true post: summary: Adds channel error codes description: Use this API to add channel error code mapping configurations

OperationId:postChannelErrors

operationId: postChannelErrors deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelErrors' description: Request object for creating channel errors. required: true /channels/{channelCode}/hotels: get: summary: Get channel hotel mappings description: Use this API to get the channel mappings to the OPERA hotel id, including hotel details for channel hotel code, room sell limit per reservation, city code and end date.

OperationId:getChannelHotelCodeMapping

operationId: getChannelHotelCodeMapping deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query required: false description: OPERA hotel code for which mapped channel hotel code should be fetched. schema: type: string - name: channelHotelCode in: query required: false description: Channel hotel code for which mapped OPERA hotel code should be fetched. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response giving OPERA hotel code mapped to channel hotel code for a booking channel and vice versa. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelHotelCodeMapping' '204': description: ChannelHotelCodeMapping not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/{channelCode}/parameters: put: summary: Updates channel control settings description: Use this API to active/inactive channel controls. It also allows to update channel control settings.

OperationId:putChannelParameters

operationId: putChannelParameters deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/changeChannelParameters' description: Request object for modifying channel parameter(s). required: true /channels/{channelCode}/rateCategories: put: summary: Updates given channel's rate categories description: Use this API to update channel rate categories for a given channel.

OperationId:putChannelRateCategories

operationId: putChannelRateCategories deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRateCategories' description: Request object for changing details of channel rate categories. required: true post: summary: Adds given channel's rate categories description: Use this API to add channel rate categories for a given channel.

OperationId:postChannelRateCategories

operationId: postChannelRateCategories deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRateCategories' description: Request object for creating channel rate categories. required: true /channels/{channelCode}/rateLevels: put: summary: Updates channel rate level description: Use this API to update channel rate level code's description

OperationId:putChannelRateLevels

operationId: putChannelRateLevels deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRateLevels' description: Request object for changing details of channel rate levels. required: true post: summary: Adds channel rate level description: Use this API to add channel rate level configurations

OperationId:postChannelRateLevels

operationId: postChannelRateLevels deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRateLevels' description: Request object for creating channel rate levels. required: true /channels/{channelCode}/ratePlans: put: summary: Publishes channel rate plan codes description: This API changes the channel rate plans for given channel code.

OperationId:publishChannelRatePlans

operationId: publishChannelRatePlans deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRatePlans' description: Request object for publishing rate codes to GDS. required: true /channels/{channelCode}/rateRoomSequences: get: summary: Gets channel property rateroom sequence description: Use this API to get sequence for given channel property rate room mapping.

OperationId:getChannelRateRoomSeq

operationId: getChannelRateRoomSeq deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: ratePlanCode in: query required: false description: Hotel Rate Plan Code. schema: type: string - name: roomType in: query required: false description: Hotel Room Type. schema: type: string - name: channelRatePlanCode in: query required: false description: Channel Rate Plan Code. schema: type: string - name: channelRoomType in: query required: false description: Channel Room Type. schema: type: string - name: channelRateRoomParameterName in: query description: Enumeration of the different parameters Channel Rate Room accepts. required: false style: form explode: true schema: type: array items: type: string enum: - ShowInactive uniqueItems: true - name: channelRateRoomParameterValue in: query required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for channel rate rooms sequence based on a criteria. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelRateRoomSequenceDetails' '204': description: ChannelRateRoomSeq not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /channels/{channelCode}/rates/{channelRateCode}/globalDescription: put: summary: Updates global descriptions for a rate description: Use this API to update OPERA rate's global description for global distribution type channels

OperationId:putRateGlobalDescription

operationId: putRateGlobalDescription deprecated: true parameters: - name: channelRateCode in: path required: true description: Channel Rate Code. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelGlobalDescription' description: Request object for changing channel rate codes global description. required: true /channels/{channelCode}/roomTypes: put: summary: Updates channel room description: Use this API to update channel room description

OperationId:putChannelRoomTypes

operationId: putChannelRoomTypes deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRoomTypes' description: Request object for changing details of channel room types. required: true post: summary: Adds channel room description: Use this API to add channel room configuration

OperationId:postChannelRoomTypes

operationId: postChannelRoomTypes deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRoomTypes' description: Request object for creating channel room types. required: true /channels/{channelCode}/subChannels: put: summary: Updates sub channel configuration description: Use this API to update sub-channel (carrier) configuration for a given channel code

OperationId:putChannelCarriers

operationId: putChannelCarriers deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelCarriers' description: Request object for changing details of channel carriers. required: true post: summary: Adds sub channel configuration description: Use this API to add sub-channel (carrier) configuration for a given channel code

OperationId:postChannelCarriers

operationId: postChannelCarriers deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelCarriers' description: Request object for creating channel carriers. required: true /channels/{channelCode}/tenants: post: summary: Adds channel tenants. description: This API adds channel tenants.

OperationId:postChannelOrgMapping

operationId: postChannelOrgMapping deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelOrgMapping' description: Request object for Create Channel to ORG and CRO Mapping. required: true /channels/{channelCode}/tenants/{tenantCode}: put: summary: Updates channel tenants mapping. description: This API changes channel tenants mapping.

OperationId:putChannelOrgMapping

operationId: putChannelOrgMapping deprecated: true parameters: - name: tenantCode in: path required: true description: Tenant Code. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelOrgMapping' description: Request object for Change Channel to ORG and CRO Mapping. required: true get: summary: Retrieves channel tenants mapping. description: This API retrieves channel tenants mapping.

OperationId:getChannelOrgMapping

operationId: getChannelOrgMapping deprecated: true parameters: - name: tenantCode in: path required: true description: Tenant Code. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: chainCode in: query required: false description: Chain code for which channel code and org code are mapped. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for Fetch Channel to ORG and CRO Mapping. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelOrgMappingsDetails' '204': description: ChannelOrgMapping not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel delete: summary: Deletes channel tenants mapping. description: This API deletes channel tenants mapping.

OperationId:deleteChannelOrgMapping

operationId: deleteChannelOrgMapping deprecated: true parameters: - name: tenantCode in: path required: true description: Tenant Code. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: chainCode in: query required: false description: Chain code for which channel code and org code are mapped. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /clusters/{clusterId}/channels/negotiatedRates: get: summary: Gets channel negotiate rate description: Use this API to update channel's negotiated rate code mapping including negotiated profile, negotiate rate access code, start date, end date, and sequence.

OperationId:getChannelNegotiatedRates

operationId: getChannelNegotiatedRates deprecated: true parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - $ref: '#/components/parameters/clusterIdPath' - name: hotelIds in: query required: true style: form explode: true schema: type: array items: type: string - name: channelCode in: query required: false schema: type: string - name: channelRateCode in: query required: false schema: type: string - name: ratePlanCode in: query required: false schema: type: string - name: accessCode in: query required: false schema: type: string - name: includeInactive in: query required: false schema: type: boolean default: false - name: internalChannelsOnly in: query required: false description: If true then it would fetch only the internal channels. If false then it expects channelCode as well to establish if its an internal or external channel. schema: type: boolean default: false - name: uniqueId in: query 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. required: false style: form explode: true schema: type: array items: type: string - name: uniqueIdType in: query required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Negotiated channel rates. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/profileNegotiatedRateDetails' '204': description: ChannelNegotiatedRate not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /clusters/{clusterId}/channels/profileRatesAccess: put: summary: Initiate profile rate access codes description:

OperationId: putProfileNegRateAccessCodes

Operation to Initiate profile rate access codes

operationId: putProfileNegRateAccessCodes deprecated: true parameters: - name: clusterId in: path required: true description: ClusterId in URI path. schema: type: string maxLength: 50 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/profileRateAccessCodes' description: Request for configuring profile rate access codes. required: true /clusters/{clusterId}/channels/profileRatesAccessDeletes: post: summary: Delete Channel Rates Access for cluster level operationId: deleteProfileNegRateAccessCodes description:

operationId:deleteProfileNegRateAccessCodes

Delete Channel Rates Access for cluster level

deprecated: true parameters: - name: clusterId in: path required: true description: ClusterId in URI path. schema: type: string maxLength: 50 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/deleteNegotiatedRates' description: Request body required: true /clusters/{clusterId}/channels/syncProfileRatesAccess: put: summary: Sync profile rate access codes description:

OperationId: syncProfileNegRateAccessCodes

Operation to Initiate profile rate access codes

operationId: syncProfileNegRateAccessCodes deprecated: true parameters: - name: clusterId in: path required: true description: ClusterId in URI path. schema: type: string maxLength: 50 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/syncProfileRatesAccessCodes' description: Request for configuring profile rate access codes. required: true /hotels/totalPricing: post: summary: Adds total pricing tax and fee types description: Use this API to add global distribution channels tax and fee configurations.

OperationId:postTotalPricingElements

operationId: postTotalPricingElements deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/totalPricingElements' description: Request object to create the total pricing elements of GDS channel. required: true put: summary: Updates total pricing tax and fee types description: Use this API to update global distribution channels tax and fee configurations

OperationId:putTotalPricingElements

operationId: putTotalPricingElements deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/totalPricingElements' description: Request object to change the total pricing elements of GDS channel. required: true delete: summary: Deletes total pricing tax and fee types description: Use this API to delete global distribution channels tax and fee configurations.

OperationId:deleteTotalPricingElements

operationId: deleteTotalPricingElements deprecated: true parameters: - name: hotelId in: query description: Hotel Code that associated with Transaction Code and Total Pricing Element required: false style: form explode: true schema: type: array items: type: string - name: code in: query required: false description: Code. schema: type: string - name: description in: query required: false description: description. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /hotels/totalPricing/copy: put: summary: Allows to copy total pricing tax and fees to another hotel id description: Use this API to copy global distribution system's fee and tax configurations from one hotel to another hotel within same chain/tenant

OperationId:copyTotalPricingElements

operationId: copyTotalPricingElements deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/totalPricingElementsCopy' description: Request object to copy the total pricing elements into the target properties. required: true /hotels/{hotelId}/channels/guarantees: get: summary: Gets channel guarantee code mappings description: Use this API to get the list of the channel guarantee code mappings to the OPERA guarantee codes.

OperationId:getChannelGuaranteeCodeMappings

operationId: getChannelGuaranteeCodeMappings deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: bookingChannelCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: guaranteeCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: channelGuaranteeCode in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactive in: query required: false description: Indicates whether search includes inactive mapping. schema: type: boolean - name: fetchUnmapped in: query required: false description: Indicates whether unmapped channel-hotel guarantee code should be fetched. schema: type: boolean - name: fetchMapped in: query required: false description: Indicates whether mapped channel-hotel guarantee code should be fetched. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching channel-hotel guarantee code mappings. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelGuaranteeCodeMappingDetails' '204': description: ChannelGuaranteeCodeMappings not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /hotels/{hotelId}/channels/ratePlans: put: summary: Publishes channel hotel rate plan codes description: This API changes the channel rate plans for given Hotel Id.

OperationId:publishHotelChannelRatePlans

operationId: publishHotelChannelRatePlans deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRatePlans' description: Request object for publishing rate codes to GDS. required: true /hotels/{hotelId}/channels/rates: post: summary: Distributes channel rate mappings to channel room types description: Use this API to link (distribute) channel a rate code to channel room types.

OperationId:postChannelRates

operationId: postChannelRates deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRates' description: Request object for distributing channel rates. required: true /hotels/{hotelId}/channels/totalPricing: get: summary: Gets total pricing tax and fee types description: Use this API to get global distribution channels tax and fee configurations.

OperationId:getTotalPricingElements

operationId: getTotalPricingElements deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: elementCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: transactionCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to populate total pricing elements of the GDS channel. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/totalPricingElements' '204': description: TotalPricingElements not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /hotels/{hotelId}/channels/{channelCode}/cardType/{cardTypeCode}: post: summary: Adds channel credit card mapping for a hotel description: Use this API to add channel mapping for OPERA credit cards to channel for a given hotel id

OperationId:postChannelCardTypeMapping

operationId: postChannelCardTypeMapping deprecated: true parameters: - name: cardTypeCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelCardTypeMappings' description: Request object for creating a new channel-hotel card type mapping. required: true put: summary: Updates channel credit card mapping for a hotel description: Use this API to update channel mapping for OPERA credit cards to channel for a given hotel id

OperationId:putChannelCardTypeMapping

operationId: putChannelCardTypeMapping deprecated: true parameters: - name: cardTypeCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelCardTypeMappings' description: Request object for changing information of an existing channel-hotel card type mapping. required: true delete: summary: Deletes channel credit card mapping for a hotel description: Use this API to delete channel mapping for OPERA credit cards to channel for a given hotel id.

OperationId:deleteChannelCardTypeMapping

operationId: deleteChannelCardTypeMapping deprecated: true parameters: - name: cardTypeCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - name: channelCardType in: query required: false description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /hotels/{hotelId}/channels/{channelCode}/guarantees/{guaranteeCode}: post: summary: Adds channel guarantee code mapping for a hotel description: Use this API to add channel guarantee code mapping to OPERA guarantee code for a given hotel

OperationId:postChannelGuaranteeCodeMapping

operationId: postChannelGuaranteeCodeMapping deprecated: true parameters: - name: guaranteeCode in: path required: true description: Guarantee Code. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelGuaranteeCodeMappings' description: Request object for creating a new channel-hotel guarantee code mapping. required: true put: summary: Updates channel guarantee code mapping for a hotel description: Use this API to update channel guarantee code mapping to OPERA guarantee code for a given hotel

OperationId:putChannelGuaranteeCodeMapping

operationId: putChannelGuaranteeCodeMapping deprecated: true parameters: - name: guaranteeCode in: path required: true description: Guarantee Code. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelGuaranteeCodeMappings' description: Request object for changing information of an existing channel-hotel guarantee code mapping. required: true delete: summary: Deletes channel guarantee code mapping for a hotel description: Use this API to delete channel guarantee code mapping to OPERA guarantee code for a given property.

OperationId:deleteChannelGuaranteeCodeMapping

operationId: deleteChannelGuaranteeCodeMapping deprecated: true parameters: - name: guaranteeCode in: path required: true description: Guarantee Code. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - name: channelGuaranteeCode in: query required: false description: Channel Guarantee Code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /hotels/{hotelId}/channels/{channelCode}/parameters: get: summary: Retrieves channel parameters. description: Use this API to get list of channel parameters and their settings.

OperationId:getChannelParameters

operationId: getChannelParameters deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - name: parameterNameWildCard in: query required: false description: Parameter for wild card search on channel parameters. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for channel parameter(s) based on search criteria. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelParameterMapping' '204': description: ChannelParameters not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /hotels/{hotelId}/channels/{channelCode}/policies: get: summary: Retrieves the channel policies description: Use this API to retrieve channel policies mapping.

OperationId:getChannelPolicies

operationId: getChannelPolicies deprecated: true parameters: - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - name: requestType in: query required: false schema: type: string - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - name: channelRatePlanCode in: query required: false style: form explode: true schema: type: array items: type: string - name: channelRoomTypeCode in: query required: false style: form explode: true schema: type: array items: type: string - name: ratePlanCode in: query required: false style: form explode: true schema: type: array items: type: string - name: roomTypeCode in: query required: false style: form explode: true schema: type: array items: type: string - name: corporateId 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. schema: type: string - name: corporateIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Request object for fetching Policies, guarantee, and deposit Details. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelPolicies' '204': description: ChannelPolicies not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /hotels/{hotelId}/channels/{channelCode}/rooms/{channelRoomType}/rates: post: summary: Distributes channel room rate mappings. description: Use this API to link (distribute) channel a room type to channel rate codes.

OperationId:postChannelRoomTypeRate

operationId: postChannelRoomTypeRate deprecated: true parameters: - name: channelRoomType in: path required: true description: Channel Room Type. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRates' description: Request object for distributing channel rates. required: true /hotels/{hotelId}/channels/{channelCode}/rooms/{roomTypeCode}: get: summary: Gets channel room mapping by room type description: This API retrieves channel room mapping by room type.

OperationId:getChannelRoomMappingById

operationId: getChannelRoomMappingById deprecated: true parameters: - name: roomTypeCode in: path required: true description: Room Type Code. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - name: beginDate in: query required: false description: Begin Date. schema: type: string format: date - name: channelRoomType in: query required: false description: Channel Room Type. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for Channel Room Mappings by ID. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelRoomMapping' '204': description: ChannelRoomMappingById not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel put: summary: Updates channel property room mapping description: Use this API to update channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.

OperationId:putChannelRoomMapping

operationId: putChannelRoomMapping deprecated: true parameters: - name: roomTypeCode in: path required: true description: Room Type Code. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/channelRoomMapping' description: Request object for changing Channel Room Mapping. required: true delete: summary: Deletes channel property room mapping description: Use this API to delete channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.

OperationId:deleteChannelRoomMapping

operationId: deleteChannelRoomMapping deprecated: true parameters: - name: roomTypeCode in: path required: true description: Room Type Code. schema: type: string maxLength: 2000 minLength: 1 - name: channelCode in: path required: true description: Unique ID that identifies a channel. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - name: beginDate in: query required: false description: Begin Date. schema: type: string format: date - name: channelRoomType in: query required: false description: Channel Room Type. schema: type: string - name: endDate in: query required: false description: End date of the hotel-channel room type mapping. schema: type: string format: date - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /hotels/{hotelId}/rates/{ratePlanCode}/globalDescription: get: summary: Gets global rate descriptions description: Use this API to get global rate description for given hotel id and rate code.

OperationId:getChannelRateCodeGlobalDesc

operationId: getChannelRateCodeGlobalDesc deprecated: true parameters: - name: ratePlanCode in: path required: true description: Rate Plan Code. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding global descriptions of hotel rate codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelEnhancedGlobalDescription' '204': description: ChannelRateCodeGlobalDesc not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /hotels/{hotelId}/rooms/mapping: get: summary: Gets channel property room mapping description: Use this API to get channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.

OperationId:getChannelRoomMapping

operationId: getChannelRoomMapping deprecated: true parameters: - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: bookingChannelCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomTypes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: channelRoomTypes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: includeInactiveMappings in: query required: false description: Flag whether to include inactive mappings or not. schema: type: boolean - name: includeUnmappedRoomTypes in: query required: false description: Flag whether to include unmapped room types or not. schema: type: boolean - name: onlyUnmappedRoomTypes in: query required: false description: Flag whether to include mapped room types only. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Operation to fetch hotel-channel room type mappings. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelRoomMappingsSummary' '204': description: ChannelRoomMapping not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /hotels/{hotelId}/rooms/{roomType}/globalDescription: get: summary: Gets global room descriptions description: Use this API to get global room description for given hotel id and room type code.

OperationId:getChannelRoomTypeGlobalDesc

operationId: getChannelRoomTypeGlobalDesc deprecated: true parameters: - name: roomType in: path required: true description: Room type. schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique ID that identifies a single hotel property. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for information regarding global descriptions of hotel room types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/channelEnhancedGlobalDescription' '204': description: ChannelRoomTypeGlobalDesc not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel /services/channels/status: get: summary: Retrieves channel service version description: This API retrieves channel service version.

OperationId:pingChannelService

operationId: pingChannelService deprecated: true parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for Ping operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaVersion' '204': description: pingChannelService not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - Channel components: schemas: channelRateRoomSequenceDetails: type: object description: Response object for channel rate rooms sequence based on a criteria. properties: channelRateRoomList: description: Booking channel rate room List. $ref: '#/components/schemas/channelRateRoomListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' systemInfoType: type: object description: External system attributes. properties: systemName: description: External system name. type: string minLength: 0 maxLength: 40 websiteURL: description: Cannel Website URL type: string minLength: 0 maxLength: 2000 iconURL: description: Channel Icon URL type: string minLength: 0 maxLength: 2000 systemCode: description: External system code such as TRAVELOCITY, EXPEDIA, etc. type: string minLength: 0 maxLength: 20 systemType: description: External system type such as CHANNEL, OXI, etc. type: string minLength: 0 maxLength: 20 systemSubType: description: External system subtype such as GDS, WEB, etc. type: string minLength: 0 maxLength: 20 inactive: description: Indicates whether code is inactive or not. type: boolean channelAccountContractsCopyResponseType: type: array description: List of channel account contracts information to create a copy of. maxItems: 4000 items: $ref: '#/components/schemas/channelAccountContractCopyResponseType' channelAccountContractCopyDetailsType: type: object description: Channel account contract type to hold account and contract details to copy. properties: sourceProfileId: description: Holds channel account profile identifier of the contract to be copied. $ref: '#/components/schemas/uniqueID_Type' sourceContractId: description: Holds contract Id of the contract to be copied. $ref: '#/components/schemas/uniqueID_Type' contractNo: description: Holds contract No of the new contract to create. type: string minLength: 0 maxLength: 20 beginDate: description: Holds begin date of the new contract. type: string format: date maxLength: 8 endDate: description: Holds end date of the new contract. type: string format: date maxLength: 8 note: description: Holds Note for the new contract. type: string minLength: 0 maxLength: 4000 retainContractNo: description: Flag to retain contract No or generate new one. type: boolean channelRateLevels: type: object description: Request object for creating channel rate levels. properties: rateLevels: description: channel rate levels to be created. type: object properties: rateLevel: description: Channel rate level details. type: array items: $ref: '#/components/schemas/systemRateLevelType' bookingChannelCode: description: Channel code. $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelHotelCodeMappingBucketsType: type: object description: Channel-hotel mapping buckets information. properties: channelHotelCodeMappingBucket: description: Default rate code revenue thresholds. type: array maxItems: 3 items: $ref: '#/components/schemas/channelHotelCodeMappingBucketType' defaultRateCode: description: Default rate code to be used to calculate the total revenue. type: string minLength: 0 maxLength: 20 available: description: Flag indicating if channel resort mapping is available. type: boolean channelRoomMappingDescriptionDetailsType: type: object description: This type holds descriptions of hotel-channel room type mapping. Descriptions may be enhanced descriptions, HTML supported description or a simple string description. properties: enhancedDescription: description: Enhanced descriptions which allow defining line 1 to 3 descriptions. $ref: '#/components/schemas/channelMappingEnhancedDescriptionType' hTMLSupportedDescription: description: HTML supported description with addition of channel room type short description. $ref: '#/components/schemas/channelRoomMappingHTMLSupportedDescriptionType' description: description: Description. type: string minLength: 0 maxLength: 2000 channelRoomMappingSummaryType: type: object description: Basic details of hotel-channel room type mapping. properties: endDate: description: End date of the hotel-channel room type mapping. type: string format: date maxLength: 8 description: description: Hotel-channel room type mapping description. $ref: '#/components/schemas/channelRoomMappingDescriptionType' alternateChannelRoomType: description: Alternate channel room type name. type: string minLength: 0 maxLength: 40 channelRoomTypeOrder: description: Channel room type order of the hotel-channel room type mapping. type: number sellSequence: description: Sell sequence for hotel-channel room type mapping. type: number active: description: Flag that indicates whether hotel-channel room type mapping is active or not. type: boolean bedTypeCode: description: Channel bed type code. type: string minLength: 0 maxLength: 20 baseAllocation: description: Channel base allocation. type: integer rateCodes: description: Rate codes where hotel-channel room type mappings belong to. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 channelRateCodes: description: Channel rate codes where hotel-channel room mappings belong to. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 noOfRateRoomsMapped: description: Number of active rate room mappings for the channel room type. type: integer maximumOccupancy: description: The maximum occupancy for this room category. type: integer defaultOccupancy: description: Default occupancy for the room type. type: integer physicalRoomsCount: description: The physical number of rooms in this room category at this property. type: integer bookingChannelCode: description: Booking Channel Code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 roomType: description: Room Type. type: string minLength: 0 maxLength: 20 channelRoomType: description: Channel Room Type. type: string minLength: 0 maxLength: 20 beginDate: description: Begin Date. type: string format: date maxLength: 8 policyBasisTypeType: type: string description: Full Amount. enum: - FlatAmount - Percentage - Nights - NightPercentage - FullAmount ratePlanPrimaryDetailsType: type: object properties: description: description: Description of the rate plan. $ref: '#/components/schemas/translationTextType2000' startSellDate: description: Start sell date of the rate plan. type: string format: date maxLength: 8 endSellDate: description: End sell date of the rate plan. type: string format: date maxLength: 8 sellSequence: description: Sell Sequence for the rate plan. type: number privilegedRate: description: The particular rate code is marked as privileged making it restrictive on who can update information. type: boolean privilegedRateRestriction: description: The restrictions marked on the rate code are marked as privileged making it restrictive on who can update information. type: boolean baseType: description: In Advanced Dynamic Base Rates, specifies how the rate code rates are defined, either as FLAT (defined by amounts) or DIFFERENTIAL (defined by offset). $ref: '#/components/schemas/baseType' lockStatus: description: Specifies the lock status of the rate code. Rates can be Unlocked, Externally locked, locked at Property level, or locked at Central level. $ref: '#/components/schemas/rateCodeLockStatusType' approvalStatus: description: Approval Status of the Rate Plan. $ref: '#/components/schemas/ratePlanApprovalStatusType' channelRateRoomSequence: type: object description: Request object for changing sequence for channel rate rooms. properties: channelRateRoomList: description: Booking channel rate room List. $ref: '#/components/schemas/channelRateRoomListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' contractElementInformationType: type: object description: To hold channel account contract element detailed information. properties: contractId: description: Contract Id of the contract. $ref: '#/components/schemas/uniqueID_Type' sequence: description: Sequence identifies contract element per contract. type: integer feeType: description: Holds Fee type of the contract element. If Fee type is not populated, it will be considered to delete this contract element. $ref: '#/components/schemas/contractFeeTypeType' bookingChannelType: description: Holds channel type of the contract element. type: string minLength: 0 maxLength: 240 bookingChannelCode: description: Holds channel of the contract element. type: string minLength: 0 maxLength: 20 contractPricing: description: Price information for this contract element. $ref: '#/components/schemas/contractPricingType' contractRangeInformation: description: Holds Contract Range per number of Properties, Rooms or reservations information. $ref: '#/components/schemas/contractRangeInformationType' frequency: description: Holds frequency of billing. $ref: '#/components/schemas/contractPriceFrequencyType' note: description: Holds Note for the contract element. type: string minLength: 0 maxLength: 4000 channelRates: type: object description: Request object for distributing channel rates. properties: distributeChannelRates: description: Information about rate code to be distributed to channels. $ref: '#/components/schemas/distributeChannelRatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountContractsType: type: object description: Channel account contracts type to hold account and contract details. properties: profileId: description: Unique channel account profile identifier. $ref: '#/components/schemas/profileId' accountCode: description: Holds Account code of the channel account. type: string minLength: 0 maxLength: 20 accountName: description: Holds Account Name of the channel account. type: string minLength: 0 maxLength: 80 channelAccountContractsInformation: description: Provides detailed information regarding Channel Account contract. $ref: '#/components/schemas/channelAccountContractsInformationType' channelBillingStatement: type: object description: Response object of the channel billing statement fetch request. properties: channelBillingStatement: description: Detailed information of channel billing statement. $ref: '#/components/schemas/channelBillingStatementType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' statementDetailsStatisticsType: type: object description: Channel statement details statistics . properties: detailsByResort: description: Channel billing statement details statistics by Resort. $ref: '#/components/schemas/statisticDetailsType' detailsByChannel: description: Channel billing statement details statistics by Channel. $ref: '#/components/schemas/statisticDetailsType' detailsByChannelType: description: Channel billing statement details statistics by Channel type. $ref: '#/components/schemas/statisticDetailsType' detailsByFeeType: description: Channel billing statement details statistics by Fee type. $ref: '#/components/schemas/statisticDetailsType' channelRateMappingType: type: object description: Basic details of a hotel-channel rate code mapping. properties: description: description: Description of channel rate plan code. $ref: '#/components/schemas/channelRateMappingDescriptionType' channelRatePlanWebName: description: Name of channel rate plan code to display on web. type: string minLength: 0 maxLength: 80 channelRatePlanCategory: description: Channel rate category of hotel-channel rate code mapping. type: string minLength: 0 maxLength: 20 rateLevel: description: Rate Level. type: string minLength: 0 maxLength: 3 rateTierAttr: description: Rate Tier. type: object properties: rateTier: type: integer blockRateIndicator: description: Block Rate Indicator. type: string minLength: 0 maxLength: 80 promotionCode: description: Promotion Code. type: string minLength: 0 maxLength: 20 channelRatePlanOrder: description: Order of the channel rate type mapping. type: number allowRateUpdate: description: Indicates if Rate updates to Channel are allowed. type: boolean allowRatesToGds: description: Indicates if the rate is to be distributed to channels. type: boolean allowRestrictionUpdate: description: Indicates if Rate Restrictions are sent to an ADS, GDS, or ODS partner, such as Expedia, via the AVH messaging functionality. type: boolean regionalAvailAttr: description: Indicates if rate participates in Regional Availability. type: object properties: inclInRegionalAvail: type: boolean allowRegionalAvail: type: boolean beginDate: description: Begin date of the channel rate code mapping. type: string format: date maxLength: 8 endDate: description: End date of the channel rate code mapping. type: string format: date maxLength: 8 carrierInfo: description: Carrier attached to the Channel Rate Plan. $ref: '#/components/schemas/carrierInfoType' newChannelRatePlanCode: description: New Channel Rate Plan Code of the mapping. Used only to change the Channel Rate Plan Code. type: string minLength: 0 maxLength: 20 roomTypes: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 ratePlanInfo: description: Rate plan information including description and sell dates. $ref: '#/components/schemas/ratePlanPrimaryDetailsType' bookingChannelCode: description: Booking Channel Code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 ratePlanCode: description: Room Type. type: string minLength: 0 maxLength: 20 channelRatePlanCode: description: Channel Room Type. type: string minLength: 0 maxLength: 20 hasNegotiatedRates: description: True if this channel rate plan code has negotiated rates, otherwise false type: boolean hasChannelNegotiatedRates: description: True if the mapping has channel negotiated rates, otherwise false. type: boolean channelStatementAccountsType: type: array description: Provides detailed information regarding Channel Account contract. maxItems: 4000 items: $ref: '#/components/schemas/channelStatementAccountType' distributionTemplateChannelRateType: type: object description: Information about channel rates of a distribution template. properties: systemInfo: description: Main details of external system. $ref: '#/components/schemas/systemInfoType' channelRateCode: description: Channel Rate Code where distribution template will be distributed to. type: string minLength: 0 maxLength: 20 channelRateCategory: description: Channel Rate Category where distribution template will be distributed to. type: string minLength: 0 maxLength: 20 channelRateLevel: description: Channel Rate Level where distribution template will be distributed to. type: string minLength: 0 maxLength: 20 regionalAvailability: description: Regional Availability flag which will be the default value when rate code is distributed to channels. type: boolean rateUpdate: description: Rate update flag which will be the default value when rate code is distributed to channels. type: boolean restrictionUpdate: description: Restriction update flag which will be the default value when rate code is distributed to channels. type: boolean returnSGA: description: Return SGA flag which will be the default value when rate code is distributed to channels. type: boolean guaranteesMapping: type: object description: Response object for fetching external system guarantees. properties: guaranteesMapping: description: Collection of external system guarantees based on the request criteria. $ref: '#/components/schemas/guaranteesMappingType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelMarketingText: type: object description: Request object for creating channel marketing texts. properties: createChannelMarketingTexts: description: List of channel marketing texts to be created. type: array items: $ref: '#/components/schemas/marketingTextType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelRateCategories: type: object description: Request object for creating channel rate categories. properties: rateCategories: description: channel rate categories to be created. type: object properties: rateCategory: description: Channel rate category details. type: array items: $ref: '#/components/schemas/systemRateCategoryType' bookingChannelCode: description: Channel code. $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountInformationType: type: object description: To hold channel account detailed information. properties: accountDetails: description: Detailed Account information. $ref: '#/components/schemas/channelAccountDetailsType' accountSetupDetails: description: Detailed Account setup information. $ref: '#/components/schemas/channelAccountSetupDetailsType' contactInformation: description: Account contact information. $ref: '#/components/schemas/channelAccountContactType' channelAccountNotes: description: Account notes information. $ref: '#/components/schemas/channelAccountNotesType' communicationDetails: description: Communication details assigned to account. $ref: '#/components/schemas/channelAccountCommunicationType' contractInformation: description: Communication details assigned to account. $ref: '#/components/schemas/channelAccountContractsInformationType' channelAccountIndicators: description: Indicators of additional information attached to the profile $ref: '#/components/schemas/indicatorsType' 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: '#/components/schemas/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 channelRateMappingsSourceDescriptionsType: type: array description: Source descriptions of a hotel-channel rate code mapping. maxItems: 4000 items: $ref: '#/components/schemas/channelRateMappingSourceDescriptionsType' profileNegotiatedRateDetails: type: object description: Response object for fetching Negotiated channel rates. properties: items: type: array items: $ref: '#/components/schemas/getChannelRatesAccessItems' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelType: type: object description: Identify details of an external system. properties: systemInfo: description: Identify main details of external system. $ref: '#/components/schemas/systemInfoType' sellBy: description: External system Sell By. type: string minLength: 0 maxLength: 20 addOnLicense: description: External system Add-on license. Available for ADS only. type: string minLength: 0 maxLength: 20 rateLevels: description: External system rate levels details. type: array maxItems: 4000 items: $ref: '#/components/schemas/systemRateLevelType' rateCategories: description: External system rate categories details. type: array maxItems: 4000 items: $ref: '#/components/schemas/systemRateCategoryType' roomTypes: description: External system room type details. type: array maxItems: 4000 items: $ref: '#/components/schemas/systemRoomTypeType' carriers: description: External system carrier details. type: array maxItems: 4000 items: $ref: '#/components/schemas/systemCarrierType' errorCodes: description: External system error details. type: array maxItems: 4000 items: $ref: '#/components/schemas/systemErrorType' parameters: description: Parameters of external system. $ref: '#/components/schemas/parametersType' channelMappingEnhancedDescriptionType: type: object description: Enhanced descriptions of hotel-channel room type or rate code mapping. properties: enhancedDescriptionLine1: description: Enhanced Description Line 1. $ref: '#/components/schemas/translationTextType50' enhancedDescriptionLine2: description: Enhanced Description Line 2. $ref: '#/components/schemas/translationTextType50' enhancedDescriptionLine3: description: Enhanced Description Line 3. $ref: '#/components/schemas/translationTextType50' channel: type: object description: Response object for fetching details of channel. properties: channel: description: Details of a channel. $ref: '#/components/schemas/channelType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelRatesAccessMain: type: object properties: hotelId: type: string description: Unique ID that identifies a single hotel property. minLength: 1 maxLength: 20 channelCode: type: string channelRatePlanCode: type: string startDate: type: string format: date description: ISO 8601 date Format 'YYYY-MM-DD' endDate: type: string format: date description: ISO 8601 date Format 'YYYY-MM-DD' rateAccessCode: type: string active: type: boolean accountId: description: Id of the profile account type: string minLength: 1 maxLength: 20 pattern: '[A-Z0-9]+' accountName: description: Name of the profile account type: string minLength: 1 profileAccountType: $ref: '#/components/schemas/accountTypeEnum' profileId: type: string minLength: 1 maxLength: 20 description: Profile Id for which Channel Rate access code is applicable for. propertiesMappingType: type: array description: Information about an external property mapping. maxItems: 4000 items: $ref: '#/components/schemas/propertyMappingType' channelHotelLettersToBeCreated: type: object description: Request object to create new Hotel Letters associated with the Channels properties: channelHotelLetters: description: Hotel Letters associated with the Booking Channel to be created. $ref: '#/components/schemas/channelHotelLettersType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountSummaryType: type: object description: To hold channel account detailed information. properties: hotelId: description: Property of the Billing Account. type: string minLength: 0 maxLength: 20 profileIdList: description: Billing Account profile Id details. $ref: '#/components/schemas/uniqueIDListType' accountDetails: description: Detailed Account information. $ref: '#/components/schemas/channelAccountDetailsType' addressInfo: description: Detailed information on an address for the Billing Account contact. $ref: '#/components/schemas/addressInfoType' telephoneInfo: description: Detailed information on telephone/ fax for the Billing Account contact. $ref: '#/components/schemas/telephoneInfoType' emailInfo: description: Detailed information on an eMail address for the customer contact. $ref: '#/components/schemas/emailInfoType' contractEndsOn: description: Channel account contract ends on date. type: string format: date maxLength: 8 channelAccountIndicators: description: Indicators of additional information attached to the profile $ref: '#/components/schemas/indicatorsType' hotels: description: List of all the hotels where channel account is associated. $ref: '#/components/schemas/codeListType' inactive: description: Indicates whether the account is inactive or not. type: boolean bookingChannelMappingType: type: object properties: bookingChannelCode: type: string minLength: 0 maxLength: 20 code: type: string minLength: 0 maxLength: 20 name: type: string minLength: 0 maxLength: 40 description: type: string minLength: 0 maxLength: 2000 distributeChannelRatesType: type: object description: Information about rate codes to be distributed to channels. properties: distributeChannelRate: description: Information about rate codes to be distributed to a channel. type: array maxItems: 4000 items: $ref: '#/components/schemas/distributeChannelRateType' hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 amenityMappingType: type: object description: Base external system mapping info. properties: systemInfo: description: Identify details of External System $ref: '#/components/schemas/systemInfoType' localSystemCode: description: Code used inside the OPERA System type: string minLength: 0 maxLength: 20 externalSystemCode: description: Code used in the External System type: string minLength: 0 maxLength: 20 description: description: Detailed Description of the given entity. type: string minLength: 0 maxLength: 2000 dateRange: description: Start and End Date of the mapping validity. If value is not supplied that mapping will be valid forever. $ref: '#/components/schemas/timeSpanType' amenityGroup: description: User defined logical group name for the amenities. $ref: '#/components/schemas/amenityGroupType' managedBy: $ref: '#/components/schemas/managedByOptions' distributionTemplateChannelRatesType: type: array description: Information about channel rate where distribution template will be distributed to. maxItems: 4000 items: $ref: '#/components/schemas/distributionTemplateChannelRateType' channelRateRoomType: type: object description: This type holds data for channel Rate room. properties: channelRateRoomDetail: $ref: '#/components/schemas/channelRateRoomDetailType' bookingChannelCode: description: Booking Channel Code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 roomType: description: Room Type. type: string minLength: 0 maxLength: 20 channelRoomType: description: Channel Room Type. type: string minLength: 0 maxLength: 20 ratePlanCode: description: Rate Plan code. type: string minLength: 0 maxLength: 20 channelRatePlanCode: description: Channel Rate Plan code. type: string minLength: 0 maxLength: 20 beginDate: description: Begin Date. type: string format: date maxLength: 8 endDate: description: End Date. type: string format: date maxLength: 8 inactive: description: Channel Rate Room Type is invalid. type: boolean channelNegotiatedRates: type: object description: Request object for changing Negotiated channel rates. properties: channelNegRates: description: Negotiated channel rate details to be modified. type: array items: $ref: '#/components/schemas/channelNegRateType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelRoomMappingHTMLSupportedDescriptionType: type: object description: This type holds HTML description of hotel-channel room type with additional channel room type short description. properties: description: description: Description. type: string minLength: 0 maxLength: 2000 shortDescription: description: Channel room type or rate code short description. type: string minLength: 0 maxLength: 80 channelStatementDetailsType: type: array description: Provides detailed information regarding Channel Account statements. maxItems: 4000 items: $ref: '#/components/schemas/channelStatementDetailType' hotelChannelInfoType: type: object properties: bookingChannelMappings: description: Booking Channels mapping for the Hotel Code. type: array maxItems: 4000 items: $ref: '#/components/schemas/bookingChannelMappingType' hotelId: type: string minLength: 0 maxLength: 20 name: type: string minLength: 0 maxLength: 40 baseType: type: string description: Simple type for base type, flat or differential. enum: - Flat - Differential channelRoomTypes: type: object description: Request object for creating channel room types. properties: roomTypes: description: channel room types to be created. type: object properties: roomType: description: Channel room type details. type: array items: $ref: '#/components/schemas/systemRoomTypeType' bookingChannelCode: description: Channel code. $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' indicatorsType: type: array description: Collection of lamp indicators. maxItems: 4000 items: $ref: '#/components/schemas/indicatorType' timeSpanType: type: object description: Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date. properties: startDate: type: string format: date maxLength: 8 endDate: type: string format: date maxLength: 8 duration: type: string channelGlobalDescriptionType: type: object description: This type holds enhanced room/rate description. properties: shortDescription: $ref: '#/components/schemas/translationTextType2000' description: $ref: '#/components/schemas/translationTextType2000' enhancedDesc1: $ref: '#/components/schemas/translationTextType50' enhancedDesc2: $ref: '#/components/schemas/translationTextType50' enhancedDesc3: $ref: '#/components/schemas/translationTextType50' source: type: string hotelId: type: string minLength: 0 maxLength: 20 bookingChannelCode: type: string minLength: 0 maxLength: 20 roomType: type: string minLength: 0 maxLength: 20 rateCode: type: string minLength: 0 maxLength: 20 totalPricingElementType: type: object description: Total Pricing Element ID type used to identify the record properties: hotelId: description: Hotel Code that associated with Transaction Code and Total Pricing Element type: string minLength: 0 maxLength: 20 transaction: description: Transaction Code with Total Pricing Element of the GDS channel $ref: '#/components/schemas/codeDescriptionType' elementCode: description: The mapped Total Pricing Element code of the GDS channel $ref: '#/components/schemas/codeDescriptionType' chargeType: description: The mapped Total Pricing Element Charge Type of the GDS channel $ref: '#/components/schemas/chargeTypeType' editPricingElementId: description: Combination of primary attributes of Total Pricing Element to update the primary attribute field $ref: '#/components/schemas/totalPricingElementIDType' indicatorType: type: object description: Lamp indicator Type. properties: indicatorName: description: Name of the indicator. type: string minLength: 0 maxLength: 80 count: description: Indicates number of occurrences of the indicator. type: integer channelGuaranteeCodeMappingType: type: object description: Channel-hotel guarantee code mapping information. properties: newChannelGuaranteeCode: description: New channel guarantee code for the existing guarantee code mapping. type: string minLength: 0 maxLength: 20 paymentType: description: Payment type of guarantee code mapping. type: string minLength: 0 maxLength: 20 inactiveDate: description: Inactive date of guarantee code mapping. type: string format: date maxLength: 8 hotelId: description: Hotel code of guarantee code mapping. type: string minLength: 0 maxLength: 20 bookingChannelCode: description: Booking channel code of guarantee code mapping. type: string minLength: 0 maxLength: 20 guaranteeCode: description: Guarantee code of guarantee code mapping. type: string minLength: 0 maxLength: 20 channelGuaranteeCode: description: Channel guarantee code of guarantee code mapping. type: string minLength: 0 maxLength: 20 channelGuaranteeCodeMappings: type: object description: Request object for creating a new channel-hotel guarantee code mapping. properties: channelGuaranteeCodeMapping: description: Channel-hotel guarantee code mapping information to be created. $ref: '#/components/schemas/channelGuaranteeCodeMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' chargeTypeType: type: string description: Total Pricing Element either Tax or Service Fee enum: - Tax - ServiceFee distributionTemplatesType: type: array description: Information about a distribution template. maxItems: 4000 items: $ref: '#/components/schemas/distributionTemplateType' channelNegRateType: type: object properties: negProfile: type: array maxItems: 4000 items: $ref: '#/components/schemas/channelNegProfileType' bookingChannelCode: description: Booking Channel Code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 channelRatePlanCode: description: Channel Room Type. type: string minLength: 0 maxLength: 20 channelRoomMappingDetailsType: type: object description: Basic details of hotel-channel room type mapping. properties: endDate: description: End date of the hotel-channel room type mapping. type: string format: date maxLength: 8 description: description: Hotel-channel room type mapping description. $ref: '#/components/schemas/channelRoomMappingDescriptionType' alternateChannelRoomType: description: Alternate channel room type name. type: string minLength: 0 maxLength: 40 channelRoomTypeOrder: description: Channel room type order of the hotel-channel room type mapping. type: number sellSequence: description: Sell sequence for hotel-channel room type mapping. type: number active: description: Flag that indicates whether hotel-channel room type mapping is active or not. type: boolean bedTypeCode: description: Channel bed type code. type: string minLength: 0 maxLength: 20 baseAllocation: description: Channel base allocation. type: integer rateCodes: description: Rate codes where hotel-channel room type mappings belong to. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 channelRateCodes: description: Channel rate codes where hotel-channel room mappings belong to. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 newChannelRoomType: description: Channel Room Type. This element is used for sending modified Channel room type value for operation ChangeChannelRoomMapping. type: string minLength: 0 maxLength: 20 newBeginDate: description: Begin date of the channel room type mapping. This element is used for sending modified Begin date value for operation ChangeChannelRoomMapping. type: string format: date maxLength: 8 bookingChannelInfo: description: Additional details about the booking channel. $ref: '#/components/schemas/bookingChannelInfoType' globalDescription: description: Global descriptions for the hotel room type. $ref: '#/components/schemas/channelMappingEnhancedDescriptionType' addressInfoType: type: object description: Provides address information. properties: address: description: Address details for the profile. $ref: '#/components/schemas/addressType' 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 channelHotelLetterType: type: object description: Provide unique identification of Hotel Letter associated with a Booking Channel. properties: bookingChannel: description: Booking channel code associated to the hotel letters. $ref: '#/components/schemas/codeDescriptionType' hotelId: description: Hotel code which the hotel letters belong to. type: string minLength: 0 maxLength: 20 languageCode: description: Language code associated with the hotel letters. $ref: '#/components/schemas/codeDescriptionType' letterType: description: Letter Type associated to hotel letters. $ref: '#/components/schemas/letterTypeType' letterName: description: Name of the letter that associated to Hotel Letter. type: string minLength: 0 maxLength: 100 warnings: $ref: '#/components/schemas/warningsType' profileChannelRateAccessCode: type: object required: - rateAccessCode - active - accountId - accountName - accountType properties: rateAccessCode: type: string description: Negotiated Rate Access Code. startDate: type: string description: Start Date of the Channel Rate Access Code. format: date endDate: type: string description: End Date of the Channel Rate Access Code. format: date active: type: boolean accountId: type: string minLength: 1 maxLength: 20 pattern: '[A-Z0-9]+' description: Account Id for which Channel Rate access code is applicable for. accountName: type: string description: Account name for which Channel Rate access Code is applicable for. minLength: 1 maxLength: 80 profileAccountType: $ref: '#/components/schemas/accountTypeEnum' profileId: type: string minLength: 1 maxLength: 20 description: Profile Id for which Channel Rate access code is applicable for. oldRateAccessCode: type: string description: Negotiated Rate Access Code. oldStartDate: type: string description: Start Date of the Channel Rate Access Code. format: date oldEndDate: type: string description: End Date of the Channel Rate Access Code. format: date warningsType: type: array description: Used in conjunction with the Success element to define a business error. maxItems: 4000 items: $ref: '#/components/schemas/warningType' channelRateMappingSourceDescriptionsType: type: object description: Source descriptions of a hotel-channel rate code mapping. properties: description: description: Description from hotel rate code configuration. type: string minLength: 0 maxLength: 2000 globalDescription: description: Global descriptions of a hotel rate code. $ref: '#/components/schemas/channelRateMappingEnhancedDescriptionType' hotelId: description: Hotel code where the descriptions belong to. type: string minLength: 0 maxLength: 20 rateCode: description: Rate code where the descriptions belong to. type: string minLength: 0 maxLength: 20 channelGuaranteeCodeMappingDetails: type: object description: Response object for fetching channel-hotel guarantee code mappings. properties: channelGuaranteeCodeMappings: description: Paging information and collection of channel-hotel guarantee code mappings. type: object properties: channelGuaranteeCodeMapping: description: Channel-hotel guarantee code mapping and its details. type: array items: $ref: '#/components/schemas/channelGuaranteeCodeMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' distributionTemplates: type: object description: Response object for fetching distribution templates based on search criteria. properties: distributionTemplates: description: Collection of chain level distribution templates. $ref: '#/components/schemas/distributionTemplatesType' hotelsDistributionTemplates: description: Collection of hotel level distribution templates. $ref: '#/components/schemas/hotelsDistributionTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' profileRateAccessCodes: type: object description: Request Object for Profile Rate Access Async Job properties: items: type: array minItems: 1 items: $ref: '#/components/schemas/profileRateAccessCode' channelAccountContractsCopy: type: object description: Request object to copy the channel account contract and create a new contract. properties: channelAccountContractsCopy: description: Channel account information to create a copy. $ref: '#/components/schemas/channelAccountContractsCopyType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' amenitiesMapping: type: object description: Response object for fetching external system amenities. properties: amenitiesMapping: description: Collection of external system amenities based on the request criteria. $ref: '#/components/schemas/amenitiesMappingType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyMarketingTextType: type: object description: Copy Channel Marketing Text among Channels properties: copyFrom: type: object properties: copyFrom: $ref: '#/components/schemas/marketingTextType' copyTo: type: object properties: bookingChannelCodes: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 hotelCodes: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 channelBillingStatementSummaryType: type: object description: To hold channel account statement detailed information. properties: statementId: description: Holds statement Id. $ref: '#/components/schemas/uniqueID_Type' accountCodeList: description: List of Billing Account profile code's. $ref: '#/components/schemas/codeListType' statementDate: description: Holds date on which statement is created. type: string format: date maxLength: 8 beginDate: description: Holds begin date of the statement. type: string format: date maxLength: 8 endDate: description: Holds end date of the statement. type: string format: date maxLength: 8 lockDate: description: Holds date on which statement is locked. type: string format: date maxLength: 8 note: description: Holds Note for the statement. type: string minLength: 0 maxLength: 4000 totalAmount: description: Holds Total amount information from statement accounts generated. $ref: '#/components/schemas/currencyAmountType' generated: description: Flag to identify Statements were generated or not. type: boolean dirty: description: Flag to identify Statements generated were dirty or not. type: boolean distributeChannelRateType: type: object description: Information about rate codes to be distributed to a channel. properties: distributeChannelRateMappings: description: Information about rate codes to be distributed to a channel. type: array maxItems: 4000 items: $ref: '#/components/schemas/distributeChannelRateMappingType' negotiatedProfiles: description: Negotiated channel rate details to be modified. type: array maxItems: 4000 items: $ref: '#/components/schemas/channelNegProfileType' bookingChannelCode: description: Channel. type: string minLength: 0 maxLength: 20 channelRatePlanCode: description: Channel Rate Code. type: string minLength: 0 maxLength: 20 contractPricingType: type: object description: Price information applied as part of contract. properties: price: description: Price that will be billed as part of this contract element. $ref: '#/components/schemas/currencyAmountType' pricePer: description: Identifies weather Price to be billed per Reservation, property, room or as a flat fee. $ref: '#/components/schemas/contractPriceType' 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 responsible 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 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 channelBillingStatementType: type: object description: To hold channel account statement detailed information. properties: statementId: description: Holds statement Id. $ref: '#/components/schemas/uniqueID_Type' accountCodeList: description: List of Billing Account profile code's. $ref: '#/components/schemas/codeListType' statementDate: description: Holds date on which statement is created. type: string format: date maxLength: 8 beginDate: description: Holds begin date of the statement. type: string format: date maxLength: 8 endDate: description: Holds end date of the statement. type: string format: date maxLength: 8 lockDate: description: Holds date on which statement is locked. type: string format: date maxLength: 8 note: description: Holds Note for the statement. type: string minLength: 0 maxLength: 4000 totalAmount: description: Holds Total amount information from statement accounts generated. $ref: '#/components/schemas/currencyAmountType' generated: description: Flag to identify Statements were generated or not. type: boolean dirty: description: Flag to identify Statements generated were dirty or not. type: boolean channelAccountStatements: description: Holds Channel account statements information. $ref: '#/components/schemas/channelStatementAccountsType' guaranteeMappingType: type: object description: Base external system mapping info. properties: systemInfo: description: Identify details of External System $ref: '#/components/schemas/systemInfoType' localSystemCode: description: Code used inside the OPERA System type: string minLength: 0 maxLength: 20 externalSystemCode: description: Code used in the External System type: string minLength: 0 maxLength: 20 description: description: Detailed Description of the given entity. type: string minLength: 0 maxLength: 2000 dateRange: description: Start and End Date of the mapping validity. If value is not supplied that mapping will be valid forever. $ref: '#/components/schemas/timeSpanType' requirementCode: description: Requirement code of guarantee. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' bookingChannelInfoType: type: object properties: hotelMappings: description: Hotel Code mapping for the Booking Channel. type: array maxItems: 4000 items: $ref: '#/components/schemas/hotelMappingType' configurationParameters: $ref: '#/components/schemas/parametersType' bookingChannelCode: type: string minLength: 0 maxLength: 20 name: type: string minLength: 0 maxLength: 40 bookingChannelType: type: string minLength: 0 maxLength: 240 currencyAmountType: type: object description: A monetary value expressed with a currency code. properties: amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 changeChannelParametersType: type: object properties: systemCode: description: External system code. type: string minLength: 0 maxLength: 20 channelParameters: description: Collection of channel parameters whose value needs to be modified. $ref: '#/components/schemas/channelParametersSimpleType' telephoneInfoType: type: object description: Information on a telephone number for the customer. properties: telephone: description: Phone details for the profile. $ref: '#/components/schemas/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 channelRateMappings: type: object description: Response object for fetching hotel-channel rate code mappings given search criteria including hotel codes, booking channel codes, rate codes, channel rate codes, etc. properties: channelRateMappings: description: Hotel-channel rate code mappings fetch results based on the search criteria. $ref: '#/components/schemas/channelRateMappingsType' masterInfo: description: Additional details about the booking channels and source descriptions for a hotel rate code referenced within the fetched results. $ref: '#/components/schemas/channelRateMappingMasterInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelMarketingTextToChange: type: object description: Request object for changing channel marketing texts. properties: changeChannelMarketingTexts: description: List of channel marketing texts to be changed. type: array items: $ref: '#/components/schemas/marketingTextType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelRateMapping: type: object description: Request object for changing channel rate mappings. properties: channelRateMappings: description: Information about the Rate mapping to be updated. type: object properties: channelRateMapping: description: Information about the Rate mapping to be updated. type: array items: $ref: '#/components/schemas/channelRateMappingType' ignoreChannelRateWarning: description: '''Y'' if warnings like "Channel Rate Code already exists in Channel" should be ignored and should proceed with creating a new mapping; otherwise, value is ''N''' type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' amenities: type: object description: Request object for changing external system amenities. properties: amenities: description: External system amenities to be changed. $ref: '#/components/schemas/amenitiesMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelRoomMappingDescriptionType: type: object description: This type holds descriptions of hotel-channel room type mapping. Description may be from Hotel Room Type description, Global description or custom user defined description. Global description only supports enhanced description. properties: roomTypeDescription: description: Description of hotel-channel room type mapping from Hotel Room Type configuration. $ref: '#/components/schemas/channelRoomMappingDescriptionDetailsType' globalDescription: description: Description of hotel-channel room type mapping from Global description. $ref: '#/components/schemas/channelMappingEnhancedDescriptionType' customDescription: description: Custom or user-defined description of hotel-channel room type mapping. $ref: '#/components/schemas/channelRoomMappingDescriptionDetailsType' hotelMappingType: type: object properties: hotelId: type: string minLength: 0 maxLength: 20 code: type: string minLength: 0 maxLength: 20 name: type: string minLength: 0 maxLength: 40 description: type: string minLength: 0 maxLength: 2000 channelParametersSimpleType: type: array description: Collection of channel parameters simple information. maxItems: 4000 items: $ref: '#/components/schemas/channelParameterSimpleType' currencies: type: object description: Request object for changing existing external system currencies. properties: currencies: description: External system currencies to be changed. $ref: '#/components/schemas/currenciesMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountDetailsType: type: object description: To hold channel account detailed information. properties: accountCode: description: Holds Account code for which details are fetched. type: string minLength: 0 maxLength: 20 templateAccountCode: description: Holds Template Account code on which current account is based on. type: string minLength: 0 maxLength: 20 accountType: description: Holds Account type for which details are fetched. $ref: '#/components/schemas/channelAccountTypeType' accountName: description: Holds Account Name for which details are fetched. type: string minLength: 0 maxLength: 80 contactName: description: Account contact name information. type: string minLength: 0 maxLength: 40 eCUNo: description: Holds ECU No alias AR_No. type: string minLength: 0 maxLength: 40 orderByAscDescType: type: string enum: - Asc - Desc codeListType: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 channelParameterGroupType: type: object properties: channelParameters: $ref: '#/components/schemas/channelParametersType' groupName: type: string minLength: 0 maxLength: 80 groupDisplayName: type: string minLength: 0 maxLength: 80 totalPricingElements: type: object description: Response object to populate total pricing elements of the GDS channel. properties: totalPricingElements: $ref: '#/components/schemas/totalPricingElementsType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 totalPricingElementIDType: type: object description: Total Pricing Element ID type used to identify the record properties: hotelId: description: Hotel Code that associated with Transaction Code and Total Pricing Element type: string minLength: 0 maxLength: 20 transaction: description: Transaction Code with Total Pricing Element of the GDS channel $ref: '#/components/schemas/codeDescriptionType' guaranteeType: type: object description: Specifies Guarantee Code attributes. properties: description: description: Description of the Guarantee Code. type: string minLength: 0 maxLength: 2000 requirements: description: Specifies various requirements for the guarantee code. $ref: '#/components/schemas/guaranteeRequirementsType' shortDescription: description: Brief description of the Guarantee Code. $ref: '#/components/schemas/translationTextType80' paymentTypes: description: Specifies various payment types for the guarantee code. $ref: '#/components/schemas/paymentTypesType' guaranteeCode: description: Code assigned to the Guarantee. type: string minLength: 0 maxLength: 20 onHold: description: If true indicates this Guarantee Code is used only to hold the inventory during reservation process. type: boolean reserveInventory: description: If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code. type: boolean orderSequence: description: Display Order sequence. type: number lateArrival: description: Represents the late arrival time. type: string genericGlobalDescriptionType: type: object description: This type holds enhanced room/rate description. properties: hotelId: description: Property mapping with Rate plan code or Room type type: string minLength: 0 maxLength: 20 ratePlanCode: description: Global description type holds Rate plan code. $ref: '#/components/schemas/codeDescriptionType' roomType: description: Global description type holds Room Type. $ref: '#/components/schemas/codeDescriptionType' globalDescType: description: Global description type to differentiate the type $ref: '#/components/schemas/globalDescTypeType' ratePlanGlobalDescription: description: Generic global description holds rate plan enhanced description details $ref: '#/components/schemas/channelRateMappingEnhancedDescriptionType' roomTypeGlobalDescription: description: Generic global description Room Type enhanced description details $ref: '#/components/schemas/channelMappingEnhancedDescriptionType' channelAccountType: type: object description: A collection of Channel Account Profile Id and account details information. properties: profileId: description: Unique Billing account profile identifier fetched. $ref: '#/components/schemas/profileId' channelAccountInformation: description: Provides detailed information regarding Channel Account. $ref: '#/components/schemas/channelAccountInformationType' channelCardTypeMappings: type: object description: Request object for creating a new channel-hotel card type mapping. properties: channelCardTypeMapping: description: Channel-hotel card type mapping information to be created. $ref: '#/components/schemas/channelCardTypeMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelOrgMappingsDetails: type: object description: Response object for Fetch Channel to ORG and CRO Mapping. properties: channelOrgMappingsDetails: $ref: '#/components/schemas/channelOrgMappingsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelCardTypeMappingDetails: type: object description: Response object for fetching channel-hotel card type mappings. properties: channelCardTypeMappings: description: Paging information and collection of channel-hotel card type mappings. type: object properties: channelCardTypeMapping: description: Channel-hotel card type mapping and its details. type: array items: $ref: '#/components/schemas/channelCardTypeMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelOrgMapping: type: object description: Request object for Create Channel to ORG and CRO Mapping. properties: channelOrgMappingDetails: $ref: '#/components/schemas/channelOrgMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelGlobalDescription: type: object description: Request object for changing channel rate codes global description. properties: channelRoomDescription: description: Channel Rate code mapping global description details. $ref: '#/components/schemas/channelGlobalDescriptionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' ratePlanApprovalStatusType: type: string description: Indicates that the Rate Plan is approved for selling. enum: - NewUnapproved - ChangedUnapproved - Rejected - Approved channelHotelLettersType: type: array description: Collection of Hotel Letters Type maxItems: 4000 items: $ref: '#/components/schemas/channelHotelLetterType' channelMarketingInfoType: type: array description: Marketing Text like cancel policy, deposit policy etc. maxItems: 4000 items: type: object properties: description: description: Marketing Text like cancel policy, deposit policy etc. type: string minLength: 0 maxLength: 4000 policyType: description: Indicates the policy type like cancel,deposit etc. $ref: '#/components/schemas/marketingPolicyType' ratePlanCode: description: Indicates the rate code for which the policy is associated with. type: string minLength: 0 maxLength: 20 channelStatementAccountType: type: object description: Channel account statement type to hold statement details. WS wont update any statement account information except Note and account details information. properties: profileId: description: Profile ID of the account statement. $ref: '#/components/schemas/uniqueID_Type' accountCode: description: Holds Account code of the channel account statement. type: string minLength: 0 maxLength: 20 contractId: description: Contract ID of the account statement. $ref: '#/components/schemas/uniqueID_Type' beginDate: description: Holds begin date of the account statement. type: string format: date maxLength: 8 endDate: description: Holds end date of the account statement. type: string format: date maxLength: 8 note: description: Holds Note for the account statement. type: string minLength: 0 maxLength: 4000 totalDetailsAmount: description: Holds Total amount information from details in channel account currency. $ref: '#/components/schemas/currencyAmountType' channelAccountStatementDetails: description: Holds Channel account statement details. $ref: '#/components/schemas/channelStatementDetailsType' systemErrorBookingResponseType: type: string description: Simple type for external system booking response. enum: - PendingNeeded - Unconfirmed - Cancelled channelAccountTypeType: type: string description: Represents channel account TEMPLATE type. enum: - Property - Chain - Dealer - Subsidiary - Routing - Template contractTransactionType: type: string description: To specify range information is considered per number of Rooms. This is allowed only if Fee type is Maintenance. enum: - Properties - Rooms channelNegProfileType: type: object description: A negotiated rate type properties: uniqueId: $ref: '#/components/schemas/uniqueIDListType' formerName: $ref: '#/components/schemas/personNameType' accessInfoList: type: array maxItems: 4000 items: $ref: '#/components/schemas/channelNegRateAccessType' channelOrgMappingType: type: object description: Respresents information of the Channel Code, OrgCode and Default Login Resort used for mapping. properties: channelCode: description: Channel code for which OrgCode mapping needs to be done. type: string minLength: 0 maxLength: 20 orgCode: description: OrgCode for which Channel code mapping needs to be done. type: string minLength: 0 maxLength: 20 defaultLoginResort: description: Default Login Resort value used while mapping Channel Code and OrgCode. type: string minLength: 0 maxLength: 20 channelRoomMappingType: type: object description: Basic details of hotel-channel room type mapping. properties: endDate: description: End date of the hotel-channel room type mapping. type: string format: date maxLength: 8 description: description: Hotel-channel room type mapping description. $ref: '#/components/schemas/channelRoomMappingDescriptionType' alternateChannelRoomType: description: Alternate channel room type name. type: string minLength: 0 maxLength: 40 channelRoomTypeOrder: description: Channel room type order of the hotel-channel room type mapping. type: number sellSequence: description: Sell sequence for hotel-channel room type mapping. type: number active: description: Flag that indicates whether hotel-channel room type mapping is active or not. type: boolean bedTypeCode: description: Channel bed type code. type: string minLength: 0 maxLength: 20 baseAllocation: description: Channel base allocation. type: integer rateCodes: description: Rate codes where hotel-channel room type mappings belong to. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 channelRateCodes: description: Channel rate codes where hotel-channel room mappings belong to. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 newChannelRoomType: description: Channel Room Type. This element is used for sending modified Channel room type value for operation ChangeChannelRoomMapping. type: string minLength: 0 maxLength: 20 newBeginDate: description: Begin date of the channel room type mapping. This element is used for sending modified Begin date value for operation ChangeChannelRoomMapping. type: string format: date maxLength: 8 bookingChannelInfo: description: Additional details about the booking channel. $ref: '#/components/schemas/bookingChannelInfoType' globalDescription: description: Global descriptions for the hotel room type. $ref: '#/components/schemas/channelMappingEnhancedDescriptionType' channelRoomMappingDetails: description: Channel Room Type. This element is used for sending modified Channel room type value for operation ChangeChannelRoomMapping. $ref: '#/components/schemas/channelRoomMappingDetailsType' bookingChannelCode: description: Booking Channel Code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 roomType: description: Room Type. type: string minLength: 0 maxLength: 20 channelRoomType: description: Channel Room Type. type: string minLength: 0 maxLength: 20 beginDate: description: Begin Date. type: string format: date maxLength: 8 systemErrorType: type: object description: Identify error details of external system. properties: errorCode: description: Code and description of error. type: string minLength: 0 maxLength: 50 errorDescription: description: description of error. type: string minLength: 0 maxLength: 2000 errorPrefix: description: Prefix of system error code. type: string minLength: 0 maxLength: 20 errorSuffix: description: Suffix of system error code. type: string minLength: 0 maxLength: 20 bookingResponse: description: Booking response of system error code. $ref: '#/components/schemas/systemErrorBookingResponseType' dateRange: description: Validity date of system error code. $ref: '#/components/schemas/timeSpanType' manualProcess: description: Indicates whether system error code is manual process or not type: boolean channelHotelCodeMappingBucketType: type: object description: Channel-hotel mapping bucket information. properties: lowRevenueThreshold: description: Low revenue threshold. type: integer highRevenueThreshold: description: High revenue threshold. type: integer defaultRateCode: description: Default rate code of channel hotel. type: string minLength: 0 maxLength: 20 status: type: object description: Response Body. properties: warnings: $ref: '#/components/schemas/warningsType' links: $ref: '#/components/schemas/links' translationTextType80: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 80. type: string minLength: 0 maxLength: 80 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' channelParameterSimpleType: type: object description: Basic channel parameter info used in changing channel parameter values. properties: parameterName: type: string minLength: 0 maxLength: 80 parameterValue: type: string minLength: 0 maxLength: 2000 hotelId: type: string minLength: 0 maxLength: 20 parameterValueType: $ref: '#/components/schemas/channelParameterValueType' contractPriceType: type: string description: To specify price will be billed per reservation. This is allowed only if Fee type is Transaction or Fax. enum: - FlatFee - Property - Room - Reservation channelAccountContractInformationType: type: object description: To hold channel account contract detailed information. properties: contractId: description: Holds contract Id of the contract. $ref: '#/components/schemas/uniqueID_Type' contractNo: description: Holds contract No of the contract. type: string minLength: 0 maxLength: 20 beginDate: description: Holds begin date of the contract. type: string format: date maxLength: 8 endDate: description: Holds end date of the contract. type: string format: date maxLength: 8 note: description: Holds Note for the account contract. type: string minLength: 0 maxLength: 4000 channelAccountContractElements: description: Holds contract elements information. $ref: '#/components/schemas/channelAccountContractElementsType' markStatementsToRegenerate: description: Flag to mark respective statements which were generated on these contracts to be regenerated. type: boolean channelMarketingTextsInfo: type: object description: Response object for fetching channel marketing texts. properties: marketingTexts: description: List of channel marketing texts based on the request criteria. $ref: '#/components/schemas/marketingTextsType' hotelsInfo: description: Reference hotel info for the hotels in the result set. type: array items: $ref: '#/components/schemas/hotelChannelInfoType' bookingChannelsInfo: description: Reference booking channel info for booking channels in the result set. type: array items: $ref: '#/components/schemas/bookingChannelInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelRoomMappingsSummary: type: object description: Operation to fetch hotel-channel room type mappings. properties: channelRoomMappingsSummary: description: Refer to Generic common types document. $ref: '#/components/schemas/channelRoomMappingsSummaryType' masterInfo: description: Additional details about the booking channels and source descriptions for a hotel room type referenced within the fetched results. $ref: '#/components/schemas/channelRoomMappingMasterInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' profileRateAccessCode: type: object required: - hotelId - channelCode - channelRatePlans properties: hotelId: type: string description: Unique ID that identifies a single hotel property. minLength: 1 maxLength: 20 channelCode: type: string description: Unique ID that identifies a single Channel. minLength: 1 maxLength: 20 channelRatePlans: type: array minItems: 1 items: $ref: '#/components/schemas/profileChannelRatePlan' systemRoomTypeType: type: object description: Identify room type details of external system. properties: roomTypeCode: description: Code and description of room type. $ref: '#/components/schemas/codeDescriptionType' inactiveDate: description: Inactive date of room type external system. type: string format: date maxLength: 8 publishRatePlanType: type: object description: Information to publish a new rate code. properties: channel: description: The target channel to send the updated rate information to the external channel. type: string minLength: 0 maxLength: 40 hotelId: description: The source Property to send the updated rate information to the external channel. type: string minLength: 0 maxLength: 20 beginDate: description: Date from which rate code will be effective on the channel. type: string format: date maxLength: 8 endDate: description: Date on which rate code will cease to be effective. type: string format: date maxLength: 8 channelCodes: description: The selected Channel Rate Codes for update. type: object properties: channelRatePlanCodes: description: The selected Channel Rate Codes for update. $ref: '#/components/schemas/codeListType' channelRoomTypes: description: The selected Channel Rate Codes for update. $ref: '#/components/schemas/codeListType' hotelCodes: description: The selected property Rate Codes for update. type: object properties: ratePlanCodes: description: The selected property Rate Codes for update. $ref: '#/components/schemas/codeListType' roomTypes: description: The selected property Rate Codes for update. $ref: '#/components/schemas/codeListType' errorType: type: object description: Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element. properties: value: type: string description: Property Value shortText: description: An abbreviated version of the error in textual format. type: string 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 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 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 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 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})*' nodeList: description: An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional constraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message. type: string systemRateCategoryType: type: object description: Identify rate category details of external system. properties: rateCategoryCode: description: Code and description of rate category. $ref: '#/components/schemas/codeDescriptionType' shoppingCategory: description: Shopping category of rate category external system. type: string minLength: 0 maxLength: 1 negotiated: description: Indicates whether external system rate category is negotiated or not. type: boolean inactive: description: Indicates whether external system rate category is active or not. type: boolean channelRoomMappingsSourceDescriptionsType: type: array description: This type holds hotel-channel room type mapping source descriptions. maxItems: 4000 items: $ref: '#/components/schemas/channelRoomMappingSourceDescriptionsType' properties: type: object description: Request object for changing existing external system properties. properties: properties: description: External system properties to be changed. $ref: '#/components/schemas/propertiesMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelRatePlans: type: object description: Request object for publishing rate codes to GDS. properties: publishRatePlan: description: Rate code information to be published. $ref: '#/components/schemas/publishRatePlanType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountContracts: type: object description: Request object to create the channel account contracts. properties: channelAccountContracts: description: Channel account information to create a new channel account contracts. $ref: '#/components/schemas/channelAccountContractsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountNotesType: type: object description: Holds channel account notes information. properties: note: description: Holds Note for the account. type: string minLength: 0 maxLength: 4000 guaranteesInfoType: type: array description: Guarantee details. maxItems: 4000 items: $ref: '#/components/schemas/guaranteeType' statementDetailsStatisticType: type: object description: Channel statement details statistics. properties: hotelId: description: Holds the property for the statement detail statistic By resort. type: string minLength: 0 maxLength: 20 bookingChannelCode: description: Holds channel of the statement details statistic By Channel. type: string minLength: 0 maxLength: 20 bookingChannelType: description: Holds channel type of the statement details statistic By Channel Type. type: string minLength: 0 maxLength: 240 feeType: description: Holds Fee type of the statement details statistic By Fee Type. $ref: '#/components/schemas/contractFeeTypeType' contractAmount: description: Holds total contract amount for all the statement details grouped by Resort/Channel/Channel Type/Fee Type. $ref: '#/components/schemas/currencyAmountType' invoiceAmount: description: Holds invoice amount for all the statement details grouped by Resort/Channel/Channel Type/Fee Type. $ref: '#/components/schemas/currencyAmountType' detailsCount: description: Channel billing statement details record count grouped by Resort/Channel/Channel Type/Fee Type. type: integer channelRateMappingDescriptionType: type: object description: This type holds descriptions of hotel-channel rate code mapping. Description may be from Hotel rate code description, Global description or custom user defined description. Global description only supports enhanced description. properties: rateCodeDescription: description: Description of hotel-channel rate code mapping from hotel rate code configuration. $ref: '#/components/schemas/channelRateMappingDescriptionDetailsType' globalDescription: description: Description of hotel-channel rate code mapping from global description. $ref: '#/components/schemas/channelRateMappingEnhancedDescriptionType' customDescription: description: Custom or user-defined description of hotel-channel rate code mapping. $ref: '#/components/schemas/channelRateMappingDescriptionDetailsType' shortDescription: description: Channel rate code short description for Channel AA or Channel with HTML support. $ref: '#/components/schemas/translationTextType80' channelGlobalDescriptions: type: object description: Request object to create new Global Descriptions of the GDS Channels properties: channelGlobalDescriptions: $ref: '#/components/schemas/channelGlobalDescriptionsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelParameterLevelType: type: string enum: - Global - Hotel guaranteeRequirementsType: type: object description: Specifies various requirement for the guarantee code. properties: requirementCode: description: Requirement Code. type: string cancellation: description: When true indicates cancellation on the reservation is required for this guarantee code. type: boolean phoneNumber: description: When true indicates phone number on the reservation is required for this guarantee code. type: boolean address: description: When true indicates address on the reservation is required for this guarantee code. type: boolean creditCard: description: When true indicates Credit Card on the reservation is required for this guarantee code. type: boolean arrivalTime: description: When true indicates arrival Time on the reservation is required for this guarantee code. type: boolean deposit: description: When true indicates deposit is required for this guarantee code. type: boolean orderByListType: type: array maxItems: 4000 items: type: object properties: attributeName: type: string maxLength: 2000 orderType: $ref: '#/components/schemas/orderByAscDescType' channelAccountCommunicationType: type: object description: Holds channel account communication information. properties: addresses: description: List of customer addresses. type: object properties: addressInfo: description: Collection of Detailed information on an address for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/addressInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer channels: type: object description: Response object for fetching channels. properties: channels: description: Collection of channels based on the request criteria. $ref: '#/components/schemas/channelsType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelCardTypeMappingType: type: object description: Channel-hotel card type mapping information. properties: newChannelCardType: description: New channel card type for the existing card type mapping. type: string minLength: 0 maxLength: 20 inactiveDate: description: Inactive date of card type mapping. type: string format: date maxLength: 8 hotelId: description: Hotel code of card type mapping. type: string minLength: 0 maxLength: 20 bookingChannelCode: description: Booking channel code of card type mapping. type: string minLength: 0 maxLength: 20 cardType: description: Card type of card type mapping. type: string minLength: 0 maxLength: 20 channelCardType: description: Channel card type of card type mapping. type: string minLength: 0 maxLength: 20 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 channelAvailability: type: object description: Request object for publishing rate availability to channels. properties: publishAvailability: description: Availability information to be published. $ref: '#/components/schemas/publishRatePlanType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelGlobalDescriptionsType: type: array description: Collection of GDS channel Global description types maxItems: 4000 items: $ref: '#/components/schemas/genericGlobalDescriptionType' globalDescTypeType: type: string description: Either Room Type or Rate Plan Code enum: - RoomType - RatePlan fetchedChannelHotelLetters: type: object description: Response object after fetch Hotel Letters associated with the Booking Channels properties: channelHotelLetters: description: Retrieve the collection detail of Hotel Letters associated with the booking channel based on the search criteria $ref: '#/components/schemas/channelHotelLettersType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountContractsInformationType: type: array description: Channel account contract information object to hold details of channel account contract. maxItems: 4000 items: $ref: '#/components/schemas/channelAccountContractInformationType' distributeChannelRateMappingType: type: object description: Basic details of a hotel-channel rate code mapping. properties: description: description: Description of channel rate plan code. $ref: '#/components/schemas/channelRateMappingDescriptionType' channelRatePlanWebName: description: Name of channel rate plan code to display on web. type: string minLength: 0 maxLength: 80 channelRatePlanCategory: description: Channel rate category of hotel-channel rate code mapping. type: string minLength: 0 maxLength: 20 rateLevel: description: Rate Level. type: string minLength: 0 maxLength: 3 rateTierAttr: description: Rate Tier. type: object properties: rateTier: type: integer blockRateIndicator: description: Block Rate Indicator. type: string minLength: 0 maxLength: 80 promotionCode: description: Promotion Code. type: string minLength: 0 maxLength: 20 channelRatePlanOrder: description: Order of the channel rate type mapping. type: number allowRateUpdate: description: Indicates if Rate updates to Channel are allowed. type: boolean allowRestrictionUpdate: description: Indicates if Rate Restrictions are sent to an ADS, GDS, or ODS partner, such as Expedia, via the AVH messaging functionality. type: boolean regionalAvailAttr: description: Indicates if rate participates in Regional Availability. type: object properties: inclInRegionalAvail: type: boolean allowRegionalAvail: type: boolean beginDate: description: Begin date of the channel rate code mapping. type: string format: date maxLength: 8 endDate: description: End date of the channel rate code mapping. type: string format: date maxLength: 8 carrierInfo: description: Carrier attached to the Channel Rate Plan. $ref: '#/components/schemas/carrierInfoType' newChannelRatePlanCode: description: New Channel Rate Plan Code of the mapping. Used only to change the Channel Rate Plan Code. type: string minLength: 0 maxLength: 20 roomTypes: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 ratePlanInfo: description: Rate plan information including description and sell dates. $ref: '#/components/schemas/ratePlanPrimaryDetailsType' ratePlanCode: description: Rate Plan Code. type: string minLength: 0 maxLength: 20 hasNegotiatedRates: description: True if this channel rate plan code has negotiated rates, otherwise false type: boolean hasChannelNegotiatedRates: description: True if the mapping has channel negotiated rates, otherwise false. type: boolean channelNegRateAccessType: type: object properties: accessInfoDetail: $ref: '#/components/schemas/channelNegRateAccessDetailType' accessCode: type: string minLength: 0 maxLength: 20 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 channelsType: type: array description: Identify details of channels. maxItems: 4000 items: $ref: '#/components/schemas/channelType' managedByOptions: description: Describes of the Configuration is Managed by Enterprise or Property. type: string enum: - EnterpriseManaged - PropertyManaged - EnterpriseEnforced - PropertyOverridden hotelIdChannelRatesAccess: description: HotelId with mappingIds type: object properties: hotelId: description: Hotel Code. type: string minLength: 0 maxLength: 20 profileId: description: Profile ID. type: string minLength: 0 maxLength: 20 accountId: description: Account ID. type: string minLength: 0 maxLength: 20 channelcode: description: channel Code. type: string minLength: 0 maxLength: 20 channelRateCode: description: channel Rate Code. type: string minLength: 0 maxLength: 20 ratePlanCode: description: ' Rate Plan Code.' type: string minLength: 0 maxLength: 20 accessCode: description: Access Code. type: string minLength: 0 maxLength: 20 startDate: type: string format: date maxLength: 8 endDate: type: string format: date maxLength: 8 policyAmountPercentType: type: object description: Defines the percentage basis for calculating the fee amount or the amount. properties: basisType: description: Provides the basis for how the amount of the guarantee is calculated. $ref: '#/components/schemas/policyBasisTypeType' nights: description: The number of nights of the hotel stay that are used to calculate the fee amount. type: integer percent: description: The percentage used to calculate the amount. type: number minimum: 0 maximum: 100 amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 marketingTextType: type: object description: Information about the the Marketing text for the Channel properties: newHotelCode: type: string minLength: 0 maxLength: 20 newTransactionType: type: string minLength: 0 maxLength: 20 newPolicyType: type: string minLength: 0 maxLength: 20 newPolicyDetail: type: string minLength: 0 maxLength: 20 newBeginDate: type: string format: date maxLength: 8 hotelId: description: The code that identifies a Hotel. type: string minLength: 0 maxLength: 20 bookingChannelCode: description: The code that identifies a Booking Channel. type: string minLength: 0 maxLength: 20 marketingText: type: string minLength: 0 maxLength: 2000 marketingTextDescription: description: Marketing Text description. $ref: '#/components/schemas/translationTextType2000' transactionType: type: string minLength: 0 maxLength: 20 policyType: type: string minLength: 0 maxLength: 20 policyDetail: type: string minLength: 0 maxLength: 20 beginDate: type: string format: date maxLength: 8 endDate: type: string format: date maxLength: 8 globalTextYN: type: boolean supportsHTMLEditor: type: boolean channelRateMappingEnhancedDescriptionType: type: object description: Enhanced descriptions of hotel-channel room type or rate code mapping. properties: enhancedDescriptionLine1: description: Enhanced Description Line 1. $ref: '#/components/schemas/translationTextType50' enhancedDescriptionLine2: description: Enhanced Description Line 2. $ref: '#/components/schemas/translationTextType50' enhancedDescriptionLine3: description: Enhanced Description Line 3. $ref: '#/components/schemas/translationTextType50' description: description: Rate code description in addition to enhanced description line 1 to 3. $ref: '#/components/schemas/translationTextType2000' channelHotelLettersToBeChanged: type: object description: Request object to update existing Hotel Letters associated with the Booking Channels properties: channelHotelLetters: description: Hotel Letters associated with a booking channel to be changed. $ref: '#/components/schemas/channelHotelLettersType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountsInformationType: type: array description: Channel account information object to hold details of channel account. maxItems: 4000 items: $ref: '#/components/schemas/channelAccountInformationType' enhancedDescriptionType: type: object description: This type holds enhanced room/rate description. properties: shortDescription: $ref: '#/components/schemas/translationTextType2000' description: $ref: '#/components/schemas/translationTextType2000' enhancedDesc1: $ref: '#/components/schemas/translationTextType50' enhancedDesc2: $ref: '#/components/schemas/translationTextType50' enhancedDesc3: $ref: '#/components/schemas/translationTextType50' source: type: string emailInfoType: type: object description: Information on an email for the customer. properties: email: description: eMail deatils for the profile. $ref: '#/components/schemas/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 baseChannelParameterType: type: object description: Parameters details for the Channel. properties: parameterName: description: Name of the parameter in the channel. type: string minLength: 0 maxLength: 80 parameterDisplay: description: The display name for the parameter in the channel. type: string minLength: 0 maxLength: 80 shortDescription: description: Short description for the parameter. type: string minLength: 0 maxLength: 2000 parameterDescription: description: The Description for the parameter. type: string minLength: 0 maxLength: 2000 parameterValue: description: The Value of the parameter. type: string minLength: 0 maxLength: 2000 hotelId: description: Hotel code identifying the parameters related to the Hotel. type: string minLength: 0 maxLength: 20 parameterType: description: The type of the parameter, the possible types are P (Parameter), Setting (S). type: string enum: - P - S scope: description: Whether this is a global or property level parameter. type: string enum: - H - P valueType: $ref: '#/components/schemas/channelParameterValueType' sequence: description: Sequence number for displaying the parameter in the channel. type: integer channelAccountContractCopyResponseType: type: object description: Channel account contract type to hold account and contract details to copy. properties: accountId: description: Target account Id to which contract copied. $ref: '#/components/schemas/uniqueID_Type' accountCode: description: Target Account code to which contract is copied. type: string minLength: 0 maxLength: 20 contractResponseInformation: description: Holds contract Id of the contract copied. type: array maxItems: 4000 items: type: object properties: contractId: description: Holds contract Id of the contract copied. $ref: '#/components/schemas/uniqueID_Type' sourceContractNo: description: Holds contract No of the contract which is copied. type: string minLength: 0 maxLength: 20 targetContractNo: description: Holds contract No of the new contract created. type: string minLength: 0 maxLength: 20 errorMessage: description: Error message if failed to copy the contract. $ref: '#/components/schemas/errorType' success: description: Flag to identify contract is copied successfully. type: boolean errorMessage: description: Error message if failed to copy all the contracts from account. $ref: '#/components/schemas/errorType' channelStatementDetailType: type: object description: To hold channel account contract element detailed information. properties: contractId: description: Contract Id of the contract. $ref: '#/components/schemas/uniqueID_Type' sequence: description: Sequence identifies contract element per contract. type: integer feeType: description: Holds Fee type of the contract element. If Fee type is not populated, it will be considered to delete this contract element. $ref: '#/components/schemas/contractFeeTypeType' bookingChannelType: description: Holds channel type of the contract element. type: string minLength: 0 maxLength: 240 bookingChannelCode: description: Holds channel of the contract element. type: string minLength: 0 maxLength: 20 contractPricing: description: Price information for this contract element. $ref: '#/components/schemas/contractPricingType' contractRangeInformation: description: Holds Contract Range per number of Properties, Rooms or reservations information. $ref: '#/components/schemas/contractRangeInformationType' frequency: description: Holds frequency of billing. $ref: '#/components/schemas/contractPriceFrequencyType' note: description: Holds Note for the contract element. type: string minLength: 0 maxLength: 4000 statementId: description: Statement Id of the statement detail. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: Holds the property for the statement detail. type: string minLength: 0 maxLength: 20 oldHotelCode: description: Holds the value of property that user changed from to find and update. type: string minLength: 0 maxLength: 20 quantity: description: Number of Units (transactions, rooms or properties). type: integer routingAccount: description: Holds Routing account. If no value is provided, it will be defaulted to * type: string minLength: 0 maxLength: 20 contractAmount: description: Holds contract amount calculated while generating the contracts. $ref: '#/components/schemas/currencyAmountType' invoiceAmount: description: Holds amount per line calculated while generating the contracts. $ref: '#/components/schemas/currencyAmountType' orderByList: description: Holds the default Order By value. $ref: '#/components/schemas/orderByListType' 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: '#/components/schemas/errorInstance' links: $ref: '#/components/schemas/links' required: - type - title channelBillingStatementDetails: type: object description: Response object of the channel account statement details fetch request. properties: channelStatementDetails: description: Holds list of channel statement details. $ref: '#/components/schemas/channelStatementDetailsType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelRoomMappingSourceDescriptionsType: type: object description: Hotel-channel room type mapping source descriptions. properties: description: description: Hotel room type description. type: string minLength: 0 maxLength: 2000 globalDescription: description: Hotel room type global description. $ref: '#/components/schemas/channelMappingEnhancedDescriptionType' hotelId: description: Hotel code the descriptions belong to. type: string minLength: 0 maxLength: 20 roomType: description: Room type the descriptions belong to. type: string minLength: 0 maxLength: 20 channelPoliciesInfoType: type: array description: To list down all the policies associated with the relevant input request. maxItems: 4000 items: $ref: '#/components/schemas/channelPolicyType' offsetUnitType: type: string description: Indicates deadline offset unit type. enum: - Year - Month - Day - Hour personNameTypeType: type: string description: Person's name in an external system. enum: - Primary - Alternate - Incognito - External - Phonetic channelRateMappingMasterInfoType: type: object description: Additional details about the booking channels and source descriptions for a hotel rate code referenced within the fetched results. properties: bookingChannelsInfo: description: Additional details about booking channels. $ref: '#/components/schemas/bookingChannelsInfoType' sourceDescriptions: description: Hotel-channel rate code mappings source descriptions. $ref: '#/components/schemas/channelRateMappingsSourceDescriptionsType' channelParametersType: type: array description: parameters details. maxItems: 4000 items: $ref: '#/components/schemas/channelParameterType' profileChannelRatePlan: type: object required: - ratePlanCode - channelRatePlanCode - channelRateAccessCodes properties: ratePlanCode: type: string description: Rate Plan Code (length of string must be less than or equal to 20) minLength: 1 maxLength: 20 channelRatePlanCode: type: string description: Chennel Rate Plan Code (length of string must be less than or equal to 20) minLength: 1 maxLength: 20 startDate: type: string description: ISO 8601 date Format 'YYYY-MM-DD' format: date endDate: type: string description: ISO 8601 date Format 'YYYY-MM-DD' format: date active: type: boolean default: true channelRatePlanOrder: type: integer default: true description: Channel Rate Plan Order channelRateAccessCodes: type: array minItems: 1 items: $ref: '#/components/schemas/profileChannelRateAccessCode' contractPriceFrequencyType: type: string description: To specify bills will be generated on Yearly basis. enum: - Monthly - Quarterly - HalfYearly - Yearly 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: '#/components/schemas/translationsTextType' channelRateRoomListType: type: object description: This type holds collection of channel Rate Room details. properties: channelRateRoom: type: array maxItems: 4000 items: $ref: '#/components/schemas/channelRateRoomType' 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 amenitiesMappingType: type: array description: Information about an external system amenity mapping. maxItems: 4000 items: $ref: '#/components/schemas/amenityMappingType' changeChannelParameters: type: object description: Request object for modifying channel parameter(s). properties: criteria: description: Collection of channel parameter(s) to be modified. $ref: '#/components/schemas/changeChannelParametersType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelPolicyType: type: object description: Policy details including guaranteeInfo, cancellation information etc. properties: guarantees: description: Guarantee details to be fetched $ref: '#/components/schemas/guaranteesInfoType' cancelPenalty: description: Cancellation details. $ref: '#/components/schemas/cancelPenaltyType' depositPolicy: description: DepositPolicy details. $ref: '#/components/schemas/depositPolicyType' channelMarketingInfo: description: Channel Marketing Text like cancel,deposit,tax,commission policy etc. $ref: '#/components/schemas/channelMarketingInfoType' ratePlanCode: type: string minLength: 0 maxLength: 20 channelRatePlanCode: type: string minLength: 0 maxLength: 20 hold: type: boolean deposit: type: boolean commissionCode: type: string channelErrors: type: object description: Request object for creating channel errors. properties: errors: description: channel errors to be created. type: object properties: error: description: Channel error details. type: array maxItems: 4000 items: $ref: '#/components/schemas/systemErrorType' bookingChannelCode: description: Channel code. $ref: '#/components/schemas/codeType' warnings: $ref: '#/components/schemas/warningsType' guarantees: type: object description: Request object for changing external system guarantees. properties: guarantees: description: External system guarantees to be changed. $ref: '#/components/schemas/guaranteesMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' accountTypeEnum: description: Type of the profile account type: string enum: - Source - TravelAgent - Company marketingTextsType: type: array maxItems: 4000 items: $ref: '#/components/schemas/marketingTextType' channelAccountContactType: type: object description: Holds channel account contact information. properties: telephones: description: List of Telephone Number Information type: object properties: telephoneInfo: description: Collection of Detailed information on telephone/fax for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/telephoneInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer emails: description: List of email address for the customer. type: object properties: emailInfo: description: Collection of Detailed information on an eMail address for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/emailInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer numberRangeType: type: object description: Date Range with Start and End dates. properties: from: description: The starting value of the range of number type: integer to: description: The ending value of the range of number type: integer channelRoomMappingsSummaryType: type: object description: Collection of hotel-channel room type mappings. properties: channelRoomMappingSummary: description: Information about hotel-channel room type mapping. type: array maxItems: 4000 items: $ref: '#/components/schemas/channelRoomMappingSummaryType' 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 currenciesMapping: type: object description: Response object for fetching external system currencies. properties: currenciesMapping: description: Collection of external system currencies based on the request criteria. $ref: '#/components/schemas/currenciesMappingType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' carrierInfoType: type: object description: Carrier Information Type. properties: carrierCode: description: Use the SGA(Signature Airline Code) to filter rate codes for specific sources of business. This field can also be used to exclude specific sources of availability and bookings from the selection of rates. type: string minLength: 0 maxLength: 20 returnToSGA: description: Return to SGA. type: boolean parametersType: type: array description: Collection of generic Name-Value-Pair parameters. maxItems: 4000 items: $ref: '#/components/schemas/parameterType' uniqueIDListType: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' copyTotalPricingElementsType: type: object description: Total Pricing Elements to copy from single source property to multi target properties properties: totalPricingElements: description: Total Pricing Element Type record details to copy $ref: '#/components/schemas/totalPricingElementsType' targetHotels: description: Target properties to copy Total Pricing Element records $ref: '#/components/schemas/codeListType' channelParameterMappingType: type: object description: Includes information about the parametersTypes and system Information for the Channel/Hotel. properties: systemInfo: description: Identify details of External System $ref: '#/components/schemas/systemInfoType' groups: description: Collection of channel parameters organized into groups. type: array maxItems: 4000 items: $ref: '#/components/schemas/channelParameterGroupType' channelCarriers: type: object description: Request object for creating channel carriers. properties: carriers: description: Channel carriers to be created. type: object properties: carrier: description: Channel carrier details. type: array items: $ref: '#/components/schemas/systemCarrierType' bookingChannelCode: description: Channel code. $ref: '#/components/schemas/codeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' paymentTypesType: type: array description: Payment card code like AX,VI etc. maxItems: 4000 items: type: string minLength: 0 maxLength: 20 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 responsible 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 systemCarrierType: type: object description: Identify carrier details of external system. properties: carrierCode: description: Code and description of carrier. $ref: '#/components/schemas/codeDescriptionType' merchant: description: Indicates whether external system carrier is merchant or not. type: boolean inactive: description: Indicates whether external system carrier is active or not. type: boolean channelMarketingTextCopy: type: object description: Request object to copy channel marketing texts. properties: copyChannelMarketingTexts: description: List of channel marketing texts to be copied. type: array items: $ref: '#/components/schemas/copyMarketingTextType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' depositCancelRevenueType: type: string description: The type to indicate what revenue is to be used for calculating deposit/cancellation amounts. enum: - Rooms - Catering - All contractRangeInformationType: type: object description: Holds Contract Range per number of Properties, Rooms or reservations information. properties: contractTransaction: description: Holds Contract Range per number of Properties, Rooms or reservations information. $ref: '#/components/schemas/contractTransactionType' range: description: Holds No of reservations range for Transaction Fee type. type: integer months: description: Holds No of months calculated while generating statements for Maintenance Fee type. type: number contractRange: description: Holds minimum and maximum range per number of Properties/Rooms/Reservations value. $ref: '#/components/schemas/numberRangeType' distributionTemplateType: type: object description: Information about a distribution template. properties: description: description: Description of the distribution template. type: string minLength: 0 maxLength: 2000 type: description: Classification or grouping of the distribution template. type: string minLength: 0 maxLength: 2000 negotiatedRate: description: Overrides availability of configuring negotiated rates given Channel is flagged as negotiated. type: boolean inactive: description: Flag that indicates whether distribution template is inactive or not. type: boolean displaySequence: description: Display sequence of the distribution template. type: integer channelRates: description: Information about channel rates where distribution template will be distributed to. $ref: '#/components/schemas/distributionTemplateChannelRatesType' code: description: Uniquely identifies the distribution template. type: string minLength: 0 maxLength: 20 systemRateLevelType: type: object description: Identify rate level details of external system. properties: rateLevelCode: description: Code and description of rate level. $ref: '#/components/schemas/codeDescriptionType' hotelDistributionTemplatesType: type: object description: Collection of distribution templates. properties: distributionTemplate: description: Information about a distribution template. type: array maxItems: 4000 items: $ref: '#/components/schemas/distributionTemplateType' hotelId: description: Hotel code where distribute templates belong to. type: string minLength: 0 maxLength: 20 operaVersionNumberType: type: string description: Current Opera Version Number minLength: 0 maxLength: 40 bookingChannelsInfoType: type: array description: Additional detail about booking channel. maxItems: 4000 items: $ref: '#/components/schemas/bookingChannelInfoType' channelAccountContractsCopyType: type: array description: List of channel account contracts information to create a copy of. maxItems: 4000 items: $ref: '#/components/schemas/channelAccountContractCopyType' guaranteesMappingType: type: array description: Information about an external system guarantee mapping. maxItems: 4000 items: $ref: '#/components/schemas/guaranteeMappingType' totalPricingElementsType: type: array description: List of Total Pricing Element Type maxItems: 4000 items: $ref: '#/components/schemas/totalPricingElementType' addressType: type: object description: Provides address information. properties: isValidated: description: Indicator to define if the Address is validated by the Address Validation System. type: boolean addressLine: description: When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. type: array maxItems: 4 items: type: string minLength: 0 maxLength: 80 cityName: description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). type: string minLength: 0 maxLength: 40 postalCode: description: Post Office Code number. type: string minLength: 0 maxLength: 15 cityExtension: description: Post Office City Extension Code number. City Extension mainly used for UK addresses. type: string minLength: 0 maxLength: 20 county: description: County or District Name (e.g., Fairfax). This is read only. type: string minLength: 0 maxLength: 20 state: description: State or Province name (e.g., Texas). type: string minLength: 0 maxLength: 20 country: description: Country name (e.g., Ireland). $ref: '#/components/schemas/countryNameType' language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' type: description: Defines the type of address (e.g. home, business, other). type: string minLength: 0 maxLength: 20 typeDescription: description: Describes the type code type: string primaryInd: description: When true, indicates a primary information. type: boolean updateReservations: description: Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address. type: boolean barCode: description: The postal barcode for the address. type: string minLength: 0 maxLength: 100 createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible 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 codeType: type: string description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. minLength: 0 maxLength: 20 channelRateRoomDetailType: type: object description: This type holds data for channel Rate room. properties: roomOrder: description: Room order for rate room combination.It will be used if RoomOrderFromRoomMapping is not set. type: number rateOrder: description: Rate order for rate room combination. It will be used if RateOrderFromRateMapping is not set. type: number roomOrderFromRoomMapping: description: Room order from the booking channel room mapping. type: number rateOrderFromRateMapping: description: Rate order from the booking channel rate mapping. type: number channelOrgMappingsType: type: array description: Respresents information of the Channel Code, OrgCode and Default Login Resort used for mapping. maxItems: 4000 items: $ref: '#/components/schemas/channelOrgMappingType' channelParameterValueType: type: string description: The value types of parameter, possible types are Boolean, String, Date, and Number. enum: - Boolean - String - Date - Time - Number - SingleSelectLOV - MultiSelectLOV channelParameterMapping: type: object description: Response object for channel parameter(s) based on search criteria. properties: channelParameterMapping: description: Collection of channel parameter(s) result based on the search criteria. $ref: '#/components/schemas/channelParameterMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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. statisticDetailsType: type: array description: Holds the statistic details for the statement details. maxItems: 4000 items: $ref: '#/components/schemas/statementDetailsStatisticType' amenityGroupType: type: string description: User defined logical group name for the amenities. enum: - PropertyFeatures - RoomFeatures - ProductsFeatures - BedCodes totalPricingElementsCopy: type: object description: Request object to copy the total pricing elements into the target properties. properties: copyInstructions: $ref: '#/components/schemas/copyTotalPricingElementsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountContractElementsType: type: array description: Channel account contract elements information object to hold details of contract elements. maxItems: 4000 items: $ref: '#/components/schemas/contractElementInformationType' channelRoomMapping: type: object description: Request object for changing Channel Room Mapping. properties: channelRoomMapping: description: Channel Room Type mapping details to be changed. $ref: '#/components/schemas/channelRoomMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelsDistributionTemplatesType: type: array description: Information about a hotel level distribution template. maxItems: 4000 items: $ref: '#/components/schemas/hotelDistributionTemplatesType' countryNameType: type: object description: Code for a country or a nationality. properties: value: type: string description: Used for Character Strings, length 0 to 200. minLength: 0 maxLength: 200 code: description: Code for a country or a nationality. type: string minLength: 0 maxLength: 20 channelRateMappingsType: type: object description: Collection of hotel-channel rate code mappings. properties: channelRateMapping: description: Information about hotel-channel rate code mapping. type: array maxItems: 4000 items: $ref: '#/components/schemas/channelRateMappingType' 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 channelBillingStatementSummariesType: type: array description: Holds summary of channel billing statement. maxItems: 4000 items: $ref: '#/components/schemas/channelBillingStatementSummaryType' 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 channelRoomMappings: type: object description: Request object for Channel Room Mapping creation. properties: channelRoomMappings: description: Channel Room Type mapping details to be defined. $ref: '#/components/schemas/channelRoomMappingsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelBillingStatements: type: object description: Request object to Change channel billing statements. properties: channelBillingStatements: description: Channel billing statements information to Change. $ref: '#/components/schemas/channelBillingStatementsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountContractsDetailsCopy: type: object description: Response object of the Channel account contract copy request. properties: channelAccountContractsCopyResponse: description: Response details of the contracts sent for copy. $ref: '#/components/schemas/channelAccountContractsCopyResponseType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelRoomMappingMasterInfoType: type: object description: Additional details about the booking channels and source descriptions for a hotel room type referenced within the fetched results. properties: bookingChannelsInfo: description: Additional details about booking channels. $ref: '#/components/schemas/bookingChannelsInfoType' sourceDescriptions: description: hotel-channel room type mapping source descriptions. $ref: '#/components/schemas/channelRoomMappingsSourceDescriptionsType' marketingPolicyType: type: string description: Indicates the channel policy type like deposit,cancel etc. enum: - Deposit - Commission - Cancel - Guarantee - General - Penalty - Tax - Promotion channelNegRateAccessDetailType: type: object properties: newAccessCode: type: string minLength: 0 maxLength: 20 channelRatePlanCodeOrder: type: integer newTimeSpan: $ref: '#/components/schemas/timeSpanType' syncProfileRatesAccessCodes: type: object properties: targetHotels: type: array maxItems: 50 minItems: 1 items: type: string oldChannelRatesAccess: $ref: '#/components/schemas/channelRatesAccessMain' newChannelRatesAccess: $ref: '#/components/schemas/channelRatesAccessMain' contractFeeTypeType: type: string description: To specify contract element is for Miscellaneous fee. enum: - Setup - Maintenance - Transaction - Fax - MinimumFee - Miscellaneous getChannelRatesAccessItems: type: object description: Response object for fetching Negotiated channel rates. properties: hotelId: description: Hotel Id. type: string minLength: 0 maxLength: 20 channelCode: description: Channel Room Type. type: string minLength: 0 maxLength: 20 ratePlanCode: description: Channel Room Type. type: string minLength: 0 maxLength: 20 channelRatePlanCode: description: Channel Room Type. type: string minLength: 0 maxLength: 20 channelRatePlanOrder: description: Channel Room Type. type: integer default: true rateAccessCode: type: string description: Negotiated Rate Access Code. startDate: type: string description: Start Date of the Channel Rate Access Code. format: date endDate: type: string description: End Date of the Channel Rate Access Code. format: date active: type: boolean profileId: type: string minLength: 1 maxLength: 20 pattern: '[A-Z0-9]+' description: Profile Id for which Channel Rate access code is applicable for. accountId: type: string minLength: 1 maxLength: 20 pattern: '[A-Z0-9]+' description: Account Id for which Channel Rate access code is applicable for. accountName: type: string description: Account name for which Channel Rate access Code is applicable for. minLength: 1 maxLength: 80 profileAccountType: $ref: '#/components/schemas/accountTypeEnum' channelParameterType: type: object properties: parameterName: description: Name of the parameter in the channel. type: string minLength: 0 maxLength: 80 parameterDisplay: description: The display name for the parameter in the channel. type: string minLength: 0 maxLength: 80 shortDescription: description: Short description for the parameter. type: string minLength: 0 maxLength: 2000 parameterDescription: description: The Description for the parameter. type: string minLength: 0 maxLength: 2000 parameterValue: description: The Value of the parameter. type: string minLength: 0 maxLength: 2000 hotelId: description: Hotel code identifying the parameters related to the Hotel. type: string minLength: 0 maxLength: 20 parameterType: description: The type of the parameter, the possible types are P (Parameter), Setting (S). type: string enum: - P - S scope: description: Whether this is a global or property level parameter. type: string enum: - H - P valueType: $ref: '#/components/schemas/channelParameterValueType' sequence: description: Sequence number for displaying the parameter in the channel. type: integer parameters: type: array maxItems: 4000 items: $ref: '#/components/schemas/baseChannelParameterType' levelType: $ref: '#/components/schemas/channelParameterLevelType' levelCode: type: string minLength: 0 maxLength: 20 description: Parameters details for the Channel. channelAccountsToChange: type: array description: Channel account information to create a new channel account. items: $ref: '#/components/schemas/channelAccountType' channelAccounts: type: object description: Request object to create the channel accounts. properties: channelAccounts: description: Channel account information to create a new channel account. $ref: '#/components/schemas/channelAccountsInformationType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' propertiesMapping: type: object description: Response object for fetching external system properties. properties: propertiesMapping: description: Collection of external system properties based on the request criteria. $ref: '#/components/schemas/propertiesMappingType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' currenciesMappingType: type: array description: Information about an external currency mapping. maxItems: 4000 items: $ref: '#/components/schemas/currencyMappingType' letterTypeType: type: string description: Represents Inquiry Letter Type. enum: - Confirmation - Cancellation - BanquetEventOrder - Contract - Inquiry cancelPenaltyType: type: object description: The CancelPenalty class defines the cancellation policy of the hotel facility. properties: deadline: description: Cancellation deadline, absolute or relative. $ref: '#/components/schemas/policyDeadlineType' amountPercent: description: Cancellation fee expressed as a fixed amount, or percentage of/or room nights. $ref: '#/components/schemas/policyAmountPercentType' penaltyDescription: description: Text description of the Penalty in a given language. type: string minLength: 0 maxLength: 2000 offsetUnit: $ref: '#/components/schemas/offsetUnitType' formattedRule: description: Formatted Text Rule of the Cancellation Penalty. type: string minLength: 0 maxLength: 2000 policyCode: description: Policy Code. type: string minLength: 0 maxLength: 20 manual: description: Flag to indicate if the cancellation policy is manual. type: boolean nonRefundable: description: Indicates if the amount is refundable if booking is canceled. type: boolean translationTextType50: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 50. type: string minLength: 0 maxLength: 50 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' hotelCodeMappingInfoType: type: object description: Generic information of the OPERA hotel code, channel hotelcode for the requested booking channel code. properties: hotelId: description: OPERA hotel code for the requested channel hotel code. type: string minLength: 0 maxLength: 20 channelHotelCode: description: Channel hotel code for the requested OPERA hotel code. type: string minLength: 0 maxLength: 20 channelHotelCodeMapping: type: object description: Response giving OPERA hotel code mapped to channel hotel code for a booking channel and vice versa. properties: channelCode: description: Channel code for which the hotel code mapping information is needed. type: string maxLength: 2000 hotelInfo: description: OPERA or Channel hotel code information. $ref: '#/components/schemas/hotelCodeMappingInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' creditCards: type: object description: Request object for changing existing external system credit cards. properties: creditCards: description: External system credit cards to be changed. $ref: '#/components/schemas/creditCardsMappingType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' creditCardsMapping: type: object description: Response object for fetching external system credit cards. properties: creditCardsMapping: description: Collection of external system credit cards based on the request criteria. $ref: '#/components/schemas/creditCardsMappingType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelRoomMappingsType: type: array description: Hotel-channel room type mapping information. maxItems: 4000 items: $ref: '#/components/schemas/channelRoomMappingType' channelAccountContractElements: type: object description: Response object of the channel account contract elements fetch request. Contains detailed information for the channel contract elements. properties: contractElements: description: Holds list of contract elements detail. $ref: '#/components/schemas/channelAccountContractElementsType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountsSummary: type: object description: Response object of the Channel accounts fetch request. properties: channelAccounts: description: Type to contain summary details of the channel account. $ref: '#/components/schemas/channelAccountsSummaryType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelNegotiatedRateDetails: type: object description: Response object for fetching Negotiated channel rates. properties: channelNegRates: description: List of negotiated channel rates based on search criteria. type: object properties: channelNegRate: description: List of negotiated channel rates based on search criteria. type: array items: $ref: '#/components/schemas/channelNegRateType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' creditCardMappingType: type: object description: Base external system mapping info. properties: systemInfo: description: Identify details of External System $ref: '#/components/schemas/systemInfoType' localSystemCode: description: Code used inside the OPERA System type: string minLength: 0 maxLength: 20 externalSystemCode: description: Code used in the External System type: string minLength: 0 maxLength: 20 description: description: Detailed Description of the given entity. type: string minLength: 0 maxLength: 2000 dateRange: description: Start and End Date of the mapping validity. If value is not supplied that mapping will be valid forever. $ref: '#/components/schemas/timeSpanType' managedBy: $ref: '#/components/schemas/managedByOptions' 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 channelEnhancedGlobalDescription: type: object description: Response object for information regarding global descriptions of hotel room types. properties: globalDescription: description: Contains the global descriptions of hotel room types. $ref: '#/components/schemas/enhancedDescriptionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelBillingStatementSummaries: type: object description: Response object of the channel billing statements fetch request. properties: channelBillingStatementsSummary: description: Summary information of channel billing statements. $ref: '#/components/schemas/channelBillingStatementSummariesType' 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: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountsSummaryType: type: array description: This type holds collection of channel accounts summary information. maxItems: 4000 items: $ref: '#/components/schemas/channelAccountSummaryType' statementDetailsStatistics: type: object description: Response object of the channel account statement details statistics fetch request. properties: channelStatementDetails: description: Holds statement details statistics. $ref: '#/components/schemas/statementDetailsStatisticsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' propertyMappingType: type: object description: Base external system mapping info. properties: systemInfo: description: Identify details of External System $ref: '#/components/schemas/systemInfoType' initialUpload: description: Initial Upload or not. type: boolean localSystemCode: description: Code used inside the OPERA System type: string minLength: 0 maxLength: 20 externalSystemCode: description: Code used in the External System type: string minLength: 0 maxLength: 20 description: description: Detailed Description of the given entity. type: string minLength: 0 maxLength: 2000 dateRange: description: Start and End Date of the mapping validity. If value is not supplied that mapping will be valid forever. $ref: '#/components/schemas/timeSpanType' city: description: City code of the channel hotel. type: string minLength: 0 maxLength: 20 roomLimit: description: Maximum room limit for the channel hotel reservation. type: integer bookingLimit: description: Booking limit used by ADS interface for booking limit upload. Available if channel type is ADS and ADS ARI is enabled. type: integer hotelChainId: description: Hotel chain ID of channel-hotel mapping. Only available for UA channel. It may not be modified if in myfidelio environment, and user is for a specific hotel. type: string minLength: 0 maxLength: 1 chainCode: description: Chain code for the channel-hotel mapping. type: string minLength: 0 maxLength: 20 prevailingRates: description: Prevailing rates flag of channel-hotel mapping. Available if PREVAILING_RATE_BY_LOS parameter is on. type: boolean aRIEnabled: description: ADS ARI enabled flag of channel-hotel mapping. Available only if channel type is ADS. type: boolean addOnLicense: description: External system Add-on license. This is mandatory when Channel Type is ADS. type: string minLength: 0 maxLength: 20 channelHotelCodeMappingBuckets: description: Rate code revenue thresholds information. $ref: '#/components/schemas/channelHotelCodeMappingBucketsType' currencyMappingType: type: object description: Base external system mapping info. properties: systemInfo: description: Identify details of External System $ref: '#/components/schemas/systemInfoType' localSystemCode: description: Code used inside the OPERA System type: string minLength: 0 maxLength: 20 externalSystemCode: description: Code used in the External System type: string minLength: 0 maxLength: 20 description: description: Detailed Description of the given entity. type: string minLength: 0 maxLength: 2000 dateRange: description: Start and End Date of the mapping validity. If value is not supplied that mapping will be valid forever. $ref: '#/components/schemas/timeSpanType' lanyonDecimalPosition: description: Number of decimal positions used by the currency. type: integer channelDecimalPosition: description: Number of decimal positions used by the currency as per the channel. type: integer managedBy: $ref: '#/components/schemas/managedByOptions' policyDeadlineType: type: object description: Cancellation deadline, absolute or relative. properties: absoluteDeadline: description: Defines the absolute deadline. Either this or the offset attributes may be used. type: string format: date-time offsetFromArrival: description: The number of days before arrival that allows cancellation without penalties. type: integer offsetDropTime: description: Time on offset day the cancellation penalties applies. type: string format: date-time offsetFromBookingDate: description: The number of days after booking deposit must be paid. type: integer channelRateMappingDescriptionDetailsType: type: object description: Descriptions of hotel-channel rate code mapping which may be enhanced descriptions, HTML supported description or a simple string description. properties: enhancedDescription: description: Enhanced descriptions which allow defining line 1 to 3 descriptions. $ref: '#/components/schemas/channelRateMappingEnhancedDescriptionType' hTMLSupportedDescription: description: HTML supported description. $ref: '#/components/schemas/translationTextType2000' description: description: Plain text description. $ref: '#/components/schemas/translationTextType2000' channelRestrictions: type: object description: Request object for publishing rate restrictions to channels. properties: publishRestriction: description: Restriction information to be published. $ref: '#/components/schemas/publishRatePlanType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelPolicies: type: object description: Request object for fetching Policies, guarantee, and deposit Details. properties: channelPoliciesInfo: description: Reservation Rules and Policies related Information $ref: '#/components/schemas/channelPoliciesInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' parameterType: type: object description: Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined. properties: parameterName: description: Name of the parameter. type: string parameterValue: description: Value of the parameter. type: string operaVersion: type: object description: Response for Ping operation. properties: operaVersion: description: Opera version number. $ref: '#/components/schemas/operaVersionNumberType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelAccountSetupDetailsType: type: object description: To hold channel account detailed setup information. properties: hotelCodes: description: Hotels information where channel account is associated/active with. $ref: '#/components/schemas/codeListType' chainCode: description: Chain information where current account is configured with. type: string minLength: 0 maxLength: 20 currencyCode: description: Holds Currency code. type: string minLength: 0 maxLength: 20 instances: description: Hold list of account codes whose template account is current account. $ref: '#/components/schemas/codeListType' rebateDate: description: The rebate date for the account. type: string format: date maxLength: 8 inactiveDate: description: The date that account was marked as inactive. type: string format: date maxLength: 8 contractEndsOn: description: Contract End date. type: string format: date maxLength: 8 registeredHotel: description: Property which registered this channel account. type: string minLength: 0 maxLength: 20 links: type: array items: $ref: '#/components/schemas/instanceLink' channelAccount: type: object description: Response object of the Channel account fetch request. Contains detailed information for the channel account. properties: channelAccount: description: Channel account detailed information type to contain details of channel account including account information, setup details, communication information. $ref: '#/components/schemas/channelAccountType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' channelBillingStatementsType: type: array description: Provides detailed information regarding channel billing statement. maxItems: 4000 items: $ref: '#/components/schemas/channelBillingStatementType' depositPolicyType: type: object description: Used to define the deposit policy, guarantees policy, and/or accepted forms of payment. properties: amountPercent: description: Payment expressed as a fixed amount, or a percentage of/or room nights. $ref: '#/components/schemas/policyAmountPercentType' deadline: description: Payment deadline, absolute or relative. $ref: '#/components/schemas/policyDeadlineType' description: description: Text description of the Payment in a given language. type: string minLength: 0 maxLength: 2000 depositReceiptNo: description: Receipt number associated with the deposit policy type: integer transactionDate: description: Transaction Date associated with the deposit policy type: string format: date maxLength: 8 depositReqReversed: description: Flag to indicate if deposit policy is reversed type: boolean formattedRule: description: Formatted Text Rule of the deposit policy. type: string minLength: 0 maxLength: 2000 typeOfCharges: description: Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both $ref: '#/components/schemas/depositCancelRevenueType' policyCode: description: Deposit Policy Code type: string minLength: 0 maxLength: 20 manual: description: Flag to indicate if the cancellation policy is manual. type: boolean deleteNegotiatedRates: type: object properties: items: type: array minItems: 1 maxItems: 100 items: $ref: '#/components/schemas/hotelIdChannelRatesAccess' channelAccountContractCopyType: type: object description: Channel account contract type to hold account and contract details to copy. properties: targetProfileId: description: Target Profile Id to which contract to be copied. User can populate either Profile ID or AccountCode. $ref: '#/components/schemas/uniqueID_Type' targetAccountCode: description: Target Account code to which contract to be copied. This is utilised to find account when TargetProfileID is not provided. type: string minLength: 0 maxLength: 20 channelAccountContractCopyDetails: description: Contract details to copy. type: array maxItems: 4000 items: $ref: '#/components/schemas/channelAccountContractCopyDetailsType' creditCardsMappingType: type: array description: Information about an external system credit card mapping. maxItems: 4000 items: $ref: '#/components/schemas/creditCardMappingType' rateCodeLockStatusType: type: string description: Indicates that the rate code is locked by the central system and cannot be edited at the property level. enum: - Unlocked - External - Property - Central responses: '406': description: Not acceptable. '414': description: Request URI Too Large '503': description: Service Unavailable '413': description: Request Entity Too Large '500': description: System Error content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '502': description: Bad Gateway '403': description: Forbidden '415': description: Unsupported Media Type '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '401': description: Unauthorized '405': description: Method not allowed parameters: x-hotelid: name: x-hotelid description: Mandatory parameter to identify the hotel code where the end user is logged in in: header required: true schema: type: string authKey: name: authorization description: Bearer token that needs to be passed which is generated post user authentication in: header required: true schema: type: string externalData: name: externalData description: Pass this header as true, if payload needs DVM in: header schema: type: string Accept-Language: name: Accept-Language description: Language code in: header schema: type: string x-app-key: name: x-app-key description: Client or Partner's Application Key in: header required: true schema: 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}$ x-externalsystem: name: x-externalsystem description: External system code. in: header x-example: EXTERNALSYSTEMCODE schema: type: string maxLength: 40 x-originating-application: name: x-originating-application description: Customer's Integration Application Id in: header schema: type: string clusterIdPath: name: clusterId description: ClusterId in URI path in: path required: true schema: type: string maxLength: 50 x-request-id: name: x-request-id description: Request Id of an incoming request in: header schema: 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} externalDocs: description: Find out more about Oracle Hospitality url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html