{ "swagger": "2.0", "info": { "title": "OPERA Cloud Activity Management API", "description": "APIs to cater for Activity Configuration functionality in OPERA Cloud. In this module you can retrieve, create, update Activity configuration codes, for example create a new Activity Type.

Compatible with OPERA Cloud release 26.2.0.0.

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



Compatible with OPERA Cloud release 20.99.99.99.

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" } }, "schemes": [ "https" ], "basePath": "/act/config/v1", "produces": [ "application/json" ], "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.", "type": "integer" }, { "name": "offset", "in": "query", "default": 0, "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.", "type": "integer" }, { "name": "fetchInactive", "in": "query", "required": false, "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { "name": "codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "description", "in": "query", "required": false, "description": "Description of the code.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching configured Activity Results.", "schema": { "$ref": "#/definitions/activityResultsConfigDetails" } }, "204": { "description": "ActivityResultsConfig not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "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": [ { "name": "activityResultsConfigInfo", "in": "body", "required": true, "description": "Request object for creating Activity Results Configuration.", "schema": { "allOf": [ { "$ref": "#/definitions/activityResultsConfigInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Activity Result Code." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Activity Result Code." }, { "name": "activityResultsConfigInfo", "in": "body", "required": true, "description": "Request object for changing Activity Results Configuration.", "schema": { "allOf": [ { "$ref": "#/definitions/activityResultsConfigInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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.", "type": "integer" }, { "name": "offset", "in": "query", "default": 0, "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.", "type": "integer" }, { "name": "codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "autoTraceGroups", "in": "query", "type": "array", "collectionFormat": "multi", "description": "A collection of supported list of Auto Trace Groups.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Accounts", "Contacts", "Blocks", "Activities" ] }, "required": false }, { "name": "description", "in": "query", "required": false, "description": "Description for the Trace Code to be searched for.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object to fetch Auto Trace Codes.", "schema": { "$ref": "#/definitions/autoTraceCodesDetails" } }, "204": { "description": "AutoTraceCodes not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] }, "post": { "summary": "Create an Auto Trace code", "description": "Create an Auto trace code.

OperationId:postAutoTraceCodes

", "operationId": "postAutoTraceCodes", "parameters": [ { "name": "autoTraceCodesInfo", "in": "body", "required": true, "description": "Request object for creating Auto Trace Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/autoTraceCodesInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique code of trace." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique code of trace." }, { "name": "autoTraceCodesInfo", "in": "body", "required": true, "description": "Request object for changing Auto Trace Codes.", "schema": { "allOf": [ { "$ref": "#/definitions/autoTraceCodesInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of trace." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of trace owner." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of the source hotel." }, { "name": "activityTypesConfigCopy", "in": "body", "required": true, "schema": { "allOf": [ { "$ref": "#/definitions/activityTypesConfigCopy" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "autoTraceDefinitionCopy", "in": "body", "required": true, "description": "Request object for copying trace definition.", "schema": { "allOf": [ { "$ref": "#/definitions/autoTraceDefinitionCopy" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "offset", "in": "query", "default": 0, "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.", "type": "integer" }, { "name": "activityType", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "description", "in": "query", "required": false, "description": "Description for the activity type is to be searched for.", "type": "string" }, { "name": "inactive", "in": "query", "required": false, "description": "Determines whether to fetch inactive records or not.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object after fetching the activity types.", "schema": { "$ref": "#/definitions/activityTypesConfigDetails" } }, "204": { "description": "ActivityTypes not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "activityTypesConfigInfo", "in": "body", "required": true, "description": "Request object for creating activity types.", "schema": { "allOf": [ { "$ref": "#/definitions/activityTypesConfigInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Activity Type Code." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Activity Type Code." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "activityTypesConfigInfo", "in": "body", "required": true, "description": "Request object for changing activity types.", "schema": { "allOf": [ { "$ref": "#/definitions/activityTypesConfigInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "offset", "in": "query", "default": 0, "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.", "type": "integer" }, { "name": "codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "autoTraceGroups", "in": "query", "type": "array", "collectionFormat": "multi", "description": "A collection of supported list of Auto Trace Groups.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Accounts", "Contacts", "Blocks", "Activities" ] }, "required": false }, { "name": "inactive", "in": "query", "required": false, "description": "Determines whether to fetch inactive records or not.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object after fetching Auto Trace Definitions.", "schema": { "$ref": "#/definitions/autoTraceDefinitionsDetails" } }, "204": { "description": "AutoTraceDefinitions not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "autoTraceDefinitionsInfo", "in": "body", "required": true, "description": "Request object for creating Auto Trace Definitions.", "schema": { "allOf": [ { "$ref": "#/definitions/autoTraceDefinitionsInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of trace." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "autoTraceDefinitionsInfo", "in": "body", "required": true, "description": "Request object for changing Auto Trace Definitions.", "schema": { "allOf": [ { "$ref": "#/definitions/autoTraceDefinitionsInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/autoTraceDefinitionsStatus" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "offset", "in": "query", "default": 0, "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.", "type": "integer" }, { "name": "codes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "traceOwnerCodes", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object to fetch trace owner assignments.", "schema": { "$ref": "#/definitions/autoTraceOwnerAssignmentsDetails" } }, "204": { "description": "AutoTraceOwnerAssignments not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "autoTraceOwnerAssignmentsInfo", "in": "body", "required": true, "description": "Request object for creating trace owner assignments.", "schema": { "allOf": [ { "$ref": "#/definitions/autoTraceOwnerAssignmentsInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of trace owner." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "autoTraceOwnerAssignmentsInfo", "in": "body", "required": true, "description": "Request object for changing trace owner assignments.", "schema": { "allOf": [ { "$ref": "#/definitions/autoTraceOwnerAssignmentsInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/autoTraceOwnerAssignmentsStatus" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/services/activityManagement/status": { "get": { "summary": "Operation to ping.", "description": "

OperationId:pingActivityManagementServices

", "operationId": "pingActivityManagementServices", "parameters": [ { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for Ping operation.", "schema": { "$ref": "#/definitions/operaVersion" } }, "204": { "description": "pingActivityManagementServices not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "autoTraceDefinitionsInfo", "in": "body", "required": true, "description": "Request object for changing Auto Trace Definitions.", "schema": { "allOf": [ { "$ref": "#/definitions/autoTraceDefinitionsInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/autoTraceDefinitionsStatus" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } }, "/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, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID of hotel." }, { "name": "autoTraceOwnerAssignmentsInfo", "in": "body", "required": true, "description": "Request object for changing trace owner assignments.", "schema": { "allOf": [ { "$ref": "#/definitions/autoTraceOwnerAssignmentsInfo" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/autoTraceOwnerAssignmentsStatus" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "ActivityManagement" ] } } }, "parameters": { "externalData": { "name": "externalData", "type": "string", "description": "Pass this header as true, if payload needs DVM", "in": "header" }, "authKey": { "name": "authorization", "description": "Bearer token that needs to be passed which is generated post user authentication", "type": "string", "in": "header", "required": true }, "x-app-key": { "name": "x-app-key", "description": "Client or Partner's Application Key", "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}$", "in": "header", "required": true }, "x-request-id": { "name": "x-request-id", "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}", "description": "Request Id of an incoming request", "in": "header" }, "x-originating-application": { "name": "x-originating-application", "type": "string", "description": "Customer's Integration Application Id", "in": "header" }, "x-hotelid": { "name": "x-hotelid", "type": "string", "description": "Mandatory parameter to identify the hotel code where the end user is logged in", "in": "header", "required": true }, "x-externalsystem": { "name": "x-externalsystem", "type": "string", "maxLength": 40, "description": "External system code.", "in": "header", "x-example": "EXTERNALSYSTEMCODE" }, "Accept-Language": { "name": "Accept-Language", "type": "string", "description": "Language code", "in": "header" }, "x-hubid": { "name": "x-hubid", "type": "string", "description": "x-hubid is a logical grouping of multiple properties that allows api consumers to manage data from a group of properties. This x-hubid is a valid list of hub codes configured in OPERA to which the user has access. Rest APIs without hotelId in the operation path can support hub level integration using x-hubid", "in": "header" } }, "responses": { "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "405": { "description": "Method not allowed" }, "406": { "description": "Not acceptable." }, "413": { "description": "Request Entity Too Large" }, "414": { "description": "Request URI Too Large" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "System Error", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "definitions": { "activityResultsConfigDetails": { "type": "object", "description": "Response object for fetching configured Activity Results.", "properties": { "activityResultsConfiguration": { "description": "Collection of configured Activity Results.", "$ref": "#/definitions/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": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "activityResultsConfigListType": { "type": "array", "description": "List of configured Activity Results.", "maxItems": 4000, "items": { "$ref": "#/definitions/activityResultsConfigDetailType" } }, "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": "#/definitions/translationTextType2000" }, "displayOrder": { "description": "Common Master record sequence number.", "type": "number" }, "inactive": { "description": "Indicates the Activity Results is inactive or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "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": "#/definitions/translationsTextType" } } }, "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." } }, "links": { "type": "array", "items": { "$ref": "#/definitions/instanceLink" } }, "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" } } }, "warningsType": { "type": "array", "description": "Used in conjunction with the Success element to define a business error.", "maxItems": 4000, "items": { "$ref": "#/definitions/warningType" } }, "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": "#/definitions/errorInstance" } }, "links": { "$ref": "#/definitions/links" } }, "required": [ "type", "title" ] }, "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" ] }, "activityResultsConfigInfo": { "type": "object", "description": "Request object for creating/changing Activity Results Configuration.", "properties": { "activityResultsConfiguration": { "description": "Activity Results Configuration to be created/changed.", "$ref": "#/definitions/activityResultsConfigListType" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "status": { "type": "object", "description": "Response Body.", "properties": { "warnings": { "$ref": "#/definitions/warningsType" }, "links": { "$ref": "#/definitions/links" } } }, "autoTraceCodesDetails": { "type": "object", "description": "Response object to fetch Auto Trace Codes.", "properties": { "autoTraceCodesConfig": { "description": "Collection of fetched Auto Trace Codes.", "$ref": "#/definitions/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": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "autoTraceCodesListType": { "type": "array", "description": "Detailed information of configured Auto Trace Codes.", "maxItems": 4000, "items": { "$ref": "#/definitions/autoTraceCodeDetailType" } }, "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": "#/definitions/autoTraceGroupConfigType" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "autoTraceGroupConfigType": { "type": "string", "description": "A collection of supported list of Auto Trace Groups.", "enum": [ "Accounts", "Contacts", "Blocks", "Activities" ] }, "autoTraceCodesInfo": { "type": "object", "description": "Request object for creating/changing Auto Trace Codes.", "properties": { "autoTraceCodesConfig": { "description": "Auto Trace Code details to be created/updated.", "$ref": "#/definitions/autoTraceCodesListType" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "activityTypesConfigCopy": { "type": "object", "properties": { "criteria": { "description": "Criteria for copying activity types.", "$ref": "#/definitions/copyActivityConfigCriteriaType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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": "#/definitions/codeListType" }, "targetHotelCode": { "description": "The hotel code(s) where the activity type should be copied to.", "$ref": "#/definitions/codeListType10" } } } } }, "codeListType": { "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "codeListType10": { "type": "array", "maxItems": 10, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "autoTraceDefinitionCopy": { "type": "object", "description": "Request object for copying trace definition.", "properties": { "criteria": { "description": "Criteria for copying trace definitions.", "$ref": "#/definitions/copyAutoTraceDefinitionCriteriaType" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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": "#/definitions/uniqueIDListType" }, "targetHotelCode": { "description": "The hotel code(s) where the activity type should be copied to.", "$ref": "#/definitions/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" } } } } } } }, "uniqueIDListType": { "type": "array", "description": "Unique Id that references an object uniquely in the system.", "maxItems": 4000, "items": { "$ref": "#/definitions/uniqueID_Type" } }, "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 } } }, "activityTypesConfigDetails": { "type": "object", "description": "Response object after fetching the activity types.", "properties": { "activityConfigTypes": { "description": "Collection of fetched activity types.", "$ref": "#/definitions/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": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "activityConfigListType": { "type": "array", "description": "Detailed information of activity type.", "maxItems": 4000, "items": { "$ref": "#/definitions/activityConfigTypeDetailType" } }, "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": "#/definitions/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": "#/definitions/managedByOptions" } } }, "activityConfigClassType": { "type": "string", "description": "A collection of supported list of activity classes.", "enum": [ "Appointment", "Todo" ] }, "activityTypesConfigInfo": { "type": "object", "description": "Request object for creating/changing activity types.", "properties": { "activityConfigTypes": { "description": "Activity type details to be created/updated.", "$ref": "#/definitions/activityConfigListType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "autoTraceDefinitionsDetails": { "type": "object", "description": "Response object after fetching Auto Trace Definitions.", "properties": { "autoTraceDefinitions": { "description": "Collection of fetched Auto Trace Definitions.", "$ref": "#/definitions/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": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "autoTraceDefinitionListType": { "type": "array", "description": "Auto Trace Definition.", "maxItems": 4000, "items": { "$ref": "#/definitions/autoTraceDefinitionType" } }, "autoTraceDefinitionType": { "type": "object", "description": "Auto Trace Definition information.", "properties": { "autoTraceDefinitionDetail": { "description": "Auto Trace Definition detail information.", "$ref": "#/definitions/autoTraceDefinitionDetailType" }, "autoTraceDefinitionActivityInfo": { "description": "Details of Activity Information associated with Auto Trace Definition.", "$ref": "#/definitions/autoTraceDefinitionActivityInfoType" }, "autoTraceDefinitionOwnerInfo": { "description": "Details of Owner Information associated with Auto Trace Definition.", "$ref": "#/definitions/autoTraceDefinitionOwnerInfoType" }, "inactive": { "description": "Determines whether to fetch inactive records or not.", "type": "boolean" }, "managedBy": { "$ref": "#/definitions/managedByOptions" }, "code": { "description": "This type holds code of AutoTraceDefinition.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "autoTraceDefinitionDetailType": { "type": "object", "description": "Auto Trace Definition detail information.", "properties": { "autoTraceId": { "description": "Trace ID.", "$ref": "#/definitions/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": "#/definitions/autoTraceGroupConfigType" }, "autoTraceBlockCategory": { "description": "Additional Block information", "$ref": "#/definitions/autoTraceBlockCategoryType" }, "autoTraceTrigger": { "description": "Element to hold information on when auto trace would be created.", "$ref": "#/definitions/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": "#/definitions/conditionGroupType" } } }, "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" } } }, "autoTraceBlockCategoryType": { "type": "string", "description": "Additional Block information used to trigger activities.", "enum": [ "Deposits", "Details" ] }, "autoTraceTriggerCategoryType": { "type": "string", "description": "Contains information on when auto trace would be created.", "enum": [ "Create", "Update", "Delete" ] }, "conditionGroupType": { "type": "object", "properties": { "condition": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/conditionType" } }, "conditionGroup": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/conditionGroupType" } }, "logicalOperator": { "$ref": "#/definitions/logicalOperatorType" } } }, "conditionType": { "type": "object", "properties": { "leftExpression": { "$ref": "#/definitions/expressionFieldType" }, "operator": { "$ref": "#/definitions/expressionOperatorType" }, "rightExpression": { "$ref": "#/definitions/expressionParameterType" }, "logicalOperator": { "$ref": "#/definitions/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 } } }, "expressionOperatorType": { "type": "object", "properties": { "operatorName": { "type": "string", "minLength": 0, "maxLength": 40 }, "operatorDescription": { "type": "string", "minLength": 0, "maxLength": 40 }, "parameterSize": { "type": "number" } } }, "expressionParameterType": { "type": "object", "properties": { "parameter": { "type": "array", "maxItems": 3, "items": { "type": "string", "minLength": 0, "maxLength": 40 } }, "functionIdOne": { "type": "number" }, "functionIdTwo": { "type": "number" } } }, "logicalOperatorType": { "type": "string", "enum": [ "And", "Or" ] }, "autoTraceDefinitionActivityInfoType": { "type": "object", "description": "Activity Related Information of Auto Trace.", "properties": { "activityClass": { "description": "Activity Class Information.", "$ref": "#/definitions/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" } } }, "autoTraceDefinitionOwnerInfoType": { "type": "object", "description": "Owner Information of Auto Trace.", "properties": { "ownerofActivity": { "description": "Owner of Auto Trace", "$ref": "#/definitions/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": "#/definitions/autoTraceOwnerAssignmentListType" } } }, "activityOwnerType": { "type": "string", "description": "Activity owner.", "enum": [ "Current", "Primary", "Custom", "Block", "Room", "Catering" ] }, "autoTraceOwnerAssignmentListType": { "type": "array", "description": "Detailed information of trace owner assignment.", "maxItems": 4000, "items": { "$ref": "#/definitions/autoTraceOwnerAssignmentType" } }, "autoTraceOwnerAssignmentType": { "type": "object", "description": "Trace owner assignment detail information.", "properties": { "autoTraceOwnerAssignmentId": { "description": "Trace Owner Assignment ID.", "$ref": "#/definitions/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": "#/definitions/managedByOptions" } } }, "autoTraceDefinitionsInfo": { "type": "object", "description": "Request object for creating/changing Auto Trace Definitions.", "properties": { "autoTraceDefinitions": { "description": "Auto Trace Definition details to be created/updated.", "$ref": "#/definitions/autoTraceDefinitionListType" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "autoTraceDefinitionsStatus": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "autoTraceOwnerAssignmentsDetails": { "type": "object", "description": "Response object to fetch trace owner assignments.", "properties": { "autoTraceOwnerAssignments": { "description": "Collection of fetched trace owner assignments.", "$ref": "#/definitions/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": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "autoTraceOwnerAssignmentsInfo": { "type": "object", "description": "Request object for creating/changing trace owner assignments.", "properties": { "autoTraceOwnerAssignments": { "description": "Trace owner assignments to be created/updated.", "$ref": "#/definitions/autoTraceOwnerAssignmentListType" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "autoTraceOwnerAssignmentsStatus": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "operaVersionNumberType": { "type": "string", "description": "Current Opera Version Number", "minLength": 0, "maxLength": 40 }, "operaVersion": { "type": "object", "description": "Response for Ping operation.", "properties": { "operaVersion": { "description": "Opera version number.", "$ref": "#/definitions/operaVersionNumberType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "managedByOptions": { "description": "Describes of the Configuration is Managed by Enterprise or Property.", "type": "string", "enum": [ "EnterpriseManaged", "PropertyManaged", "EnterpriseEnforced", "PropertyOverridden" ] } }, "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." } ], "externalDocs": { "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } }