openapi: 3.2.0 info: title: OPERA Cloud CRM Configuration Profile Configuration API description: APIs for Customer Relationship Management (profile) configuration, such as creating preferences, or address types. It also includes Membership Configuration, where you can retrieve membership levels that are configured for a property, or create new membership enrollment codes .

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: /crm/config/v1 tags: - name: ProfileConfiguration description: APIs for Customer Relationship Management (profile) configuration including preference groups and preferences. paths: /addressFormats: get: summary: Get address formats description: You can use this API to get address formats.

OperationId:getAddressFormats

operationId: getAddressFormats parameters: - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the 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})*' description: Response object for fetching Address Formats. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/addressFormats' '204': description: AddressFormats 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: - ProfileConfiguration put: summary: Change address formats description: You can use this API to change address formats.

OperationId:putAddressFormats

operationId: putAddressFormats 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/addressFormats' description: Request object for change address formats. required: true delete: summary: Delete address formats description: You can use this API to delete address formats.

OperationId:deleteAddressFormats

operationId: deleteAddressFormats parameters: - name: formatCodes in: query required: true 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})*' 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: - ProfileConfiguration post: summary: Create address formats description: You can use this API to create address formats.

OperationId:postAddressFormats

operationId: postAddressFormats 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/addressFormats' description: Request object for creating address formats. required: true /claimAdjustmentLimits: get: summary: Get Claim Adjustment Limits description: You can use this API to get Claim Adjustment Limits.

This API is deprecated.

OperationId:getClaimAdjustmentLimits

operationId: getClaimAdjustmentLimits parameters: - name: limitCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: hotelId in: query required: false description: The name of the property code for the Claim Adjustment Limit to be searched. 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 fetching Claim Adjustment Limits. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/claimAdjustmentLimitsInfo' '204': description: ClaimAdjustmentLimits 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: - ProfileConfiguration put: summary: Change Claim Adjustment Limits description: You can use this API to change Claim Adjustment Limits.

This API is deprecated.

OperationId:putClaimAdjustmentLimits

operationId: putClaimAdjustmentLimits parameters: - $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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/claimAdjustmentLimits' description: Request object for modifying Claim Adjustment Limits. required: true post: summary: Create Claim Adjustment Limits description: You can use this API to create Claim Adjustment Limits.

This API is deprecated.

OperationId:postClaimAdjustmentLimits

operationId: postClaimAdjustmentLimits parameters: - $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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/claimAdjustmentLimits' description: Request object for creating Claim Adjustment Limits. required: true /upsert/claimAdjustmentLimits: put: summary: Create/Change Claim Adjustment Limits description: You can use this API to create/change Claim Adjustment Limits.

This API is deprecated.

OperationId:putUpsertClaimAdjustmentLimits

operationId: putUpsertClaimAdjustmentLimits parameters: - $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' tags: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/claimAdjustmentLimits' description: Request object for modifying Claim Adjustment Limits. required: true /creditRatings: get: summary: Get credit ratings description: You can use this API to get credit ratings.

OperationId:getCreditRatings

operationId: getCreditRatings parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the 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})*' description: Response object for fetching credit ratings. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/creditRatings' '204': description: CreditRatings 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: - ProfileConfiguration put: summary: Change credit ratings description: You can use this API to change credit ratings.

OperationId:putCreditRatings

operationId: putCreditRatings 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/creditRatings' description: Request object for changing credit ratings. required: true delete: summary: Delete credit ratings description: You can use this API to delete credit ratings.

OperationId:deleteCreditRatings

operationId: deleteCreditRatings parameters: - name: creditRatings in: query required: true 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})*' 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: - ProfileConfiguration post: summary: Create credit ratings description: You can use this API to create credit ratings.

OperationId:postCreditRatings

operationId: postCreditRatings 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/creditRatings' description: Request object for creating credit ratings. required: true /exclusivePreferences: get: summary: Get template Exclusive Preferences description: You can use this API to get template Exclusive Preferences.

OperationId:getTemplateExclusivePreferences

operationId: getTemplateExclusivePreferences parameters: - name: exclusivePreferenceCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: preferenceGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: preferenceCodes 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 exclusive preferences at the template level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateExclusivePreferences' '204': description: TemplateExclusivePreferences 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: - ProfileConfiguration put: summary: Change template Exclusive Preferences description: You can use this API to change template Exclusive Preferences.

