openapi: 3.2.0
info:
title: OPERA Cloud Reservation Master Data Management Reservation Config API
description: APIs to cater for Reservation Configuration in OPERA Cloud. In this module you can retrieve, create, modify or delete configuration related to Reservations, Blocks and Leisure Management.
Compatible with OPERA Cloud release 26.2.0.0.
This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.
version: 26.2.0.0 termsOfService: https://www.oracle.com/legal/terms.html contact: email: hospitality_apis_ww_grp@oracle.com license: name: UPL url: https://opensource.org/licenses/upl servers: - url: /rsv/config/v1 tags: - name: ReservationConfig description: The Reservation Configuration module offers capability of creating, managing, and retrieving of Reservation configuration. paths: /alertCodes: get: summary: Get Alert Code Templates description: Retrieve all configured Alert Code Templates.OperationId:getAlertCodeTemplates
operationId: getAlertCodeTemplates parameters: - name: alertCodes 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 information regarding alert templates. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/alertCodeTemplates' '204': description: AlertCodeTemplates 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: - ReservationConfig put: summary: Change Alert Code Template description: Update an existing alert code template.OperationId:putAlertCodeTemplates
operationId: putAlertCodeTemplates 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/alertTemplates' description: Request object for modifying the existing alert code templates. required: true delete: summary: Delete Alert Code Template description: Delete an existing alert code template.OperationId:deleteAlertCodeTemplates
operationId: deleteAlertCodeTemplates parameters: - name: alertCodeTemplateCodes in: query description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X. required: true style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ReservationConfig post: summary: Create Alert Code Template description: Create a new Alert Code Template.OperationId:postAlertCodeTemplates
operationId: postAlertCodeTemplates 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/alertTemplates' description: Request object for creating a new alert code template. required: true /autoAttachElements: put: summary: Delete Auto Attach Elements description: Delete an Auto Attach Element Rule on a property.OperationId:deleteAutoAttachElements
operationId: deleteAutoAttachElements 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoAttachElements' description: Delete auto attach configuration rule(s) for resort. required: true /ecoupons: get: summary: Get eCoupon Codes description: Get existing property eCoupon Codes.OperationId:getECouponCodes
operationId: getECouponCodes parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: eCouponCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCardECouponCodes in: query required: false description: Wildcard search on the code. schema: type: string - name: ratePlansCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCardRatePlans in: query required: false description: Wildcard search on the code. schema: type: string - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive rules in search results . schema: type: boolean default: 'false' - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch eCoupon codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/eCouponCodes' '204': description: ECouponCodes 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: - ReservationConfig /globalAlerts: put: summary: Delete a Global Alert Code description: Delete a Global Alert for a property.OperationId:deleteGlobalAlerts
operationId: deleteGlobalAlerts 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/globalAlerts' description: Request object for removing the existing Global Alerts. required: true get: summary: Get Global Alerts description: Retrieve all configured Global Alerts for a property.OperationId:getGlobalAlerts
operationId: getGlobalAlerts parameters: - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: alertCodes 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: welcomeOffer in: query required: false schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Global Alerts. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/globalAlertsInfo' '204': description: GlobalAlerts 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: - ReservationConfig /globalAlerts/copy: put: summary: Copy Global Alerts description: Copy a Global Alert for a property.OperationId:copyGlobalAlerts
operationId: copyGlobalAlerts 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/globalAlertsCopy' description: Request object for copying Global Alerts. required: true /guestMessages: get: summary: Get Guest Message Templates description: Retrieve the configured Guest Message Templates.OperationId:getGuestMessageTemplates
operationId: getGuestMessageTemplates parameters: - name: guestMessageCodes 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 information regarding guest message templates. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/guestMessageTemplates' '204': description: GuestMessageTemplates 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: - ReservationConfig put: summary: Change Guest Message Templates description: Update an existing Guest Message Template.OperationId:putGuestMessageTemplates
operationId: putGuestMessageTemplates 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guestMessageTemplates' description: Request object for modifying an existing guest message template. required: true delete: summary: Delete an existing guest message template description: Delete an existing Guest Message Template.OperationId:deleteGuestMessageTemplates
operationId: deleteGuestMessageTemplates parameters: - name: guestMessageTemplateCodes 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: - ReservationConfig post: summary: Create a new guest message template description: Message templates enable you to define standard message texts within OPERA Cloud to ensure consistency in the format of guest messages. You can use this API to create a new Guest Message Template.OperationId:postGuestMessageTemplates
operationId: postGuestMessageTemplates parameters: - $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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guestMessageTemplates' description: Request object for creating a new guest message template. required: true /hotels/{hotelId}/alertCodes: get: summary: Get Alert Codes description: You can use this API to get Alert Codes.OperationId:getAlertCodes
operationId: getAlertCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: alertCodes 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 information regarding alert templates. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/alertCodes' '204': description: AlertCodes 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: - ReservationConfig put: summary: Change Alert Codes description: You can use this API to change Alert Codes.OperationId:putAlertCodes
operationId: putAlertCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/alertCodes' description: Request object for modifying an existing alert. required: true delete: summary: Delete an Alert Code description: You can use this API to delete an Alert Code.OperationId:deleteAlertCodes
operationId: deleteAlertCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: codes in: query description: Configuration code. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ReservationConfig post: summary: Create a new alert code description: You can use this API to create a new alert code.OperationId:postAlertCodes
operationId: postAlertCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/alertCodes' description: Request object for creating a new group of alerts. required: true /hotels/{hotelId}/autoAttachElements: get: summary: Get Auto Attach Elements description: Retrieve the Auto Attach Element Rules that are configured. Auto attach elements are rules defined to auto-update various fields (elements) on a new reservation. Rules can be associated with rate codes, memberships, room types, preferences etc. An example could be 'If rate code is PROMO1 then update specials on the reservation to include FB (Fruit Basket).OperationId:getAutoAttachElements
operationId: getAutoAttachElements parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: criteriaCode in: query required: false description: The name of the rule. schema: type: string - name: type in: query required: false description: Available only when Reservation Discounts and Advanced Discounts are active schema: type: string enum: - Item - Product - ResvPreference - Trace - RoomFeatures - Preference - Promotions - AdvancedDiscount uniqueItems: true - name: basedOn in: query required: false description: Available only when Keyword Functionality is active. schema: type: string enum: - Membership - Preference - RateCode - RoomType - MinAdults - MinChildren - KeywordType - Special - Vip - Condition uniqueItems: true - name: includeInactive in: query required: false description: Indicator that tells whether to include inactive rules in search results. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for the configuration rules that specify the elements to be automatically attached to the reservation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/autoAttachElementsConfig' '204': description: AutoAttachElements 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: - ReservationConfig put: summary: Update Auto Attach Elements description: Modify the configuration of an Auto Attach Element Rule that exists on a property.OperationId:putAutoAttachElements
operationId: putAutoAttachElements parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoAttachElements' description: Modify auto attach configuration rule(s). required: true post: summary: Create Auto Attach Elements description: Create a new Auto Attach Element Rule. Auto attach elements are rules defined to auto-update various fields (elements) on a new reservation. Rules can be associated with rate codes, memberships, room types, preferences etc. An example could be 'If rate code is PROMO1 then update specials on the reservation to include FB (Fruit Basket).OperationId:postAutoAttachElements
operationId: postAutoAttachElements parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoAttachElements' description: Add configuration rule(s) that specify the elements to be automatically attached to the reservation. required: true /hotels/{hotelId}/autoAttachElements/copy: put: summary: Copy Auto Attach Elements description: You can use this API to copy Auto Attach Elements.OperationId:copyAutoAttachElements
operationId: copyAutoAttachElements parameters: - name: hotelId in: path required: true description: Unique OPERA Source Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoAttachElementsCopy' description: List of the auto attach configuration rule(s) to be copied. required: true /hotels/{hotelId}/colors: get: summary: Get Reservation Colors description: Use this API to get Reservation Colors.OperationId:getReservationColors
operationId: getReservationColors parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - name: description in: query required: false description: Description to filter result. schema: type: string - name: includeInactive in: query required: false description: Indicates whether to include inactive reservation colors or not. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetch reservation colors. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/reservationColorsResponse' '204': description: ReservationColors 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: - ReservationConfig /hotels/{hotelId}/colors/{code}: put: summary: Change Reservation Colors description: Use this API to put Reservation Colors.OperationId:putReservationColors
operationId: putReservationColors parameters: - name: code in: path required: true description: '' schema: type: string maxLength: 2000 minLength: 1 - 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reservationColorsToChange' description: Request object to change reservation colors. required: true /hotels/{hotelId}/ecouponCodes/{ecouponCode}: delete: summary: Delete an eCoupon Code description: Delete an existing eCoupon Code.OperationId:deleteECouponCodes
operationId: deleteECouponCodes parameters: - name: ecouponCode in: path required: true description: '' schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: 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: - ReservationConfig /hotels/{hotelId}/ecoupons: put: summary: Change an eCoupon Code description: Update an existing eCoupon Code.OperationId:putECouponCodes
operationId: putECouponCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/eCouponCodes' description: Request object for changing the existing eCoupon codes. required: true post: summary: Create an eCoupon Code description: You can create an ecoupon for a specified property and it can be a maximum of 8 alphanumeric characters. You can enter a quantity value from 1 to 99.OperationId:postECouponCodes
operationId: postECouponCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/eCouponCodes' description: Request object to create new eCoupon codes. required: true /hotels/{hotelId}/ecoupons/copy: put: summary: Copy eCoupon Codes description: Copy an existing property eCoupon Codes to create a new one.OperationId:copyECouponCodes
operationId: copyECouponCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/eCouponCodesCopy' description: Request object to copy the existing eCoupon codes from source property to the selected target properties. required: true /hotels/{hotelId}/globalAlerts: put: summary: Change Global Alerts description: Use this API to change Global Alerts for a property.OperationId:putGlobalAlerts
operationId: putGlobalAlerts parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/globalAlerts' description: Request object for modifying an existing Global Alert. required: true post: summary: Create Global Alerts description: You can create a Global Alerts to generate automatically for all reservations that meet the alert condition.OperationId:postGlobalAlerts
operationId: postGlobalAlerts parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/globalAlerts' description: Request object for creating a new Global Alert. required: true /hotels/{hotelId}/guestMessages: get: summary: Get Guest Messages description: You can use this API to get Guest Messages.OperationId:getGuestMessages
The maximum allowable limit for this API is 100.
operationId: getGuestMessages parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: guestMessageCodes 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 information regarding guest message. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/retrievedGuestMessages' '204': description: GuestMessages 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: - ReservationConfig put: summary: Change a Guest messages description: You can use this API to change a Guest messages.OperationId:putGuestMessages
operationId: putGuestMessages parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guestMessages' description: Request object for modifying an existing guest message. required: true post: summary: Create Guest Messages description: This API is used to create a new guest messages based on the request.OperationId:postGuestMessages
operationId: postGuestMessages parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/guestMessages' description: Request object for creating a new guest message. required: true /hotels/{hotelId}/guestMessages/{messageCode}: delete: summary: Delete a Guest messages description: You can use this API to delete a Guest messages.OperationId:deleteGuestMessages
operationId: deleteGuestMessages parameters: - name: messageCode in: path required: true description: '' schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: 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: - ReservationConfig /hotels/{hotelId}/locatorCodes: get: summary: Get existing property Locator Codes description: You can use this API to get existing property Locator Codes.OperationId:getLocatorCodes
operationId: getLocatorCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: List of Hotels. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: locatorCodes 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: includeInactive in: query required: false description: Indicator that tells whether to include inactive rules in search results. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching locator codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/locatorCodesInfo' '204': description: LocatorCodes 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: - ReservationConfig put: summary: Change the existing Locator Code description: You can use this API to change the existing Locator Code.OperationId:putLocatorCodes
operationId: putLocatorCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/locatorCodes' description: Request object for modifying an existing locator code. required: true post: summary: Create a new Locator Code description: You can use this API to create a new Locator Code.OperationId:postLocatorCodes
operationId: postLocatorCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/locatorCodes' description: Request object for creating a new locator code. required: true /hotels/{hotelId}/locatorCodes/{locatorCode}: delete: summary: Delete a Locator Code description: You can use this API to delete a Locator Code.OperationId:deleteLocatorCodes
operationId: deleteLocatorCodes parameters: - name: locatorCode in: path required: true description: '' schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: 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: - ReservationConfig /hotels/{hotelId}/membershipLevels/ratings: get: summary: Get Membership Level Ratings description: This API accepts the membership level ratings in the request and returns gets the membership levels.OperationId:getMembershipLevelRatings
operationId: getMembershipLevelRatings parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: membershipTypeCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCardMembershipTypes in: query required: false description: Wildcard search on the code. schema: type: string - name: membershipLevelCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCardMembershipLevels in: query required: false description: Wildcard search on the code. schema: type: string - name: descriptionWildCard in: query required: false description: Criteria to specify which membership levels description would be included in the results. 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 the membership levels and their rating details. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/membershipLevelRatingsInfo' '204': description: MembershipLevelRatings 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: - ReservationConfig /hotels/{hotelId}/membershipTypes/{membershipType}/membershipLevels/{membershipLevel}/ratings: put: summary: Change Membership Level Ratings description: You can use this API to change Membership Level Ratings.OperationId:putMembershipLevelRatings
operationId: putMembershipLevelRatings parameters: - name: membershipLevel in: path required: true description: OPERA Membership level schema: type: string maxLength: 2000 minLength: 1 - name: membershipType in: path required: true description: OPERA Membership type schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/membershipLevelRatings' description: Request object for modifying membership levels rating details. required: true /hotels/{hotelId}/ratePlans/ratings: get: summary: Get Rate Plan Ratings description: You can use this API to get Rate Plan Ratings.OperationId:getRatePlanRatings
operationId: getRatePlanRatings parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: ratePlanCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: rateCategoryCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: ratings in: query description: Possible Rate plan rating values. required: false style: form explode: true schema: type: array items: type: string enum: - MostImportant - Important - SomewhatImportant - LessImportant - LeastImportant - NoValueSet uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching the rate codes and their rating details. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/ratePlanRatings' '204': description: RatePlanRatings 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: - ReservationConfig put: summary: Change Rate Plan Ratings description: You can use this API to change Rate Plan Ratings.OperationId:putRatePlanRatings
operationId: putRatePlanRatings parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/ratePlanRatingsInfo' description: Request object for modifying rate plan codes and their rating details. required: true /hotels/{hotelId}/reservationProtectionCondition: get: summary: Get Reservation Protection Condition description: Retrieve the configured reservation protection condition for the property.OperationId:getReservationProtectionCondition
operationId: getReservationProtectionCondition parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Reservation Protection Condition. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/reservationProtectionCondition' '204': description: Reservation Protection Condition 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: - ReservationConfig post: summary: Create Reservation Protection Condition description: This API can be used to create the condition in which a reservation would be automatically marked as protected for the property.OperationId:postReservationProtectionCondition
operationId: postReservationProtectionCondition parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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})*' 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reservationProtectionCondition' description: Request to create the conditions in which a reservation would be automatically marked as protected for the property. required: true put: summary: Change Reservation Protection Condition description: This API can be used to change the condition in which a reservation would be automatically marked as protected for the property.OperationId:putReservationProtectionCondition
operationId: putReservationProtectionCondition parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/reservationProtectionCondition' description: Request to change the conditions in which a reservation would be automatically marked as protected for the property. required: true delete: summary: Delete Reservation Protection Condition description: Deletes the reservation protection condition for the particular hotelId.OperationId:deleteReservationProtectionCondition
operationId: deleteReservationProtectionCondition parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: 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: - ReservationConfig /hotels/{hotelId}/roomFeatures/ratings: get: summary: Get Room Feature Ratings description: You can use this API to get Room Feature Ratings.OperationId:getRoomFeatureRatings
operationId: getRoomFeatureRatings parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: featureCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCardRoomFeatures in: query required: false description: Wildcard search on the code. schema: type: string - name: descriptionWildCard in: query required: false description: Criteria to specify which rooms features description would be included in the results. schema: type: string - name: ratings in: query description: Possible Room Feature rating values. required: false style: form explode: true schema: type: array items: type: string enum: - MostImportant - Important - SomewhatImportant - LessImportant - LeastImportant - NoValueSet uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching the room features and their rating details. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomFeatureRatingsInfo' '204': description: RoomFeatureRatings 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: - ReservationConfig put: summary: Change Room Feature Ratings description: You can use this API to change Room Feature Ratings.OperationId:putRoomFeatureRatings
operationId: putRoomFeatureRatings parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomFeatureRatings' description: Request object for modifying room features rating details. required: true /hotels/{hotelId}/roomSpecials/ratings: get: summary: Get Room Special Ratings description: You can use this API to get Room Special Ratings.OperationId:getRoomSpecialRatings
operationId: getRoomSpecialRatings parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: specialCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCardRoomSpecials in: query required: false description: Wildcard search on the code. schema: type: string - name: descriptionWildCard in: query required: false description: Criteria to specify which rooms specials description would be included in the results. schema: type: string - name: ratings in: query description: Possible Room special rating values. required: false style: form explode: true schema: type: array items: type: string enum: - MostImportant - Important - SomewhatImportant - LessImportant - LeastImportant - NoValueSet uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching the room specials and their rating details. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomSpecialRatingsInfo' '204': description: RoomSpecialRatings 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: - ReservationConfig put: summary: Change Room Special Ratings description: You can use this API to change Room Special Ratings.OperationId:putRoomSpecialRatings
operationId: putRoomSpecialRatings parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomSpecialRatings' description: Request object for modifying room specials rating details. required: true /hotels/{hotelId}/rooms/ratings: get: summary: Get Room Ratings description: You can use this API to get Room Ratings.OperationId:getRoomRatings
operationId: getRoomRatings parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: roomNumberCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: roomClassCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: ratings in: query description: Possible room rating values. required: false style: form explode: true schema: type: array items: type: string enum: - MostDesirable - Desirable - SomewhatDesirable - LessDesirable - LeastDesirable - NoValueDefined uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching the rooms and their rating details. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/roomRatings' '204': description: RoomRatings 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: - ReservationConfig /hotels/{hotelId}/rooms/{roomId}/ratings: put: summary: Change Room Ratings description: You can use this API to change Room Ratings.OperationId:putRoomRatings
operationId: putRoomRatings parameters: - name: roomId in: path required: true description: OPERA Room id schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/roomRatingsInfo' description: Request object for modifying room rating details. required: true /hotels/{hotelId}/traceTexts/copy: put: summary: 'Copy trace text ' description: Copy an existing Trace Text to create a new one.OperationId:copyTraceTexts
operationId: copyTraceTexts parameters: - name: hotelId in: path required: true description: Unique OPERA Source Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/traceTextsCopy' description: Request object for copying trace texts. required: true /hotels/{hotelId}/turnawayCodes: get: summary: Get Turnaway codes description: Turnaway Codes enable you to record the number of potential reservations that were "turned away" and could not be confirmed. Use this API to fetch all configured Turnaway codes for a property.OperationId:getHotelTurnAwayCodes
operationId: getHotelTurnAwayCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. schema: type: integer default: 0 - name: code in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: turnAwayCodes 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: includeInactive in: query required: false description: Inactive flag - whether or not to display inactive records schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching hotel turnaway codes content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/hotelTurnAwayCodes' '204': description: HotelTurnAwayCodes 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: - ReservationConfig put: summary: Change TurnAway Codes description: Update an existing Turnaway code for a property.OperationId:putHotelTurnAwayCodes
operationId: putHotelTurnAwayCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelTurnAwayCodes' description: Request object for modifying hotel turnaway codes. required: true post: summary: Create Turn Away Codes description: Turnaway Codes enable you to record the number of potential reservations that were "turned away" and could not be confirmed. Use this API to create a new Turnaway Code for a property.OperationId:postHotelTurnAwayCodes
operationId: postHotelTurnAwayCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/hotelTurnAwayCodes' description: Request object for creating new hotel turnaway code. required: true /hotels/{hotelId}/turnawayCodes/{code}: delete: summary: Delete an existing turnaway code description: Delete an existing Turnaway code for a property.OperationId:deleteHotelTurnAwayCodes
operationId: deleteHotelTurnAwayCodes parameters: - name: code in: path required: true description: '' schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: 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: - ReservationConfig /hotels/{hotelId}/upsellRules: get: summary: Get upsell rules description: This API will retrieve all configured Upgrade Rules. These enable you to configure the rules for calculating the reservation upsell amounts.OperationId:getUpsellRules
operationId: getUpsellRules parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: stayDate in: query required: false description: The stay date to be searched. schema: type: string format: date - name: rule in: query required: false description: Wildcard search for the upsell rule code or description. schema: type: string - name: searchByRoomType in: query required: false description: Signifies whether upsell rules are to be searched based on Room Type or Room Class. schema: type: boolean - name: fromCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: toCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: rateCode in: query required: false description: Rate code to be searched. schema: type: string - name: membershipType in: query required: false description: Membership type to be searched. schema: type: string - name: channel in: query required: false description: Channel to be searched. schema: type: string - name: ReservationTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: marketCodes 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 upsell rules. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/upsellRules' '204': description: UpsellRules 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: - ReservationConfig put: summary: Modify Upsell Rule description: Use this API to modify an existing Upgrade rule for a property.OperationId:putUpsellRules
operationId: putUpsellRules parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/upsellRules' description: Request object for changing existing upsell rules. required: true post: summary: Create Upsell Rules description: Use this API to create a new Upgrade rule for a property. You can upgrade a reservation during the check-in process, but it must match the date ranges, the room types, and the formulas defined in the upgrade rules for the property. A message alerts you to available upgrades and prices.OperationId:postUpsellRules
operationId: postUpsellRules parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/upsellRules' description: Request object for creating new upsell rules. required: true /hotels/{hotelId}/upsellRules/action/validate: put: summary: Test upsell rules description: Use this API to test and see if the rule that you have created works. E.g. you can test by giving a rate code and dates, and see that the rule returns the correct upsell details.OperationId:testUpsellRules
operationId: testUpsellRules parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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 object for testing upsell rules. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/upsellRulesToTestDetails' '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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/upsellRulesToTest' description: Request object for testing upsell rules. required: true /hotels/{hotelId}/upsellRules/copy: put: summary: Copy upsell rules description: Copy an existing upsell rule, to create a new one.OperationId:copyUpsellRules
operationId: copyUpsellRules parameters: - name: hotelId in: path required: true description: Unique OPERA Source Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/upsellRulesCopy' description: List of the upsell rules to be copied to hotel code(s). required: true /hotels/{hotelId}/upsellRules/{ruleCode}: delete: summary: Delete an Upsell Rule description: Use this API to delete an existing Upgrade rule for a property.OperationId:deleteUpsellRules
operationId: deleteUpsellRules parameters: - name: ruleCode in: path required: true description: '' schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: 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: - ReservationConfig /services/reservations/status: get: summary: ' ping' description: Ping Reservation Configuration ServiceOperationId:pingReservationConfigService
operationId: pingReservationConfigService parameters: - name: operaPingInput in: query required: false description: Opera Ping request input type schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for Ping operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaVersion' '204': description: pingReservationConfigService 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: - ReservationConfig /templates/locatorCodes: get: summary: Get template Locator Codes description: Get existing template Locator CodesOperationId:getLocatorCodesTemplate
operationId: getLocatorCodesTemplate parameters: - name: locatorCodes 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: includeInactive in: query required: false description: Indicator that tells whether to include inactive rules in search results. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching locator codes at template level. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/locatorCodesTemplateInfo' '204': description: LocatorCodesTemplate 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: - ReservationConfig put: summary: Change a Locator Code description: Change an existing Locator CodeOperationId:putLocatorCodesTemplate
operationId: putLocatorCodesTemplate 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/locatorCodesTemplate' description: Request object for modifying an existing locator code template. required: true delete: summary: Delete a Locator Code description: Delete the selected Locator CodeOperationId:deleteLocatorCodesTemplate
operationId: deleteLocatorCodesTemplate parameters: - name: locatorCodes 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: - ReservationConfig post: summary: Create a template Locator Code description: Create a new Locator Code at template level.OperationId:postLocatorCodesTemplate
operationId: postLocatorCodesTemplate 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/locatorCodesTemplate' description: Request object for creating locator code template. required: true /traceTexts: get: summary: 'Get trace texts ' description: Fetch all configured Trace Texts for a property.OperationId:getTraceTexts
operationId: getTraceTexts parameters: - name: excludeGlobal in: query required: false description: Flag to tell whether to exclude global traces or not. schema: type: boolean default: 'false' - name: departmentCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: hotelIds in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $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 trace texts. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/traceTextsToBeFetched' '204': description: TraceTexts 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: - ReservationConfig put: summary: 'Change trace text ' description: Update an existing Trace Text for a property.OperationId:putTraceTexts
operationId: putTraceTexts 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/traceTextChanges' description: Request object for changing trace texts. required: true post: summary: Create new trace texts description: When you create traces for reservation, blocks, or AR accounts, you must first set up the standard messages that are available. When you create a trace, these texts can be selected and used as-is, or they can be modified as necessary. When you create a trace text, it must be associated with a department, like Reservations.OperationId:postTraceTexts
operationId: postTraceTexts parameters: - $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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/traceTextsToBeCreated' description: Request object for creating new trace texts. required: true delete: summary: 'Delete trace text ' description: Delete an existing Trace Text for a property.OperationId:deleteTraceTexts
operationId: deleteTraceTexts parameters: - name: hotelId in: query description: Property Code where the trace text belongs to. required: false style: form explode: true schema: type: array items: type: string - name: departmentCode in: query description: Department Code where the trace text belongs to. required: false style: form explode: true schema: type: array items: type: string - name: traceText in: query description: Trace text value. required: false style: form explode: true schema: type: array items: type: string - name: canDelete in: query description: Determines whether this trace text can be deleted. required: false style: form explode: true schema: type: array items: type: boolean - name: displaySequence in: query description: Display Sequence for the trace text. required: false style: form explode: true schema: type: array items: type: number - $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: - ReservationConfig /turnawayCodes: get: summary: Get Template TurnAway Codes description: Retrieve all existing Turnaway Code Templates.OperationId:getTemplateTurnAwayCodes
operationId: getTemplateTurnAwayCodes 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 - name: includeInactive in: query required: false description: Inactive flag - whether or not to display inactive records. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching template turnaway codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/templateTurnAwayCodes' '204': description: TemplateTurnAwayCodes 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: - ReservationConfig put: summary: Change a Turnaway code template description: Update an existing Turnaway Code Template.OperationId:putTemplateTurnAwayCodes
operationId: putTemplateTurnAwayCodes 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateTurnAwayCodes' description: Request object for modifying template turnaway codes. required: true post: summary: Create Template TurnAway Codes description: Create a new Turnaway Code Template.OperationId:postTemplateTurnAwayCodes
operationId: postTemplateTurnAwayCodes 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/templateTurnAwayCodes' description: Request object for creating new template turnaway code. required: true /turnawayCodes/{turnawayCode}: delete: summary: Delete a Turnaway code template description: Delete an existing Turnaway Code Template.OperationId:deleteTemplateTurnAwayCodes
operationId: deleteTemplateTurnAwayCodes parameters: - name: turnawayCode in: path required: true description: '' 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: 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: - ReservationConfig /upsert/hotels/{hotelId}/autoAttachElements: put: summary: Create/Update Auto Attach Elements description: Create/update the configuration of an Auto Attach Element Rule that exists on a property.OperationId:putUpsertAutoAttachElements
operationId: putUpsertAutoAttachElements parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoAttachElements' description: Modify auto attach configuration rule(s). required: true /upsert/hotels/{hotelId}/ecoupons: put: summary: Create/Change an eCoupon Code description: Create/Update an existing eCoupon Code.OperationId:putUpsertECouponCodes
operationId: putUpsertECouponCodes parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/eCouponCodes' description: Request object for changing the existing eCoupon codes. required: true /upsert/hotels/{hotelId}/globalAlerts: put: summary: Create/Change Global Alerts description: Use this API to create/change Global Alerts for a property.OperationId:putUpsertGlobalAlerts
operationId: putUpsertGlobalAlerts parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/globalAlerts' description: Request object for modifying an existing Global Alert. required: true /upsert/hotels/{hotelId}/upsellRules: put: summary: Create/Modify Upsell Rule description: Use this API to create/modify an existing Upgrade rule for a property.OperationId:putUpsertUpsellRules
operationId: putUpsertUpsellRules parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code 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: - ReservationConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/upsellRules' description: Request object for changing existing upsell rules. required: true components: responses: '406': description: Not acceptable. '414': description: Request URI Too Large '503': description: Service Unavailable '413': description: Request Entity Too Large '500': description: System Error content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '502': description: Bad Gateway '403': description: Forbidden '415': description: Unsupported Media Type '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '401': description: Unauthorized '405': description: Method not allowed parameters: x-hotelid: name: x-hotelid description: Mandatory parameter to identify the hotel code where the end user is logged in in: header required: true schema: type: string authKey: name: authorization description: Bearer token that needs to be passed which is generated post user authentication in: header required: true schema: type: string externalData: name: externalData description: Pass this header as true, if payload needs DVM in: header schema: type: string Accept-Language: name: Accept-Language description: Language code in: header schema: type: string x-app-key: name: x-app-key description: Client or Partner's Application Key in: header required: true schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$ x-externalsystem: name: x-externalsystem description: External system code. in: header x-example: EXTERNALSYSTEMCODE schema: type: string maxLength: 40 x-originating-application: name: x-originating-application description: Customer's Integration Application Id in: header schema: type: string 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} schemas: copyGlobalAlertType: type: object description: Copy Global Alerts criteria from one property to another property properties: resvAlertIds: description: Each Reservation Alert details copy to target properties $ref: '#/components/schemas/uniqueIDListType' targetHotelCodes: description: Copy and store reservation alert details on the destination properties $ref: '#/components/schemas/codeListType' traceTextsToBeCreated: type: object description: Request object for creating new trace texts. properties: traceTexts: description: Trace texts to be created. $ref: '#/components/schemas/traceTextsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' locatorCodesTemplate: type: object description: Request object for modifying an existing locator code template. properties: locatorCodes: $ref: '#/components/schemas/locatorCodesTemplateType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomFeatureRatingsInfoType: type: array description: Collection of rooms features and their ratings. maxItems: 4000 items: $ref: '#/components/schemas/roomFeatureRatingInfoType' roomRatingInfoType: type: object description: Rating details for a room. properties: hotelId: description: Property code of the rooms. type: string minLength: 0 maxLength: 20 roomId: description: Room number whose ratings are fetched. type: string minLength: 0 maxLength: 20 roomClass: description: Room Class of the room. type: string minLength: 0 maxLength: 20 roomType: description: Room Type and its description of the room. $ref: '#/components/schemas/codeDescriptionType' rating: description: Ratings associated with the room. $ref: '#/components/schemas/roomRatingType' scriptLocationsType: type: object description: Collection of locations where a Script is to be used. properties: hotels: description: Location where a Script is to be used. type: array maxItems: 4000 items: $ref: '#/components/schemas/scriptLocationType' cROs: description: Location where a Script is to be used. type: array maxItems: 4000 items: $ref: '#/components/schemas/scriptLocationType' chains: description: Location where a Script is to be used.. type: array maxItems: 4000 items: $ref: '#/components/schemas/scriptLocationType' traceTextsCopy: type: object description: Request object for copying trace texts. properties: criteria: description: Criteria for copying trace texts. $ref: '#/components/schemas/copyTraceTextsCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' colorType: type: string description: Color configuration type. This color configuration provides a visual category of entities. enum: - Red - DarkRed - Green - DarkGreen - LightGreen - Orange - White - Yellow - DarkYellow - Purple - Brown - Gray - Aqua - Chocolate - Blue - LightBlue - DarkBlue - Cyan - DarkCyan - Magenta - DarkMagenta - Black - Deepteal - Sunsetorange - Aquasky - Mochabrown - Mossgreen - Rosewood - Claybrown - Softlavender - Olivegold - Plumpurple - Mistblue - Forestgreen - Dustyviolet - Oceanblue - Copper roomFeatureRatingsInfo: type: object description: Response object for fetching the room features and their rating details. properties: roomFeatureRatingsInfo: description: List of rooms and their rating details. $ref: '#/components/schemas/roomFeatureRatingsInfoType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' alertTemplates: type: object description: Request object for modifying the existing alert code templates. properties: alertTemplates: description: Alert code template group details to be changed. $ref: '#/components/schemas/alertTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' guestMessageTemplatesType: type: array description: Collection of guest messages templates. maxItems: 4000 items: $ref: '#/components/schemas/guestMessageTemplateType' resvAutoAttchTypeCode: type: string enum: - Item - Product - ResvPreference - Trace - RoomFeatures - Preference - Promotions - AdvancedDiscount description: Available only when Reservation Discounts and Advanced Discounts are active configTestUpsellRuleType: type: object description: This gives detailed information about an upsell rule which is returned upon testing an upsell rule against a reservation. properties: toRoomType: description: The room type for the upsell offer. type: string minLength: 0 maxLength: 20 totalStayAmount: description: The regular rate amount for the upsell offer. This amount is taken from the Rate Code configuration. type: number totalUpsellMoneyAmount: description: The adjusted rate amount for the room type, based on the upsell offer. type: number upsellRuleCode: description: Specifies the upsell rule code used for the calculation. type: string minLength: 0 maxLength: 20 reservationProtectionConditionType: type: object description: Details of reservation protection condition properties: hotelId: type: string description: Unique OPERA Hotel code identifier minLength: 0 maxLength: 20 conditions: description: Reservation protection condition which may consist of multiple layers of conditions and groups of conditions $ref: '#/components/schemas/conditionGroupType' configOccupancyLevelType: type: object description: This type holds the upsell amount by occupancy levels. This is used when upsell rule is being set bu occupancy levels properties: level: description: Used to specify the occupancy level id. type: integer levelDescription: description: Used to specify the occupancy level description. type: string minLength: 0 maxLength: 20 levelUpsellAmount: description: Used to specify the occupancy level upsell amount. type: number expressionParameterType: type: object properties: parameter: type: array maxItems: 3 items: type: string minLength: 0 maxLength: 40 functionIdOne: type: number functionIdTwo: type: number templateTurnAwayCodeType: type: object description: Base details common between hotel and template TurnAway codes. properties: code: description: TurnAway code type: string minLength: 0 maxLength: 20 description: description: Description of the TurnAway code. $ref: '#/components/schemas/translationTextType50' displaySequence: description: Sequence of TurnAway code. type: number turnAwayType: description: TurnAway type. e.g. Denial,Regret. $ref: '#/components/schemas/turnAwayTypeType' inactive: description: Inactive flag for a TurnAway code. type: boolean canDelete: description: Determines whether this TurnAway code can be deleted. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' guestMessages: type: object description: Request object for creating a new guest message. properties: guestMessages: $ref: '#/components/schemas/guestMessageCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' scriptLocationType: type: object description: Unique identifier of a Script. properties: hotelId: description: Hotel code the script belonged to. type: string minLength: 0 maxLength: 20 croCode: description: CRO the script belonged to. type: string minLength: 0 maxLength: 20 chainCode: description: Chain the script belonged to. type: string minLength: 0 maxLength: 20 traceTextsType: type: array description: Collection of trace texts. maxItems: 4000 items: $ref: '#/components/schemas/traceTextType' roomSpecialRatings: type: object description: Request object for modifying room specials rating details. properties: roomSpecialRatingsInfo: $ref: '#/components/schemas/roomSpecialRatingsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyTraceTextsCriteriaType: type: object description: Copy Trace texts criteria type to copy multiple trace texts from one Hotel to another Hotel. properties: targetHotels: description: List of hotel codes for which the trace texts needs to be copied. $ref: '#/components/schemas/hotelCodeListType' traceTexts: description: List of Trace Texts that will be copied. $ref: '#/components/schemas/traceTextsType' warningsType: type: array description: Used in conjunction with the Success element to define a business error. maxItems: 4000 items: $ref: '#/components/schemas/warningType' templateTurnAwayCodes: type: object description: Response object for fetching template turnaway codes. properties: turnAwayCodes: description: Collection of template turnaway codes and their information. $ref: '#/components/schemas/templateTurnAwayCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' addtionalCodeInfoType: type: array description: Holds name of additional code information maxItems: 4000 items: type: object properties: name: description: Holds name of additional code information $ref: '#/components/schemas/masterInfoCodeDetailType' value: description: Holds value of additional code information type: string minLength: 0 maxLength: 2000 eCouponCodesType: type: array description: List of eCoupon Codes. maxItems: 4000 items: $ref: '#/components/schemas/eCouponCodeType' conditionGroupType: type: object properties: condition: type: array maxItems: 4000 items: $ref: '#/components/schemas/conditionType' conditionGroup: type: array maxItems: 4000 items: $ref: '#/components/schemas/conditionGroupType' logicalOperator: $ref: '#/components/schemas/logicalOperatorType' uniqueID_Type: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 currencyAmountType: type: object description: A monetary value expressed with a currency code. properties: amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 alertCodesType: type: array description: Collection of hotel level alert codes with attached alert types. maxItems: 4000 items: $ref: '#/components/schemas/alertCodeType' traceTextsToBeFetched: type: object description: Response object for fetching trace texts. properties: traceTexts: description: Type contains trace texts. $ref: '#/components/schemas/traceTextsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipLevelRatings: type: object description: Request object for modifying membership levels rating details. properties: membershipLevelRatingsInfo: $ref: '#/components/schemas/membershipLevelRatingsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' traceTextChangeType: type: object description: Type provides trace text that will be modified. properties: originalTraceText: description: Original settings of the trace text that will be changed. $ref: '#/components/schemas/traceTextType' newTraceText: description: New settings of the trace text. $ref: '#/components/schemas/traceTextType' turnAwayTypeType: type: string description: Simple Type for TurnAwayType Types. enum: - Denial - Regret reservationColorType: type: object description: Property level reservation color information. properties: hotelId: description: Property which the reservation color belongs to. type: string minLength: 0 maxLength: 20 colorCode: description: Code to identify reservation color. type: string minLength: 0 maxLength: 20 description: description: Description of reservation color. $ref: '#/components/schemas/translationTextType2000' displaySequence: description: Display sequence for reservation color. type: number inactive: description: Indicates if reservation color is inactive. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' alertCodeType: type: object description: Common code type for code, description properties: code: description: Code for the code type. type: string minLength: 0 maxLength: 20 description: description: Description for the code type. type: string minLength: 0 maxLength: 2000 displaySequence: description: Sequence for alert. type: number hotelId: description: Hotel Code for alert. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' isAdvancedAlert: description: Indicates whether the Alert is an Advanced Alert with script. type: boolean script: description: Script associated with Alert. $ref: '#/components/schemas/scriptType' copyConfigurationCodeType: type: object description: Information needed to copy configuration code from one property to the other. properties: targetHotelCode: description: Property to which configuration code type to be copied to. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 sourceHotelCode: description: Code that is to be copied. type: string minLength: 0 maxLength: 20 code: description: Source hotel code from which code is to be copied from. type: string minLength: 0 maxLength: 20 codeListType: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 reservationColorsResponse: type: object description: Response object for fetch reservation colors. properties: reservationColors: description: Reservation colors. $ref: '#/components/schemas/reservationColorsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' retrievedGuestMessages: type: object description: Response object for information regarding guest message. properties: guestMessages: $ref: '#/components/schemas/guestMessageCodesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' instanceLink: type: object description: Metadata describing link description objects that MAY appear in the JSON instance representation. properties: href: description: URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true. type: string rel: description: Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile. type: string templated: description: Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false. type: boolean default: false method: description: HTTP method for requesting the target of the link. type: string enum: - GET - POST - PUT - DELETE - PATCH - OPTIONS - HEAD targetSchema: description: Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.. type: string operationId: description: The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply. type: string title: description: Exact copy of the "summary" field on the linked operation. type: string roomFeatureRatingType: type: string description: Possible Room Feature rating values. enum: - MostImportant - Important - SomewhatImportant - LessImportant - LeastImportant - NoValueSet upsellRulesToTest: type: object description: Request object for testing upsell rules. properties: criteria: description: Search criteria for testing upsell rules. $ref: '#/components/schemas/configTestUpsellRuleSearchType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' upsellRulesToTestDetails: type: object description: Response object for testing upsell rules. properties: upsellRules: description: Collection of upsell rules which satisfy the test search criteria. $ref: '#/components/schemas/configTestUpsellRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' masterInfoCodeDetailType: type: string enum: - LongDescription - ShortDescription alertCodes: type: object description: Response object for information regarding alert templates. properties: alerts: description: Collection of alert code templates and their information. $ref: '#/components/schemas/alertCodesType' 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' masterInfoType: type: object properties: codeInfo: type: array maxItems: 4000 items: $ref: '#/components/schemas/codeInfoType' codeType: $ref: '#/components/schemas/masterType' ratePlanRatingType: type: string description: Possible Rate plan rating values. enum: - MostImportant - Important - SomewhatImportant - LessImportant - LeastImportant - NoValueSet configTestUpsellRuleSearchType: type: object description: Search criteria for testing upsell rules. properties: hotelId: description: Specifies the hotel code for which the upsell rules have to be tested. type: string minLength: 0 maxLength: 20 arrivalDate: description: Arrival date set in the test reservation. type: string format: date maxLength: 8 nights: description: Number of nights set in the test reservation. type: integer adults: description: Signifies the number of adults set in the test reservation. type: integer children: description: Signifies the number of children set in the test reservation. type: integer numberOfRooms: description: The number of rooms set in the test reservation. type: integer roomType: description: Signifies the room type for which the upsell rule test has to be run. type: string minLength: 0 maxLength: 20 rateCode: description: Signifies the rate code for which the upsell rule test has to be run. type: string minLength: 0 maxLength: 20 membershipType: description: Signifies the membership type for which the upsell rule test has to be run. type: string minLength: 0 maxLength: 20 membershipLevel: description: Signifies the membership level for which the upsell rule test has to be run. type: string minLength: 0 maxLength: 20 reservationType: description: Signifies the reservation type for which the upsell rule test has to be run. type: string minLength: 0 maxLength: 20 marketCode: description: Signifies the market code for which the upsell rule test has to be run. type: string minLength: 0 maxLength: 20 channel: description: Signifies the channel for which the upsell rule test has to be run. type: string minLength: 0 maxLength: 20 occupancyLevelId: description: Signifies the occupancy level id for which the upsell rule test has to be run. This field is only available when the test upgrade rule is set for 'Upgrade By Occupancy Levels'. type: integer guestMessageTemplateType: type: object description: A template for guest message. properties: code: description: Code for the guest message type type: string minLength: 0 maxLength: 20 description: description: Description for guest message type. $ref: '#/components/schemas/translationTextType2000' displaySequence: description: Sequence for guest message template. type: number managedBy: $ref: '#/components/schemas/managedByOptions' roomSpecialRatingInfoType: type: object description: Rating details for room Specials. properties: hotelId: description: Property code of the room Special. type: string minLength: 0 maxLength: 20 roomSpecial: description: Room Special along with its description whose rating is fetched. $ref: '#/components/schemas/codeDescriptionType' rating: description: Ratings associated with the room special. $ref: '#/components/schemas/roomSpecialRatingType' locatorCodesInfo: type: object description: Response object for fetching locator codes. properties: locatorCodes: $ref: '#/components/schemas/locatorCodesType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomRatingsInfoType: type: array description: Collection of rooms and their ratings. maxItems: 4000 items: $ref: '#/components/schemas/roomRatingInfoType' articlePostItType: type: object description: Post it information of an article. properties: availableForPostIt: description: Indicates whether the article is available for post it. type: boolean color: description: Color indicator which is only configurable if article is available for post it. $ref: '#/components/schemas/colorType' autoAttachElementsConfig: type: object description: Response object for the configuration rules that specify the elements to be automatically attached to the reservation. properties: autoAttachRules: description: List of auto attachment configuration rules. $ref: '#/components/schemas/autoAttachElementsConfigType' masterInfoList: description: Refer to Generic common types document. type: array items: $ref: '#/components/schemas/masterInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' alertTemplatesType: type: array description: Collection of alert code templates. maxItems: 4000 items: $ref: '#/components/schemas/alertTemplateType' eCouponCodeType: type: object description: eCoupon code detailed information. properties: hotel: description: Property for which the eCoupon code belongs to. type: string minLength: 0 maxLength: 20 code: description: eCoupon code to be configured. type: string minLength: 0 maxLength: 20 description: description: Description of the eCoupon code to be configured. type: string minLength: 0 maxLength: 2000 postingRoom: description: Pseudo Room where the postings should be diverted. type: string minLength: 0 maxLength: 20 defaultQty: description: Defines the default quantity of the eCoupon Code. type: integer ratePlans: description: Ratecodes. $ref: '#/components/schemas/codeListType' welcomeOffer: description: Determines whether the eCoupon Code is eligible for Welcome Offer or not. type: boolean displaySequence: description: Sequence for eCoupon code. type: number inactive: description: Indicates whether the eCoupon code is active or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' hotelTurnAwayCodes: type: object description: Response object for fetching hotel turnaway codes properties: turnAwayCodes: description: Collection of turnaway codes. $ref: '#/components/schemas/hotelTurnAwayCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipLevelRatingsInfoType: type: array description: Collection of membership levels and their ratings. maxItems: 4000 items: $ref: '#/components/schemas/membershipLevelRatingInfoType' upsellRules: type: object description: Response object for fetching upsell rules. properties: upsellRules: description: Collection of upsell rules fetched. $ref: '#/components/schemas/configUpsellRulesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' locatorCodesTemplateInfo: type: object description: Response object for fetching locator codes at template level. properties: locatorCodes: $ref: '#/components/schemas/locatorCodesTemplateType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' mergeCodesType: type: array description: A Merge Code. maxItems: 4000 items: $ref: '#/components/schemas/mergeCodeType' configOccupancyLevelsType: type: array description: This type holds a collection of upsell amounts by occupancy levels. maxItems: 4000 items: $ref: '#/components/schemas/configOccupancyLevelType' roomRatings: type: object description: Response object for fetching the rooms and their rating details. properties: roomRatingsInfo: description: List of rooms and their rating details. $ref: '#/components/schemas/roomRatingsInfoType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' reservationColorsType: type: array description: Collection of reservation colors. maxItems: 4000 items: $ref: '#/components/schemas/reservationColorType' ratePlanRatingsInfoType: type: array description: Collection of rate plan Codes and their ratings. maxItems: 4000 items: $ref: '#/components/schemas/ratePlanRatingInfoType' 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 membershipLevelRatingType: type: integer description: The desired rating for membership level, up to 4 numeric values. articleInfoType: type: object description: Information regarding an article. properties: description: description: Description of the article. type: string minLength: 0 maxLength: 2000 transactionCode: description: Transaction code to which the article belongs. type: string minLength: 0 maxLength: 20 price: description: Default price of the article. $ref: '#/components/schemas/currencyAmountType' postIt: description: Post it information of the article. $ref: '#/components/schemas/articlePostItType' universalProductCode: description: Unique Universal product code of the article. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel code to which the article belongs. type: string minLength: 0 maxLength: 20 articleCode: description: Unique code of the article. type: string minLength: 0 maxLength: 20 inactive: description: Indicates whether the article is inactive or not. type: boolean orderSequence: description: Display Order sequence. type: number traceTextType: type: object description: Type provides trace text information. properties: hotelId: description: Property Code where the trace text belongs to. type: string minLength: 0 maxLength: 20 departmentCode: description: Department Code where the trace text belongs to. type: string minLength: 0 maxLength: 10 traceText: description: Trace text value. type: string minLength: 0 maxLength: 2000 canDelete: description: Determines whether this trace text can be deleted. type: boolean displaySequence: description: Display Sequence for the trace text. type: number managedBy: $ref: '#/components/schemas/managedByOptions' attachTraceType: type: object description: Auto attach trace element. properties: traceText: description: The trace text that will be sent to the selected department(s) when Trace is selected as the Rule Type. type: string minLength: 0 maxLength: 2000 departments: description: List of departments codes. $ref: '#/components/schemas/codeListType' managedByOptions: description: Describes of the Configuration is Managed by Enterprise or Property. type: string enum: - EnterpriseManaged - PropertyManaged - EnterpriseEnforced - PropertyOverridden logicalOperatorType: type: string enum: - And - Or reservationProtectionCondition: type: object description: Reservation protection condition in which a reservation would be automatically marked as protected for the property. properties: reservationProtectionCondition: description: Reservation protection condition in which a reservation would be automatically marked as protected for the property. maxItems: 4000 $ref: '#/components/schemas/reservationProtectionConditionType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' alertTemplateType: type: object description: Common code type for code, description properties: code: description: Code for the code type. type: string minLength: 0 maxLength: 20 description: description: Description for the code type. type: string minLength: 0 maxLength: 2000 displaySequence: description: Sequence for alert template. type: number managedBy: $ref: '#/components/schemas/managedByOptions' isAdvancedAlert: description: Indicates whether the Alert is an Advanced Alert with script. type: boolean script: description: Script associated with Alert. $ref: '#/components/schemas/scriptType' hotelTurnAwayCodesType: type: array description: Turnaway code details for hotels. maxItems: 4000 items: $ref: '#/components/schemas/hotelTurnAwayCodeType' roomFeatureRatingInfoType: type: object description: Rating details for room features. properties: hotelId: description: Property code of the room feature. type: string minLength: 0 maxLength: 20 roomFeature: description: Room feature along with its description whose rating is fetched. $ref: '#/components/schemas/codeDescriptionType' rating: description: Ratings associated with the room feature. $ref: '#/components/schemas/roomFeatureRatingType' resvAutoAttchBasedOnCode: type: string enum: - Membership - Preference - RateCode - RoomType - MinAdults - MinChildren - KeywordType - Special - Vip - Condition description: Available only when Keyword Functionality is active. ratePlanRatingsInfo: type: object description: Request object for modifying rate plan codes and their rating details. properties: ratePlanRatingsInfo: $ref: '#/components/schemas/ratePlanRatingsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' globalAlertsInfo: type: object description: Response object for fetching Global Alerts. properties: globalAlerts: description: Collection of Global Alerts information details $ref: '#/components/schemas/globalAlertsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' conditionType: type: object properties: leftExpression: $ref: '#/components/schemas/expressionFieldType' operator: $ref: '#/components/schemas/expressionOperatorType' rightExpression: $ref: '#/components/schemas/expressionParameterType' logicalOperator: $ref: '#/components/schemas/logicalOperatorType' trxInfoType: type: object description: Transaction codes info. properties: description: description: Transaction codes info. type: string minLength: 0 maxLength: 2000 transactionGroup: description: Category of the transaction code. type: string minLength: 0 maxLength: 20 transactionSubGroup: description: Sub category of the transaction code. type: string minLength: 0 maxLength: 20 universalProductCode: description: Unique Universal product code of the transaction code. type: string minLength: 0 maxLength: 20 routingInstructionsId: description: This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer. type: number articles: description: The List of Articles defined for this transaction code, when using the Articles functionality. type: array maxItems: 4000 items: $ref: '#/components/schemas/articleInfoType' trxServiceType: description: Contains service type for transaction code. type: string minLength: 0 maxLength: 20 transactionCode: description: Unique identifier for the Transaction code. type: string minLength: 0 maxLength: 20 hotelId: description: Hotel context of the Transaction code. type: string minLength: 0 maxLength: 20 printTrxReceipt: description: Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code. type: boolean expressionFieldType: type: object properties: fieldName: type: string minLength: 0 maxLength: 40 fieldDescription: type: string minLength: 0 maxLength: 2000 tableName: type: string minLength: 0 maxLength: 40 virtual: type: boolean dataType: type: string minLength: 0 maxLength: 40 lovSelected: type: string minLength: 0 maxLength: 20 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 globalAlerts: type: object description: Request object for creating a new Global Alert. properties: globalAlerts: description: Global Alert details to be created. $ref: '#/components/schemas/globalAlertsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' formulaType: type: string description: Simple type for storing formula type. enum: - FlatAmountAddedToOriginalRate - PercentOfDifferenceAddedToOriginalRate - PercentOfOriginalRateAddedToOriginalRate scriptType: type: object description: A Script associated to either Chain, CRO or Property and to a Language and/or Membership Type. properties: scriptId: description: Unique identifier of a Script. $ref: '#/components/schemas/uniqueID_Type' language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' membershipType: description: Membership Type the script belonged to. type: string minLength: 0 maxLength: 20 script: description: Script. type: string format: byte mergeCodes: description: Merge Codes in the script. $ref: '#/components/schemas/mergeCodesType' type: description: Type of script. $ref: '#/components/schemas/scriptTypeType' locations: description: Collection of locations where Script is to be used. $ref: '#/components/schemas/scriptLocationsType' masterType: type: string enum: - Country - State - AddressType - PhoneType - RateCategory - CalculationRule - PostingRythym - BillingInstruction - TransactionCode - DisplaySet - MailingActions - DistanceType - District - Territory - FiscalRegion - InventoryItem - Package - RoomFeaturePreference - SpecialPreference - Promotion - Department - ReservationPreference - FacilityTask - RoomType - RateCode - OutOfOrderReason - Block scriptTypeType: type: string description: Type for Web Reg Card. enum: - ClosingScript - WebRegCard 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' phoneNumberType: type: string description: Phone number minLength: 0 maxLength: 40 reservationColorsToChange: type: object description: Request object to change reservation colors. properties: reservationColors: description: Criteria to change reservation colors. $ref: '#/components/schemas/reservationColorsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' locatorCodesType: type: array description: Collection of locator codes. maxItems: 4000 items: $ref: '#/components/schemas/locatorCodeType' ratePlanRatingInfoType: type: object description: Rating details for a rate plan. properties: hotelId: description: Property code of the rate plan codes. type: string minLength: 0 maxLength: 20 ratePlan: description: Rate Plan Code and its description $ref: '#/components/schemas/codeDescriptionType' rateCategory: description: Rate category of the rate code. $ref: '#/components/schemas/codeDescriptionType' rating: description: Ratings associated with the rate code. $ref: '#/components/schemas/ratePlanRatingType' configUpsellRuleType: type: object description: This gives detailed information about an upsell rule. properties: description: description: Description gives the description for the upsell rule. type: string minLength: 0 maxLength: 40 upsellByRoomType: description: Signifies whether upsell rule involves upselling from room type to room type or from room class to room class. type: boolean fromRoomTypeOrFromRoomClass: description: The "from" room type or room class for the upsell rule. This is the original room type/room class category. type: string minLength: 0 maxLength: 20 toRoomTypeOrToRoomClass: description: The "to" room type or room class for the upsell rule. This is the room type that the original room type/room class will be upsold to. type: string minLength: 0 maxLength: 20 startDate: description: This represents the begin date of the date range for which the upsell rule is valid. type: string format: date maxLength: 8 endDate: description: This represents the end date of the date range for which the upsell rule is valid. type: string format: date maxLength: 8 rateCodes: description: This specifies the rate code for which the upsell rule is being created. $ref: '#/components/schemas/codeListType' rateCategories: description: This specifies the rate category for which the upsell rule is being created. $ref: '#/components/schemas/codeListType' membershipTypes: description: This specifies the membership types/levels for which the upsell rule is applicable. $ref: '#/components/schemas/codeListType' channels: description: This specifies the channels (e.g. Web channel or some other type of distribution channel) for which the upsell rule is applicable. $ref: '#/components/schemas/codeListType' reservationTypes: description: This specifies the reservation types for which the upsell rule is applicable. $ref: '#/components/schemas/codeListType' marketCodes: description: This specifies the market codes for which the upsell rule is applicable. $ref: '#/components/schemas/codeListType' upsellByOccupancyLevels: description: Signifies whether upsell rule is by occupancy levels or by amount. type: boolean formula: description: Signifies the formula to apply to the rule. The formula selected is used to calculate the upsell amount that is offered. $ref: '#/components/schemas/formulaType' upsellAmount: description: Signifies the formula to apply to the rule. The formula selected is used to calculate the upsell amount that is offered. type: number currencyCode: description: The currency code used in the upsell rule. type: string minLength: 0 maxLength: 20 roundingRule: description: Signifies the rounding operation for the rule depending on how the calculated rates have to be rounded. $ref: '#/components/schemas/roundingRuleType' occupancyLevelsType: description: Specifies the upsell amounts by occupancy levels. This is used when upsell rule is set by occupancy levels. If a new formula is selected, all occupancy level amounts that are defined will be cleared. $ref: '#/components/schemas/configOccupancyLevelsType' daysInAdvance: description: Specifies the number of days in advance of the reservation arrival date that a reservation can be upsold using this rule. So if this field is set to 10, then the reservation must be booked at least 10 days before the arrival date, in order to be eligible for the upsell. type: integer useDefaultTrxCode: description: Signifies whether the default trx code defined for the property has to be used when posting upsell charges. type: boolean transactionCode: description: Specifies the transaction code used to post upsell charges. $ref: '#/components/schemas/trxInfoType' hotelId: description: Specifies the hotel code for which the upsell rule is defined. type: string minLength: 0 maxLength: 20 upsellRuleCode: description: Specifies the user defined code that identifies a upsell rule. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' guestMessageTemplates: type: object description: Response object for information regarding guest message templates. properties: guestMessageTemplates: $ref: '#/components/schemas/guestMessageTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' uniqueIDListType: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' eCouponCodes: type: object description: Response object to fetch eCoupon codes. properties: eCouponCodes: $ref: '#/components/schemas/eCouponCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' globalAlertType: type: object description: A property level global alert attached with global alert types. properties: alertId: type: number hotelId: type: string minLength: 0 maxLength: 20 alertCode: type: string minLength: 0 maxLength: 20 description: type: string minLength: 0 maxLength: 2000 area: type: string minLength: 0 maxLength: 20 queryId: type: number notifications: $ref: '#/components/schemas/notificationType' conditions: $ref: '#/components/schemas/conditionGroupType' welcomeOffer: description: Determines the Global Alert is a Welcome Offer Alert or not. type: boolean stopCheckInCheckOut: description: Indicates the Reservation Stop Check In/Check Out Global Alert. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' templateTurnAwayCodesType: type: array description: Collection of template turnaway codes maxItems: 4000 items: $ref: '#/components/schemas/templateTurnAwayCodeType' guestMessageCodeType: type: object description: A template for guest message. properties: code: description: Code for the guest message type type: string minLength: 0 maxLength: 20 description: description: Description for guest message type. $ref: '#/components/schemas/translationTextType2000' displaySequence: description: Sequence for guest message template. type: number hotelId: description: Sequence for guest message. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' alertCodeTemplates: type: object description: Response object for information regarding alert templates. properties: alertCodeTemplates: description: Collection of alert code templates and their information. $ref: '#/components/schemas/alertTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' traceTextChanges: type: object description: Request object for changing trace texts. properties: traceTexts: description: Trace texts to be changed. $ref: '#/components/schemas/traceTextChangesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' basedOnCondition: type: object description: Auto attach based advanced query filter. properties: queryId: description: The query ID that is used to filter condition. type: number conditions: description: Conditions for attached rule. $ref: '#/components/schemas/conditionGroupType' basedOnMembershipType: type: object description: Auto attach based on membership. properties: membershipType: description: The membership type that will be required for the element type (one that is based on Membership condition) to auto attach to the reservation. type: string minLength: 0 maxLength: 20 level: description: The membership level of the selected membership type. type: string minLength: 0 maxLength: 20 operaVersionNumberType: type: string description: Current Opera Version Number minLength: 0 maxLength: 40 autoAttachElementsConfigType: type: array description: Auto attachment rule details. maxItems: 4000 items: $ref: '#/components/schemas/autoAttachRuleType' attachElementsType: type: object description: Elements to be attached to the rule. properties: preference: description: Auto attach preference. type: array maxItems: 4000 items: $ref: '#/components/schemas/attachPreferenceType' trace: description: Auto attach trace. $ref: '#/components/schemas/attachTraceType' code: description: List of attached elements codes. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 type: description: Auto attach rule type. $ref: '#/components/schemas/resvAutoAttchTypeCode' description: description: Auto attach rule type description. type: string minLength: 0 maxLength: 2000 upsellRulesCopy: type: object properties: UpsellRules: type: array description: List of the upsell rules to be copied to hotel code(s). items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomSpecialRatingsInfoType: type: array description: Collection of rooms specials and their ratings. maxItems: 4000 items: $ref: '#/components/schemas/roomSpecialRatingInfoType' codeInfoType: type: object description: '' properties: description: type: string minLength: 0 maxLength: 80 addtionalCodeInfo: $ref: '#/components/schemas/addtionalCodeInfoType' hotelId: type: string minLength: 0 maxLength: 20 code: type: string minLength: 0 maxLength: 20 configTestUpsellRulesType: type: array description: This type holds a collection of upsell rules which are returned on testing a reservation. maxItems: 4000 items: $ref: '#/components/schemas/configTestUpsellRuleType' roundingRuleType: type: string description: Simple type for storing rounding rule type. enum: - Up - Down - None - UpKeepDecimal - DownKeepDecimal globalAlertsType: type: array description: Collection of property level global alert details with attached global alert types. maxItems: 4000 items: $ref: '#/components/schemas/globalAlertType' locatorCodesTemplateType: type: array description: Collection of locator codes. maxItems: 4000 items: $ref: '#/components/schemas/locatorCodeTemplateType' traceTextChangesType: type: array description: Collection of trace texts that will be modified. maxItems: 4000 items: $ref: '#/components/schemas/traceTextChangeType' 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. ratePlanRatings: type: object description: Response object for fetching the rate codes and their rating details. properties: ratePlanRatingsInfo: description: List of rate plan codes and their rating details. $ref: '#/components/schemas/ratePlanRatingsInfoType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' locatorCodeType: type: object description: Common code type for code, description properties: code: description: Code for the code type. type: string minLength: 0 maxLength: 20 description: description: Description for the code type. type: string minLength: 0 maxLength: 2000 displaySequence: description: Sequence for locator code type: number inactive: description: Indicates whether the locator code is active or not type: boolean hotelId: description: Property for which the locator code belongs to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' attachPreferenceType: type: object description: Auto attach preference element. properties: type: description: Preference group. type: string minLength: 0 maxLength: 20 code: description: Preference code.. type: string minLength: 0 maxLength: 20 roomRatingType: type: string description: Possible room rating values. enum: - MostDesirable - Desirable - SomewhatDesirable - LessDesirable - LeastDesirable - NoValueDefined 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 eCouponCodesCopy: type: object description: Request object to copy the existing eCoupon codes from source property to the selected target properties. properties: eCouponCopy: description: Request object to copy the eCoupon codes from source property to the selected target properties. $ref: '#/components/schemas/eCouponCopyType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' autoAttachElements: type: object description: Add configuration rule(s) that specify the elements to be automatically attached to the reservation. properties: autoAttachRules: description: List of configuration rule(s) to be added to the configuration of resort. $ref: '#/components/schemas/autoAttachElementsConfigType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' hotelTurnAwayCodeType: type: object description: Base details common between hotel and template TurnAway codes. properties: code: description: TurnAway code type: string minLength: 0 maxLength: 20 description: description: Description of the TurnAway code. $ref: '#/components/schemas/translationTextType50' displaySequence: description: Sequence of TurnAway code. type: number turnAwayType: description: TurnAway type. e.g. Denial,Regret. $ref: '#/components/schemas/turnAwayTypeType' inactive: description: Inactive flag for a TurnAway code. type: boolean canDelete: description: Determines whether this TurnAway code can be deleted. type: boolean hotelId: description: Hotel code that the turnaway code belongs to. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' guestMessageCodesType: type: array description: Collection of guest messages with attached guest message types. maxItems: 4000 items: $ref: '#/components/schemas/guestMessageCodeType' roomSpecialRatingType: type: string description: Possible Room special rating values. enum: - MostImportant - Important - SomewhatImportant - LessImportant - LeastImportant - NoValueSet notificationType: type: object description: Global Alert Notification type for Screen, Print, email and text properties: screen: type: boolean print: type: boolean printerName: type: string minLength: 0 maxLength: 20 reportName: type: string minLength: 0 maxLength: 80 email: type: boolean emailAddress: type: string minLength: 0 maxLength: 100 department: type: string minLength: 0 maxLength: 20 textMessage: type: boolean phoneNumber: $ref: '#/components/schemas/phoneNumberType' eCouponCopyType: type: object description: Copy eCoupons from one Property to one or multiple properties. properties: hotelId: description: Source property from which copy operation will happen. type: string minLength: 0 maxLength: 20 eCouponCodes: description: List of eCoupon codes to copy from souce to list of target properties. $ref: '#/components/schemas/codeListType' targetHotelCodes: description: List of target properties to which the selected eCoupons will be copied. $ref: '#/components/schemas/codeListType' translationTextType50: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 50. type: string minLength: 0 maxLength: 50 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' autoAttachElementsCopy: type: object properties: autoAttachRule: type: array description: List of the auto attach configuration rule(s) to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' expressionOperatorType: type: object properties: operatorName: type: string minLength: 0 maxLength: 40 operatorDescription: type: string minLength: 0 maxLength: 400 parameterSize: type: number roomRatingsInfo: type: object description: Request object for modifying room rating details. properties: roomRatingsInfo: $ref: '#/components/schemas/roomRatingsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' resvAutoAttchBasedOn: type: object description: The Based On information for the rule. properties: preference: description: Based on Preference information. $ref: '#/components/schemas/attachPreferenceType' special: description: Based on Special information. $ref: '#/components/schemas/attachPreferenceType' membership: description: Membership information. $ref: '#/components/schemas/basedOnMembershipType' condition: description: Indicates if this rule uses advanced filter conditions. $ref: '#/components/schemas/basedOnCondition' ratePlanCode: description: Rate Code. type: string minLength: 0 maxLength: 20 roomType: description: Room type Code. type: string minLength: 0 maxLength: 20 count: description: A positive numeric number, When the number of adults/children or a reservation equals or exceeds this value, then the items that were selected in the Associated Preferences will automatically be attached to the reservation. type: integer keywordType: description: The Keyword attached in the profile,when a reservation is made by a profile that has the selected Keyword attached, then the items that were selected in the Associated Preferences will automatically be attached to the reservation. type: string minLength: 0 maxLength: 20 vipCode: description: The associated VIP Status. type: string minLength: 0 maxLength: 20 type: description: Code. $ref: '#/components/schemas/resvAutoAttchBasedOnCode' description: description: description. type: string minLength: 0 maxLength: 2000 globalAlertsCopy: type: object description: Request object for copying Global Alerts. properties: copyInstructions: description: Copy Global Alert type to copy from one Hotel to another Hotel. $ref: '#/components/schemas/copyGlobalAlertType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' locatorCodes: type: object description: Request object for modifying an existing locator code. properties: locatorCodes: $ref: '#/components/schemas/locatorCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' membershipLevelRatingInfoType: type: object description: Rating details for membership levels. properties: hotelId: description: Property code of the membership level. type: string minLength: 0 maxLength: 20 membershipType: description: Membership type of the membership level. type: string minLength: 0 maxLength: 20 membershipLevel: description: Membership Level along with its description whose rating is fetched. $ref: '#/components/schemas/codeDescriptionType' rating: description: Ratings associated with the membership level. $ref: '#/components/schemas/membershipLevelRatingType' membershipLevelRatingsInfo: type: object description: Response object for fetching the membership levels and their rating details. properties: membershipLevelRatingsInfo: description: List of membership levels and their rating details. $ref: '#/components/schemas/membershipLevelRatingsInfoType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomSpecialRatingsInfo: type: object description: Response object for fetching the room specials and their rating details. properties: roomSpecialRatingsInfo: description: List of room specials and their rating details. $ref: '#/components/schemas/roomSpecialRatingsInfoType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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' roomFeatureRatings: type: object description: Request object for modifying room features rating details. properties: roomFeatureRatingsInfo: $ref: '#/components/schemas/roomFeatureRatingsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' links: type: array items: $ref: '#/components/schemas/instanceLink' autoAttachRuleType: type: object description: Auto attachment rule details. properties: attachElements: description: The elements attached with the rule. $ref: '#/components/schemas/attachElementsType' basedOn: description: The condition or requirement that the rule type is based on. $ref: '#/components/schemas/resvAutoAttchBasedOn' code: description: The name of the rule. type: string minLength: 0 maxLength: 20 hotelId: description: The property in which the rule code belongs to. type: string minLength: 0 maxLength: 20 inactive: description: Indicates whether the rule is active or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' hotelCodeListType: type: array description: Hotel code. maxItems: 4000 items: type: string minLength: 0 maxLength: 20 mergeCodeType: type: object description: A Merge Code. properties: tag: description: Merge Code. type: string minLength: 0 maxLength: 100 value: description: Default value of Merge Code. type: string minLength: 0 maxLength: 80 configUpsellRulesType: type: array description: This type holds a collection of upsell rules. maxItems: 4000 items: $ref: '#/components/schemas/configUpsellRuleType' locatorCodeTemplateType: type: object description: Common code type for code, description properties: code: description: Code for the code type. type: string minLength: 0 maxLength: 20 description: description: Description for the code type. type: string minLength: 0 maxLength: 2000 displaySequence: description: Sequence for locator code type: number inactive: description: Indicates whether the locator code is active or not type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' externalDocs: description: Find out more about Oracle Hospitality url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html