openapi: 3.2.0
info:
  title: OPERA Cloud Leisure Management Leisure Management Config API
  description: APIs to cater for external Leisure Management functionality integrated with OPERA Cloud.<br /><br /> Compatible with OPERA Cloud release 26.2.0.0.<br /><br /><p> 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.</p>
  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: /lms/v1
tags:
- name: LeisureManagementConfig
  description: The Leisure Management Configuration module offers a set of operations to manage the configuration of activities like Status codes, locations, types etc. User can create, change, remove and fetch Status codes, locations, types etc.
paths:
  /activityLocations:
    post:
      summary: Create an Activity Locations
      description: Use this API to create a new Activity location for a property. <p><strong>OperationId:</strong>postActivityLocations</p>
      operationId: postActivityLocations
      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:
      - LeisureManagementConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/createActivityLocations'
        description: Request object for creating Activity Locations.
        required: true
    get:
      summary: Look up of Activity Locations
      description: Use this API to fetch Activity location codes for a property. <p><strong>OperationId:</strong>getActivityLocations</p>
      operationId: getActivityLocations
      parameters:
      - name: hotelIds
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: criteriaCodes
        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 after fetching the Activity Locations.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/fetchActivityLocations'
        '204':
          description: ActivityLocations 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:
      - LeisureManagementConfig
  /activityLocations/{activityLocationsId}:
    put:
      summary: Change in Activity Locations
      description: Use this API to update an existing Activity location Code for a property. <p><strong>OperationId:</strong>putActivityLocations</p>
      operationId: putActivityLocations
      parameters:
      - name: activityLocationsId
        in: path
        required: true
        description: OPERA Activity locations id
        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/changeActivityLocationsRS'
        '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:
      - LeisureManagementConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/changeActivityLocations'
        description: Request object for changing Activity Locations.
        required: true
    delete:
      summary: Remove Activity Locations
      description: Use this API to delete an Activity location for a property. <p><strong>OperationId:</strong>deleteActivityLocations</p>
      operationId: deleteActivityLocations
      parameters:
      - name: activityLocationsId
        in: path
        required: true
        description: OPERA Activity locations id
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelIds
        in: query
        required: true
        description: Hotel where the code is configured.
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - LeisureManagementConfig
  /activityLocations/{activityLocationsId}/copy:
    put:
      summary: Copy Activity Locations
      description: Use this API to copy an Activity location for a property. <p><strong>OperationId:</strong>copyActivityLocations</p>
      operationId: copyActivityLocations
      parameters:
      - name: activityLocationsId
        in: path
        required: true
        description: OPERA Source Activity locations id
        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/copyActivityLocationsRS'
        '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:
      - LeisureManagementConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/copyActivityLocations'
        description: Request object for copying Activity Locations to hotel(s).
        required: true
  /activityStatusCodes:
    post:
      summary: Create Activity Status Code
      description: Retrieve Activity Status Code that are configured for a property.  Activity Status Codes are typically used when an EAS (External Activities Scheduler system) interface is connected to OPERA.   <p><strong>OperationId:</strong>postActivityStatusCodes</p>
      operationId: postActivityStatusCodes
      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:
      - LeisureManagementConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/createActivityStatusCodes'
        description: Request object for creating Activity Status Codes.
        required: true
    get:
      summary: Get Activity Status Codes
      description: Fetch Activity Status Codes that are configured for a property.  <p><strong>OperationId:</strong>getActivityStatusCodes</p>
      operationId: getActivityStatusCodes
      parameters:
      - name: hotelIds
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: criteriaCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: applicationCodes
        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 after fetching the Activity Status Codes.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/fetchActivityStatusCodes'
        '204':
          description: ActivityStatusCodes 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:
      - LeisureManagementConfig
  /activityStatusCodes/{activityStatusCodesId}:
    put:
      summary: Change Activity Status Code
      description: Modify an Activity Status Code that is configured for a property.  <p><strong>OperationId:</strong>putActivityStatusCodes</p>
      operationId: putActivityStatusCodes
      parameters:
      - name: activityStatusCodesId
        in: path
        required: true
        description: OPERA Activity status codes
        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/changeActivityStatusCodesRS'
        '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:
      - LeisureManagementConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/changeActivityStatusCodes'
        description: Request object for changing Activity Status Codes.
        required: true
    delete:
      summary: Remove Activity Status Code
      description: Remove an Activity Status Code that is configured for a property.  <p><strong>OperationId:</strong>deleteActivityStatusCodes</p>
      operationId: deleteActivityStatusCodes
      parameters:
      - name: activityStatusCodesId
        in: path
        required: true
        description: OPERA Activity status codes
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelIds
        in: query
        required: true
        description: Hotel where the code is configured.
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - LeisureManagementConfig
  /activityTypes:
    get:
      summary: Fetch Activity Types
      description: Retrieve Activity Types that are configured for a property.  Activity Types are typically used when an EAS (External Activities Scheduler system) interface is connected to OPERA.   <p><strong>OperationId:</strong>getActivityTypes</p> <p>The maximum allowable limit for this API is <strong>25</strong>.</p>
      operationId: getActivityTypes
      parameters:
      - name: hotelIds
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: typeCodes
        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 after fetching the Activity Types.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/fetchActivityTypes'
        '204':
          description: ActivityTypes 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:
      - LeisureManagementConfig
    post:
      summary: Create Activity Types
      description: Create a new Activity Type Code for a specific property. <p><strong>OperationId:</strong>postActivityTypes</p>
      operationId: postActivityTypes
      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:
      - LeisureManagementConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/createActivityTypes'
        description: Request object for creating Activity Types.
        required: true
  /activityTypes/{activityTypesId}:
    put:
      summary: Change Activity Types
      description: Modify an Activity Type Code that is configured for a property. <p><strong>OperationId:</strong>putActivityTypes</p>
      operationId: putActivityTypes
      parameters:
      - name: activityTypesId
        in: path
        required: true
        description: OPERA Activity types id
        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/changeActivityTypesRS'
        '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:
      - LeisureManagementConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/changeActivityTypes'
        description: Request object for changing Activity Types.
        required: true
    delete:
      summary: Remove Activity Types
      description: Delete an Activity Type Code that is configured for a property. <p><strong>OperationId:</strong>deleteActivityTypes</p>
      operationId: deleteActivityTypes
      parameters:
      - name: activityTypesId
        in: path
        required: true
        description: OPERA Activity types id
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: hotelIds
        in: query
        required: true
        description: Hotel where the code is configured.
        schema:
          type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      responses:
        '200':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      tags:
      - LeisureManagementConfig
  /activityTypes/{activityTypesId}/copy:
    put:
      summary: Copy Activity Types
      description: Copy existing Activity Types from source property to target properties. <p><strong>OperationId:</strong>copyActivityTypes</p>
      operationId: copyActivityTypes
      parameters:
      - name: activityTypesId
        in: path
        required: true
        description: OPERA Activity types id
        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/copyActivityTypesRS'
        '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:
      - LeisureManagementConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/copyActivityTypes'
        description: Request object for copying Activity Types to hotel(s).
        required: true
  /upsert/activityLocations/{activityLocationsId}:
    put:
      summary: Create/Change in Activity Locations
      description: Use this API to create/update an existing Activity location Code for a property. <p><strong>OperationId:</strong>putUpsertActivityLocations</p>
      operationId: putUpsertActivityLocations
      parameters:
      - name: activityLocationsId
        in: path
        required: true
        description: OPERA Activity locations id
        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/changeActivityLocationsRS'
        '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:
      - LeisureManagementConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/changeActivityLocations'
        description: Request object for changing Activity Locations.
        required: true
  /upsert/activityStatusCodes/{activityStatusCodesId}:
    put:
      summary: Create/Change Activity Status Code
      description: Create/Modify an Activity Status Code that is configured for a property.  <p><strong>OperationId:</strong>putUpsertActivityStatusCodes</p>
      operationId: putUpsertActivityStatusCodes
      parameters:
      - name: activityStatusCodesId
        in: path
        required: true
        description: OPERA Activity status codes
        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/changeActivityStatusCodesRS'
        '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:
      - LeisureManagementConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/changeActivityStatusCodes'
        description: Request object for changing Activity Status Codes.
        required: true
  /upsert/activityTypes/{activityTypesId}:
    put:
      summary: Create/Change Activity Types
      description: Create/Modify an Activity Type Code that is configured for a property. <p><strong>OperationId:</strong>putUpsertActivityTypes</p>
      operationId: putUpsertActivityTypes
      parameters:
      - name: activityTypesId
        in: path
        required: true
        description: OPERA Activity types id
        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/changeActivityTypesRS'
        '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:
      - LeisureManagementConfig
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/changeActivityTypes'
        description: Request object for changing Activity Types.
        required: true