OperationId:putTemplateExclusivePreferences

operationId: putTemplateExclusivePreferences 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateExclusivePreferences' description: Request object for changing Exclusive preferences at the template level. required: true delete: summary: Delete template Exclusive Preferences description: You can use this API to delete template Exclusive Preferences.

OperationId:deleteTemplateExclusivePreferences

operationId: deleteTemplateExclusivePreferences parameters: - name: exclusivePreferenceCode in: query required: true description: Specifies the Exclusive preference code. schema: type: string - name: exclusivePreferenceGroup in: query required: true description: Specifies the preference group the Exclusive preference belongs to. 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: - ProfileConfiguration post: summary: Create template Exclusive Preferences description: You can use this API to create template Exclusive Preferences.

OperationId:postTemplateExclusivePreferences

operationId: postTemplateExclusivePreferences 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateExclusivePreferences' description: Request object for creating exclusive preferences at the template level. required: true /exclusivePreferences/copy: put: summary: Copy Exclusive Preferences description: You can use this API to copy Exclusive Preferences.

OperationId:copyExclusivePreferences

operationId: copyExclusivePreferences 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/exclusivePreferencesCopy' description: Request object for copying template Exclusive preferences to hotel(s). required: true /hotels/{hotelId}/exclusivePreferences: get: summary: Get Exclusive preferences description: You can use this API to get Exclusive preferences at hotel Level.

OperationId:getExclusivePreferences

operationId: getExclusivePreferences parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: exclusivePreferenceCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: preferenceGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: preferenceCodes 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 Exclusive preferences at the property level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/exclusivePreferences' '204': description: ExclusivePreferences 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: - ProfileConfiguration put: summary: Change Exclusive Preferences description: You can use this API to change Exclusive Preferences at hotel Level.

OperationId:putExclusivePreferences

operationId: putExclusivePreferences parameters: - name: hotelId in: path required: true description: Unique ID of hotel. 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/exclusivePreferences' description: Request object for changing Exclusive preferences at the property level. required: true delete: summary: Delete Exclusive Preferences description: You can use this API to delete Exclusive Preferences at hotel Level.

OperationId:deleteExclusivePreferences

operationId: deleteExclusivePreferences parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: exclusivePreferenceCode in: query required: true description: Specifies the Exclusive preference code. schema: type: string - name: exclusivePreferenceGroup in: query required: true description: Specifies the preference group the Exclusive preference belongs to. 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: - ProfileConfiguration post: summary: Create Exclusive Preferences description: You can use this API to create Exclusive Preferences at hotel Level.

OperationId:postExclusivePreferences

operationId: postExclusivePreferences parameters: - name: hotelId in: path required: true description: Unique ID of hotel. 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/exclusivePreferences' description: Request object for creating Exclusive preferences at the property level. required: true /hotels/{hotelId}/preferences: get: summary: Get preferences description: Use this API to get all configured preferences.

OperationId:getPreferences

operationId: getPreferences parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: preferenceCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: preferenceGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: createdByUserIds in: query required: false style: form explode: true schema: type: array items: type: integer 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 preferences at the property level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelPreferences' '204': description: Preferences 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: - ProfileConfiguration put: summary: Change preferences description: Use this API to update and change existing preferences.

OperationId:putPreferences

operationId: putPreferences parameters: - name: hotelId in: path required: true description: Unique ID of hotel. 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelPreferences' description: Request object for changing preferences at the property level. required: true delete: summary: Delete preferences description: Use this API to delete preferences.

OperationId:deletePreferences

operationId: deletePreferences parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: preferenceCode in: query required: true description: Specifies the preference code. schema: type: string - name: preferenceGroup in: query required: true description: Specifies the preference group the preference belongs to. 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: - ProfileConfiguration post: summary: Create preferences description: This will allow you to create new preferences.

OperationId:postPreferences

operationId: postPreferences parameters: - name: hotelId in: path required: true description: Unique ID of hotel. 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelPreferences' description: Request object for creating preferences at the property level. required: true /preference: delete: summary: Delete preferences description: Use this API to delete preferences, this API allows us to delete both the Global and Hotel level preferences.

OperationId:deleteHotelAndGlobalPreferences

