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,2023 Oracle and/or its affiliates.
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: /act/config/v1 tags: - name: ActivityManagement description: The Activity Configuration APIs offers capability of creating, managing, and retrieving Activity configuration elements, such as Activity Type code, Activity Result codes. paths: /activityResults: get: summary: 'Get all Configured Activity Result Codes ' description: Retrieve a list of all configured Activity Result codes and descriptions. Activity Results appear on the Activities screen in the Results field after the Activity is completed. And example could be Call Again - an activity is Completed but the result code as part of the completion is to Call Again.OperationId:getActivityResultsConfig
The maximum allowable limit for this API is 25.
operationId: getActivityResultsConfig 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: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching configured Activity Results. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/activityResultsConfigDetails' '204': description: ActivityResultsConfig 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: - ActivityManagement post: summary: Create an Activity results code description: Create a new Activity Results Code, for example SUCCESS, END, CALLAGAIN. These codes are used when you complete an activity. You need to specify an Activity Result Code as part of that completion process.OperationId:postActivityResultsConfig
operationId: postActivityResultsConfig 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: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/activityResultsConfigInfo' description: Request object for creating Activity Results Configuration. required: true /activityResults/{activityResultCode}: delete: summary: Delete an Activity results code description: Delete an Activity Result Code from OPERA Cloud.OperationId:deleteActivityResultsConfig
operationId: deleteActivityResultsConfig parameters: - name: activityResultCode in: path required: true description: Activity Result 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: - ActivityManagement put: summary: Change an Activity Result Code description: Change or update details of an existing Activity Results Code.OperationId:putActivityResultsConfig
operationId: putActivityResultsConfig parameters: - name: activityResultCode in: path required: true description: Activity Result 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: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/activityResultsConfigInfo' description: Request object for changing Activity Results Configuration. required: true /autoTraceCodes: get: summary: Get Auto Trace codes description: Retrieve a list of all configured Auto Trace Codes for a property.OperationId:getAutoTraceCodes
The maximum allowable limit for this API is 25.
operationId: getAutoTraceCodes 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: codes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: autoTraceGroups in: query description: A collection of supported list of Auto Trace Groups. required: false style: form explode: true schema: type: array items: type: string enum: - Accounts - Contacts - Blocks - Activities uniqueItems: true - name: description in: query required: false description: Description for the Trace Code to be searched for. 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 to fetch Auto Trace Codes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/autoTraceCodesDetails' '204': description: AutoTraceCodes 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: - ActivityManagement post: summary: Create an Auto Trace code description: Create an Auto trace code.OperationId:postAutoTraceCodes
operationId: postAutoTraceCodes 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: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoTraceCodesInfo' description: Request object for creating Auto Trace Codes. required: true /autoTraceCodes/{autoTraceCode}: delete: summary: Delete an Auto Trace code description: Delete an Auto trace code.OperationId:deleteAutoTraceCodes
operationId: deleteAutoTraceCodes parameters: - name: autoTraceCode in: path required: true description: Unique code of trace. 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: - ActivityManagement put: summary: Change an Auto Trace code description: Update an Auto Trace Code.OperationId:putAutoTraceCodes
operationId: putAutoTraceCodes parameters: - name: autoTraceCode in: path required: true description: Unique code of trace. 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: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoTraceCodesInfo' description: Request object for changing Auto Trace Codes. required: true /autoTraceDefinitions/{autoTraceDefinitionId}: delete: summary: Delete an Auto Trace definitions Code description: Delete an Auto trace definition code.OperationId:deleteAutoTraceDefinitions
operationId: deleteAutoTraceDefinitions parameters: - name: autoTraceDefinitionId in: path required: true description: Unique ID of trace. 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: - ActivityManagement /autoTraceOwnerAssignments/{autoTraceOwnerAssignmentID}: delete: summary: 'Delete an Auto Trace owner assignment ' description: Delete a Trace owner assignment configured for a property.OperationId:deleteAutoTraceOwnerAssignments
operationId: deleteAutoTraceOwnerAssignments parameters: - name: autoTraceOwnerAssignmentID in: path required: true description: Unique ID of trace owner. 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: - ActivityManagement /copyActivityTypes/sourceHotel/{hotelId}: post: summary: Copy Activity Types configuration codes description: With this API you can select existing Activity Type Codes from the source property and copy them to another (target) property.OperationId:copyActivityTypesConfig
operationId: copyActivityTypesConfig parameters: - name: hotelId in: path required: true description: Unique ID of the source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/activityTypesConfigCopy' required: true /copyAutoTraceDefinitions/sourceHotel/{hotelId}: post: summary: Copy an Auto Trace definition Code description: Copy an existing auto trace definition code to another property.OperationId:copyAutoTraceDefinitions
operationId: copyAutoTraceDefinitions parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoTraceDefinitionCopy' description: Request object for copying trace definition. required: true /hotels/{hotelId}/activityTypes: get: summary: Get all Activity Type Codes description: Retrieve all configured Activity types for a specified hotel.OperationId:getActivityTypes
The maximum allowable limit for this API is 25.
operationId: getActivityTypes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. 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: activityType in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Description for the activity type is to be searched for. schema: type: string - name: inactive in: query required: false description: Determines whether to fetch inactive records 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 after fetching the activity types. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/activityTypesConfigDetails' '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: - ActivityManagement post: summary: Create a new Activity type in configuration description: Create a new Activity Type for a specified hotel. Examples could be MEETING, LUNCH, EXTMEETING.OperationId:postActivityTypes
operationId: postActivityTypes parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/activityTypesConfigInfo' description: Request object for creating activity types. required: true /hotels/{hotelId}/activityTypes/{activityTypeCode}: delete: summary: Delete an Activity Type Code description: This will delete an Activity Type Code from the properties configuration.OperationId:deleteActivityTypes
operationId: deleteActivityTypes parameters: - name: activityTypeCode in: path required: true description: Activity Type Code. 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: 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: - ActivityManagement put: summary: Update Activity Types description: Change or update details of an existing Activity Type for a property.OperationId:putActivityTypes
operationId: putActivityTypes parameters: - name: activityTypeCode in: path required: true description: Activity Type Code. 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: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/activityTypesConfigInfo' description: Request object for changing activity types. required: true /hotels/{hotelId}/autoTraceDefinitions: get: summary: Get a list of Auto Trace definition Codes description: Get a list of all Auto trace definitions for a property.OperationId:getAutoTraceDefinitions
The maximum allowable limit for this API is 25.
operationId: getAutoTraceDefinitions parameters: - name: hotelId in: path required: true description: Unique ID of hotel. 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: codes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: autoTraceGroups in: query description: A collection of supported list of Auto Trace Groups. required: false style: form explode: true schema: type: array items: type: string enum: - Accounts - Contacts - Blocks - Activities uniqueItems: true - name: inactive in: query required: false description: Determines whether to fetch inactive records 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 after fetching Auto Trace Definitions. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/autoTraceDefinitionsDetails' '204': description: AutoTraceDefinitions 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: - ActivityManagement post: summary: Create an Auto Trace Definition Code description: Create a new Auto Trace Definition code for a specified property.OperationId:postAutoTraceDefinitions
operationId: postAutoTraceDefinitions parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoTraceDefinitionsInfo' description: Request object for creating Auto Trace Definitions. required: true /hotels/{hotelId}/autoTraceDefinitions/{autoTraceDefinitionId}: put: summary: Change an Auto Trace definition Code description: Change an Auto Trace Definition code for a specified property.OperationId:putAutoTraceDefinitions
operationId: putAutoTraceDefinitions parameters: - name: autoTraceDefinitionId in: path required: true description: Unique ID of trace. 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/autoTraceDefinitionsStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoTraceDefinitionsInfo' description: Request object for changing Auto Trace Definitions. required: true /hotels/{hotelId}/autoTraceOwnerAssignments: get: summary: Get an Auto Trace owner mappings description: This API will provide a list of all configured Auto Trace Owner Mappings.OperationId:getAutoTraceOwnerAssignments
The maximum allowable limit for this API is 25.
operationId: getAutoTraceOwnerAssignments parameters: - name: hotelId in: path required: true description: Unique ID of hotel. 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: codes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: traceOwnerCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch trace owner assignments. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/autoTraceOwnerAssignmentsDetails' '204': description: AutoTraceOwnerAssignments 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: - ActivityManagement post: summary: Create an Auto Trace owner assignment description: You can create Auto traces so that activities are created automatically under certain configured conditions. You first need a Trace code configured, and then using this API you can link the Owner code and Trace Code to a Trace Group (account, contact, activity, or block).OperationId:postAutoTraceOwnerAssignments
operationId: postAutoTraceOwnerAssignments parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoTraceOwnerAssignmentsInfo' description: Request object for creating trace owner assignments. required: true /hotels/{hotelId}/autoTraceOwnerAssignments/{autoTraceOwnerAssignmentID}: put: summary: Change Trace owner assignments description: Change a Trace owner assignment configured for a property.OperationId:putAutoTraceOwnerAssignments
operationId: putAutoTraceOwnerAssignments parameters: - name: autoTraceOwnerAssignmentID in: path required: true description: Unique ID of trace owner. 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/autoTraceOwnerAssignmentsStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoTraceOwnerAssignmentsInfo' description: Request object for changing trace owner assignments. required: true /services/activityManagement/status: get: summary: Operation to ping. description: 'OperationId:pingActivityManagementServices
' operationId: pingActivityManagementServices parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response for Ping operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaVersion' '204': description: pingActivityManagementServices 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: - ActivityManagement /upsert/hotels/{hotelId}/autoTraceDefinitions: put: summary: Create/Change an Auto Trace definition Code description: Create/Change an Auto Trace Definition code for a specified property.OperationId:putUpsertAutoTraceDefinitions
operationId: putUpsertAutoTraceDefinitions parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/autoTraceDefinitionsStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoTraceDefinitionsInfo' description: Request object for changing Auto Trace Definitions. required: true /upsert/hotels/{hotelId}/autoTraceOwnerAssignments: put: summary: Create/Change Trace owner assignments description: Create/Change a Trace owner assignment configured for a property.OperationId:putUpsertAutoTraceOwnerAssignments
operationId: putUpsertAutoTraceOwnerAssignments parameters: - name: hotelId in: path required: true description: Unique ID of hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/autoTraceOwnerAssignmentsStatus' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ActivityManagement requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/autoTraceOwnerAssignmentsInfo' description: Request object for changing trace owner assignments. required: true components: schemas: activityConfigTypeDetailType: type: object description: Activity Type detail information. properties: activityTypeCode: 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 activityClassList: description: Element to hold Activity Class value. type: array maxItems: 2 items: $ref: '#/components/schemas/activityConfigClassType' internal: description: Check for whether to consider the activity type is internal. type: boolean sequence: description: Display sequence for the activity code type. type: integer autoiCalendar: description: To create an iCal file (.ics) automatically and send it to the email address of the activity owner on activity creation, update, and deletion. type: boolean minutesBeforeAlert: description: Defines the number of minutes before the start time of an activity of this activity type, an alert should be issued. type: integer inactive: description: When checked,the activity type will still be valid for existing activities and traces,but it cannot be selected for new activities and traces type: boolean hotelId: description: The hotel code where the activity type to be created. type: string minLength: 0 maxLength: 20 managedBy: $ref: '#/components/schemas/managedByOptions' autoTraceTriggerCategoryType: type: string description: Contains information on when auto trace would be created. enum: - Create - Update - Delete activityConfigListType: type: array description: Detailed information of activity type. maxItems: 4000 items: $ref: '#/components/schemas/activityConfigTypeDetailType' copyActivityConfigCriteriaType: type: object description: Criteria to copy multiple Activity Types from one Hotel to another Hotel. properties: copyActivityConfig: description: The hotel code where the activity type was created. type: object properties: sourceHotelCode: description: The hotel code where the activity type was created. type: string minLength: 0 maxLength: 20 activityCodeList: description: List of Codes for which the activity types are to be searched for. $ref: '#/components/schemas/codeListType' targetHotelCode: description: The hotel code(s) where the activity type should be copied to. $ref: '#/components/schemas/codeListType10' expressionParameterType: type: object properties: parameter: type: array maxItems: 3 items: type: string minLength: 0 maxLength: 40 functionIdOne: type: number functionIdTwo: type: number activityTypesConfigDetails: type: object description: Response object after fetching the activity types. properties: activityConfigTypes: description: Collection of fetched activity types. $ref: '#/components/schemas/activityConfigListType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' activityConfigClassType: type: string description: A collection of supported list of activity classes. enum: - Appointment - Todo copyAutoTraceDefinitionCriteriaType: type: object description: Criteria to copy multiple trace definitions from one property to another. properties: copyAutoTraceDefinition: description: The hotel code where the trace definition was created. type: object properties: sourceHotelCode: description: The hotel code where the trace definition was created. type: string minLength: 0 maxLength: 20 traceDefinitionCodeList: description: List of Trace Definition IDs. $ref: '#/components/schemas/uniqueIDListType' targetHotelCode: description: The hotel code(s) where the activity type should be copied to. $ref: '#/components/schemas/codeListType' copyInstructions: description: Instructions which will be considered when copying from the template. If this element is not sent, all the flags will be ignored. type: object properties: allowOwnerAssignmentsCopy: description: When true, this will copy the owner assignments to the trace definition. type: boolean warningsType: type: array description: Used in conjunction with the Success element to define a business error. maxItems: 4000 items: $ref: '#/components/schemas/warningType' activityTypesConfigInfo: type: object description: Request object for creating/changing activity types. properties: activityConfigTypes: description: Activity type details to be created/updated. $ref: '#/components/schemas/activityConfigListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' activityResultsConfigDetailType: type: object description: Contains Common Master configuration detail. properties: code: description: Common Master unique code. type: string minLength: 0 maxLength: 40 description: description: Description of the Master code. $ref: '#/components/schemas/translationTextType2000' displayOrder: description: Common Master record sequence number. type: number inactive: description: Indicates the Activity Results is inactive or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' autoTraceOwnerAssignmentListType: type: array description: Detailed information of trace owner assignment. maxItems: 4000 items: $ref: '#/components/schemas/autoTraceOwnerAssignmentType' codeListType10: type: array maxItems: 10 items: type: string minLength: 0 maxLength: 20 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 codeListType: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 autoTraceDefinitionsDetails: type: object description: Response object after fetching Auto Trace Definitions. properties: autoTraceDefinitions: description: Collection of fetched Auto Trace Definitions. $ref: '#/components/schemas/autoTraceDefinitionListType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' instanceLink: type: object description: Metadata describing link description objects that MAY appear in the JSON instance representation. properties: href: description: URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true. type: string rel: description: Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile. type: string templated: description: Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false. type: boolean default: false method: description: HTTP method for requesting the target of the link. type: string enum: - GET - POST - PUT - DELETE - PATCH - OPTIONS - HEAD targetSchema: description: Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.. type: string operationId: description: The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply. type: string title: description: Exact copy of the "summary" field on the linked operation. type: string autoTraceId: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer autoTraceDefinitionActivityInfoType: type: object description: Activity Related Information of Auto Trace. properties: activityClass: description: Activity Class Information. $ref: '#/components/schemas/activityConfigClassType' activityTypeCode: description: Type for the Activity. type: string minLength: 0 maxLength: 20 purpose: description: Purpose for the Activity. type: string minLength: 0 maxLength: 100 activityStartTime: description: Start Time of the Activity. type: string activityStartDate: description: Start Date of the Activity.Input for this field is selected from the list. type: string daysFromActivityStartDate: description: Number of days from activity start date type: integer activityResultsConfigInfo: type: object description: Request object for creating/changing Activity Results Configuration. properties: activityResultsConfiguration: description: Activity Results Configuration to be created/changed. $ref: '#/components/schemas/activityResultsConfigListType' warnings: $ref: '#/components/schemas/warningsType' autoTraceOwnerAssignmentsStatus: type: object description: Response Body. properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' autoTraceCodesInfo: type: object description: Request object for creating/changing Auto Trace Codes. properties: autoTraceCodesConfig: description: Auto Trace Code details to be created/updated. $ref: '#/components/schemas/autoTraceCodesListType' warnings: $ref: '#/components/schemas/warningsType' autoTraceOwnerAssignmentsDetails: type: object description: Response object to fetch trace owner assignments. properties: autoTraceOwnerAssignments: description: Collection of fetched trace owner assignments. $ref: '#/components/schemas/autoTraceOwnerAssignmentListType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' autoTraceCodesDetails: type: object description: Response object to fetch Auto Trace Codes. properties: autoTraceCodesConfig: description: Collection of fetched Auto Trace Codes. $ref: '#/components/schemas/autoTraceCodesListType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' autoTraceDefinitionsInfo: type: object description: Request object for creating/changing Auto Trace Definitions. properties: autoTraceDefinitions: description: Auto Trace Definition details to be created/updated. $ref: '#/components/schemas/autoTraceDefinitionListType' warnings: $ref: '#/components/schemas/warningsType' status: type: object description: Response Body. properties: warnings: $ref: '#/components/schemas/warningsType' links: $ref: '#/components/schemas/links' autoTraceDefinitionOwnerInfoType: type: object description: Owner Information of Auto Trace. properties: ownerofActivity: description: Owner of Auto Trace $ref: '#/components/schemas/activityOwnerType' customOwnerCode: description: Custom owner code type: string minLength: 0 maxLength: 20 ownerAssignmentExist: description: Indicates if Owner Assignment exists type: boolean ownerAssignment: description: Owner Assignment Information $ref: '#/components/schemas/autoTraceOwnerAssignmentListType' activityResultsConfigDetails: type: object description: Response object for fetching configured Activity Results. properties: activityResultsConfiguration: description: Collection of configured Activity Results. $ref: '#/components/schemas/activityResultsConfigListType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' autoTraceDefinitionCopy: type: object description: Request object for copying trace definition. properties: criteria: description: Criteria for copying trace definitions. $ref: '#/components/schemas/copyAutoTraceDefinitionCriteriaType' warnings: $ref: '#/components/schemas/warningsType' autoTraceDefinitionDetailType: type: object description: Auto Trace Definition detail information. properties: autoTraceId: description: Trace ID. $ref: '#/components/schemas/autoTraceId' hotelId: description: The hotel code where the Auto Trace should be created. type: string minLength: 0 maxLength: 20 traceCode: description: Trace code type: string minLength: 0 maxLength: 20 traceGroup: description: Trace Group. $ref: '#/components/schemas/autoTraceGroupConfigType' autoTraceBlockCategory: description: Additional Block information $ref: '#/components/schemas/autoTraceBlockCategoryType' autoTraceTrigger: description: Element to hold information on when auto trace would be created. $ref: '#/components/schemas/autoTraceTriggerCategoryType' fieldNameOnUpdate: description: Element to hold column name of relevant table on selection of Update in AutoTraceTriggerCategoryType. type: string fieldNameOnUpdateId: description: Element to hold column ID of relevant table on selection of Update in AutoTraceTriggerCategoryType. type: string conditions: description: Conditions for trace. $ref: '#/components/schemas/conditionGroupType' 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 autoTraceCodesListType: type: array description: Detailed information of configured Auto Trace Codes. maxItems: 4000 items: $ref: '#/components/schemas/autoTraceCodeDetailType' autoTraceDefinitionListType: type: array description: Auto Trace Definition. maxItems: 4000 items: $ref: '#/components/schemas/autoTraceDefinitionType' conditionType: type: object properties: leftExpression: $ref: '#/components/schemas/expressionFieldType' operator: $ref: '#/components/schemas/expressionOperatorType' rightExpression: $ref: '#/components/schemas/expressionParameterType' logicalOperator: $ref: '#/components/schemas/logicalOperatorType' expressionFieldType: type: object properties: fieldName: type: string minLength: 0 maxLength: 40 fieldDescription: type: string minLength: 0 maxLength: 40 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 activityTypesConfigCopy: type: object properties: criteria: description: Criteria for copying activity types. $ref: '#/components/schemas/copyActivityConfigCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' 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' autoTraceDefinitionsStatus: type: object description: Response Body. properties: links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' autoTraceCodeDetailType: type: object description: Auto Trace Code detail information. properties: traceCode: description: Trace Code. type: string minLength: 0 maxLength: 20 description: description: Description for the Trace Code. type: string minLength: 0 maxLength: 100 traceGroup: description: Trace Group for the Code. $ref: '#/components/schemas/autoTraceGroupConfigType' managedBy: $ref: '#/components/schemas/managedByOptions' autoTraceGroupConfigType: type: string description: A collection of supported list of Auto Trace Groups. enum: - Accounts - Contacts - Blocks - Activities uniqueIDListType: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' operaVersionNumberType: type: string description: Current Opera Version Number minLength: 0 maxLength: 40 activityOwnerType: type: string description: Activity owner. enum: - Current - Primary - Custom - Block - Room - Catering 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. 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 expressionOperatorType: type: object properties: operatorName: type: string minLength: 0 maxLength: 40 operatorDescription: type: string minLength: 0 maxLength: 40 parameterSize: type: number autoTraceDefinitionType: type: object description: Auto Trace Definition information. properties: autoTraceDefinitionDetail: description: Auto Trace Definition detail information. $ref: '#/components/schemas/autoTraceDefinitionDetailType' autoTraceDefinitionActivityInfo: description: Details of Activity Information associated with Auto Trace Definition. $ref: '#/components/schemas/autoTraceDefinitionActivityInfoType' autoTraceDefinitionOwnerInfo: description: Details of Owner Information associated with Auto Trace Definition. $ref: '#/components/schemas/autoTraceDefinitionOwnerInfoType' inactive: description: Determines whether to fetch inactive records or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' code: description: This type holds code of AutoTraceDefinition. type: string minLength: 0 maxLength: 20 autoTraceOwnerAssignmentsInfo: type: object description: Request object for creating/changing trace owner assignments. properties: autoTraceOwnerAssignments: description: Trace owner assignments to be created/updated. $ref: '#/components/schemas/autoTraceOwnerAssignmentListType' warnings: $ref: '#/components/schemas/warningsType' autoTraceOwnerAssignmentType: type: object description: Trace owner assignment detail information. properties: autoTraceOwnerAssignmentId: description: Trace Owner Assignment ID. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: The hotel code where trace owner assignments are created. type: string minLength: 0 maxLength: 20 ownerCode: description: Owner code of trace owner assignment. type: string minLength: 0 maxLength: 20 ownerName: description: Owner name of trace owner assignment. type: string traceOwnerCode: description: Trace Owner code of trace owner assignment. type: string minLength: 0 maxLength: 20 traceOwnerName: description: Trace Owner name of trace owner assignment. type: string managedBy: $ref: '#/components/schemas/managedByOptions' activityResultsConfigListType: type: array description: List of configured Activity Results. maxItems: 4000 items: $ref: '#/components/schemas/activityResultsConfigDetailType' operaVersion: type: object description: Response for Ping operation. properties: operaVersion: description: Opera version number. $ref: '#/components/schemas/operaVersionNumberType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' links: type: array items: $ref: '#/components/schemas/instanceLink' autoTraceBlockCategoryType: type: string description: Additional Block information used to trigger activities. enum: - Deposits - Details parameters: x-hotelid: name: x-hotelid description: Mandatory parameter to identify the hotel code where the end user is logged in in: header required: true schema: type: string authKey: name: authorization description: Bearer token that needs to be passed which is generated post user authentication in: header required: true schema: type: string externalData: name: externalData description: Pass this header as true, if payload needs DVM in: header schema: type: string Accept-Language: name: Accept-Language description: Language code in: header schema: type: string x-app-key: name: x-app-key description: Client or Partner's Application Key in: header required: true schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$ x-externalsystem: name: x-externalsystem description: External system code. in: header x-example: EXTERNALSYSTEMCODE schema: type: string maxLength: 40 x-originating-application: name: x-originating-application description: Customer's Integration Application Id in: header schema: type: string x-request-id: name: x-request-id description: Request Id of an incoming request in: header schema: type: string pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} responses: '406': description: Not acceptable. '414': description: Request URI Too Large '503': description: Service Unavailable '413': description: Request Entity Too Large '500': description: System Error content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '502': description: Bad Gateway '403': description: Forbidden '415': description: Unsupported Media Type '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '401': description: Unauthorized '405': description: Method not allowed externalDocs: description: Find out more about Oracle Hospitality url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html