components:
  schemas:
    copyActivityTypesRS:
      type: object
      description: Response Body.
      properties:
        success:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/successType'
        warnings:
          $ref: '#/components/schemas/warningsType'
        errors:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/errorsType'
        echoToken:
          description: A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.
          type: string
          minLength: 0
          maxLength: 128
        timeStamp:
          description: Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).
          type: string
          format: date-time
        version:
          description: For all Opera versioned messages, the version of the message is indicated by a Opera Version value.
          type: string
          minLength: 0
          maxLength: 40
        correlationId:
          description: Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
          type: string
          minLength: 0
          maxLength: 80
        retryAllowed:
          description: Indicates if the operation supports the ability to retry the request.
          type: boolean
        enforceAllowed:
          description: Indicates if the operation supports the ability to force the retry request through OPERA services in the case where the external system continues to fail.
          type: boolean
        useLocalAllowed:
          description: This attribute carries the user selected confirmation value on confirmation popup.
          type: boolean
        links:
          $ref: '#/components/schemas/links'
    copyConfigurationCodesType:
      type: array
      description: Information needed to copy configuration code from one property to the other.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/copyConfigurationCodeType'
    changeActivityTypes:
      type: object
      description: Request object for changing Activity Types.
      properties:
        activityTypes:
          description: Collection of Activity Types to be changed.
          $ref: '#/components/schemas/activityTypesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    copyActivityLocations:
      type: object
      description: Request object for copying Activity Locations to hotel(s).
      properties:
        copyInstructions:
          description: List of the Activity Location details to be copied to hotel(s).
          $ref: '#/components/schemas/copyConfigurationCodesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    changeActivityLocations:
      type: object
      description: Request object for changing Activity Locations.
      properties:
        activityLocations:
          description: Collection of Activity Locations to be changed.
          $ref: '#/components/schemas/activityLocationsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    changeActivityTypesRS:
      type: object
      description: Response Body.
      properties:
        success:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/successType'
        warnings:
          $ref: '#/components/schemas/warningsType'
        errors:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/errorsType'
        echoToken:
          description: A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.
          type: string
          minLength: 0
          maxLength: 128
        timeStamp:
          description: Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).
          type: string
          format: date-time
        version:
          description: For all Opera versioned messages, the version of the message is indicated by a Opera Version value.
          type: string
          minLength: 0
          maxLength: 40
        correlationId:
          description: Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
          type: string
          minLength: 0
          maxLength: 80
        retryAllowed:
          description: Indicates if the operation supports the ability to retry the request.
          type: boolean
        enforceAllowed:
          description: Indicates if the operation supports the ability to force the retry request through OPERA services in the case where the external system continues to fail.
          type: boolean
        useLocalAllowed:
          description: This attribute carries the user selected confirmation value on confirmation popup.
          type: boolean
        links:
          $ref: '#/components/schemas/links'
    managedByOptions:
      description: Describes of the Configuration is Managed by Enterprise or Property.
      type: string
      enum:
      - EnterpriseManaged
      - PropertyManaged
      - EnterpriseEnforced
      - PropertyOverridden
    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
    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
    successType:
      type: object
      description: Returning an empty element of this type indicates the successful processing of an message. This is used in conjunction with the Warning Type to report any warnings or business errors.
      properties: {}
    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
    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
    activityTypesType:
      type: array
      description: Collection of Activity Types.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/activityTypeDetailType'
    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
    activityStatusCodeType:
      type: object
      description: Activity Status Code detail information.
      properties:
        hotelId:
          description: Property to which the activity status code belongs to. Cannot be null.
          type: string
          minLength: 0
          maxLength: 20
        code:
          description: Code for the activity status code. Cannot be null.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description for the Activity Status Code. Cannot be null.
          type: string
          minLength: 0
          maxLength: 80
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        priority:
          description: Priority for the activity status code.
          type: integer
        application:
          description: Used in Application for the activity status code.
          type: string
          minLength: 0
          maxLength: 20
        managedBy:
          $ref: '#/components/schemas/managedByOptions'
    activityTypeDetailType:
      type: object
      description: Activity Type detail information.
      properties:
        hotelId:
          description: Property to which the activity Type belongs to.
          type: string
          minLength: 0
          maxLength: 20
        typeCode:
          description: Type for the activity Type.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description for the Activity Type.
          type: string
          minLength: 0
          maxLength: 100
        managedBy:
          $ref: '#/components/schemas/managedByOptions'
    createActivityTypes:
      type: object
      description: Request object for creating Activity Types.
      properties:
        activityTypes:
          description: Collection of Activity Types to be created.
          $ref: '#/components/schemas/activityTypesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    changeActivityStatusCodes:
      type: object
      description: Request object for changing Activity Status Codes.
      properties:
        activityStatusCodes:
          description: Collection of Activity Status Codes to be changed.
          $ref: '#/components/schemas/activityStatusCodesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    copyActivityLocationsRS:
      type: object
      description: Response Body.
      properties:
        success:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/successType'
        warnings:
          $ref: '#/components/schemas/warningsType'
        errors:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/errorsType'
        echoToken:
          description: A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.
          type: string
          minLength: 0
          maxLength: 128
        timeStamp:
          description: Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).
          type: string
          format: date-time
        version:
          description: For all Opera versioned messages, the version of the message is indicated by a Opera Version value.
          type: string
          minLength: 0
          maxLength: 40
        correlationId:
          description: Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
          type: string
          minLength: 0
          maxLength: 80
        retryAllowed:
          description: Indicates if the operation supports the ability to retry the request.
          type: boolean
        enforceAllowed:
          description: Indicates if the operation supports the ability to force the retry request through OPERA services in the case where the external system continues to fail.
          type: boolean
        useLocalAllowed:
          description: This attribute carries the user selected confirmation value on confirmation popup.
          type: boolean
        links:
          $ref: '#/components/schemas/links'
    fetchActivityLocations:
      type: object
      description: Response object after fetching the Activity Locations.
      properties:
        activityLocations:
          description: Collection of fetched Activity Locations.
          $ref: '#/components/schemas/activityLocationsType'
        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'
    activityLocationsType:
      type: array
      description: Collection of Activity Locations.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/activityLocationType'
    copyActivityTypes:
      type: object
      description: Request object for copying Activity Types to hotel(s).
      properties:
        copyInstructions:
          description: List of the Activity Type details to be copied to hotel(s).
          $ref: '#/components/schemas/copyConfigurationCodesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    fetchActivityStatusCodes:
      type: object
      description: Response object after fetching the Activity Status Codes.
      properties:
        activityStatusCodes:
          description: Collection of fetched Activity Status Codes
          $ref: '#/components/schemas/activityStatusCodesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    createActivityLocations:
      type: object
      description: Request object for creating Activity Locations.
      properties:
        activityLocations:
          description: Collection of Activity Locations to be created.
          $ref: '#/components/schemas/activityLocationsType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    errorType:
      type: object
      description: Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.
      properties:
        value:
          type: string
          description: Property Value
        shortText:
          description: An abbreviated version of the error in textual format.
          type: string
        code:
          description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.
          type: string
          minLength: 0
          maxLength: 20
        docURL:
          description: If present, this URL refers to an online description of the error that occurred.
          type: string
        status:
          description: If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.
          type: string
        tag:
          description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].
          type: string
        recordId:
          description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.
          type: string
        type:
          description: The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown".
          type: string
          minLength: 0
          maxLength: 20
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        nodeList:
          description: An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional constraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.
          type: string
    warningsType:
      type: array
      description: Used in conjunction with the Success element to define a business error.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/warningType'
    createActivityStatusCodes:
      type: object
      description: Request object for creating Activity Status Codes.
      properties:
        activityStatusCodes:
          description: Collection of Activity Status Codes to be created.
          $ref: '#/components/schemas/activityStatusCodesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    changeActivityLocationsRS:
      type: object
      description: Response Body.
      properties:
        success:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/successType'
        warnings:
          $ref: '#/components/schemas/warningsType'
        errors:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/errorsType'
        echoToken:
          description: A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.
          type: string
          minLength: 0
          maxLength: 128
        timeStamp:
          description: Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).
          type: string
          format: date-time
        version:
          description: For all Opera versioned messages, the version of the message is indicated by a Opera Version value.
          type: string
          minLength: 0
          maxLength: 40
        correlationId:
          description: Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
          type: string
          minLength: 0
          maxLength: 80
        retryAllowed:
          description: Indicates if the operation supports the ability to retry the request.
          type: boolean
        enforceAllowed:
          description: Indicates if the operation supports the ability to force the retry request through OPERA services in the case where the external system continues to fail.
          type: boolean
        useLocalAllowed:
          description: This attribute carries the user selected confirmation value on confirmation popup.
          type: boolean
        links:
          $ref: '#/components/schemas/links'
    changeActivityStatusCodesRS:
      type: object
      description: Response Body.
      properties:
        success:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/successType'
        warnings:
          $ref: '#/components/schemas/warningsType'
        errors:
          description: Refer to Generic common types document.
          $ref: '#/components/schemas/errorsType'
        echoToken:
          description: A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.
          type: string
          minLength: 0
          maxLength: 128
        timeStamp:
          description: Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).
          type: string
          format: date-time
        version:
          description: For all Opera versioned messages, the version of the message is indicated by a Opera Version value.
          type: string
          minLength: 0
          maxLength: 40
        correlationId:
          description: Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
          type: string
          minLength: 0
          maxLength: 80
        retryAllowed:
          description: Indicates if the operation supports the ability to retry the request.
          type: boolean
        enforceAllowed:
          description: Indicates if the operation supports the ability to force the retry request through OPERA services in the case where the external system continues to fail.
          type: boolean
        useLocalAllowed:
          description: This attribute carries the user selected confirmation value on confirmation popup.
          type: boolean
        links:
          $ref: '#/components/schemas/links'
    activityLocationType:
      type: object
      description: Activity Location detail information.
      properties:
        hotelId:
          description: Property to which the activity Location belongs to.
          type: string
          minLength: 0
          maxLength: 20
        code:
          description: Code for the activity Location.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: Description for the Activity Location.
          type: string
          minLength: 0
          maxLength: 80
        managedBy:
          $ref: '#/components/schemas/managedByOptions'
    links:
      type: array
      items:
        $ref: '#/components/schemas/instanceLink'
    activityStatusCodesType:
      type: array
      description: Activity Status Codes object.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/activityStatusCodeType'
    errorsType:
      type: array
      description: An error that occurred during the processing of a message.
      maxItems: 99
      items:
        $ref: '#/components/schemas/errorType'
    fetchActivityTypes:
      type: object
      description: Response object after fetching the Activity Types.
      properties:
        activityTypes:
          description: Collection of fetched Activity Types.
          $ref: '#/components/schemas/activityTypesType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
  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
    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}$
    authKey:
      name: authorization
      description: Bearer token that needs to be passed which is generated post user authentication
      in: header
      required: true
      schema:
        type: string
    x-externalsystem:
      name: x-externalsystem
      description: External system code.
      in: header
      x-example: EXTERNALSYSTEMCODE
      schema:
        type: string
        maxLength: 40
    externalData:
      name: externalData
      description: Pass this header as true, if payload needs DVM
      in: header
      schema:
        type: string
    x-originating-application:
      name: x-originating-application
      description: Customer's Integration Application Id
      in: header
      schema:
        type: string
    Accept-Language:
      name: Accept-Language
      description: Language code
      in: header
      schema:
        type: string
    x-request-id:
      name: x-request-id
      description: Request Id of an incoming request
      in: header
      schema:
        type: string
        pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
  responses:
    '406':
      description: Not acceptable.
    '414':
      description: Request URI Too Large
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '403':
      description: Forbidden
    '413':
      description: Request Entity Too Large
    '415':
      description: Unsupported Media Type
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '502':
      description: Bad Gateway
    '500':
      description: System Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '503':
      description: Service Unavailable
    '401':
      description: Unauthorized
    '405':
      description: Method not allowed
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html