operationId: deleteHotelAndGlobalPreferences parameters: - name: preferenceCode in: query required: true description: Specifies the preference code. schema: type: string - name: preferenceGroup in: query required: true description: Specifies the preference group the preference belongs to. schema: type: string - name: hotelId in: query required: false description: Specifies the hotel code for which the preference is specified. 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: - ProfileConfiguration /preferenceGroups: get: summary: Get Preference Groups description: The API can be used to retrieve preference groups that match the given criteria in the request.

OperationId:getPreferenceGroups

operationId: getPreferenceGroups parameters: - name: preferenceGroupsCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Preference group description to be searched. 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 fetching preference groups. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/preferenceGroups' '204': description: PreferenceGroups 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: - ProfileConfiguration put: summary: Change Preference Groups description: This API can be used to modify the preference groups. Changes can be made concurrently to multiple groups.

OperationId:putPreferenceGroups

operationId: putPreferenceGroups parameters: - $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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/preferenceGroups' description: Request object for changing existing preference groups. required: true delete: summary: Delete preference groups description: This will allow you to delete an existing Preference Group.

OperationId:deletePreferenceGroups

operationId: deletePreferenceGroups parameters: - name: preferenceGroup in: query required: true description: Code identifying the preference group. 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: - ProfileConfiguration post: summary: 'Create new preference groups ' description: Use this API to create a new Preference group.

OperationId:postPreferenceGroups

operationId: postPreferenceGroups 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/preferenceGroups' description: Request object for creating new preference groups. required: true /preferences: get: summary: Get template Preferences description: You can use this API to get template Preferences.

OperationId:getTemplatePreferences

operationId: getTemplatePreferences parameters: - name: preferenceCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: preferenceGroupsCodes 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 preferences at the template level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templatePreferences' '204': description: TemplatePreferences 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: - ProfileConfiguration put: summary: Change template preferences description: You can use this API to change template preferences.

OperationId:putTemplatePreferences

operationId: putTemplatePreferences 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templatePreferences' description: Request object for changing preferences at the template level. required: true delete: summary: Delete template preferences description: You can use this API to delete template preferences.

OperationId:deleteTemplatePreferences

operationId: deleteTemplatePreferences parameters: - name: preferenceCode in: query required: true description: Specifies the preference code. schema: type: string - name: preferenceGroup in: query required: true description: Specifies the preference group the preference belongs to. 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: - ProfileConfiguration post: summary: Create template preferences description: You can use this API to create template preferences.

OperationId:postTemplatePreferences

operationId: postTemplatePreferences 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templatePreferences' description: Request object for creating preferences at the template level. required: true /preferences/copy: put: summary: Copy preferences description: Use this API to copy preferences.

OperationId:copyPreferences

operationId: copyPreferences 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/preferencesCopy' description: Request object for copying template preferences to hotel(s). required: true /profileNameValidations: get: summary: Get Profile Name Validations description: You can use this API to get Profile Name Validations.

OperationId:getProfileNameValidations

operationId: getProfileNameValidations parameters: - name: typeCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: name in: query required: false description: Profile Name to be Searched. 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 for fetching Profile names. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/profileNameValidations' '204': description: ProfileNameValidations 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: - ProfileConfiguration put: summary: Change Profile Name Validations description: You can use this API to change Profile Name Validations.

OperationId:putProfileNameValidations

operationId: putProfileNameValidations 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/profileNameValidationsToChange' description: Request object to edit Profile names. required: true delete: summary: Delete Profile Name Validations description: You can use this API to delete Profile Name Validations.

OperationId:deleteProfileNameValidations

operationId: deleteProfileNameValidations parameters: - name: profileType in: query required: true description: Simple Type for Profile Name Validations Type. e.g. Company,Travel Agent,Source. schema: type: string enum: - Company - TravelAgent - Source uniqueItems: true - name: profileName in: query required: true description: Name of the Profile. 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: - ProfileConfiguration post: summary: Create Profile Name Validations description: You can use this API to create Profile Name Validations.

OperationId:postProfileNameValidations

operationId: postProfileNameValidations 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/profileNameValidations' description: Request object to create Profile names. required: true /upsert/profileNameValidations: put: summary: Create/Change Profile Name Validations description: You can use this API to create/change Profile Name Validations.

OperationId:putUpsertProfileNameValidations

operationId: putUpsertProfileNameValidations parameters: - $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' tags: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/profileNameValidationsToChange' description: Request object to edit Profile names. required: true /profiles/links: get: summary: Get profile links description: You can use this API to get profile links.

This API is deprecated. Please use getProfileRelationships instead

OperationId:getProfileLinks

operationId: getProfileLinks deprecated: true parameters: - name: fromType in: query required: false description: From type to process schema: type: string - name: toType in: query required: false description: To type to process 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: Respose object for fetch profile links content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/profileLinks' '204': description: ProfileLinks 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: - ProfileConfiguration put: summary: Change profile links description: You can use this API to change profile links.

This API is deprecated. Please use putProfileRelationships instead

OperationId:putProfileLinks

operationId: putProfileLinks deprecated: true parameters: - $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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/profileLinks' description: Request Object for change profile links required: true delete: summary: Delete profile links description: You can use this API to delete profile links.

This API is deprecated. Please use deleteProfileRelationships instead

OperationId:deleteProfileLinks

operationId: deleteProfileLinks deprecated: true parameters: - name: fromType in: query required: true description: From type to process schema: type: string - name: toType in: query required: true description: To type to process schema: type: string - name: fromCode in: query required: true description: From code to process schema: type: string - name: toCode in: query required: true description: To code to process 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: - ProfileConfiguration post: summary: Create profile links description: You can use this API to create profile links.

This API is deprecated. Please use postProfileRelationships instead

OperationId:postProfileLinks

operationId: postProfileLinks deprecated: true parameters: - $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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/profileLinks' description: Request Object to create Profile Links required: true /relationships: get: summary: Get profile relationships description: You can use this API to get profile relationships.

OperationId:getProfileRelationships

operationId: getProfileRelationships parameters: - name: fromType in: query required: false description: From type to process schema: type: string - name: toType in: query required: false description: To type to process 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: Respose object for fetch profile links content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/profileLinks' '204': description: ProfileRelationships 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: - ProfileConfiguration put: summary: Change profile relationships description: You can use this API to change profile relationships.

OperationId:putProfileRelationships

operationId: putProfileRelationships 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/profileLinks' description: Request Object for change profile links required: true delete: summary: Delete profile relationships description: You can use this API to delete profile relationships.

OperationId:deleteProfileRelationships

operationId: deleteProfileRelationships parameters: - name: fromType in: query required: true description: From type to process schema: type: string - name: toType in: query required: true description: To type to process schema: type: string - name: fromCode in: query required: true description: From code to process schema: type: string - name: toCode in: query required: true description: To code to process 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: - ProfileConfiguration post: summary: Create profile relationships description: You can use this API to create profile relationships.

OperationId:postProfileRelationships

operationId: postProfileRelationships 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/profileLinks' description: Request Object to create Profile Links required: true /services/profile/status: get: summary: ' ping' description: Ping Profile Configuration Service

OperationId:pingProfileConfigService

operationId: pingProfileConfigService 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: pingProfileConfigService 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: - ProfileConfiguration /upsert/relationships: put: summary: Create/Change profile relationships description: You can use this API to create/change profile relationships.

OperationId:putUpsertProfileRelationships

operationId: putUpsertProfileRelationships 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: - ProfileConfiguration requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/profileLinks' description: Request Object for change profile links required: true components: schemas: configHotelExclusivePreferencesType: type: array description: This gives detailed information about a Exclusive preference at the property level. maxItems: 4000 items: $ref: '#/components/schemas/configHotelExclusivePreferenceType' addressFormatType: type: object description: A representation of the information contained by an address format. properties: formatCode: description: Address format code. type: string minLength: 0 maxLength: 20 formatDefinition: description: Address format definition with the elements of the address. type: string minLength: 0 maxLength: 2000 description: description: Description of the address format. type: string minLength: 0 maxLength: 200 displayOrder: description: sequence number of the address format. type: number formattedExample: description: An example address formatted with the current format definition. type: string minLength: 0 maxLength: 2000 salesFormat: description: Determines if the format is a sales format or not. type: boolean canDelete: description: Determines whether this address format can be deleted. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' claimAdjustmentLimitsInfo: type: object description: Response object for fetching Claim Adjustment Limits. properties: claimAdjustmentLimits: description: Collection of Claim Adjustment Limits. $ref: '#/components/schemas/claimAdjustmentLimitsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' profileNameValidationsToChange: type: object description: Request object to edit Profile names. properties: profileNames: description: Details of the Profile names to edit. $ref: '#/components/schemas/profileNameValidationEditType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' creditRatingsType: type: array description: List of Credit Ratings. maxItems: 4000 items: $ref: '#/components/schemas/creditRatingType' creditRatingType: type: object description: Contains Common Master configuration detail. properties: code: description: Common Master unique code. type: string minLength: 0 maxLength: 40 description: description: Description of the Master code. $ref: '#/components/schemas/translationTextType2000' displayOrder: description: Common Master record sequence number. type: number inactive: description: Determines whether this credit rating is inactive or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' claimAdjustmentLimitsRangeType: type: object description: List of Claim Adjustment Limits. properties: awardPoints: description: Threshold limit for the award. $ref: '#/components/schemas/pointsThreshold' stayPoints: description: Threshold limit for the Tier Stay Points. $ref: '#/components/schemas/pointsThreshold' nightPoints: description: Threshold limit for the Tier Nights Points. $ref: '#/components/schemas/pointsThreshold' revenuePoints: description: Threshold limit for the Tier Revenue Points. $ref: '#/components/schemas/pointsThreshold' configHotelExclusivePreferenceType: type: object description: Base details common between both template and property level Exclusive preference ids. properties: code: description: Specifies the Exclusive preference code. type: string minLength: 0 maxLength: 20 preferenceGroup: description: Specifies the preference group the Exclusive preference belongs to. type: string minLength: 0 maxLength: 20 preferenceCodes: description: Specifies the preference codes mapped to the exclusive preference. $ref: '#/components/schemas/preferenceCodesType' orderSequence: description: Display Order sequence. type: number hotelId: description: Specifies the hotel code for which the Exclusive preference is specified. type: string minLength: 0 maxLength: 20 configExclusivePreferenceBaseType: type: object description: Base details common between both template and property level Exclusive preference ids. properties: code: description: Specifies the Exclusive preference code. type: string minLength: 0 maxLength: 20 preferenceGroup: description: Specifies the preference group the Exclusive preference belongs to. type: string minLength: 0 maxLength: 20 preferenceCodes: description: Specifies the preference codes mapped to the exclusive preference. $ref: '#/components/schemas/preferenceCodesType' orderSequence: description: Display Order sequence. type: number preferenceGroupType: type: object description: Preference group identification details. properties: code: description: Code identifying the preference group. type: string minLength: 0 maxLength: 20 description: description: Description of the preference group. type: string minLength: 0 maxLength: 40 mandatoryReservation: description: When this mandatory reservation is true then user cannot set or change reservation preference flag and also this is a non editable field. SPECIALS AND ROOM FEATURES preference groups will have true for this field type: boolean reservationPreference: description: Indicates if the preference group can be used in reservations. type: boolean maxQuantity: description: Maximum number of preferences which can be created in this preference group. type: integer sequence: description: Display sequence for the preference group. type: integer allowSubTypes: description: This is a placeholder element for future use. Functionality may not be available for the current implementation. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' creditRatings: type: object description: Response object for fetching credit ratings. properties: creditRatings: description: Collection of Credit Ratings. $ref: '#/components/schemas/creditRatingsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' warningsType: type: array description: Used in conjunction with the Success element to define a business error. maxItems: 4000 items: $ref: '#/components/schemas/warningType' configCopyPreferencesType: type: object description: Copy instructions for copying template preferences to hotel(s) properties: hotelCodes: description: Hotel codes to copy the template preferences to. $ref: '#/components/schemas/codeListType' templatePreferences: description: Template preference to be copied to the hotel(s). type: array maxItems: 4000 items: $ref: '#/components/schemas/configTemplatePreferenceIDType' configHotelPreferencesType: type: array description: This type holds a collection of preferences at the property level. maxItems: 4000 items: $ref: '#/components/schemas/configHotelPreferenceType' profileNameValidationsType: type: array description: List of the Profile name to be configured or fetched. maxItems: 4000 items: $ref: '#/components/schemas/profileNameValidationType' templateExclusivePreferences: type: object description: Response object for fetching exclusive preferences at the template level. properties: templateExclusivePreferences: description: Collection of exclusive preferences specified at the template level. $ref: '#/components/schemas/configTemplateExclusivePreferencesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' claimAdjustmentLimits: type: object description: Request object for modifying Claim Adjustment Limits. properties: claimAdjustmentLimits: description: Collection of Claim Adjustment Limits to be changed. $ref: '#/components/schemas/claimAdjustmentLimitsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' codeListType: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 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 addressFormats: type: object description: Response object for fetching Address Formats. properties: formats: description: Collection of Address formats fetched. $ref: '#/components/schemas/addressFormatsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' preferencesCopy: type: object description: Request object for copying template preferences to hotel(s). properties: copyInstructions: description: List of the template preferences to be copied to hotel(s). $ref: '#/components/schemas/configCopyPreferencesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' configTemplatePreferenceIDType: type: object description: Base details common between both template and property level preference ids. properties: code: description: Specifies the preference code. type: string minLength: 0 maxLength: 20 preferenceGroup: description: Specifies the preference group the preference belongs to. type: string minLength: 0 maxLength: 20 profileLinks: type: object description: Response object for fetch profile links properties: profileLinks: $ref: '#/components/schemas/profileLinksType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' status: type: object description: Response Body. properties: warnings: $ref: '#/components/schemas/warningsType' links: $ref: '#/components/schemas/links' profileNameValidationEditType: type: object description: Provides information about the Profile Names. properties: type: description: Type of the Profile. $ref: '#/components/schemas/profileNameValidationTypeType' name: description: Name of the Profile. type: string minLength: 0 maxLength: 80 newProfileName: description: List of new values for Profile Name and Type . $ref: '#/components/schemas/profileNameValidationType' addressFormatsType: type: array description: An Address formats. maxItems: 4000 items: $ref: '#/components/schemas/addressFormatType' exclusivePreferences: type: object description: Response object for fetching Exclusive preferences at the property level. properties: hotelExclusivePreferences: description: Collection of Exclusive preferences specified at the property level. $ref: '#/components/schemas/configHotelExclusivePreferencesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 managedByOptions: description: Describes of the Configuration is Managed by Enterprise or Property. type: string enum: - EnterpriseManaged - PropertyManaged - EnterpriseEnforced - PropertyOverridden profileNameValidations: type: object description: Response for fetching Profile names. properties: profileNames: description: Collection of Profile names. $ref: '#/components/schemas/profileNameValidationsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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 configCopyExclusivePreferencesType: type: object description: Copy instructions for copying template Exclusive preferences to hotel(s) properties: templateExclusivePreference: description: Template Exclusive preference to be copied to the hotel(s). type: array maxItems: 4000 items: $ref: '#/components/schemas/configExclusivePrefCodeAndGroupType' hotelCodes: description: Hotel codes list to which the exclusive pref is to be copied. $ref: '#/components/schemas/codeListType' configExclusivePrefCodeAndGroupType: type: object description: Base details common between both template and property level Exclusive preference ids. properties: code: description: Specifies the Exclusive preference code. type: string minLength: 0 maxLength: 20 preferenceGroup: description: Specifies the preference group the Exclusive preference belongs to. type: string minLength: 0 maxLength: 20 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' pointsThreshold: type: object description: Points Threshold Information. properties: lowerLimit: description: Lower limit. type: integer higherLimit: description: Higher limit. type: integer profileLinksType: type: array description: Holds the collection of profile link objects maxItems: 4000 items: $ref: '#/components/schemas/profileLinkType' profileLinkType: type: object description: ProfileLinksType for create, change and delete properties: fromType: description: From type to process type: string minLength: 0 maxLength: 20 toType: description: To type to process type: string minLength: 0 maxLength: 20 fromCode: description: From code to process type: string minLength: 0 maxLength: 20 toCode: description: To code to process type: string minLength: 0 maxLength: 20 fromDescription: description: The description about from relation type: string minLength: 0 maxLength: 2000 toDescription: description: The description about to relation type: string minLength: 0 maxLength: 2000 defaultProfileLink: description: Relationship is default relationship or not type: boolean globalProfileLink: description: Relationship is global relationship or not type: boolean inheritRates: description: Inherit rates will take either to or from $ref: '#/components/schemas/profileLinkInheritRates' protected: description: Determines whether this code is protected from deleting. This is a read-only element and is only populated during the fetch operation. type: boolean hasHierarchy: description: Determines whether this relationship is hierarchichal or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' configTemplateExclusivePreferencesType: type: array description: Base details common between both template and property level exclusive preferences. maxItems: 4000 items: $ref: '#/components/schemas/configExclusivePreferenceBaseType' profileNameValidationTypeType: type: string description: Simple Type for Profile Name Validations Type. e.g. Company,Travel Agent,Source. enum: - Company - TravelAgent - Source templatePreferences: type: object description: Response object for fetching preferences at the template level. properties: templatePreferences: description: Collection of preferences specified at the template level. $ref: '#/components/schemas/configTemplatePreferencesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' operaVersionNumberType: type: string description: Current Opera Version Number minLength: 0 maxLength: 40 configHotelPreferenceType: type: object description: Base details common between both template and property level preferences. properties: description: description: The description about the preference. type: string minLength: 0 maxLength: 2000 code: description: Specifies the preference code. type: string minLength: 0 maxLength: 20 preferenceGroup: description: Specifies the preference group the preference belongs to. type: string minLength: 0 maxLength: 20 preferenceSubGroup: description: This is a placeholder element for future use. Functionality may not be available for the current implementation. type: string minLength: 0 maxLength: 20 housekeeping: description: Flag to indicate if this preference should be available on the Task Sheet Workflow configuration. It is only applicable for preference types FLOOR and SPECIALS. type: boolean orderSequence: description: Display Order sequence. type: number hotelId: description: Specifies the hotel code for which the preference is specified. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' 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. profileNameValidationType: type: object description: Provides information about the Profile Names. properties: type: description: Type of the Profile. $ref: '#/components/schemas/profileNameValidationTypeType' name: description: Name of the Profile. type: string minLength: 0 maxLength: 80 managedBy: $ref: '#/components/schemas/managedByOptions' preferenceGroupsType: type: array description: Collection of preference groups. maxItems: 4000 items: $ref: '#/components/schemas/preferenceGroupType' 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 configTemplatePreferenceType: type: object description: Base details common between both template and property level preferences. properties: description: description: The description about the preference. type: string minLength: 0 maxLength: 2000 code: description: Specifies the preference code. type: string minLength: 0 maxLength: 20 preferenceGroup: description: Specifies the preference group the preference belongs to. type: string minLength: 0 maxLength: 20 preferenceSubGroup: description: This is a placeholder element for future use. Functionality may not be available for the current implementation. type: string minLength: 0 maxLength: 20 housekeeping: description: Flag to indicate if this preference should be available on the Task Sheet Workflow configuration. It is only applicable for preference types FLOOR and SPECIALS. type: boolean orderSequence: description: Display Order sequence. type: number global: description: Specifies whether the preference is to be available for selection at all properties . type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' profileLinkInheritRates: type: string description: Simple type for inherit rates enum: - From - To claimAdjustmentLimitsType: type: array description: Collection of Claim Adjustment Limits maxItems: 4000 items: $ref: '#/components/schemas/claimAdjustmentLimitType' preferenceCodesType: type: array description: Specifies the preference code and its description mapped to the exclusive preference. maxItems: 4000 items: $ref: '#/components/schemas/codeDescriptionType' hotelPreferences: type: object description: Response object for fetching preferences at the property level. properties: hotelPreferences: description: Collection of preferences specified at the property level. $ref: '#/components/schemas/configHotelPreferencesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' claimAdjustmentLimitType: type: object description: Details of Claim Adjustment Limit. properties: limitCode: description: A Type that holds key value, that uniquely identifies a Claim Adjustment Limit. type: string minLength: 0 maxLength: 20 billingGroup: description: The billing group that represents a billing rule schedule for the Claim Adjustment Limit. type: string minLength: 0 maxLength: 20 limits: description: Threshold limits. $ref: '#/components/schemas/claimAdjustmentLimitsRangeType' hotels: description: Collection of property codes which associated for a Claim Adjustment Limit code. $ref: '#/components/schemas/codeListType' managedBy: $ref: '#/components/schemas/managedByOptions' preferenceGroups: type: object description: Response object for fetching preference groups. properties: preferenceGroups: description: Collection of preference groups matching the search criteria. $ref: '#/components/schemas/preferenceGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' exclusivePreferencesCopy: type: object description: Request object for copying template Exclusive preferences to hotel(s). properties: copyInstructions: description: List of the template Exclusive preferences to be copied to hotel(s). $ref: '#/components/schemas/configCopyExclusivePreferencesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' configTemplatePreferencesType: type: array description: This type holds a collection of preferences at the template level. maxItems: 4000 items: $ref: '#/components/schemas/configTemplatePreferenceType' 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' links: type: array items: $ref: '#/components/schemas/instanceLink' 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 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} 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 externalDocs: description: Find out more about Oracle Hospitality url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html