diff --git a/rest-api-specs/property/act.json b/rest-api-specs/property/act.json index 8a2189a..e3cbbdc 100644 --- a/rest-api-specs/property/act.json +++ b/rest-api-specs/property/act.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Activity API", - "description": "APIs to cater for Sales Activity functionality in OPERA Cloud.

Activities provide you with an account management tool for managing daily tasks such as appointments, sales calls, contact follow-up, and so on.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Sales Activity functionality in OPERA Cloud.

Activities provide you with an account management tool for managing daily tasks such as appointments, sales calls, contact follow-up, and so on.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -551,6 +551,106 @@ "tags": [ "Activity" ] + }, + "put": { + "summary": "Operation to update multiple activities", + "description": "You can use this API to bulk update activities

OperationId:putBulkActivities

", + "operationId": "putBulkActivities", + "parameters": [ + { + "name": "putBulkActivities", + "in": "body", + "required": true, + "description": "Request object that will Change a list of activities.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/activitiesBulkUpdate" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Status/Info of the processed activities.", + "schema": { + "$ref": "#/definitions/activitiesBulkUpdateStatus" + } + }, + "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": [ + "Activity" + ] } }, "/activities/activitiesCompletion": { @@ -6130,6 +6230,169 @@ "items": { "$ref": "#/definitions/activityId" } + }, + "activitiesBulkUpdate": { + "type": "object", + "description": "Request object that will Change a list of activities.", + "properties": { + "activitiesBulkUpdate": { + "description": "Activities information, that is going to be updated in batch.", + "$ref": "#/definitions/activitiesBulkUpdateType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "activitiesBulkUpdateType": { + "type": "object", + "description": "Collection of Activity Ids their details to be updated.", + "properties": { + "activityIdList": { + "type": "array", + "description": "Selected activities Unique identifier.", + "maxItems": 200, + "items": { + "$ref": "#/definitions/activityIdRecord" + } + }, + "skipProcessing": { + "description": "Boolean flag if True will skip processing activities", + "type": "boolean" + }, + "activityRec": { + "description": "Selected activities to be updated with these activity details.", + "$ref": "#/definitions/activityChanges" + } + } + }, + "activityChanges": { + "type": "object", + "description": "Activities details to be updated.", + "properties": { + "activityClass": { + "description": "Indicates the Activity Class.", + "$ref": "#/definitions/activityConfigClassType" + }, + "activityType": { + "description": "Indicates the Activity Type used for the Activity.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "activityPurpose": { + "description": "Indicates Purpose of the Activity.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "activityTraceCode": { + "description": "Activity Trace code used for the Activity.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "activityOwner": { + "description": "Owner of Activity.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "startDate": { + "description": "Start Date of Activity.", + "type": "string", + "format": "date" + }, + "startTime": { + "description": "Start time of the Activity.", + "type": "string" + }, + "endDate": { + "description": "End Date of Activity.", + "type": "string", + "format": "date" + }, + "endTime": { + "description": "End time of the Activity.", + "type": "string" + }, + "notes": { + "description": "Notes associated with an Activity.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "highPriority": { + "description": "Indicates whether Activity has a high priority.", + "type": "boolean" + }, + "activityAccount": { + "description": "The list of accounts associated with an activity.", + "$ref": "#/definitions/uniqueID_Type" + }, + "activityContact": { + "description": "The list of accounts associated with an activity.", + "$ref": "#/definitions/uniqueID_Type" + } + } + }, + "activityIdRecord": { + "type": "object", + "description": "Unique identifier for the Activity Record containing activity ID and activity property.", + "properties": { + "hotelId": { + "description": "Hotel code to which activity belongs", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "id": { + "description": "Unique ID belonging to the activity.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "activitiesBulkUpdateStatus": { + "type": "object", + "properties": { + "activitiesBulkUpdateStatusType": { + "description": "Status/Info of the processed activities.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/activitiesProcessedInfoType" + } + } + } + }, + "activitiesProcessedInfoType": { + "type": "object", + "description": "Status/Info of the processed activities.", + "properties": { + "activityIdRecord": { + "description": "The activity details which were not processed.", + "$ref": "#/definitions/activityIdRecord" + }, + "reason": { + "description": "Reason for not processing the activity.", + "type": "string" + }, + "processingInfoType": { + "description": "Flag to indicate the warning messages from the API", + "type": "string" + }, + "processingInfoCode": { + "description": "Erorr/Warning code for not processing the activity.", + "type": "string", + "minLength": 0, + "maxLength": 200 + } + } } }, "tags": [ diff --git a/rest-api-specs/property/actcfg.json b/rest-api-specs/property/actcfg.json index 3ad43ab..81ff8be 100644 --- a/rest-api-specs/property/actcfg.json +++ b/rest-api-specs/property/actcfg.json @@ -2,8 +2,8 @@ "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 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "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 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/ars.json b/rest-api-specs/property/ars.json index c45ba94..c462792 100644 --- a/rest-api-specs/property/ars.json +++ b/rest-api-specs/property/ars.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Accounts Receivables API", - "description": "APIs to cater for Accounts Receivables functionality in OPERA Cloud.


Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Accounts Receivables functionality in OPERA Cloud.


Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/blk.json b/rest-api-specs/property/blk.json index 6f8495f..d0230b3 100644 --- a/rest-api-specs/property/blk.json +++ b/rest-api-specs/property/blk.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Block API", - "description": "APIs to cater for Business Block functionality in OPERA Cloud.

A block is a group of rooms held for guests who are attending an event, meeting, or function. You can create blocks for family reunions, business conferences, weddings, and so on. You can also set aside rooms for the event (block).

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Business Block functionality in OPERA Cloud.

A block is a group of rooms held for guests who are attending an event, meeting, or function. You can create blocks for family reunions, business conferences, weddings, and so on. You can also set aside rooms for the event (block).

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -984,7 +984,8 @@ "Statistics", "SummaryStatistics", "Traces", - "WashSchedules" + "WashSchedules", + "IncludeSubBlocks" ] }, "required": false @@ -2142,6 +2143,7 @@ "summary": "Create alternate dates for a Block", "description": "Use this API to create alternate dates for a block.

OperationId:postAlternateDates

", "operationId": "postAlternateDates", + "deprecated": true, "parameters": [ { "name": "blockId", @@ -2251,6 +2253,7 @@ "summary": "Change alternate dates for a Block", "description": "Use this API to change alternate dates for a block.

OperationId:putAlternateDates

", "operationId": "putAlternateDates", + "deprecated": true, "parameters": [ { "name": "blockId", @@ -2360,6 +2363,7 @@ "summary": "Delete alternate dates for a Block", "description": "Use this API to delete alternate dates for a block.

OperationId:deleteAlternateDates

", "operationId": "deleteAlternateDates", + "deprecated": true, "parameters": [ { "name": "blockId", @@ -3265,6 +3269,7 @@ "summary": "Assign a Block owner", "description": "Use this API to assign block owners.

OperationId:postBlockOwners

", "operationId": "postBlockOwners", + "deprecated": true, "parameters": [ { "name": "blockId", @@ -3374,6 +3379,7 @@ "summary": "Delete a Block owner", "description": "Use this API to delete a block owner.

OperationId:deleteBlockOwners

", "operationId": "deleteBlockOwners", + "deprecated": true, "parameters": [ { "name": "blockId", @@ -3470,6 +3476,7 @@ "summary": "Change Block owners", "description": "Use this API to change block owners.

OperationId:putBlockOwners

", "operationId": "putBlockOwners", + "deprecated": true, "parameters": [ { "name": "blockId", @@ -19299,6 +19306,7 @@ "summary": "Set Contract Defaults", "description": "Use this API to set the contract defaults.

OperationId:putContractDefaults

", "operationId": "putContractDefaults", + "deprecated": true, "parameters": [ { "name": "blockStatus", @@ -19511,6 +19519,106 @@ "tags": [ "Block" ] + }, + "post": { + "summary": "Create default Block Code for Multiple blocks", + "description": "Use this API to retrieve a list of default block code for Multiple blocks based on template.

OperationId:getDefaultBlockCode

>", + "operationId": "postDefaultBlockCode", + "parameters": [ + { + "name": "blockDetails", + "in": "body", + "required": true, + "description": "Request object for generating default block code for multiple blocks.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/blockBasicInfos" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": { + "description": "Location of newly created resource", + "type": "string" + } + }, + "description": "Response object for generating default block code", + "schema": { + "$ref": "#/definitions/blockBasicInfos" + } + }, + "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": [ + "Block" + ] } }, "/hotels/{hotelId}/block": { @@ -23279,6 +23387,8 @@ "summary": "Cancel the Block", "description": "Use this API to complete a cancellation of the block.

OperationId:postCancelBlock

", "operationId": "postCancelBlock", + "deprecated": true, + "x-alternative": "/hotels/{hotelId}/blocks/{blockId}/status", "parameters": [ { "name": "blockId", @@ -31210,6 +31320,7 @@ "summary": "Borrow Inventory", "description": "Use this API to borrow inventory from the block or house when you encounter an insufficient number of rooms for block a reservation.

OperationId:putInventory

", "operationId": "putInventory", + "deprecated": true, "parameters": [ { "name": "inventoryToBorrow", @@ -31312,6 +31423,7 @@ "summary": "Return Borrowed Inventory", "description": "Use this API to return the previously borrowed inventory on the block back to the original source from which it was borrowed. The original source can be a room type or house inventory, as indicated in the request.

OperationId:putReleasedInventory

", "operationId": "putReleasedInventory", + "deprecated": true, "parameters": [ { "name": "borrowedInventoryToReturn", @@ -40172,6 +40284,10 @@ "description": "Indicates whether BoardInfo changes can be applied to all events of the block.", "type": "boolean" }, + "applyMoveEvents": { + "description": "Indicates whether catering event dates are moved when the block dates are changed.", + "type": "boolean" + }, "overrideEventsProcessingWarnings": { "description": "Indicates whether to ignore any warning during applying the changes to the events associated with the current block.", "type": "boolean" @@ -52240,6 +52356,15 @@ "description": "Information about the new block.", "$ref": "#/definitions/newBlockDetailsType" }, + "subBlocks": { + "type": "array", + "description": "Collection of sub block details that will be copied along with the source master block.", + "minItems": 0, + "maxItems": 4000, + "items": { + "$ref": "#/definitions/copySubBlockDetail" + } + }, "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", @@ -52339,6 +52464,10 @@ "eventForecastFigures": { "description": "Event forecast figures will be copied from the source to the events of the new Block.", "type": "boolean" + }, + "masterBlock": { + "description": "When true, Master block will be copied along with the sub blocks.", + "type": "boolean" } } }, @@ -55363,6 +55492,79 @@ "$ref": "#/definitions/hotelCodeListType" } } + }, + "blockBasicInfo": { + "type": "object", + "description": "Common Type used to store basic information of a block", + "properties": { + "blockName": { + "type": "string", + "description": "Name of the block. This is used for generating the default block code", + "minLength": 1 + }, + "startDate": { + "type": "string", + "format": "date", + "description": "Start date of the block. This is used for generatting the default block code" + }, + "hotelId": { + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Hotel where the block will be created" + }, + "blockCodeTemplate": { + "type": "string", + "description": "Format in which the Block Code should be generated.", + "maxLength": 20 + }, + "blockCode": { + "type": "string", + "maxLength": 20, + "description": "Response object that returns a default block code based on template" + } + } + }, + "blockBasicInfos": { + "type": "object", + "description": "Collection of basic block informatioin", + "properties": { + "blocks": { + "description": "Contains a collection of basic block information", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/blockBasicInfo" + } + } + } + }, + "copySubBlockDetail": { + "type": "object", + "description": "Details of sub blocks that will be copied along with the Source Master Block.", + "properties": { + "sourceSubBlockId": { + "description": "The unique identifier of the source sub block.", + "$ref": "#/definitions/uniqueID_Type" + }, + "startDate": { + "description": "The start date of the new sub block.", + "type": "string", + "format": "date" + }, + "hotelId": { + "description": "The hotel code of the new sub block.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "blockcode": { + "description": "The block code of the new sub block.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } } }, "tags": [ diff --git a/rest-api-specs/property/blkasync.json b/rest-api-specs/property/blkasync.json index b701d4b..bd20e11 100644 --- a/rest-api-specs/property/blkasync.json +++ b/rest-api-specs/property/blkasync.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Block Reservation Asynchronous API", - "description": "APIs to cater Block Reservation related asynchronous functionality in OPERA.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater Block Reservation related asynchronous functionality in OPERA.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -1111,6 +1111,372 @@ "BlockAsync" ] } + }, + "/hotels/{hotelId}/blocks/{blockId}/shift": { + "post": { + "summary": "Shifts the Block start date.", + "description": "Use this API to move or shift the dates of a block in OPERA.

OperationId:startShiftBlockProcess

", + "operationId": "startShiftBlockProcess", + "x-interaction": [ + "async-polling" + ], + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA." + }, + { + "name": "blockToShift", + "in": "body", + "required": true, + "description": "Request object to shift business block starting date.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/blockToShift" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "202": { + "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 process status resource" + } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/links" + } + }, + "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": [ + "BlockAsync" + ] + } + }, + "/hotels/{hotelId}/blocks/{blockId}/shift/{requestId}": { + "head": { + "summary": "This API returns the status of asynchronous process scheduled for given id.", + "description": "

OperationId:getShiftBlockProcessStatus

", + "operationId": "getShiftBlockProcessStatus", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA." + }, + { + "name": "requestId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$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" + }, + "Status": { + "type": "string", + "description": "Status of the requested process.", + "enum": [ + "Processing", + "Invalid" + ] + }, + "Cache-Control": { + "type": "string", + "description": "number of seconds to wait before polling again.", + "x-example": "max-age=10" + } + }, + "description": "Response for status of scheduled asynchronous process." + }, + "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" + }, + "Status": { + "type": "string", + "description": "Status of the requested process.", + "enum": [ + "Completed" + ] + }, + "Location": { + "type": "string", + "description": "Location of newly created resource once the status of process run is Complete." + } + }, + "description": "Response for status of scheduled asynchronous process." + }, + "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": [ + "BlockAsync" + ] + }, + "get": { + "summary": "This API returns information about the shift block process.", + "description": "This API will fetch shift Block warnings and errors to be returned as part of the response.

OperationId:getShiftBlockProcessInfo

", + "operationId": "getShiftBlockProcessInfo", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA." + }, + { + "name": "requestId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$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": "Callback request object for fetched shift block process information.", + "schema": { + "$ref": "#/definitions/processDetails" + } + }, + "204": { + "description": "Shift Block information 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": [ + "BlockAsync" + ] + } } }, "parameters": { @@ -2500,6 +2866,57 @@ "$ref": "#/definitions/warningsType" } } + }, + "shiftBlockCriteriaType": { + "type": "object", + "properties": { + "newStartDate": { + "description": "New start date of the business block.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "removeAlternateDates": { + "description": "When true, this will remove alternate dates for this block before shifting dates.", + "type": "boolean" + }, + "validateAlternateDates": { + "description": "When true, this will validate alternate dates for this block before shifting dates.", + "type": "boolean" + }, + "overbookAll": { + "description": "When true, this will overbook allocated rooms if needed.", + "type": "boolean" + }, + "validatePreAllocatedRooms": { + "description": "When true, this will validate if there are rooms pre-allocated before shifting the block dates.", + "type": "boolean" + }, + "validateTraces": { + "description": "When true, this will validate if there are active traces before shifting the block dates.", + "type": "boolean" + }, + "overrideEventsProcessingWarnings": { + "description": "Indicates whether to ignore any warning during applying the changes to the events associated with the current block.", + "type": "boolean" + } + } + }, + "blockToShift": { + "type": "object", + "description": "Request object to shift business block starting date.", + "properties": { + "criteria": { + "description": "Contains details of the block to be shifted along with the new start date to be applied.", + "$ref": "#/definitions/shiftBlockCriteriaType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/blkcfg.json b/rest-api-specs/property/blkcfg.json index dcbecad..faff00d 100644 --- a/rest-api-specs/property/blkcfg.json +++ b/rest-api-specs/property/blkcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Block Configuration API", - "description": "APIs for Block configuration, such as creating, updating, fetching and removing codes related to blocks.
< This might include fetching the block cancellation reasons, or creating new block refused reasons. Wash schedules can be create, or new reservation methods could be added for a property.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs for Block configuration, such as creating, updating, fetching and removing codes related to blocks.
< This might include fetching the block cancellation reasons, or creating new block refused reasons. Wash schedules can be create, or new reservation methods could be added for a property.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/bof.json b/rest-api-specs/property/bof.json index 6620589..1ef3ecb 100644 --- a/rest-api-specs/property/bof.json +++ b/rest-api-specs/property/bof.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Back Office Operations API", - "description": "APIs to cater for Back Office Operations functionality in OPERA Cloud.

A common BackOffice industry term is End of Day. This closes and balances each day's business activities. It reconciles guest folios and processes credit card transactions. The End of Day routine rolls the business date forward and prints final reports.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Back Office Operations functionality in OPERA Cloud.

A common BackOffice industry term is End of Day. This closes and balances each day's business activities. It reconciles guest folios and processes credit card transactions. The End of Day routine rolls the business date forward and prints final reports.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/chl.json b/rest-api-specs/property/chl.json index 87754da..729ed13 100644 --- a/rest-api-specs/property/chl.json +++ b/rest-api-specs/property/chl.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Channel Configuration API", - "description": "APIs to cater for Channel Management functionality in OPERA Cloud.

Channel Management allows a property to configure and administer channels such as OTAs, and web channels, covering functionality such as channel configuration, availability, inventory and restrictions.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Channel Management functionality in OPERA Cloud.

Channel Management allows a property to configure and administer channels such as OTAs, and web channels, covering functionality such as channel configuration, availability, inventory and restrictions.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -21610,6 +21610,10 @@ "description": "Indicates if Rate updates to Channel are allowed.", "type": "boolean" }, + "allowRatesToGds": { + "description": "Indicates if the rate is to be distributed to channels.", + "type": "boolean" + }, "allowRestrictionUpdate": { "description": "Indicates if Rate Restrictions are sent to an ADS, GDS, or ODS partner, such as Expedia, via the AVH messaging functionality.", "type": "boolean" diff --git a/rest-api-specs/property/cms.json b/rest-api-specs/property/cms.json index af6ac79..f291eea 100644 --- a/rest-api-specs/property/cms.json +++ b/rest-api-specs/property/cms.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud API for Customer Management Service", - "description": "This API deals with the different aspect of the CustomerManagement.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "This API deals with the different aspect of the CustomerManagement.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/crm.json b/rest-api-specs/property/crm.json index bd1bb14..1b373b9 100644 --- a/rest-api-specs/property/crm.json +++ b/rest-api-specs/property/crm.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Customer Relationship Management API", - "description": "APIs to cater for Customer Relationship Management (profile) functionality in OPERA Cloud. There are different types of profiles in OPERA Cloud, including Guest, Company, Travel Agent, Source, Group, and Contact profile types. A profile can store and display a wide range of information about the guest, company, travel agent etc., depending upon the type of profile. For example, a guest profile can store the guest name, address, contact information, details on billing, membership benefits, preferences and much more. All profiles in OPERA when created are assigned a ProfileID. This ID will be used throughout the CRM APIs.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Customer Relationship Management (profile) functionality in OPERA Cloud. There are different types of profiles in OPERA Cloud, including Guest, Company, Travel Agent, Source, Group, and Contact profile types. A profile can store and display a wide range of information about the guest, company, travel agent etc., depending upon the type of profile. For example, a guest profile can store the guest name, address, contact information, details on billing, membership benefits, preferences and much more. All profiles in OPERA when created are assigned a ProfileID. This ID will be used throughout the CRM APIs.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -1199,7 +1199,8 @@ "Profile", "Indicators", "SalesInfo", - "Relationship" + "Relationship", + "Subscriptions" ] }, "required": false @@ -4665,6 +4666,185 @@ } }, "/membershipPointsExceptions": { + "get": { + "summary": "Get membership points exception details", + "description": "Use this API to get membership points exceptions.

OperationId:getMembershipPointsExceptions


The maximum date Range supported between arrival and departure date is 90 days.", + "operationId": "getMembershipPointsExceptions", + "parameters": [ + { + "name": "hotelId", + "in": "query", + "minLength": 1, + "maxLength": 20, + "required": false, + "description": "Membership transaction belongs to which Hotel.", + "type": "string" + }, + { + "name": "profileId", + "in": "query", + "required": false, + "description": "Profile Id of the guest.", + "type": "number" + }, + { + "name": "arrivalFrom", + "in": "query", + "required": false, + "description": "Arrival From Date to fetch the reservations flagged for Membership Points Exception", + "type": "string", + "format": "date" + }, + { + "name": "departureTo", + "in": "query", + "required": false, + "description": "Departure To Date to fetch the reservation flagged for Membership Points Exception", + "type": "string", + "format": "date" + }, + { + "name": "membershipType", + "in": "query", + "required": false, + "description": "The type of the membership.", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "membershipLevel", + "in": "query", + "required": false, + "description": "The current level of the membership.", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "membershipCardNo", + "in": "query", + "required": false, + "description": "The card number associated with this membership.", + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + { + "name": "limit", + "in": "query", + "required": false, + "default": 20, + "maximum": 100, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" + }, + { + "name": "offset", + "in": "query", + "default": 1, + "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": "exceptionStatus", + "in": "query", + "required": true, + "type": "string", + "description": "Indicates the type of Exception like Exception not resolved,Points Rejected on Exception etc.,", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "AllExceptions", + "PointsAwardedOnException", + "PointsRejectedOnException", + "ExceptionNotResolved" + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 membership points exceptions.", + "schema": { + "$ref": "#/definitions/memberPointsExceptions" + } + }, + "204": { + "description": "MembershipPointsExceptions 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": [ + "ProfileMembership" + ] + }, "put": { "summary": "Update membership points exceptions", "description": "Use this API to update membership points exceptions.

OperationId:putMembershipPointsExceptions

", @@ -14297,6 +14477,7 @@ "summary": "Get membership transaction exception details", "description": "Use this API to get membership transaction exceptions on a profile.

OperationId:getMembershipTransactionExceptions

", "operationId": "getMembershipTransactionExceptions", + "deprecated": true, "parameters": [ { "name": "profileId", @@ -18086,282 +18267,61 @@ ] } }, - "/stagedProfiles": { + "/suspendedAddresses": { "get": { - "summary": "Get staged profiles", - "description": "The system suspends / stages a profile with a point value between the upper and lower thresholds. When a profile is staged, you must review the suspended profile and determine if it should be merged with an internal profile or added as a new profile.

OperationId:getStagedProfiles

", - "operationId": "getStagedProfiles", + "summary": "Fetch Suspended Profile Addresses", + "description": "Fetch Suspended Profile Addresses

OperationId:getSuspendedAddresses

", + "operationId": "getSuspendedAddresses", "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": "hotelIds", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "id", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "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.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "idContext", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "type", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "items": { - "type": "string" - }, - "required": false - }, { "name": "name", "in": "query", "required": false, - "description": "Family name, last name or Company Name.", - "type": "string" - }, - { - "name": "givenName", - "in": "query", - "required": false, - "description": "Given name, first name or names.", + "description": "Last Name of the Profile against which the Suspended Addresses are fetched.", "type": "string" }, { - "name": "region", + "name": "hotelId", "in": "query", "required": false, - "description": "The profile region for which the staged profiles shall be fetched.", + "description": "Hotel Code, It is used to filter hotel specific children to this specific hotel code.", "type": "string" }, { - "name": "countryCode", + "name": "firstName", "in": "query", "required": false, - "description": "Code for a country or a nationality.", + "description": "First Name of the Profile against which the Suspended Addresses are fetched.", "type": "string" }, { "name": "profileType", "in": "query", "required": false, - "description": "Profile type to be included in the search.", + "description": "ProfileT ype of the Profile against which the Suspended Addresses are fetched..", "type": "string" }, { - "name": "importDate", + "name": "matchCode", "in": "query", "required": false, - "description": "The date on which the staged profiles have been received.", - "type": "string", - "format": "date" + "description": "Match Code of the Address Validation Performed from the batch processing", + "type": "string" }, { - "name": "stageStatus", + "name": "countryCode", "in": "query", "required": false, - "description": "The status of the staged profiles.", + "description": "Code for a country or a nationality.", "type": "string" }, { - "name": "applyTo", + "name": "validateDate", "in": "query", "required": false, + "description": "Validate Date.", "type": "string", - "description": "Membership filter of staged profiles.", - "uniqueItems": true, - "enum": [ - "StagedProfiles", - "MatchingProfiles", - "StagedAndMatchingProfiles" - ] - }, - { - "name": "membershipCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$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 the staged profiles.", - "schema": { - "$ref": "#/definitions/stagedProfiles" - } - }, - "204": { - "description": "StagedProfiles 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": [ - "Profile" - ] - } - }, - "/suspendedAddresses": { - "get": { - "summary": "Fetch Suspended Profile Addresses", - "description": "Fetch Suspended Profile Addresses

OperationId:getSuspendedAddresses

", - "operationId": "getSuspendedAddresses", - "parameters": [ - { - "name": "name", - "in": "query", - "required": false, - "description": "Last Name of the Profile against which the Suspended Addresses are fetched.", - "type": "string" - }, - { - "name": "hotelId", - "in": "query", - "required": false, - "description": "Hotel Code, It is used to filter hotel specific children to this specific hotel code.", - "type": "string" - }, - { - "name": "firstName", - "in": "query", - "required": false, - "description": "First Name of the Profile against which the Suspended Addresses are fetched.", - "type": "string" - }, - { - "name": "profileType", - "in": "query", - "required": false, - "description": "ProfileT ype of the Profile against which the Suspended Addresses are fetched..", - "type": "string" - }, - { - "name": "matchCode", - "in": "query", - "required": false, - "description": "Match Code of the Address Validation Performed from the batch processing", - "type": "string" - }, - { - "name": "countryCode", - "in": "query", - "required": false, - "description": "Code for a country or a nationality.", - "type": "string" - }, - { - "name": "validateDate", - "in": "query", - "required": false, - "description": "Validate Date.", - "type": "string", - "format": "date" + "format": "date" }, { "$ref": "#/parameters/authKey" @@ -19312,7 +19272,7 @@ "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 25 }, "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.", @@ -37446,116 +37406,6 @@ } } }, - "stagedProfiles": { - "type": "object", - "description": "Response object for the staged profiles.", - "properties": { - "stagedProfiles": { - "description": "A collection of staged profiles.", - "$ref": "#/definitions/stagedProfileSummariesType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "stagedProfileSummariesType": { - "type": "object", - "description": "A collection of staged profiles.", - "properties": { - "profileInfo": { - "description": "Basic information about staged profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileSummaryType" - } - }, - "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" - } - } - }, - "stagedProfileSummaryType": { - "type": "object", - "description": "Basic information about staged profile.", - "properties": { - "hotelId": { - "description": "Hotel code associated with the staged profile.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "profileIdList": { - "description": "List of unique identifier of staged profile.", - "$ref": "#/definitions/uniqueIDListType" - }, - "profileName": { - "description": "Name information for the staged profile.", - "$ref": "#/definitions/profileNameType" - }, - "importDate": { - "description": "The date on which the staged profile has been received.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "profileType": { - "description": "Type of the staged profile.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "region": { - "description": "The region of the staged profile.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "country": { - "description": "The country of residence where the property is located that has received the staged profile.", - "$ref": "#/definitions/countryNameType" - }, - "stageStatus": { - "description": "The status of the staged profiles.", - "$ref": "#/definitions/stagedProfileStatus" - } - } - }, - "stagedProfileStatus": { - "type": "string", - "description": "Simple type for status of the staged profiles.", - "enum": [ - "Valid", - "Invalid", - "MatchFound", - "New" - ] - }, "suspendedAddresses": { "type": "object", "description": "Response object for fetching unique company profile.", @@ -38182,6 +38032,154 @@ "enum": [ "IMPORT_TAX_PERC" ] + }, + "memberPointsExceptionType": { + "type": "object", + "description": "Details about a membership like ProfileID, Card Number, Type, Level, etc.", + "properties": { + "hotelId": { + "description": "Hotel code of the membership transaction exceptions.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "profileId": { + "description": "The profile to which this membership is associated with.", + "$ref": "#/definitions/profileId" + }, + "name": { + "description": "The profile name associated with this membership.", + "type": "string" + }, + "fromToRangeDate": { + "description": "Arrival and Departure date of stay for which you are displaying membership transaction exceptions.", + "$ref": "#/definitions/dateRangeType" + }, + "membershipIdNo": { + "description": "Unique identifier of this membership.", + "type": "number" + }, + "membershipType": { + "description": "The type of the membership.", + "$ref": "#/definitions/codeDescriptionType" + }, + "membershipCardNo": { + "description": "The card number associated with this membership.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "membershipLevel": { + "description": "The current level of the membership.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "membershipTransactionId": { + "description": "Unique identifier associated with the membership transaction.", + "$ref": "#/definitions/membershipTransactionId" + }, + "roomsBooked": { + "description": "The number of rooms booked.(MR)", + "type": "integer" + }, + "backToBack": { + "description": "Indicates if back to back membership transaction exceptions have occurred or not.", + "type": "boolean" + }, + "averageRate": { + "description": "The average rate of the stay.", + "type": "number" + }, + "awardPoints": { + "description": "Award points associated with this membership points transaction.", + "type": "number" + }, + "tierNightPoints": { + "description": "Tier night points associated with this membership points transaction.", + "type": "number" + }, + "tierStayPoints": { + "description": "Tier stay points associated with this membership points transaction.", + "type": "number" + }, + "tierRevenuePoints": { + "description": "Tier revenue points associated with this membership points transaction.", + "type": "number" + }, + "pointsCalculate": { + "description": "Points Calculated value(Y/N) for the selected transaction.", + "type": "boolean" + }, + "reservationIdList": { + "description": "The reservation related ids.", + "$ref": "#/definitions/reservationIdList" + }, + "processingMessages": { + "description": "The systems records and notes identifying the exception criteria.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "exceptionStatus": { + "description": "Indicates the type of Exception like Exception not resolved,Points Rejected on Exception etc.,", + "$ref": "#/definitions/membershipExceptionStatusType" + } + } + }, + "memberPointsExceptions": { + "type": "object", + "description": "Response object for fetching membership points exceptions.", + "properties": { + "memberPointsExceptions": { + "type": "array", + "maxItems": 100, + "description": "A collection of membership points exceptions.", + "items": { + "$ref": "#/definitions/memberPointsExceptionType" + } + }, + "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" + } + } + }, + "membershipExceptionStatusType": { + "type": "string", + "description": "List of possible membership exception type.", + "enum": [ + "AllExceptions", + "PointsAwardedOnException", + "PointsRejectedOnException", + "ExceptionNotResolved" + ] } }, "tags": [ diff --git a/rest-api-specs/property/crmasync.json b/rest-api-specs/property/crmasync.json index a8d35a1..62c6e6d 100644 --- a/rest-api-specs/property/crmasync.json +++ b/rest-api-specs/property/crmasync.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud CRM Asynchronous API", - "description": "APIs to insert Stay Records related asynchronous functionality in OPERA.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to insert Stay Records related asynchronous functionality in OPERA.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/crmcfg.json b/rest-api-specs/property/crmcfg.json index f55d7dc..0f81258 100644 --- a/rest-api-specs/property/crmcfg.json +++ b/rest-api-specs/property/crmcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud CRM Configuration API", - "description": "APIs for Customer Relationship Management (profile) configuration, such as creating preferences, or address types. It also includes Membership Configuration, where you can retrieve membership levels that are configured for a property, or create new membership enrollment codes.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs for Customer Relationship Management (profile) configuration, such as creating preferences, or address types. It also includes Membership Configuration, where you can retrieve membership levels that are configured for a property, or create new membership enrollment codes.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -31196,7 +31196,7 @@ }, "membershipTypeRuleType": { "type": "string", - "description": "Membership Type/Program rule types.", + "description": "Membership Type/Program rule types, Points is the only valid value for non primary membership types.", "enum": [ "All", "Points", @@ -32139,8 +32139,8 @@ "description": "Criteria for detecting exceptions in points calculation", "properties": { "multipleRooms": { - "description": "Exception applied to multiple rooms.", - "$ref": "#/definitions/multipleRoomsType" + "description": "Enter the number of multiple rooms that should be flagged as an exception for same stay dates.", + "type": "integer" }, "bBSingleProperty": { "description": "Back to Back stay at a Single Property", @@ -32160,21 +32160,6 @@ } } }, - "multipleRoomsType": { - "type": "string", - "description": "Exception rule for 10 Rooms.", - "enum": [ - "Two", - "Three", - "Four", - "Five", - "Six", - "Seven", - "Eight", - "Nine", - "Ten" - ] - }, "tierPointsType": { "type": "object", "description": "Base parent type for membership points comprising common elements between award points and tier points.", diff --git a/rest-api-specs/property/csh.json b/rest-api-specs/property/csh.json index 860c764..6df31ad 100644 --- a/rest-api-specs/property/csh.json +++ b/rest-api-specs/property/csh.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Cashiering API", - "description": "APIs to cater for Cashiering related functionality in OPERA Cloud.

Cashiering provides access to a guest folio, posting journals, receipt histories, currency calculations, credit card settlements, and check a guest out.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Cashiering related functionality in OPERA Cloud.

Cashiering provides access to a guest folio, posting journals, receipt histories, currency calculations, credit card settlements, and check a guest out.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -8136,8 +8136,9 @@ "/hotels/{hotelId}/folio/{folioId}/convert": { "put": { "summary": "Convert Folio", - "description": "You can use this API to Convert folio.

OperationId:convertFolio

", + "description": "You can use this API to Convert folio.This API is deprecated. Please use putFolioType instead

OperationId:convertFolio

", "operationId": "convertFolio", + "deprecated": true, "parameters": [ { "name": "folioId", @@ -33483,6 +33484,10 @@ "upgradedByAI": { "description": "Represents the room was assigned by AI Room Assignment.", "type": "boolean" + }, + "backToBackSequence": { + "description": "This attribute represents Back To Back Sequence of Linked Reservations(e.g. '1,2' i.e, 1 indicates Sequence Position of total count 2). This is applicable when OPERA control Back to Back Handling for Linked Reservations is active.", + "$ref": "#/definitions/backToBackResSequenceType" } } }, @@ -37695,6 +37700,18 @@ "description": "Flag to check Folio Conversion Allowed.", "type": "boolean" }, + "isARAttached": { + "description": "Flag to check if the folio has an AR number attached.", + "type": "boolean" + }, + "isFiscalFolio": { + "description": "Flag to check if the folio type is fiscal or not.", + "type": "boolean" + }, + "creditBillGenerated": { + "description": "Flag which indicates whether credit folio has been generated.", + "type": "boolean" + }, "accountReceivablesFolio": { "description": "Flag to check Folio generated from Acoount Receivables.", "type": "boolean" @@ -46654,6 +46671,20 @@ "$ref": "#/definitions/warningsType" } } + }, + "backToBackResSequenceType": { + "type": "object", + "description": "Type object represents Back To Back Sequence Position and Total Count of Linked Back To Back Reservations ordered by consecutive Stay Dates.", + "properties": { + "position": { + "description": "Indicates the Sequence position of Back to Back Reservation.", + "type": "integer" + }, + "totalCount": { + "description": "Indicates the total count of Back To Back Reservations in the group of Linked Reservations.", + "type": "integer" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/dvm.json b/rest-api-specs/property/dvm.json index 5d41858..05fdaeb 100644 --- a/rest-api-specs/property/dvm.json +++ b/rest-api-specs/property/dvm.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud DataValueMapping Service API", - "description": "APIs which offer external systems to config and use values different than what are configured in opera

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs which offer external systems to config and use values different than what are configured in opera

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/entcfg.json b/rest-api-specs/property/entcfg.json index 055a92a..92d4a76 100644 --- a/rest-api-specs/property/entcfg.json +++ b/rest-api-specs/property/entcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Enterprise Configuration API", - "description": "APIs to cater for Enterprise Configuration functionality in OPERA Cloud.


Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Enterprise Configuration functionality in OPERA Cloud.


Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -28401,6 +28401,112 @@ ] } }, + "/operation": { + "get": { + "summary": "Fetch all operations", + "description": "This API will fetch all the operations wrt a code.

OperationId:getOperation

", + "operationId": "getOperation", + "parameters": [ + { + "name": "code", + "in": "query", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique code for a configuration." + }, + { + "name": "operation", + "in": "query", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Describing the type of operation a particular configuration supports" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "List of configurations added from central.", + "schema": { + "$ref": "#/definitions/operationResponse" + } + }, + "204": { + "description": "Central Configs 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": [ + "HotelConfig" + ] + } + }, "/parameters": { "get": { "summary": "Get OPERA Parameters", @@ -49416,6 +49522,43 @@ "description": "Status of the Configuation Item." } } + }, + "operationResponse": { + "type": "object", + "properties": { + "configs": { + "type": "array", + "description": "Collection of Operation Details", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/operation" + } + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "operation": { + "type": "object", + "description": "Type that holds Operation values", + "properties": { + "operation": { + "description": "Operations", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "code": { + "description": "Unique identifier of Configuation Item", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } } }, "tags": [ diff --git a/rest-api-specs/property/evm.json b/rest-api-specs/property/evm.json index d62e4db..0e99d8c 100644 --- a/rest-api-specs/property/evm.json +++ b/rest-api-specs/property/evm.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Sales Event Management API", - "description": "APIs to cater for Event Management functionality in OPERA Cloud.

The Events feature in OPERA Cloud is designed to manage any kind of catering activity. Events can be as simple as a one-hour reception or more complex, such as a three-day business meeting with meals, breaks, and specific meeting functionSpaceDetails with setupCode and resource requirements. Any group function can be an Event.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Event Management functionality in OPERA Cloud.

The Events feature in OPERA Cloud is designed to manage any kind of catering activity. Events can be as simple as a one-hour reception or more complex, such as a three-day business meeting with meals, breaks, and specific meeting functionSpaceDetails with setupCode and resource requirements. Any group function can be an Event.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/evmcfg.json b/rest-api-specs/property/evmcfg.json index d832509..de0a7b6 100644 --- a/rest-api-specs/property/evmcfg.json +++ b/rest-api-specs/property/evmcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Event Configuration API", - "description": "This API caters for Event Configuration in OPERA Cloud.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "This API caters for Event Configuration in OPERA Cloud.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/expcfg.json b/rest-api-specs/property/expcfg.json index 507c039..2ab264d 100644 --- a/rest-api-specs/property/expcfg.json +++ b/rest-api-specs/property/expcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Export Configuration API", - "description": "APIs catering to the managing export master data configuration.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs catering to the managing export master data configuration.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/fof.json b/rest-api-specs/property/fof.json index 65df6b7..d031cf8 100644 --- a/rest-api-specs/property/fof.json +++ b/rest-api-specs/property/fof.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Front Desk Operations Service", - "description": "APIs to cater for Front Desk Operations and Front Desk Statistic functionality in OPERA Cloud.

Front Desk features some of the most commonly used operations in OPERA Cloud, such as managing guest arrivals, managing in-house guests, and managing guest departures. Some additional tasks you can complete from the Front Desk menu are room searches, room assignments, and quick check outs as well as opening folios, creating registration cards, setting wake up calls, and sending messages to guests.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Front Desk Operations and Front Desk Statistic functionality in OPERA Cloud.

Front Desk features some of the most commonly used operations in OPERA Cloud, such as managing guest arrivals, managing in-house guests, and managing guest departures. Some additional tasks you can complete from the Front Desk menu are room searches, room assignments, and quick check outs as well as opening folios, creating registration cards, setting wake up calls, and sending messages to guests.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -4606,6 +4606,7 @@ "summary": "Requests room key(s)", "description": "API that manages requests for Door Lock Room Keys. This operation is used by OPERA Cloud PMS connected to external Door Lock Systems systems via Outbound Systems configuration: \n\nOPERA Cloud utilizes this operation \n\n- to request new or additional room keys - e.g. when guest checks in, or additional keys post check in.\n\n- to request to activate new keys after check on e.g. when a room key has been lost for a room.\n\n- to request a room key which is not related to a guest reservation but valid for a defined time - (for show rooms, repair) - One Shot Key.\n\n- to request to re-encode a key whereby other keys for this room remain active.\n\n- to request to read a key data from a room key and display it to the user in the PMS.\n\n- to request to modify existing key data - upon room move or change of departure date. (online key systems only!!)\n\n- to request to remove / delete a room key from a room on. Usually sent with check out of a reservation.\n\nUse this API to post a room key action to the active Door Lock System.\n\nNotes on keyType values:\n\nkeyType = New\n\nkeyType = Lost \n\nIt is expected that all previous active keys for the room will become invalid.\n\nIt is expected that partner system handles multiple keys being active in case numberOfKeys is >1.\n\nkeyType = Duplicate\n\nkeyType = ReEncode\n\nIt is expected that existing active keys for this room remain active.\n\nkeyType = OneShot\n\nIt is expected that the room key is only valid for a room for specific time (for maintenance or Show room).\n\nIt is never related to a reservation.\n\nkeyType = Read A request to the Key Card system to read Key Card information from requested Key Encoder/reader.\n\nThe Key Read functionality is of pure informational purpose. None of the received information is stored or processed in the PMS, and it is only for display to the user.\n\nkeyType = Remove\n\nIt is expected that with this request all active keys for a room or reservation will become inactive or invalid so they will not be able to open the room after defined validityEnd time.\n\nAdditional KeyType actions used by Online Door Lock Systems:\n\nOnline Key card Systems are systems which do not write guest data to the room key directly but do store guest data internally and send the information to the related door lock.\n\nkeyType = ModifyStay\n\nFor Online Door Lock Systems - Request to adjust Room key data when guest changes length of stay (validityEnd)\n\nkeyType = RoomMove\n\nFor Online Door Lock Systems - adjust Room key data when guest performs room move. \n\n

OperationId: postExternalRoomKeys

", "operationId": "postExternalRoomKeys", + "deprecated": true, "parameters": [ { "name": "hotelId", @@ -11287,7 +11288,7 @@ "name": "includeDueOut", "in": "query", "required": false, - "description": "This flag when set to true will include rooms assigned to due out reservations.", + "description": "This flag when set to true when include rooms assigned to due out reservations.", "type": "boolean" }, { @@ -14064,7 +14065,8 @@ "AuthorizationInfo", "ExcludeRoomSuggestion", "Keys", - "Voucher" + "Voucher", + "ScheduledRoomMoves" ] }, "required": false @@ -14893,6 +14895,113 @@ ] } }, + "/hotels/{hotelId}/roomKeysExternal": { + "post": { + "summary": "Requests room key(s)", + "description": "API that manages requests for Door Lock Room Keys. This operation is used by OPERA Cloud PMS connected to external Door Lock Systems systems via Outbound Systems configuration: \n\nOPERA Cloud utilizes this operation \n\n- to request new or additional room keys - e.g. when guest checks in, or additional keys post check in.\n\n- to request to activate new keys after check on e.g. when a room key has been lost for a room.\n\n- to request a room key which is not related to a guest reservation but valid for a defined time - (for show rooms, repair) - One Shot Key.\n\n- to request to re-encode a key whereby other keys for this room remain active.\n\n- to request to read a key data from a room key and display it to the user in the PMS.\n\n- to request to modify existing key data - upon room move or change of departure date. (online key systems only!!)\n\n- to request to remove / delete a room key from a room on. Usually sent with check out of a reservation.\n\nUse this API to post a room key action to the active Door Lock System.\n\nNotes on keyType values:\n\nkeyType = New\n\nkeyType = Lost \n\nIt is expected that all previous active keys for the room will become invalid.\n\nIt is expected that partner system handles multiple keys being active in case numberOfKeys is >1.\n\nkeyType = Duplicate\n\nkeyType = ReEncode\n\nIt is expected that existing active keys for this room remain active.\n\nkeyType = OneShot\n\nIt is expected that the room key is only valid for a room for specific time (for maintenance or Show room).\n\nIt is never related to a reservation.\n\nkeyType = Read A request to the Key Card system to read Key Card information from requested Key Encoder/reader.\n\nThe Key Read functionality is of pure informational purpose. None of the received information is stored or processed in the PMS, and it is only for display to the user.\n\nkeyType = Remove\n\nIt is expected that with this request all active keys for a room or reservation will become inactive or invalid so they will not be able to open the room after defined validityEnd time.\n\nAdditional KeyType actions used by Online Door Lock Systems:\n\nOnline Key card Systems are systems which do not write guest data to the room key directly but do store guest data internally and send the information to the related door lock.\n\nkeyType = ModifyStay\n\nFor Online Door Lock Systems - Request to adjust Room key data when guest changes length of stay (validityEnd)\n\nkeyType = RoomMove\n\nFor Online Door Lock Systems - adjust Room key data when guest performs room move. \n\n

OperationId: postRoomKeysExternal

", + "operationId": "postRoomKeysExternal", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel" + }, + { + "name": "roomKey", + "in": "body", + "required": true, + "description": "Request for generation of room key.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/roomKeysExternal" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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" + } + }, + "description": "Response from the active Door Locking System Property Interface to the post request.

Note on Response messages:\n\nIt is necessary to specify both the PMS 'encoderTerminal' and the Key Service system's coder (encoderId) in cases where more than one PMS workstation may be addressing one key coder. ORACLE PMS will NOT send another Request command automatically should a negative response be received. The user sees the response and decides if another try should be made.

", + "schema": { + "$ref": "#/definitions/roomKeysExternalDetails" + } + }, + "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": [ + "FrontDeskOperations" + ] + } + }, "/hotels/{hotelId}/roomStatusStatistics": { "get": { "summary": "Get counts of rooms by housekeeping status and front office status.", @@ -15337,6 +15446,21 @@ }, "required": false }, + { + "name": "includeScheduledMoveOutRoom", + "in": "query", + "required": false, + "description": "This flag when set to true will include rooms assigned to move out reservations. This query parameter is supported when OPERA Control Advanced Daily Details is active.", + "type": "boolean" + }, + { + "name": "scheduledRoomMoveOutTime", + "in": "query", + "required": false, + "description": "When IncludeMoveOut is enabled, it is the move out time before which to search. It will return rooms assigned to moving reservations that have a scheduled move out time before the entered time. This query parameter is supported when OPERA Control Advanced Daily Details is active", + "type": "string", + "format": "date-time" + }, { "$ref": "#/parameters/authKey" }, @@ -24656,6 +24780,15 @@ "type": "object", "description": "This type represents the primary room attributes.", "properties": { + "scheduledRoomMoveOut": { + "description": "This flag will be set to true for rooms assigned to reservations that are scheduled to move to another room.", + "type": "boolean" + }, + "scheduledRoomMoveOutTime": { + "description": "It indicates the time of the reservation which is scheduled for move out.", + "type": "string", + "format": "date-time" + }, "roomType": { "description": "Room type basic information of the room.", "$ref": "#/definitions/roomTypeShortInfoType" @@ -25050,7 +25183,7 @@ "type": "boolean" }, "departureTime": { - "description": "When IncludeDueOut is enable,it is the departure time before which to search.", + "description": "When IncludeDueOut is enabled, it is the departure time before which to search. It will return rooms assigned to departing reservations that have an ETD (Estimated Time of Departure) before the entered time.", "type": "string", "format": "date-time" }, @@ -25956,6 +26089,121 @@ "hasVoucher": { "description": "This flag value true indicates the reservation matches a Voucher Rule. It is supported only if OPERA Control Vouchers is active.", "type": "boolean" + }, + "scheduledRoomMoves": { + "description": "Scheduled Moves", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/scheduledRoomMoveType" + } + } + } + }, + "scheduledRoomMoveType": { + "description": "Scheduled Room Move information.", + "type": "object", + "properties": { + "scheduledMoveInfo": { + "description": "Scheduled Room Move information for a reservation.", + "$ref": "#/definitions/scheduledRoomMoveInfoType" + }, + "roomAssignmentSegmentBegin": { + "type": "string", + "description": "Date Room Assignment Begins.", + "format": "date-time" + }, + "roomAssignmentSegmentEnd": { + "type": "string", + "description": "Date of the Scheduled Move Room.", + "format": "date-time" + }, + "roomAssignmentSegmentNo": { + "type": "integer", + "description": "Room Assignment Segment Number." + } + } + }, + "scheduledRoomMoveInfoType": { + "description": "Scheduled Room Move information.", + "type": "object", + "properties": { + "moveStatus": { + "description": "Scheduled Room Move Status.", + "$ref": "#/definitions/scheduledRoomMoveStatusType" + }, + "moveComments": { + "type": "string", + "description": "Comments about scheduled room move.", + "minLength": 0, + "maxLength": 200 + }, + "moveInRoomOccupancyInfo": { + "description": "Scheduled Move In Room Occupancy Information.", + "$ref": "#/definitions/roomOccupancyType" + }, + "estimatedMoveTime": { + "type": "string", + "description": "Estimated Move Time in 24Hour Format" + }, + "moveOutRoomId": { + "type": "string", + "description": "Scheduled Move Out Room Id.", + "minLength": 0, + "maxLength": 20 + }, + "moveOutRoomType": { + "type": "string", + "description": "Scheduled Move Out Room Type.", + "minLength": 0, + "maxLength": 20 + } + } + }, + "scheduledRoomMoveStatusType": { + "type": "string", + "description": "Flag indicating scheduled room move status.", + "enum": [ + "Completed", + "Pending" + ] + }, + "roomOccupancyType": { + "description": "Room Occupancy information.", + "type": "object", + "properties": { + "roomId": { + "type": "string", + "description": "Room Id.", + "minLength": 0, + "maxLength": 20 + }, + "roomType": { + "type": "string", + "description": "Room Type.", + "minLength": 0, + "maxLength": 20 + }, + "roomIsOccupied": { + "type": "boolean", + "description": "Indicates if the Room is currently occupied." + }, + "estimatedDepartureTime": { + "type": "string", + "description": "Estimated Time of Departure of reservation when room status is occupied.", + "format": "date-time" + }, + "guestFirstName": { + "type": "string", + "description": "Guest First/Given Name on reservation when room status is occupied.", + "minLength": 0, + "maxLength": 40 + }, + "guestLastName": { + "type": "string", + "description": "Guest Last Name /Surname on reservation when room status is occupied.", + "minLength": 0, + "maxLength": 40 } } }, @@ -36597,6 +36845,10 @@ "overrideRoomFeatures": { "description": "This flag indicates true/false. When this is true, it will allow to override the room feature preference validation while assigning rooms. The Reservation Room Features OPERA Control will determine which room feature preferences will be validated. When Reservation Room Features is on, the validation will be against the Room Feature preferences attached to the reservation. If the parameter is off, the validation will be against the room feature preferences attached to the profile. This is applicable when the Room Feature Validation OPERA Control is on.", "type": "boolean" + }, + "skipDiscrepantRoom": { + "description": "This flag indicates true/false. When it is true, you will be allowed to override the room selection for a skip discrepancy. This flag is available when the Discrepant Rooms OPERA Control is active.", + "type": "boolean" } } }, @@ -36996,6 +37248,11 @@ "type": "string", "maxLength": 2000 }, + "originalRoomNumber": { + "description": "Old Room Number is used when a room move is performed.", + "type": "string", + "maxLength": 2000 + }, "keyTrack": { "description": "KeyTrack Data.", "$ref": "#/definitions/keyTrackType" @@ -38571,6 +38828,338 @@ "maxLength": 200 } } + }, + "keyOptionsType": { + "type": "object", + "description": "This contains code and description information for key options.", + "properties": { + "keyOptionsCode": { + "description": "key options code.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "keyOptionDescription": { + "description": "key options description.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "externalRoomKeyType": { + "type": "string", + "description": "Simple type for representing room key request type. 'HardKey' = request for physical key card with RFID; 'MobileKey' = request for mobile key (no physical key); 'PinCode' = request for PinCode; 'KeyPayload' = request Key image from DLS System", + "enum": [ + "HardKey", + "MobileKey", + "PinCode", + "KeyPayload" + ] + }, + "keyUserType": { + "type": "string", + "description": "Simple type for representing key user type. 'Guest' = request Opera Guest room key", + "enum": [ + "Guest" + ] + }, + "printDataType": { + "type": "object", + "description": "Lists the text, file or picture to print onto a Guest room key (only for roomKeyType is HardKey).", + "properties": { + "printText": { + "description": "key options code.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "printFile": { + "description": "Base64 format of file representing data to print.", + "type": "string", + "format": "byte" + }, + "printPicture": { + "description": "Base64 format of picture representing data to print.", + "type": "string", + "format": "byte" + } + } + }, + "keyOptionsResponseType": { + "type": "object", + "description": "This contains code and description information for key options.", + "properties": { + "keyOptionsCode": { + "description": "key options code.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "keyOptionDescription": { + "description": "key options description.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "isEnabled": { + "description": "Indicates that the keyOption is enabled for this key.", + "type": "boolean" + }, + "default": { + "description": "Indicates that this keyOption is a default access.", + "type": "boolean" + } + } + }, + "roomKeysExternal": { + "type": "object", + "description": "Request for generation of room key used for OutBound.", + "properties": { + "encoderId": { + "type": "string", + "description": "Unique Id as defined by Door Lock System.", + "minLength": 1, + "maxLength": 2000 + }, + "encoderTerminal": { + "type": "string", + "description": "The Unique PMS encoder name linked with the encoderId", + "minLength": 1, + "maxLength": 2000 + }, + "roomId": { + "description": "The PMS room number to generate a key for.", + "type": "string", + "maxLength": 2000 + }, + "oldRoomId": { + "description": "Old Room Number is used when a room move (keyType RoomMove) is performed.", + "type": "string", + "maxLength": 2000 + }, + "noOfKeys": { + "type": "integer", + "description": "Number of keys to be created.", + "minimum": 1, + "maximum": 1 + }, + "reservationIdList": { + "description": "Collection of unique reservation identifiers for the reservation we are trying to make a room key for.", + "$ref": "#/definitions/uniqueIDListType" + }, + "guestShareFlag": { + "type": "boolean", + "description": "Indicates if Guest is a sharer or not" + }, + "OldGuestShareFlag": { + "type": "boolean", + "description": "Indicates if old Guest room is a sharer or not when a room move (keyType RoomMove) is performed." + }, + "keyValidityStart": { + "type": "string", + "description": "The date/time the room key is valid from.", + "format": "date-time" + }, + "keyValidityEnd": { + "type": "string", + "description": "The date/time the room key is valid to.", + "format": "date-time" + }, + "keyType": { + "$ref": "#/definitions/roomKeyOutBoundType" + }, + "keyTrack": { + "description": "KeyTrack Data.", + "$ref": "#/definitions/keyTrackType" + }, + "outBoundCode": { + "description": "OutBound Code of the Door Lock System (DLS).", + "type": "string" + }, + "additionalRooms": { + "description": "Collection of additional rooms to be included in key creation of reservation room.", + "type": "array", + "maxItems": 999, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "oldAdditionalRooms": { + "description": "Collection of old additional rooms in key creation of reservation room when a room move (keyType RoomMove) is performed.", + "type": "array", + "maxItems": 999, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "userId": { + "type": "string", + "description": "Unique identifier for the PMS user.", + "maxLength": 2000 + }, + "roomKeyGuests": { + "type": "array", + "description": "Collection of of Room key guests for multiple guest room key functionality.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/roomKeyGuest" + } + }, + "keyOptions": { + "description": "Lists the access areas defined in PMS valid for the room key.", + "type": "array", + "maxItems": 1000, + "items": { + "$ref": "#/definitions/keyOptionsType" + } + }, + "keyRequestTime": { + "type": "string", + "description": "The date/time the room key is requested.", + "format": "date-time" + }, + "roomKeyType": { + "$ref": "#/definitions/externalRoomKeyType" + }, + "keyUserType": { + "$ref": "#/definitions/keyUserType" + }, + "cardSerialNumber": { + "description": "Unique identifier of RFID card used for KeyPayload generation. Required when roomKeyType is KeyPayload.", + "type": "string", + "maxLength": 80 + }, + "printData": { + "$ref": "#/definitions/printDataType" + } + }, + "required": [ + "keyType", + "encoderTerminal", + "encoderId", + "roomKeyType", + "keyUserType", + "keyRequestTime" + ] + }, + "roomKeysExternalDetails": { + "type": "object", + "description": "Response for the key request made to DLS from OPERA Cloud.", + "properties": { + "encoderId": { + "type": "string", + "description": "Unique Id as defined by Door Lock System.", + "maxLength": 2000 + }, + "encoderTerminal": { + "type": "string", + "description": "The Unique PMS encoder name linked with the encoderId", + "minLength": 1, + "maxLength": 2000 + }, + "reservationIdList": { + "description": "Collection of unique reservation identifiers for the reservation we are trying to make a room key for.", + "$ref": "#/definitions/uniqueIDListType" + }, + "roomId": { + "description": "The PMS room number to generate a key for.", + "type": "string", + "maxLength": 2000 + }, + "keyTrack": { + "description": "KeyTrack Data.", + "type": "array", + "items": { + "$ref": "#/definitions/keyTrackType" + } + }, + "keyValidityStart": { + "type": "string", + "description": "Date/Time Key is valid from - only send in response for keyType: 'Read' request", + "format": "date-time" + }, + "keyValidityEnd": { + "type": "string", + "description": "Date/Time Key is valid to - only send in response for keyType: 'Read' request", + "format": "date-time" + }, + "noOfKeys": { + "type": "integer", + "description": "Number of keys to be created.The value is always 1" + }, + "responseText": { + "type": "string", + "description": "A user-friendly text with information on why a request is not successful", + "maxLength": 2000 + }, + "responseCode": { + "$ref": "#/definitions/roomKeyResponseCodeType" + }, + "additionalRooms": { + "description": "Collection of additional rooms to be included in key creation of reservation room.", + "type": "array", + "maxItems": 999, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "keyOptions": { + "description": "Lists all PMS access areas.", + "type": "array", + "maxItems": 1000, + "items": { + "$ref": "#/definitions/keyOptionsResponseType" + } + }, + "userId": { + "type": "string", + "description": "Unique identifier for the PMS user.", + "maxLength": 2000 + }, + "digitalKeyData": { + "description": "Base64 format of Mobile Key data provided by DLS System which the external system requested - only send in response for roomKeyType: 'MobileKey'", + "type": "string", + "format": "byte" + }, + "keyImage": { + "description": "Image of the created key - only send in response for roomKeyType: 'KeyPayload'", + "type": "string", + "format": "byte" + }, + "cardSerialNumber": { + "description": "Unique identifier of RFID card used for KeyPayload generation - only send in response for roomKeyType: 'KeyPayload'.", + "type": "string", + "maxLength": 80 + }, + "keyCreationTime": { + "type": "string", + "description": "Date/Time the key has been generated by Door Locking system.", + "format": "date-time" + }, + "roomKeyType": { + "$ref": "#/definitions/externalRoomKeyType" + }, + "keyUserType": { + "$ref": "#/definitions/keyUserType" + } + }, + "required": [ + "roomId", + "responseCode", + "encoderTerminal", + "roomKeyType", + "keyUserType", + "keyValidityStart", + "keyValidityEnd", + "keyCreationTime" + ] } }, "tags": [ diff --git a/rest-api-specs/property/fofcfg.json b/rest-api-specs/property/fofcfg.json index 3a3c16f..fed6286 100644 --- a/rest-api-specs/property/fofcfg.json +++ b/rest-api-specs/property/fofcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Front Desk Configuration API", - "description": "APIs to cater for Front Desk Configuration in OPERA Cloud. Here you can find operations to get, post, put and delete front desk codes such as commission codes, transaction groups, codes & subgroups, articles, payment methods and credit card types.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Front Desk Configuration in OPERA Cloud. Here you can find operations to get, post, put and delete front desk codes such as commission codes, transaction groups, codes & subgroups, articles, payment methods and credit card types.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -50631,7 +50631,7 @@ }, "controlSequenceType": { "type": "object", - "description": "Provides information about the Opera Control Sequence", + "description": "Provides information about the OPERA Control Sequence", "properties": { "hotelId": { "description": "Control Sequence code associated with Hotel", @@ -50676,9 +50676,11 @@ "Folio", "OfficialReceipt", "Bill", - "ArInvoice", + "ARInvoice", "SupportingDocument", - "TaxRegNo" + "TaxRegNo", + "InternalPOSAccount", + "InternalPOSAccountCredit" ] }, "packageArrangementCodes": { diff --git a/rest-api-specs/property/hsk.json b/rest-api-specs/property/hsk.json index 18bdc23..3ea9b40 100644 --- a/rest-api-specs/property/hsk.json +++ b/rest-api-specs/property/hsk.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Housekeeping Service API", - "description": "APIs to cater for Housekeeping functionality in OPERA Cloud.

Housekeeping enables you to schedule daily room cleaning, maintenance, and housekeeping staff activities. It provides information on room status, out of order/out of service rooms, and forecasting.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Housekeeping functionality in OPERA Cloud.

Housekeeping enables you to schedule daily room cleaning, maintenance, and housekeeping staff activities. It provides information on room status, out of order/out of service rooms, and forecasting.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -14862,6 +14862,30 @@ "optedForCommunication": { "description": "Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.", "type": "boolean" + }, + "backToBack": { + "description": "Indicates if the Reservation is Back to Back Reservation. Available when the Back to Back Handling for Linked Reservations OPERA Control is active. ", + "type": "boolean" + }, + "backToBackHSKIndicator": { + "description": "Indicates if the Reservation is departing today with a Back to Back Reservation arriving today. Available when the Back to Back Handling for Linked Reservations OPERA Control is active.", + "type": "boolean" + }, + "scheduledRoomMoveInfo": { + "description": "Indicates Scheduled Room Move In/Out information.", + "$ref": "#/definitions/scheduledRoomMoveInfoType" + }, + "scheduledMoveInRoomId": { + "description": "Indicates the scheduled Move-In Room Number.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "scheduledMoveOutRoomId": { + "description": "Indicates the scheduled Move-Out Room Number.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, diff --git a/rest-api-specs/property/int.json b/rest-api-specs/property/int.json index 41c24e9..3b6b6ae 100644 --- a/rest-api-specs/property/int.json +++ b/rest-api-specs/property/int.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Integration Processor API", - "description": "APIs to get Business Events generated in OPERA Cloud.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to get Business Events generated in OPERA Cloud.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/intcfg.json b/rest-api-specs/property/intcfg.json index f9d9463..aeb715e 100644 --- a/rest-api-specs/property/intcfg.json +++ b/rest-api-specs/property/intcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Integration Configuration API", - "description": "APIs catering to Integration Configuration in OPERA Cloud. Operations such as get Hotel Interface Types, or get UDF mappings can be found in this module.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs catering to Integration Configuration in OPERA Cloud. Operations such as get Hotel Interface Types, or get UDF mappings can be found in this module.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -312,7 +312,8 @@ "BillingFolio", "QueueRush", "AR", - "OtherFolio" + "OtherFolio", + "PayByLink" ] }, "required": false @@ -6330,6 +6331,9 @@ }, "otherFolios": { "$ref": "#/definitions/otherFolioDeliveryMethodType" + }, + "payByLink": { + "$ref": "#/definitions/payByLinkDeliveryMethodType" } } }, @@ -6433,7 +6437,8 @@ "Confirmation", "General", "Other", - "AR" + "AR", + "PayByLink" ] }, "faxDeliveryConfigurationType": { @@ -8860,7 +8865,7 @@ "type": "boolean" }, "keyPinActive": { - "description": "Indicator if the Key Pin is active or not.", + "description": "Indicator if the Key Pin is active or not. It is supported only if OPERA Control Display Key Pin is active.", "type": "boolean" }, "allPrintDetailOn": { @@ -9978,6 +9983,15 @@ "$ref": "#/definitions/warningsType" } } + }, + "payByLinkDeliveryMethodType": { + "type": "object", + "description": "Pay By Link delivery method configuration, settings for Email containing payment url", + "properties": { + "email": { + "$ref": "#/definitions/emailDeliveryConfigurationType" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/inv.json b/rest-api-specs/property/inv.json index d6b7cd9..e56f362 100644 --- a/rest-api-specs/property/inv.json +++ b/rest-api-specs/property/inv.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Inventory API", - "description": "APIs to cater for Inventory functionality in OPERA Cloud. This includes sell limits for date ranges, viewing and updating the property's inventory, as well as item inventory (such as rollaways, microwaves etc.).

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Inventory functionality in OPERA Cloud. This includes sell limits for date ranges, viewing and updating the property's inventory, as well as item inventory (such as rollaways, microwaves etc.).

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/invasync.json b/rest-api-specs/property/invasync.json index 0825b98..dee9109 100644 --- a/rest-api-specs/property/invasync.json +++ b/rest-api-specs/property/invasync.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "Opera Cloud Inventory Asynchronous API", - "description": "APIs to cater for Inventory related asynchronous functionality in OPERA Cloud. This includes viewing inventory data along with its revenue and updating inventory's sell limits for date ranges.

This API follows an async pattern where

  • You make an initial request, which returns a Location header
  • You poll HEAD on the Location header returned to obtain the status of the process
  • Once the process completes HEAD will return in the Location header the URL that must be called to obtain the results of the process
  • You call the URL to obtain the results of the process


Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Inventory related asynchronous functionality in OPERA Cloud. This includes viewing inventory data along with its revenue and updating inventory's sell limits for date ranges.

This API follows an async pattern where

  • You make an initial request, which returns a Location header
  • You poll HEAD on the Location header returned to obtain the status of the process
  • Once the process completes HEAD will return in the Location header the URL that must be called to obtain the results of the process
  • You call the URL to obtain the results of the process


Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/lms.json b/rest-api-specs/property/lms.json index 6d71b0b..b2f75a7 100644 --- a/rest-api-specs/property/lms.json +++ b/rest-api-specs/property/lms.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Leisure Management API", - "description": "APIs to cater for external Leisure Management functionality integrated with OPERA Cloud.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for external Leisure Management functionality integrated with OPERA Cloud.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -1734,6 +1734,364 @@ ] } }, + "/hotels/{hotelId}/profiles/{profileId}/activityBookings": { + "post": { + "summary": "Send a response to Creation of Activity Booking", + "description": "This API will send a response to Creation of Activity Booking.

OperationId:postActivityBooking

", + "operationId": "postActivityBookingForProfile", + "parameters": [ + { + "name": "profileId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Profile ID which is used to find any profile in OPERA." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Hotel code" + }, + { + "name": "createActivityBookingForProfile", + "in": "body", + "required": true, + "description": "Self-contained Request object that is used when Creating activities.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/createActivityBooking" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "LeisureManagement" + ] + }, + "put": { + "summary": "Send a response to Change in Activity Booking", + "description": "This API will send a response to a Change in Activity Booking request from external Activity Scheduler system.

OperationId:putActivityBookingForProfile

", + "operationId": "putActivityBookingForProfile", + "parameters": [ + { + "name": "profileId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Profile ID which is used to find any profile in OPERA." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Hotel code" + }, + { + "name": "changeActivityBookingForProfile", + "in": "body", + "required": true, + "description": "Self-contained Request object that is used when Updating activities.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/changeActivityBooking" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "Self-contained response object that is used when Updating activities.", + "schema": { + "$ref": "#/definitions/activityBookingModified" + } + }, + "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": [ + "LeisureManagement" + ] + }, + "delete": { + "summary": "Send a response to Cancellation of an Activity Booking", + "description": "This API will send a response to Cancellation of an Activity Booking.

OperationId:deleteActivityBooking

", + "operationId": "deleteActivityBookingForProfile", + "parameters": [ + { + "name": "profileId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Profile ID which is used to find any profile in OPERA." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Hotel code" + }, + { + "name": "activityId", + "in": "query", + "required": true, + "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" + }, + { + "name": "activityIdType", + "in": "query", + "x-example": "EXTERNALSYSTEMCODE", + "required": true, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "LeisureManagement" + ] + } + }, "/hotels/{hotelId}/reservations/{reservationId}/activityBookings": { "post": { "summary": "Send a response to Creation of Activity Booking", diff --git a/rest-api-specs/property/lov.json b/rest-api-specs/property/lov.json index 28d83fd..d0330c7 100644 --- a/rest-api-specs/property/lov.json +++ b/rest-api-specs/property/lov.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud List of Values Management API", - "description": "APIs to cater for List of Value functionality in OPERA Cloud. A List of Values in the OPERA Application can be configured by a property. Then by using these APIs you can retrieve all configured codes. As an example, Titles is a configurable ListOfValues. A hotel can specify what titles they wish to use, and thus fetching the LOV for title, you can view the codes that are configured for a property.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for List of Value functionality in OPERA Cloud. A List of Values in the OPERA Application can be configured by a property. Then by using these APIs you can retrieve all configured codes. As an example, Titles is a configurable ListOfValues. A hotel can specify what titles they wish to use, and thus fetching the LOV for title, you can view the codes that are configured for a property.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -23,8 +23,8 @@ "paths": { "/listOfValues": { "get": { - "summary": "Return list of value names", - "description": "Use this API to return list of value names.

OperationId:getLOVNames

", + "summary": "Fetch Names", + "description": "

OperationId:getLOVNames

", "operationId": "getLOVNames", "parameters": [ { @@ -111,8 +111,8 @@ }, "/listOfValues/airlines/{airlines}/loyalty/{loyalty}/membershipClassTypes": { "get": { - "summary": "Return list of values for membership class types", - "description": "Use this API to return the list of values for membership class types based on search criteria such as loyalty, airlines, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipClassTypesLOV

", + "summary": "Fetch List Of Values for Membership Class Types", + "description": "

OperationId:getMembershipClassTypesLOV

", "operationId": "getMembershipClassTypesLOV", "parameters": [ { @@ -265,8 +265,8 @@ }, "/listOfValues/alertPrinters/{alertPrinters}/printers": { "get": { - "summary": "Return list of values for printers", - "description": "Use this API to return the list of values for printers based on search criteria such as alertPrinters, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPrintersLOV

", + "summary": "Fetch List Of Values for Printers", + "description": "

OperationId:getPrintersLOV

", "operationId": "getPrintersLOV", "parameters": [ { @@ -406,8 +406,8 @@ }, "/listOfValues/blockId/{blockId}/blockBookingStatuses": { "get": { - "summary": "Return list of values for block booking statuses", - "description": "Use this API to return the list of values for block booking statuses based on search criteria such as blockId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockBookingStatusesLOV

", + "summary": "Fetch List Of Values for Block Booking Statuses", + "description": "

OperationId:getBlockBookingStatusesLOV

", "operationId": "getBlockBookingStatusesLOV", "parameters": [ { @@ -543,8 +543,8 @@ }, "/listOfValues/blockId/{blockId}/blockCurrentStatuses": { "get": { - "summary": "Return list of values for block current statuses", - "description": "Use this API to return the list of values for block current statuses based on search criteria such as blockId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockBookingStatusesLOV

", + "summary": "Fetch List Of Values for Block Current Statuses", + "description": "

OperationId:getBlockCurrentStatusesLOV

", "operationId": "getBlockCurrentStatusesLOV", "parameters": [ { @@ -680,8 +680,8 @@ }, "/listOfValues/bookingChannels/{bookingChannelCodes}/gdsRoomCategoryTemplates": { "get": { - "summary": "Return list of values for gds room category templates", - "description": "Use this API to return the list of values for gds room category templates based on search criteria such as bookingChannelCodes, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGdsRoomCategoryTemplatesLOV

", + "summary": "Fetch List Of Values for Gds Room Category Templates", + "description": "

OperationId:getGdsRoomCategoryTemplatesLOV

", "operationId": "getGdsRoomCategoryTemplatesLOV", "parameters": [ { @@ -817,8 +817,8 @@ }, "/listOfValues/bookingChannels/{bookingChannelCode}/gdsGuaranteeCodes": { "get": { - "summary": "Return list of values for gds guarantee codes", - "description": "Use this API to return the list of values for gds guarantee codes based on search criteria such as bookingChannelCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGdsGuaranteeCodesLOV

", + "summary": "Fetch List Of Values for Gds Guarantee Codes", + "description": "

OperationId:getGdsGuaranteeCodesLOV

", "operationId": "getGdsGuaranteeCodesLOV", "parameters": [ { @@ -954,8 +954,8 @@ }, "/listOfValues/bookingChannels/{bookingChannelCode}/gdsRateCategories": { "get": { - "summary": "Return list of values for gds rate categories", - "description": "Use this API to return the list of values for gds rate categories based on search criteria such as bookingChannelCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGdsRateCategoriesLOV

", + "summary": "Fetch List Of Values for Gds Rate Categories", + "description": "

OperationId:getGdsRateCategoriesLOV

", "operationId": "getGdsRateCategoriesLOV", "parameters": [ { @@ -1091,8 +1091,8 @@ }, "/listOfValues/bookingChannels/{bookingChannelCode}/gdsRateLevels": { "get": { - "summary": "Return list of values for gds rate levels", - "description": "Use this API to return the list of values for gds rate levels based on search criteria such as bookingChannelCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGdsRateLevelsLOV

", + "summary": "Fetch List Of Values for Gds Rate Levels", + "description": "

OperationId:getGdsRateLevelsLOV

", "operationId": "getGdsRateLevelsLOV", "parameters": [ { @@ -1228,8 +1228,8 @@ }, "/listOfValues/bookingChannels/{bookingChannelCode}/templateBookingChannelRoomTypes": { "get": { - "summary": "Return list of values for booking channel room type templates", - "description": " Use this API to return the list of values for booking channel room type templates based on search criteria such as bookingChannelCodes, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTemplateBookingChannelRoomTypesLOV

", + "summary": "Fetch List Of Values for Template Booking Channel Room Types", + "description": "

OperationId:getTemplateBookingChannelRoomTypesLOV

", "operationId": "getTemplateBookingChannelRoomTypesLOV", "parameters": [ { @@ -1365,8 +1365,8 @@ }, "/listOfValues/bookingStatus/{bookingStatus}/blockNextStatuses": { "get": { - "summary": "Return list of values for block next statuses", - "description": "Use this API to return the list of values for block next statuses based on search criteria such as bookingStatus, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockNextStatusesLOV

", + "summary": "Fetch List Of Values for Block Next Statuses", + "description": "

OperationId:getBlockNextStatusesLOV

", "operationId": "getBlockNextStatusesLOV", "parameters": [ { @@ -1502,8 +1502,8 @@ }, "/listOfValues/bookingStatus/{bookingStatus}/gridTypes": { "get": { - "summary": "Return list of values for grid types", - "description": "Use this API to return the list of values for grid types based on search criteria such as bookingStatus, includeInactiveFlag, parameterName, parameterValue, excludeCodes.

OperationId:getGridTypesLOV

", + "summary": "Fetch List Of Values for Grid Types", + "description": "

OperationId:getGridTypesLOV

", "operationId": "getGridTypesLOV", "parameters": [ { @@ -1639,8 +1639,8 @@ }, "/listOfValues/breakOutId/{breakOutId}/taskSheet": { "get": { - "summary": "Return list of values for task sheets", - "description": "Use this API to return the list of values for task sheets based on search criteria such as breakOutId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTaskSheetLOV

", + "summary": "Fetch List Of Values for Task Sheet", + "description": "

OperationId:getTaskSheetLOV

", "operationId": "getTaskSheetLOV", "parameters": [ { @@ -1776,8 +1776,8 @@ }, "/listOfValues/cashierId/{cashierId}/cashierHotels": { "get": { - "summary": "Return list of values for cashier hotels", - "description": "Use this API to return the list of values for cashier hotels based on search criteria such as cashierId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCashierHotelsLOV

", + "summary": "Fetch List Of Values for Cashier Hotels", + "description": "

OperationId:getCashierHotelsLOV

", "operationId": "getCashierHotelsLOV", "parameters": [ { @@ -1911,21 +1911,12 @@ ] } }, - "/listOfValues/catStatus/{catStatus}/blockCatNextStatuses": { + "/listOfValues/catBudgetTypeEventCodesLoad": { "get": { - "summary": "Return list of values for block cat next statuses", - "description": "Use this API to return the list of values for block cat next statuses based on search criteria such as catStatus, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockCatNextStatusesLOV

", - "operationId": "getBlockCatNextStatusesLOV", + "summary": "Fetch List Of Values for Cat Budget Type Event Codes", + "description": "

OperationId:getCatBudgetTypeEventCodesLoadLOV

", + "operationId": "getCatBudgetTypeEventCodesLoadLOV", "parameters": [ - { - "name": "catStatus", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'catStatus' which is required to fetch BlockCatNextStatuses LOV" - }, { "name": "includeInactiveFlag", "in": "query", @@ -1972,9 +1963,6 @@ { "$ref": "#/parameters/x-app-key" }, - { - "$ref": "#/parameters/x-hotelid" - }, { "$ref": "#/parameters/x-externalsystem" }, @@ -1998,7 +1986,7 @@ } }, "204": { - "description": "BlockCatNextStatusesLOV not found." + "description": "CatBudTypeEventCodesLoadLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2048,21 +2036,12 @@ ] } }, - "/listOfValues/category/{category}/userDbFunctions": { + "/listOfValues/catBudgetTypeMealCodesLoad": { "get": { - "summary": "Return list of values for user database functions", - "description": "Use this API to return the list of values for user database functions based on search criteria such as category, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUserDbFunctionsLOV

", - "operationId": "getUserDbFunctionsLOV", + "summary": "Fetch List Of Values for Cat Budget Type Meal Codes", + "description": "

OperationId:getCatBudgetTypeMealCodesLoadLOV

", + "operationId": "getCatBudgetTypeMealCodesLoadLOV", "parameters": [ - { - "name": "category", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'category' which is required to fetch UserDbFunctions LOV" - }, { "name": "includeInactiveFlag", "in": "query", @@ -2109,9 +2088,6 @@ { "$ref": "#/parameters/x-app-key" }, - { - "$ref": "#/parameters/x-hotelid" - }, { "$ref": "#/parameters/x-externalsystem" }, @@ -2135,7 +2111,7 @@ } }, "204": { - "description": "UserDbFunctionsLOV not found." + "description": "CatBudTypeMealCodesLoadLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2185,37 +2161,20 @@ ] } }, - "/listOfValues/catering/{catering}/active/{active}/cateringBudgetTypes": { + "/listOfValues/catStatus/{catStatus}/blockCatNextStatuses": { "get": { - "summary": "Return list of values for catering budget types", - "description": "Use this API to return the list of values for catering budget types based on search criteria such as active, catering, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCateringBudgetTypesLOV

", - "operationId": "getCateringBudgetTypesLOV", + "summary": "Fetch List Of Values for Block Cat Next Statuses", + "description": "

OperationId:getBlockCatNextStatusesLOV

", + "operationId": "getBlockCatNextStatusesLOV", "parameters": [ { - "name": "active", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'active' which is required to fetch CateringBudgetTypes LOV", - "enum": [ - "Y", - "N" - ] - }, - { - "name": "catering", + "name": "catStatus", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'catering' which is required to fetch CateringBudgetTypes LOV", - "enum": [ - "Y", - "N" - ] + "description": "Value of the parameter 'catStatus' which is required to fetch BlockCatNextStatuses LOV" }, { "name": "includeInactiveFlag", @@ -2289,7 +2248,7 @@ } }, "204": { - "description": "CateringBudTypesLOV not found." + "description": "BlockCatNextStatusesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2339,20 +2298,20 @@ ] } }, - "/listOfValues/cateringEvents/{cateringEvents}/hotelsForSnC": { + "/listOfValues/category/{category}/userDbFunctions": { "get": { - "summary": "Return list of values for hotels for OPERA Sales and Catering", - "description": "Use this API to return the list of values for hotels for OPERA Sales and Catering based on search criteria such as cateringEvents, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHotelsForSnCLOV

", - "operationId": "getHotelsForSnCLOV", + "summary": "Fetch List Of Values for User Db Functions", + "description": "

OperationId:getUserDbFunctionsLOV

", + "operationId": "getUserDbFunctionsLOV", "parameters": [ { - "name": "cateringEvents", + "name": "category", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'cateringEvents' which is required to fetch HotelsForSnC LOV" + "description": "Value of the parameter 'category' which is required to fetch UserDbFunctions LOV" }, { "name": "includeInactiveFlag", @@ -2426,7 +2385,7 @@ } }, "204": { - "description": "HotelsForSnCLOV not found." + "description": "UserDbFunctionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2476,20 +2435,37 @@ ] } }, - "/listOfValues/chainCode/{chainCode}/chainLanguages": { + "/listOfValues/catering/{catering}/active/{active}/cateringBudgetTypes": { "get": { - "summary": "Return list of values for chain languages", - "description": "Use this API to return the list of values for chain languages based on search criteria such as chainCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getChainLanguagesLOV

", - "operationId": "getChainLanguagesLOV", + "summary": "Fetch List Of Values for Catering Budget Types", + "description": "

OperationId:getCateringBudgetTypesLOV

", + "operationId": "getCateringBudgetTypesLOV", "parameters": [ { - "name": "chainCode", + "name": "active", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'chainCode' which is required to fetch ChainLanguages LOV" + "description": "Value of the parameter 'active' which is required to fetch CateringBudgetTypes LOV", + "enum": [ + "Y", + "N" + ] + }, + { + "name": "catering", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'catering' which is required to fetch CateringBudgetTypes LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -2563,7 +2539,7 @@ } }, "204": { - "description": "ChainLanguagesLOV not found." + "description": "CateringBudTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2613,29 +2589,20 @@ ] } }, - "/listOfValues/chainCode/{chainCode}/preferenceGroup/{preferenceGroup}/preferenceSubgroups": { + "/listOfValues/cateringEvents/{cateringEvents}/hotelsForSnC": { "get": { - "summary": "Return list of values for preference subgroups", - "description": "Use this API to return the list of values for preference subgroups based on search criteria such as preferenceGroup, chainCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPreferenceSubgroupsLOV

", - "operationId": "getPreferenceSubgroupsLOV", + "summary": "Fetch List Of Values for Hotels For Sn C", + "description": "

OperationId:getHotelsForSnCLOV

", + "operationId": "getHotelsForSnCLOV", "parameters": [ { - "name": "preferenceGroup", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'preferenceGroup' which is required to fetch PreferenceSubgroups LOV" - }, - { - "name": "chainCode", + "name": "cateringEvents", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'chainCode' which is required to fetch PreferenceSubgroups LOV" + "description": "Value of the parameter 'cateringEvents' which is required to fetch HotelsForSnC LOV" }, { "name": "includeInactiveFlag", @@ -2709,7 +2676,7 @@ } }, "204": { - "description": "PreferenceSubgroupsLOV not found." + "description": "HotelsForSnCLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2759,21 +2726,12 @@ ] } }, - "/listOfValues/chainCode/{chainCode}/screenCode/{screenCode}/screenStyleCodes": { + "/listOfValues/chainCode/{chainCode}/chainLanguages": { "get": { - "summary": "Return list of values for screen style codes", - "description": "Use this API to return the list of values for screen style codes based on search criteria such as screenCode, chainCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getScreenStyleCodesLOV

", - "operationId": "getScreenStyleCodesLOV", + "summary": "Fetch List Of Values for Chain Languages", + "description": "

OperationId:getChainLanguagesLOV

", + "operationId": "getChainLanguagesLOV", "parameters": [ - { - "name": "screenCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'screenCode' which is required to fetch ScreenStyleCodes LOV" - }, { "name": "chainCode", "in": "path", @@ -2781,7 +2739,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'chainCode' which is required to fetch ScreenStyleCodes LOV" + "description": "Value of the parameter 'chainCode' which is required to fetch ChainLanguages LOV" }, { "name": "includeInactiveFlag", @@ -2855,7 +2813,7 @@ } }, "204": { - "description": "ScreenStyleCodesLOV not found." + "description": "ChainLanguagesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2905,29 +2863,20 @@ ] } }, - "/listOfValues/chainCode/{chainCode}/screenType/{screenType}/screenArea/{screenArea}/screenCodes": { + "/listOfValues/chainCode/{chainCode}/preferenceGroup/{preferenceGroup}/preferenceSubgroups": { "get": { - "summary": "Return list of values for screen codes", - "description": "Use this API to return the list of values for screen codes based on search criteria such as screenArea, screenType, chainCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getScreenCodesLOV

", - "operationId": "getScreenCodesLOV", + "summary": "Fetch List Of Values for Preference Subgroups", + "description": "

OperationId:getPreferenceSubgroupsLOV

", + "operationId": "getPreferenceSubgroupsLOV", "parameters": [ { - "name": "screenArea", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'screenArea' which is required to fetch ScreenCodes LOV" - }, - { - "name": "screenType", + "name": "preferenceGroup", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'screenType' which is required to fetch ScreenCodes LOV" + "description": "Value of the parameter 'preferenceGroup' which is required to fetch PreferenceSubgroups LOV" }, { "name": "chainCode", @@ -2936,7 +2885,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'chainCode' which is required to fetch ScreenCodes LOV" + "description": "Value of the parameter 'chainCode' which is required to fetch PreferenceSubgroups LOV" }, { "name": "includeInactiveFlag", @@ -3010,7 +2959,7 @@ } }, "204": { - "description": "ScreenCodesLOV not found." + "description": "PreferenceSubgroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3060,20 +3009,29 @@ ] } }, - "/listOfValues/changeSource/{changeSource}/fieldName": { + "/listOfValues/chainCode/{chainCode}/screenCode/{screenCode}/screenStyleCodes": { "get": { - "summary": "Return list of values for field names", - "description": "Use this API to return the list of values for field names based on search criteria such as changeSource, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFieldNameLOV

", - "operationId": "getFieldNameLOV", + "summary": "Fetch List Of Values for Screen Style Codes", + "description": "

OperationId:getScreenStyleCodesLOV

", + "operationId": "getScreenStyleCodesLOV", "parameters": [ { - "name": "changeSource", + "name": "screenCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'changeSource' which is required to fetch FieldName LOV" + "description": "Value of the parameter 'screenCode' which is required to fetch ScreenStyleCodes LOV" + }, + { + "name": "chainCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'chainCode' which is required to fetch ScreenStyleCodes LOV" }, { "name": "includeInactiveFlag", @@ -3147,7 +3105,7 @@ } }, "204": { - "description": "FieldNameLOV not found." + "description": "ScreenStyleCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3197,20 +3155,38 @@ ] } }, - "/listOfValues/channel/{channel}/bookingChannelRoomTypes": { + "/listOfValues/chainCode/{chainCode}/screenType/{screenType}/screenArea/{screenArea}/screenCodes": { "get": { - "summary": "Return list of values for booking channel room types", - "description": "Use this API to return the list of values for booking channel room types based on search criteria such as channel, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBookingChannelRoomTypesLOV

", - "operationId": "getBookingChannelRoomTypesLOV", + "summary": "Fetch List Of Values for Screen Codes", + "description": "

OperationId:getScreenCodesLOV

", + "operationId": "getScreenCodesLOV", "parameters": [ { - "name": "channel", + "name": "screenArea", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'channel' which is required to fetch BookingChannelRoomTypes LOV" + "description": "Value of the parameter 'screenArea' which is required to fetch ScreenCodes LOV" + }, + { + "name": "screenType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'screenType' which is required to fetch ScreenCodes LOV" + }, + { + "name": "chainCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'chainCode' which is required to fetch ScreenCodes LOV" }, { "name": "includeInactiveFlag", @@ -3284,7 +3260,7 @@ } }, "204": { - "description": "BookingChannelRoomTypesLOV not found." + "description": "ScreenCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3334,20 +3310,20 @@ ] } }, - "/listOfValues/channelType/{channelType}/gdsHotels": { + "/listOfValues/changeSource/{changeSource}/fieldName": { "get": { - "summary": "Return list of values for gds hotels", - "description": "Use this API to return the list of values for gds hotel based on search criteria such as channelType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGdsHotelsLOV

", - "operationId": "getGdsHotelsLOV", + "summary": "Fetch List Of Values for Field Name", + "description": "

OperationId:getFieldNameLOV

", + "operationId": "getFieldNameLOV", "parameters": [ { - "name": "channelType", + "name": "changeSource", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'channelType' which is required to fetch GdsHotels LOV" + "description": "Value of the parameter 'changeSource' which is required to fetch FieldName LOV" }, { "name": "includeInactiveFlag", @@ -3421,7 +3397,7 @@ } }, "204": { - "description": "GdsHotelsLOV not found." + "description": "FieldNameLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3471,20 +3447,20 @@ ] } }, - "/listOfValues/codeType/{codeType}/cateringCodes": { + "/listOfValues/channel/{channel}/bookingChannelRoomTypes": { "get": { - "summary": "Return list of values for catering codes", - "description": "Use this API to return the list of values for catering codes based on search criteria such as codeType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCateringCodesLOV

", - "operationId": "getCateringCodesLOV", + "summary": "Fetch List Of Values for Booking Channel Room Types", + "description": "

OperationId:getBookingChannelRoomTypesLOV

", + "operationId": "getBookingChannelRoomTypesLOV", "parameters": [ { - "name": "codeType", + "name": "channel", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'codeType' which is required to fetch CateringCodes LOV" + "description": "Value of the parameter 'channel' which is required to fetch BookingChannelRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -3558,7 +3534,7 @@ } }, "204": { - "description": "CateringCodesLOV not found." + "description": "BookingChannelRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3608,20 +3584,20 @@ ] } }, - "/listOfValues/country/{country}/postalCodes": { + "/listOfValues/channelType/{channelType}/gdsHotels": { "get": { - "summary": "Return list of values for postal codes", - "description": "Use this API to return the list of values for postal codes based on search criteria such as country, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPostalCodesLOV

", - "operationId": "getPostalCodesLOV", + "summary": "Fetch List Of Values for Gds Hotels", + "description": "

OperationId:getGdsHotelsLOV

", + "operationId": "getGdsHotelsLOV", "parameters": [ { - "name": "country", + "name": "channelType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'country' which is required to fetch PostalCodes LOV" + "description": "Value of the parameter 'channelType' which is required to fetch GdsHotels LOV" }, { "name": "includeInactiveFlag", @@ -3695,7 +3671,7 @@ } }, "204": { - "description": "PostalCodesLOV not found." + "description": "GdsHotelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3745,20 +3721,20 @@ ] } }, - "/listOfValues/country/{country}/toPostalCodes": { + "/listOfValues/codeType/{codeType}/cateringCodes": { "get": { - "summary": "Return list of values for to postal codes", - "description": "Use this API to return the list of values for to postal codes based on search criteria such as country, includeInactiveFlag, parameterName, parameterValue.

OperationId:getToPostalCodesLOV

", - "operationId": "getToPostalCodesLOV", + "summary": "Fetch List Of Values for Catering Codes", + "description": "

OperationId:getCateringCodesLOV

", + "operationId": "getCateringCodesLOV", "parameters": [ { - "name": "country", + "name": "codeType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'country' which is required to fetch ToPostalCodes LOV" + "description": "Value of the parameter 'codeType' which is required to fetch CateringCodes LOV" }, { "name": "includeInactiveFlag", @@ -3832,7 +3808,7 @@ } }, "204": { - "description": "ToPostalCodesLOV not found." + "description": "CateringCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3882,20 +3858,20 @@ ] } }, - "/listOfValues/currencyCode/{currencyCode}/exchangeTypes": { + "/listOfValues/country/{country}/postalCodes": { "get": { - "summary": "Return list of values for exchange types", - "description": "Use this API to return the list of values for exchange types based on search criteria such as currencyCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getExchangeTypesLOV

", - "operationId": "getExchangeTypesLOV", + "summary": "Fetch List Of Values for Postal Codes", + "description": "

OperationId:getPostalCodesLOV

", + "operationId": "getPostalCodesLOV", "parameters": [ { - "name": "currencyCode", + "name": "country", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'currencyCode' which is required to fetch ExchangeTypes LOV" + "description": "Value of the parameter 'country' which is required to fetch PostalCodes LOV" }, { "name": "includeInactiveFlag", @@ -3969,7 +3945,7 @@ } }, "204": { - "description": "ExchangeTypesLOV not found." + "description": "PostalCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4019,20 +3995,20 @@ ] } }, - "/listOfValues/decimal/{decimal}/currencyFormats": { + "/listOfValues/country/{country}/toPostalCodes": { "get": { - "summary": "Return list of values for currency formats", - "description": "Use this API to return the list of values for currency formats based on search criteria such as decimal, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCurrencyFormatsLOV

", - "operationId": "getCurrencyFormatsLOV", + "summary": "Fetch List Of Values for To Postal Codes", + "description": "

OperationId:getToPostalCodesLOV

", + "operationId": "getToPostalCodesLOV", "parameters": [ { - "name": "decimal", + "name": "country", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'decimal' which is required to fetch CurrencyFormats LOV" + "description": "Value of the parameter 'country' which is required to fetch ToPostalCodes LOV" }, { "name": "includeInactiveFlag", @@ -4106,7 +4082,7 @@ } }, "204": { - "description": "CurrencyFormatsLOV not found." + "description": "ToPostalCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4156,20 +4132,20 @@ ] } }, - "/listOfValues/departments/{departmentType}/noteTypes": { + "/listOfValues/currencyCode/{currencyCode}/exchangeTypes": { "get": { - "summary": "Return list of values for note types", - "description": "Use this API to return the list of values for note types based on search criteria such as departmentType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getNoteTypesLOV

", - "operationId": "getNoteTypesLOV", + "summary": "Fetch List Of Values for Exchange Types", + "description": "

OperationId:getExchangeTypesLOV

", + "operationId": "getExchangeTypesLOV", "parameters": [ { - "name": "departmentType", + "name": "currencyCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'departmentType' which is required to fetch NoteTypes LOV" + "description": "Value of the parameter 'currencyCode' which is required to fetch ExchangeTypes LOV" }, { "name": "includeInactiveFlag", @@ -4243,7 +4219,7 @@ } }, "204": { - "description": "NoteTypesLOV not found." + "description": "ExchangeTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4293,47 +4269,20 @@ ] } }, - "/listOfValues/deviceType/{deviceType}/deviceCode/{deviceCode}/codeType/{codeType}/externalCode/{externalCode}/deviceCodeMappingValues": { + "/listOfValues/decimal/{decimal}/currencyFormats": { "get": { - "summary": "Return list of values for device code mapping values", - "description": "Use this API to return the list of values for device code mapping values based on search criteria such as externalCode, codeType, deviceCode, deviceType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getDeviceCodeMappingValuesLOV

", - "operationId": "getDeviceCodeMappingValuesLOV", + "summary": "Fetch List Of Values for Currency Formats", + "description": "

OperationId:getCurrencyFormatsLOV

", + "operationId": "getCurrencyFormatsLOV", "parameters": [ { - "name": "externalCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'externalCode' which is required to fetch DeviceCodeMappingValues LOV" - }, - { - "name": "codeType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'codeType' which is required to fetch DeviceCodeMappingValues LOV" - }, - { - "name": "deviceCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'deviceCode' which is required to fetch DeviceCodeMappingValues LOV" - }, - { - "name": "deviceType", + "name": "decimal", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'deviceType' which is required to fetch DeviceCodeMappingValues LOV" + "description": "Value of the parameter 'decimal' which is required to fetch CurrencyFormats LOV" }, { "name": "includeInactiveFlag", @@ -4407,7 +4356,7 @@ } }, "204": { - "description": "DeviceCodeMappingValuesLOV not found." + "description": "CurrencyFormatsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4457,20 +4406,20 @@ ] } }, - "/listOfValues/entityName/{entityName}/eCertificateGroupEntity": { + "/listOfValues/departments/{departmentType}/noteTypes": { "get": { - "summary": "Return list of values for ecertificate group entities", - "description": "Use this API to return the list of values for ecertificate group entities based on search criteria such as entityName, includeInactiveFlag, parameterName, parameterValue.

OperationId:getECertificateGroupEntityLOV

", - "operationId": "getECertificateGroupEntityLOV", + "summary": "Fetch List Of Values for Note Types", + "description": "

OperationId:getNoteTypesLOV

", + "operationId": "getNoteTypesLOV", "parameters": [ { - "name": "entityName", + "name": "departmentType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'entityName' which is required to fetch ECertificateGroupEntity LOV" + "description": "Value of the parameter 'departmentType' which is required to fetch NoteTypes LOV" }, { "name": "includeInactiveFlag", @@ -4544,7 +4493,7 @@ } }, "204": { - "description": "ECertificateGroupEntityLOV not found." + "description": "NoteTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4594,157 +4543,47 @@ ] } }, - "/listOfValues/errorType/{errorType}/adsEchoToken": { + "/listOfValues/deviceType/{deviceType}/deviceCode/{deviceCode}/codeType/{codeType}/externalCode/{externalCode}/deviceCodeMappingValues": { "get": { - "summary": "Return list of values for ADSEcho token", - "description": "Use this API to return the list of values for ADSEcho token based on search criteria such as errorType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getADSEchoTokenLOV

", - "operationId": "getADSEchoTokenLOV", + "summary": "Fetch List Of Values for Device Code Mapping Values", + "description": "

OperationId:getDeviceCodeMappingValuesLOV

", + "operationId": "getDeviceCodeMappingValuesLOV", "parameters": [ { - "name": "errorType", + "name": "externalCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'errorType' which is required to fetch ADSEchoToken LOV" - }, - { - "name": "includeInactiveFlag", - "in": "query", - "required": false, - "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", - "type": "boolean" - }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$ref": "#/parameters/x-hotelid" + "description": "Value of the parameter 'externalCode' which is required to fetch DeviceCodeMappingValues LOV" }, { - "$ref": "#/parameters/x-externalsystem" + "name": "codeType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'codeType' which is required to fetch DeviceCodeMappingValues LOV" }, { - "$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": "", - "schema": { - "$ref": "#/definitions/listOfValues" - } - }, - "204": { - "description": "ADSEchoTokenLOV 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" + "name": "deviceCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'deviceCode' which is required to fetch DeviceCodeMappingValues LOV" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/errorType/{errorType}/adsStatus": { - "get": { - "summary": "Return list of values for ADSStatus", - "description": "Use this API to return the list of values for ADSStatus based on search criteria such as errorType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getADSStatusLOV

", - "operationId": "getADSStatusLOV", - "parameters": [ { - "name": "errorType", + "name": "deviceType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'errorType' which is required to fetch ADSStatus LOV" + "description": "Value of the parameter 'deviceType' which is required to fetch DeviceCodeMappingValues LOV" }, { "name": "includeInactiveFlag", @@ -4818,7 +4657,7 @@ } }, "204": { - "description": "ADSStatusLOV not found." + "description": "DeviceCodeMappingValuesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4868,20 +4707,20 @@ ] } }, - "/listOfValues/exclusionList/{exclusionList}/cateringStatusCodes": { + "/listOfValues/entityName/{entityName}/eCertificateGroupEntity": { "get": { - "summary": "Return list of values for catering status codes", - "description": "Use this API to return the list of values for catering status codes based on search criteria such as exclusionList, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCateringStatusCodesLOV

", - "operationId": "getCateringStatusCodesLOV", + "summary": "Fetch List Of Values for ECertificate Group Entity", + "description": "

OperationId:getECertificateGroupEntityLOV

", + "operationId": "getECertificateGroupEntityLOV", "parameters": [ { - "name": "exclusionList", + "name": "entityName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'exclusionList' which is required to fetch CateringStatusCodes LOV" + "description": "Value of the parameter 'entityName' which is required to fetch ECertificateGroupEntity LOV" }, { "name": "includeInactiveFlag", @@ -4955,7 +4794,7 @@ } }, "204": { - "description": "CateringStatusCodesLOV not found." + "description": "ECertificateGroupEntityLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5005,20 +4844,20 @@ ] } }, - "/listOfValues/exclusionList/{exclusionList}/eventStatusCodes": { + "/listOfValues/errorType/{errorType}/adsEchoToken": { "get": { - "summary": "Return list of values for event status codes", - "description": "Use this API to return the list of values for event status codes based on search criteria such as exclusionList, includeInactiveFlag, parameterName, parameterValue.

OperationId:getEventStatusCodesLOV

", - "operationId": "getEventStatusCodesLOV", + "summary": "Fetch List Of Values for ADSEcho Token", + "description": "

OperationId:getADSEchoTokenLOV

", + "operationId": "getADSEchoTokenLOV", "parameters": [ { - "name": "exclusionList", + "name": "errorType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'exclusionList' which is required to fetch EventStatusCodes LOV" + "description": "Value of the parameter 'errorType' which is required to fetch ADSEchoToken LOV" }, { "name": "includeInactiveFlag", @@ -5092,7 +4931,7 @@ } }, "204": { - "description": "EventStatusCodesLOV not found." + "description": "ADSEchoTokenLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5142,29 +4981,20 @@ ] } }, - "/listOfValues/featureType/{featureType}/bookingChannels/{bookingChannelCodes}/gdsConvAmenityCodes": { + "/listOfValues/errorType/{errorType}/adsStatus": { "get": { - "summary": "Return list of values for gds conversion amenity codes", - "description": "Use this API to return the list of values for gds conversion amenity codes based on search criteria such as bookingChannelCodes, featureType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGdsConvAmenityCodesLOV

", - "operationId": "getGdsConvAmenityCodesLOV", + "summary": "Fetch List Of Values for ADSStatus", + "description": "

OperationId:getADSStatusLOV

", + "operationId": "getADSStatusLOV", "parameters": [ { - "name": "bookingChannelCodes", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'bookingChannelCodes' which is required to fetch GdsConvAmenityCodes LOV" - }, - { - "name": "featureType", + "name": "errorType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'featureType' which is required to fetch GdsConvAmenityCodes LOV" + "description": "Value of the parameter 'errorType' which is required to fetch ADSStatus LOV" }, { "name": "includeInactiveFlag", @@ -5238,7 +5068,7 @@ } }, "204": { - "description": "GdsConvAmenityCodesLOV not found." + "description": "ADSStatusLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5288,24 +5118,20 @@ ] } }, - "/listOfValues/fetchOnlyUniqueValues/{fetchOnlyUniqueValues}/templateTransactionSubgroups": { + "/listOfValues/exclusionList/{exclusionList}/cateringStatusCodes": { "get": { - "summary": "Return list of values for transaction subgroup templates", - "description": "Use this API to return the list of values for transaction subgroup templates based on search criteria such as fetchOnlyUniqueValues, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTemplateTransactionSubgroupsLOV

", - "operationId": "getTemplateTransactionSubgroupsLOV", + "summary": "Fetch List Of Values for Catering Status Codes", + "description": "

OperationId:getCateringStatusCodesLOV

", + "operationId": "getCateringStatusCodesLOV", "parameters": [ { - "name": "fetchOnlyUniqueValues", + "name": "exclusionList", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'fetchOnlyUniqueValues' which is required to fetch TemplateTransactionSubgroups LOV", - "enum": [ - "Y", - "N" - ] + "description": "Value of the parameter 'exclusionList' which is required to fetch CateringStatusCodes LOV" }, { "name": "includeInactiveFlag", @@ -5379,7 +5205,7 @@ } }, "204": { - "description": "TemplateTransactionSubgroupsLOV not found." + "description": "CateringStatusCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5429,20 +5255,20 @@ ] } }, - "/listOfValues/fieldType/{fieldType}/globalAlertFunction": { + "/listOfValues/exclusionList/{exclusionList}/eventStatusCodes": { "get": { - "summary": "Return list of values for global alert functions", - "description": "Use this API to return the list of values for global alert functions based on search criteria such as fieldType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGlobalAlertFunctionLOV

", - "operationId": "getGlobalAlertFunctionLOV", + "summary": "Fetch List Of Values for Event Status Codes", + "description": "

OperationId:getEventStatusCodesLOV

", + "operationId": "getEventStatusCodesLOV", "parameters": [ { - "name": "fieldType", + "name": "exclusionList", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'fieldType' which is required to fetch GlobalAlertFunction LOV" + "description": "Value of the parameter 'exclusionList' which is required to fetch EventStatusCodes LOV" }, { "name": "includeInactiveFlag", @@ -5516,7 +5342,7 @@ } }, "204": { - "description": "GlobalAlertFunctionLOV not found." + "description": "EventStatusCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5566,29 +5392,29 @@ ] } }, - "/listOfValues/functionName/{functionName}/category/{category}/userDbFunctionArgs": { + "/listOfValues/featureType/{featureType}/bookingChannels/{bookingChannelCodes}/gdsConvAmenityCodes": { "get": { - "summary": "Return list of values for user database function arguments", - "description": "Use this API to return the list of values for user database function arguments based on search criteria such as category, functionName, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUserDbFunctionArgsLOV

", - "operationId": "getUserDbFunctionArgsLOV", + "summary": "Fetch List Of Values for Gds Conv Amenity Codes", + "description": "

OperationId:getGdsConvAmenityCodesLOV

", + "operationId": "getGdsConvAmenityCodesLOV", "parameters": [ { - "name": "category", + "name": "bookingChannelCodes", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'category' which is required to fetch UserDbFunctionArgs LOV" + "description": "Value of the parameter 'bookingChannelCodes' which is required to fetch GdsConvAmenityCodes LOV" }, { - "name": "functionName", + "name": "featureType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'functionName' which is required to fetch UserDbFunctionArgs LOV" + "description": "Value of the parameter 'featureType' which is required to fetch GdsConvAmenityCodes LOV" }, { "name": "includeInactiveFlag", @@ -5662,7 +5488,7 @@ } }, "204": { - "description": "UserDbFunctionArgsLOV not found." + "description": "GdsConvAmenityCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5712,29 +5538,24 @@ ] } }, - "/listOfValues/gdsHost/{gdsHost}/cardType/{cardType}/channelCardTypeMappingChannelCardType": { + "/listOfValues/fetchOnlyUniqueValues/{fetchOnlyUniqueValues}/templateTransactionSubgroups": { "get": { - "summary": "Return list of values for channel card type mappings", - "description": "Use this API to return the list of values for channel card type mappings based on search criteria such as cardType, gdsHost, includeInactiveFlag, parameterName, parameterValue.

OperationId:getChannelCardTypeMappingChannelCardTypeLOV

", - "operationId": "getChannelCardTypeMappingChannelCardTypeLOV", + "summary": "Fetch List Of Values for Template Transaction Subgroups", + "description": "

OperationId:getTemplateTransactionSubgroupsLOV

", + "operationId": "getTemplateTransactionSubgroupsLOV", "parameters": [ { - "name": "cardType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'cardType' which is required to fetch ChannelCardTypeMappingChannelCardType LOV" - }, - { - "name": "gdsHost", + "name": "fetchOnlyUniqueValues", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'gdsHost' which is required to fetch ChannelCardTypeMappingChannelCardType LOV" + "description": "Value of the parameter 'fetchOnlyUniqueValues' which is required to fetch TemplateTransactionSubgroups LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -5808,7 +5629,7 @@ } }, "204": { - "description": "ChannelCardTypeMappingChannelCardTypeLOV not found." + "description": "TemplateTransactionSubgroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5858,20 +5679,20 @@ ] } }, - "/listOfValues/groupName/{groupName}/repGroupReports": { + "/listOfValues/fieldType/{fieldType}/globalAlertFunction": { "get": { - "summary": "Return list of values for rep group reports", - "description": "Use this API to return the list of values for rep group reports based on search criteria such as groupName, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepGroupReportsLOV

", - "operationId": "getRepGroupReportsLOV", + "summary": "Fetch List Of Values for Global Alert Function", + "description": "

OperationId:getGlobalAlertFunctionLOV

", + "operationId": "getGlobalAlertFunctionLOV", "parameters": [ { - "name": "groupName", + "name": "fieldType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'groupName' which is required to fetch RepGroupReports LOV" + "description": "Value of the parameter 'fieldType' which is required to fetch GlobalAlertFunction LOV" }, { "name": "includeInactiveFlag", @@ -5945,7 +5766,7 @@ } }, "204": { - "description": "RepGroupReportsLOV not found." + "description": "GlobalAlertFunctionLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5995,29 +5816,29 @@ ] } }, - "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequency": { + "/listOfValues/functionName/{functionName}/category/{category}/userDbFunctionArgs": { "get": { - "summary": "Return list of values for frequency", - "description": "Use this API to return the list of values for frequency based on search criteria such as defaultDepartureTask, guestRequested, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFrequencyLOV

", - "operationId": "getFrequencyLOV", + "summary": "Fetch List Of Values for User Db Function Args", + "description": "

OperationId:getUserDbFunctionArgsLOV

", + "operationId": "getUserDbFunctionArgsLOV", "parameters": [ { - "name": "defaultDepartureTask", + "name": "category", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'defaultDepartureTask' which is required to fetch Frequency LOV" + "description": "Value of the parameter 'category' which is required to fetch UserDbFunctionArgs LOV" }, { - "name": "guestRequested", + "name": "functionName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'guestRequested' which is required to fetch Frequency LOV" + "description": "Value of the parameter 'functionName' which is required to fetch UserDbFunctionArgs LOV" }, { "name": "includeInactiveFlag", @@ -6091,7 +5912,7 @@ } }, "204": { - "description": "FrequencyLOV not found." + "description": "UserDbFunctionArgsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6141,29 +5962,29 @@ ] } }, - "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequencyType": { + "/listOfValues/gdsHost/{gdsHost}/cardType/{cardType}/channelCardTypeMappingChannelCardType": { "get": { - "summary": "Return list of values for frequency types", - "description": "Use this API to return the list of values for frequency types based on search criteria such as defaultDepartureTask, guestRequested, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFrequencyTypeLOV

", - "operationId": "getFrequencyTypeLOV", + "summary": "Fetch List Of Values for Channel Card Type Mapping Channel Card Type", + "description": "

OperationId:getChannelCardTypeMappingChannelCardTypeLOV

", + "operationId": "getChannelCardTypeMappingChannelCardTypeLOV", "parameters": [ { - "name": "defaultDepartureTask", + "name": "cardType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'defaultDepartureTask' which is required to fetch FrequencyType LOV" + "description": "Value of the parameter 'cardType' which is required to fetch ChannelCardTypeMappingChannelCardType LOV" }, { - "name": "guestRequested", + "name": "gdsHost", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'guestRequested' which is required to fetch FrequencyType LOV" + "description": "Value of the parameter 'gdsHost' which is required to fetch ChannelCardTypeMappingChannelCardType LOV" }, { "name": "includeInactiveFlag", @@ -6237,7 +6058,7 @@ } }, "204": { - "description": "FrequencyTypeLOV not found." + "description": "ChannelCardTypeMappingChannelCardTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6287,20 +6108,20 @@ ] } }, - "/listOfValues/hotelCodeList/{hotelCodeList}/queueName": { + "/listOfValues/groupName/{groupName}/repGroupReports": { "get": { - "summary": "Return list of values for queue names", - "description": "Use this API to return the list of values for queue names based on search criteria such as hotelCodeList, includeInactiveFlag, parameterName, parameterValue.

OperationId:getQueueNameLOV

", - "operationId": "getQueueNameLOV", + "summary": "Fetch List Of Values for Rep Group Reports", + "description": "

OperationId:getRepGroupReportsLOV

", + "operationId": "getRepGroupReportsLOV", "parameters": [ { - "name": "hotelCodeList", + "name": "groupName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelCodeList' which is required to fetch QueueName LOV" + "description": "Value of the parameter 'groupName' which is required to fetch RepGroupReports LOV" }, { "name": "includeInactiveFlag", @@ -6374,7 +6195,7 @@ } }, "204": { - "description": "QueueNameLOV not found." + "description": "RepGroupReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6424,20 +6245,29 @@ ] } }, - "/listOfValues/hotelCodeList/{hotelCodeList}/repRoomTypeMultiHotel": { + "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequency": { "get": { - "summary": "Return list of values for rep room type multi hotel", - "description": "Use this API to return the list of values for rep room type multi hotel based on search criteria such as hotelCodeList, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepRoomTypeMultiHotelLOV

", - "operationId": "getRepRoomTypeMultiHotelLOV", + "summary": "Fetch List Of Values for Frequency", + "description": "

OperationId:getFrequencyLOV

", + "operationId": "getFrequencyLOV", "parameters": [ { - "name": "hotelCodeList", + "name": "defaultDepartureTask", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelCodeList' which is required to fetch RepRoomTypeMultiHotel LOV" + "description": "Value of the parameter 'defaultDepartureTask' which is required to fetch Frequency LOV" + }, + { + "name": "guestRequested", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'guestRequested' which is required to fetch Frequency LOV" }, { "name": "includeInactiveFlag", @@ -6511,7 +6341,7 @@ } }, "204": { - "description": "RepRoomTypeMultiHotelLOV not found." + "description": "FrequencyLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6561,20 +6391,29 @@ ] } }, - "/listOfValues/hotelCodeList/{hotelCodeList}/roomClassMultiProperty": { + "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequencyType": { "get": { - "summary": "Return list of values for room class multi property", - "description": "Use this API to return the list of values for room class multi property based on search criteria such as hotelCodeList, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomClassMultiPropertyLOV

", - "operationId": "getRoomClassMultiPropertyLOV", + "summary": "Fetch List Of Values for Frequency Type", + "description": "

OperationId:getFrequencyTypeLOV

", + "operationId": "getFrequencyTypeLOV", "parameters": [ { - "name": "hotelCodeList", + "name": "defaultDepartureTask", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelCodeList' which is required to fetch RoomClassMultiProperty LOV" + "description": "Value of the parameter 'defaultDepartureTask' which is required to fetch FrequencyType LOV" + }, + { + "name": "guestRequested", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'guestRequested' which is required to fetch FrequencyType LOV" }, { "name": "includeInactiveFlag", @@ -6648,7 +6487,7 @@ } }, "204": { - "description": "RoomClassMultiPropertyLOV not found." + "description": "FrequencyTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6698,20 +6537,20 @@ ] } }, - "/listOfValues/hotelCodesList/{hotelCodesList}/repOwnerCodes": { + "/listOfValues/hotelCodeList/{hotelCodeList}/queueName": { "get": { - "summary": "Return list of values for rep owner codes", - "description": "Use this API to return the list of values for rep owner codes based on search criteria such as hotelCodeList, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepOwnerCodesLOV

", - "operationId": "getRepOwnerCodesLOV", + "summary": "Fetch List Of Values for Queue Name", + "description": "

OperationId:getQueueNameLOV

", + "operationId": "getQueueNameLOV", "parameters": [ { - "name": "hotelCodesList", + "name": "hotelCodeList", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelCodesList' which is required to fetch RepOwnerCodes LOV" + "description": "Value of the parameter 'hotelCodeList' which is required to fetch QueueName LOV" }, { "name": "includeInactiveFlag", @@ -6785,7 +6624,7 @@ } }, "204": { - "description": "RepOwnerCodesLOV not found." + "description": "QueueNameLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6835,20 +6674,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activities": { + "/listOfValues/hotelCodeList/{hotelCodeList}/repRoomTypeMultiHotel": { "get": { - "summary": "Return list of values for hotel activities", - "description": "Use this API to return the list of values for activities for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getActivitiesLOV

", - "operationId": "getActivitiesLOV", + "summary": "Fetch List Of Values for Rep Room Type Multi Hotel", + "description": "

OperationId:getRepRoomTypeMultiHotelLOV

", + "operationId": "getRepRoomTypeMultiHotelLOV", "parameters": [ { - "name": "hotelId", + "name": "hotelCodeList", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Activities LOV" + "description": "Value of the parameter 'hotelCodeList' which is required to fetch RepRoomTypeMultiHotel LOV" }, { "name": "includeInactiveFlag", @@ -6922,7 +6761,7 @@ } }, "204": { - "description": "ActivitiesLOV not found." + "description": "RepRoomTypeMultiHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6972,20 +6811,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activityConfigTypes": { + "/listOfValues/hotelCodeList/{hotelCodeList}/roomClassMultiProperty": { "get": { - "summary": "Return list of values for hotel activity config types", - "description": "Use this API to return the list of values for activities config types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getActivityConfigTypesLOV

", - "operationId": "getActivityConfigTypesLOV", + "summary": "Fetch List Of Values for Room Class Multi Property", + "description": "

OperationId:getRoomClassMultiPropertyLOV

", + "operationId": "getRoomClassMultiPropertyLOV", "parameters": [ { - "name": "hotelId", + "name": "hotelCodeList", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ActivityConfigTypes LOV" + "description": "Value of the parameter 'hotelCodeList' which is required to fetch RoomClassMultiProperty LOV" }, { "name": "includeInactiveFlag", @@ -7059,7 +6898,7 @@ } }, "204": { - "description": "ActivityConfigTypesLOV not found." + "description": "RoomClassMultiPropertyLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7109,29 +6948,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activityGroup/{activityGroup}/userLogActivityTypes": { + "/listOfValues/hotelCodesList/{hotelCodesList}/repOwnerCodes": { "get": { - "summary": "Return list of values for hotel user log activity types", - "description": "Use this API to return the list of values for user log activity types for a specific property based on search criteria such as activityGroup, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUserLogActivityTypesLOV

", - "operationId": "getUserLogActivityTypesLOV", + "summary": "Fetch List Of Values for Rep Owner Codes", + "description": "

OperationId:getRepOwnerCodesLOV

", + "operationId": "getRepOwnerCodesLOV", "parameters": [ { - "name": "activityGroup", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'activityGroup' which is required to fetch UserLogActivityTypes LOV" - }, - { - "name": "hotelId", + "name": "hotelCodesList", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UserLogActivityTypes LOV" + "description": "Value of the parameter 'hotelCodesList' which is required to fetch RepOwnerCodes LOV" }, { "name": "includeInactiveFlag", @@ -7205,7 +7035,7 @@ } }, "204": { - "description": "UserLogActivityTypesLOV not found." + "description": "RepOwnerCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7255,11 +7085,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activityLocations": { + "/listOfValues/hotels/{hotelId}/activities": { "get": { - "summary": "Return list of values for hotel activity locations", - "description": "Use this API to return the list of values for activity locations for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getActivityLocationsLOV

", - "operationId": "getActivityLocationsLOV", + "summary": "Fetch List Of Values for Activities", + "description": "

OperationId:getActivitiesLOV

", + "operationId": "getActivitiesLOV", "parameters": [ { "name": "hotelId", @@ -7268,7 +7098,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ActivityLocations LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Activities LOV" }, { "name": "includeInactiveFlag", @@ -7342,7 +7172,7 @@ } }, "204": { - "description": "ActivityLocationsLOV not found." + "description": "ActivitiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7392,11 +7222,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activityStatus": { + "/listOfValues/hotels/{hotelId}/activityConfigTypes": { "get": { - "summary": "Return list of values for hotel activity status", - "description": "Use this API to return the list of values for activity status for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getActivityStatusLOV

", - "operationId": "getActivityStatusLOV", + "summary": "Fetch List Of Values for Activity Config Types", + "description": "

OperationId:getActivityConfigTypesLOV

", + "operationId": "getActivityConfigTypesLOV", "parameters": [ { "name": "hotelId", @@ -7405,7 +7235,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ActivityStatus LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ActivityConfigTypes LOV" }, { "name": "includeInactiveFlag", @@ -7479,7 +7309,7 @@ } }, "204": { - "description": "ActivityStatusLOV not found." + "description": "ActivityConfigTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7529,12 +7359,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activityTypes": { + "/listOfValues/hotels/{hotelId}/activityGroup/{activityGroup}/userLogActivityTypes": { "get": { - "summary": "Return list of values for hotel activity types", - "description": "Use this API to return the list of values for activity types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getActivityTypesLOV

", - "operationId": "getActivityTypesLOV", + "summary": "Fetch List Of Values for User Log Activity Types", + "description": "

OperationId:getUserLogActivityTypesLOV

", + "operationId": "getUserLogActivityTypesLOV", "parameters": [ + { + "name": "activityGroup", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'activityGroup' which is required to fetch UserLogActivityTypes LOV" + }, { "name": "hotelId", "in": "path", @@ -7542,7 +7381,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ActivityTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UserLogActivityTypes LOV" }, { "name": "includeInactiveFlag", @@ -7616,7 +7455,7 @@ } }, "204": { - "description": "ActivityTypesLOV not found." + "description": "UserLogActivityTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7666,48 +7505,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/adults/{adults}/children/{children}/arrival/{arrival}/departure/{departure}/reservationPackages": { + "/listOfValues/hotels/{hotelId}/activityLocations": { "get": { - "summary": "Return list of values for hotel reservation packages", - "description": "Use this API to return the list of values for reservation packages for a specific property based on search criteria such as departure, arrival, children, adults, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getReservationPackagesLOV

", - "operationId": "getReservationPackagesLOV", + "summary": "Fetch List Of Values for Activity Locations", + "description": "

OperationId:getActivityLocationsLOV

", + "operationId": "getActivityLocationsLOV", "parameters": [ - { - "name": "departure", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'departure' which is required to fetch ReservationPackages LOV" - }, - { - "name": "arrival", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'arrival' which is required to fetch ReservationPackages LOV" - }, - { - "name": "children", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'children' which is required to fetch ReservationPackages LOV" - }, - { - "name": "adults", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'adults' which is required to fetch ReservationPackages LOV" - }, { "name": "hotelId", "in": "path", @@ -7715,7 +7518,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ReservationPackages LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ActivityLocations LOV" }, { "name": "includeInactiveFlag", @@ -7789,7 +7592,7 @@ } }, "204": { - "description": "ReservationPackagesLOV not found." + "description": "ActivityLocationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7839,48 +7642,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/adults/{adults}/children/{children}/arrival/{arrival}/group/{group}/reservationPackagesGroupItems": { + "/listOfValues/hotels/{hotelId}/activityStatus": { "get": { - "summary": "Return list of values for hotel reservation package group items", - "description": "Use this API to return the list of values for reservation package group items for a specific property based on search criteria such as group, arrival, children, adults, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getReservationPackagesGroupItemsLOV

", - "operationId": "getReservationPackagesGroupItemsLOV", + "summary": "Fetch List Of Values for Activity Status", + "description": "

OperationId:getActivityStatusLOV

", + "operationId": "getActivityStatusLOV", "parameters": [ - { - "name": "group", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'group' which is required to fetch ReservationPackagesGroupItems LOV" - }, - { - "name": "arrival", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'arrival' which is required to fetch ReservationPackagesGroupItems LOV" - }, - { - "name": "children", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'children' which is required to fetch ReservationPackagesGroupItems LOV" - }, - { - "name": "adults", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'adults' which is required to fetch ReservationPackagesGroupItems LOV" - }, { "name": "hotelId", "in": "path", @@ -7888,7 +7655,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ReservationPackagesGroupItems LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ActivityStatus LOV" }, { "name": "includeInactiveFlag", @@ -7962,7 +7729,7 @@ } }, "204": { - "description": "ReservationPackagesGroupItemsLOV not found." + "description": "ActivityStatusLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8012,11 +7779,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/agentAccounts": { + "/listOfValues/hotels/{hotelId}/activityTypes": { "get": { - "summary": "Return list of values for hotel agent accounts", - "description": "Use this API to return the list of values for agent accounts for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAgentAccountsLOV

", - "operationId": "getAgentAccountsLOV", + "summary": "Fetch List Of Values for Activity Types", + "description": "

OperationId:getActivityTypesLOV

", + "operationId": "getActivityTypesLOV", "parameters": [ { "name": "hotelId", @@ -8025,7 +7792,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AgentAccounts LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ActivityTypes LOV" }, { "name": "includeInactiveFlag", @@ -8099,7 +7866,7 @@ } }, "204": { - "description": "AgentAccountsLOV not found." + "description": "ActivityTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8149,149 +7916,48 @@ ] } }, - "/listOfValues/hotels/{hotelId}/agentSourceCities": { + "/listOfValues/hotels/{hotelId}/adults/{adults}/children/{children}/arrival/{arrival}/departure/{departure}/reservationPackages": { "get": { - "summary": "Return list of values for hotel agent source cities", - "description": "Use this API to return the list of values for agent source cities for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAgentSourceCitiesLOV

", - "operationId": "getAgentSourceCitiesLOV", + "summary": "Fetch List Of Values for Reservation Packages", + "description": "

OperationId:getReservationPackagesLOV

", + "operationId": "getReservationPackagesLOV", "parameters": [ { - "name": "hotelId", + "name": "departure", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AgentSourceCities LOV" - }, - { - "name": "includeInactiveFlag", - "in": "query", - "required": false, - "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", - "type": "boolean" - }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" + "description": "Value of the parameter 'departure' which is required to fetch ReservationPackages LOV" }, { - "$ref": "#/parameters/x-hotelid" + "name": "arrival", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'arrival' which is required to fetch ReservationPackages LOV" }, { - "$ref": "#/parameters/x-externalsystem" + "name": "children", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'children' which is required to fetch ReservationPackages LOV" }, { - "$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": "", - "schema": { - "$ref": "#/definitions/listOfValues" - } - }, - "204": { - "description": "AgentSourceCitiesLOV 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" + "name": "adults", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'adults' which is required to fetch ReservationPackages LOV" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/agentSourceResvCities": { - "get": { - "summary": "Return list of values for hotel agent source reservation cities", - "description": "Use this API to return the list of values for agent source reservation cities for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAgentSourceResvCitiesLOV

", - "operationId": "getAgentSourceResvCitiesLOV", - "parameters": [ { "name": "hotelId", "in": "path", @@ -8299,7 +7965,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AgentSourceResvCities LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ReservationPackages LOV" }, { "name": "includeInactiveFlag", @@ -8373,7 +8039,7 @@ } }, "204": { - "description": "AgentSourceResvCitiesLOV not found." + "description": "ReservationPackagesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8423,12 +8089,48 @@ ] } }, - "/listOfValues/hotels/{hotelId}/alertCodes": { + "/listOfValues/hotels/{hotelId}/adults/{adults}/children/{children}/arrival/{arrival}/group/{group}/reservationPackagesGroupItems": { "get": { - "summary": "Return list of values for hotel alert codes", - "description": "Use this API to return the list of values for alert codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAlertCodesLOV

", - "operationId": "getAlertCodesLOV", + "summary": "Fetch List Of Values for Reservation Packages Group Items", + "description": "

OperationId:getReservationPackagesGroupItemsLOV

", + "operationId": "getReservationPackagesGroupItemsLOV", "parameters": [ + { + "name": "group", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'group' which is required to fetch ReservationPackagesGroupItems LOV" + }, + { + "name": "arrival", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'arrival' which is required to fetch ReservationPackagesGroupItems LOV" + }, + { + "name": "children", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'children' which is required to fetch ReservationPackagesGroupItems LOV" + }, + { + "name": "adults", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'adults' which is required to fetch ReservationPackagesGroupItems LOV" + }, { "name": "hotelId", "in": "path", @@ -8436,7 +8138,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AlertCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ReservationPackagesGroupItems LOV" }, { "name": "includeInactiveFlag", @@ -8510,7 +8212,7 @@ } }, "204": { - "description": "AlertCodesLOV not found." + "description": "ReservationPackagesGroupItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8560,11 +8262,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/alternateHotelCodes": { + "/listOfValues/hotels/{hotelId}/agentAccounts": { "get": { - "summary": "Return list of values for hotel alternate hotel codes", - "description": "Use this API to return the list of values for alternate hotel codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAlternateHotelCodesLOV

", - "operationId": "getAlternateHotelCodesLOV", + "summary": "Fetch List Of Values for Agent Accounts", + "description": "

OperationId:getAgentAccountsLOV

", + "operationId": "getAgentAccountsLOV", "parameters": [ { "name": "hotelId", @@ -8573,7 +8275,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AlternateHotelCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AgentAccounts LOV" }, { "name": "includeInactiveFlag", @@ -8647,7 +8349,7 @@ } }, "204": { - "description": "AlternateHotelCodesLOV not found." + "description": "AgentAccountsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8697,11 +8399,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/amenities": { + "/listOfValues/hotels/{hotelId}/agentSourceCities": { "get": { - "summary": "Return list of values for hotel amenities", - "description": "Use this API to return the list of values for amenities for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAmenitiesLOV

", - "operationId": "getAmenitiesLOV", + "summary": "Fetch List Of Values for Agent Source Cities", + "description": "

OperationId:getAgentSourceCitiesLOV

", + "operationId": "getAgentSourceCitiesLOV", "parameters": [ { "name": "hotelId", @@ -8710,7 +8412,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Amenities LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AgentSourceCities LOV" }, { "name": "includeInactiveFlag", @@ -8784,7 +8486,7 @@ } }, "204": { - "description": "AmenitiesLOV not found." + "description": "AgentSourceCitiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8834,11 +8536,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arAccountTypes": { + "/listOfValues/hotels/{hotelId}/agentSourceResvCities": { "get": { - "summary": "Return list of values for hotel ARAccount types", - "description": "Use this API to return the list of values for ARAccount types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getARAccountTypesLOV

", - "operationId": "getARAccountTypesLOV", + "summary": "Fetch List Of Values for Agent Source Resv Cities", + "description": "

OperationId:getAgentSourceResvCitiesLOV

", + "operationId": "getAgentSourceResvCitiesLOV", "parameters": [ { "name": "hotelId", @@ -8847,7 +8549,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ARAccountTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AgentSourceResvCities LOV" }, { "name": "includeInactiveFlag", @@ -8921,7 +8623,7 @@ } }, "204": { - "description": "ARAccountTypesLOV not found." + "description": "AgentSourceResvCitiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8971,11 +8673,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arCreditCards": { + "/listOfValues/hotels/{hotelId}/alertCodes": { "get": { - "summary": "Return list of values for hotel ARCredit cards", - "description": "Use this API to return the list of values for ARCredit cards for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getARCreditCardsLOV

", - "operationId": "getARCreditCardsLOV", + "summary": "Fetch List Of Values for Alert Codes", + "description": "

OperationId:getAlertCodesLOV

", + "operationId": "getAlertCodesLOV", "parameters": [ { "name": "hotelId", @@ -8984,7 +8686,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ARCreditCards LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AlertCodes LOV" }, { "name": "includeInactiveFlag", @@ -9058,7 +8760,7 @@ } }, "204": { - "description": "ARCreditCardsLOV not found." + "description": "AlertCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9108,11 +8810,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arrangementCode": { + "/listOfValues/hotels/{hotelId}/alternateHotelCodes": { "get": { - "summary": "Return list of values for hotel arrangement codes", - "description": "Use this API to return the list of values for arrangement codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getArrangementCodeLOV

", - "operationId": "getArrangementCodeLOV", + "summary": "Fetch List Of Values for Alternate Hotel Codes", + "description": "

OperationId:getAlternateHotelCodesLOV

", + "operationId": "getAlternateHotelCodesLOV", "parameters": [ { "name": "hotelId", @@ -9121,7 +8823,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ArrangementCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AlternateHotelCodes LOV" }, { "name": "includeInactiveFlag", @@ -9195,7 +8897,7 @@ } }, "204": { - "description": "ArrangementCodeLOV not found." + "description": "AlternateHotelCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9245,21 +8947,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arrangementCode/{arrangementCode}/packageArrangementAssociation": { + "/listOfValues/hotels/{hotelId}/amenities": { "get": { - "summary": "Return list of values for hotel package arrangement associations", - "description": "Use this API to return the list of values for package arrangement associations for a specific property based on search criteria such as arrangementCode, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPackageArrangementAssociationLOV

", - "operationId": "getPackageArrangementAssociationLOV", + "summary": "Fetch List Of Values for Amenities", + "description": "

OperationId:getAmenitiesLOV

", + "operationId": "getAmenitiesLOV", "parameters": [ - { - "name": "arrangementCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'arrangementCode' which is required to fetch PackageArrangementAssociation LOV" - }, { "name": "hotelId", "in": "path", @@ -9267,7 +8960,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PackageArrangementAssociation LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Amenities LOV" }, { "name": "includeInactiveFlag", @@ -9341,7 +9034,7 @@ } }, "204": { - "description": "PackageArrangementAssociationLOV not found." + "description": "AmenitiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9391,39 +9084,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arrival/{arrival}/departure/{departure}/blockId/{blockId}/blockRates": { + "/listOfValues/hotels/{hotelId}/arAccountTypes": { "get": { - "summary": "Return list of values for hotel block rates", - "description": "Use this API to return the list of values for block rates for a specific property based on search criteria such as blockId, departure, arrival, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockRatesLOV

", - "operationId": "getBlockRatesLOV", + "summary": "Fetch List Of Values for ARAccount Types", + "description": "

OperationId:getARAccountTypesLOV

", + "operationId": "getARAccountTypesLOV", "parameters": [ - { - "name": "blockId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'blockId' which is required to fetch BlockRates LOV" - }, - { - "name": "departure", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'departure' which is required to fetch BlockRates LOV" - }, - { - "name": "arrival", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'arrival' which is required to fetch BlockRates LOV" - }, { "name": "hotelId", "in": "path", @@ -9431,7 +9097,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BlockRates LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ARAccountTypes LOV" }, { "name": "includeInactiveFlag", @@ -9505,7 +9171,7 @@ } }, "204": { - "description": "BlockRatesLOV not found." + "description": "ARAccountTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9555,30 +9221,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arrival/{arrival}/departure/{departure}/reservationTicketsCodes": { + "/listOfValues/hotels/{hotelId}/arCreditCards": { "get": { - "summary": "Return list of values for hotel reservation tickets codes", - "description": "Use this API to return the list of values for reservation tickets codes for a specific property based on search criteria such as departure, arrival, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getReservationTicketsCodesLOV

", - "operationId": "getReservationTicketsCodesLOV", + "summary": "Fetch List Of Values for ARCredit Cards", + "description": "

OperationId:getARCreditCardsLOV

", + "operationId": "getARCreditCardsLOV", "parameters": [ - { - "name": "departure", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'departure' which is required to fetch ReservationTicketsCodes LOV" - }, - { - "name": "arrival", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'arrival' which is required to fetch ReservationTicketsCodes LOV" - }, { "name": "hotelId", "in": "path", @@ -9586,7 +9234,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ReservationTicketsCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ARCreditCards LOV" }, { "name": "includeInactiveFlag", @@ -9660,7 +9308,7 @@ } }, "204": { - "description": "ReservationTicketsCodesLOV not found." + "description": "ARCreditCardsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9710,21 +9358,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arrivalDate/{arrivalDate}/blockCodesByArrivalDate": { + "/listOfValues/hotels/{hotelId}/arrangementCode": { "get": { - "summary": "Return list of values for hotel block codes by arrival date", - "description": "Use this API to return the list of values for block codes by arrival date for a specific property based on search criteria such as arrivalDate, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockCodesByArrivalDateLOV

", - "operationId": "getBlockCodesByArrivalDateLOV", + "summary": "Fetch List Of Values for Arrangement Code", + "description": "

OperationId:getArrangementCodeLOV

", + "operationId": "getArrangementCodeLOV", "parameters": [ - { - "name": "arrivalDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'arrivalDate' which is required to fetch BlockCodesByArrivalDate LOV" - }, { "name": "hotelId", "in": "path", @@ -9732,7 +9371,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BlockCodesByArrivalDate LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ArrangementCode LOV" }, { "name": "includeInactiveFlag", @@ -9806,7 +9445,7 @@ } }, "204": { - "description": "BlockCodesByArrivalDateLOV not found." + "description": "ArrangementCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9856,12 +9495,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/articleCodes": { + "/listOfValues/hotels/{hotelId}/arrangementCode/{arrangementCode}/packageArrangementAssociation": { "get": { - "summary": "Return list of values for hotel article codes", - "description": "Use this API to return the list of values for article codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getArticleCodesLOV

", - "operationId": "getArticleCodesLOV", + "summary": "Fetch List Of Values for Package Arrangement Association", + "description": "

OperationId:getPackageArrangementAssociationLOV

", + "operationId": "getPackageArrangementAssociationLOV", "parameters": [ + { + "name": "arrangementCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'arrangementCode' which is required to fetch PackageArrangementAssociation LOV" + }, { "name": "hotelId", "in": "path", @@ -9869,7 +9517,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ArticleCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PackageArrangementAssociation LOV" }, { "name": "includeInactiveFlag", @@ -9943,7 +9591,7 @@ } }, "204": { - "description": "ArticleCodesLOV not found." + "description": "PackageArrangementAssociationLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9993,12 +9641,39 @@ ] } }, - "/listOfValues/hotels/{hotelId}/attractions": { + "/listOfValues/hotels/{hotelId}/arrival/{arrival}/departure/{departure}/blockId/{blockId}/blockRates": { "get": { - "summary": "Return list of values for hotel attractions", - "description": "Use this API to return the list of values for attractions for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAttractionsLOV

", - "operationId": "getAttractionsLOV", + "summary": "Fetch List Of Values for Block Rates", + "description": "

OperationId:getBlockRatesLOV

", + "operationId": "getBlockRatesLOV", "parameters": [ + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'blockId' which is required to fetch BlockRates LOV" + }, + { + "name": "departure", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'departure' which is required to fetch BlockRates LOV" + }, + { + "name": "arrival", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'arrival' which is required to fetch BlockRates LOV" + }, { "name": "hotelId", "in": "path", @@ -10006,7 +9681,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Attractions LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BlockRates LOV" }, { "name": "includeInactiveFlag", @@ -10080,7 +9755,7 @@ } }, "204": { - "description": "AttractionsLOV not found." + "description": "BlockRatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10130,12 +9805,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/authorizer": { + "/listOfValues/hotels/{hotelId}/arrival/{arrival}/departure/{departure}/reservationTicketsCodes": { "get": { - "summary": "Return list of values for hotel authorizers", - "description": "Use this API to return the list of values for authorizers for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAuthorizerLOV

", - "operationId": "getAuthorizerLOV", + "summary": "Fetch List Of Values for Reservation Tickets Codes", + "description": "

OperationId:getReservationTicketsCodesLOV

", + "operationId": "getReservationTicketsCodesLOV", "parameters": [ + { + "name": "departure", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'departure' which is required to fetch ReservationTicketsCodes LOV" + }, + { + "name": "arrival", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'arrival' which is required to fetch ReservationTicketsCodes LOV" + }, { "name": "hotelId", "in": "path", @@ -10143,7 +9836,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Authorizer LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ReservationTicketsCodes LOV" }, { "name": "includeInactiveFlag", @@ -10217,7 +9910,7 @@ } }, "204": { - "description": "AuthorizerLOV not found." + "description": "ReservationTicketsCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10267,12 +9960,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/availableProfileOwnerRooms": { + "/listOfValues/hotels/{hotelId}/arrivalDate/{arrivalDate}/blockCodesByArrivalDate": { "get": { - "summary": "Return list of values for hotel available profile owner rooms", - "description": "Use this API to return the list of values for available profile owner rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAvailableProfileOwnerRoomsLOV

", - "operationId": "getAvailableProfileOwnerRoomsLOV", + "summary": "Fetch List Of Values for Block Codes By Arrival Date", + "description": "

OperationId:getBlockCodesByArrivalDateLOV

", + "operationId": "getBlockCodesByArrivalDateLOV", "parameters": [ + { + "name": "arrivalDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'arrivalDate' which is required to fetch BlockCodesByArrivalDate LOV" + }, { "name": "hotelId", "in": "path", @@ -10280,7 +9982,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AvailableProfileOwnerRooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BlockCodesByArrivalDate LOV" }, { "name": "includeInactiveFlag", @@ -10354,7 +10056,7 @@ } }, "204": { - "description": "AvailableProfileOwnerRoomsLOV not found." + "description": "BlockCodesByArrivalDateLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10404,11 +10106,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/availableScriptLanguages": { + "/listOfValues/hotels/{hotelId}/articleCodes": { "get": { - "summary": "Return list of values for hotel available script languages", - "description": "Use this API to return the list of values for available script languages for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAvailableScriptLanguagesLOV

", - "operationId": "getAvailableScriptLanguagesLOV", + "summary": "Fetch List Of Values for Article Codes", + "description": "

OperationId:getArticleCodesLOV

", + "operationId": "getArticleCodesLOV", "parameters": [ { "name": "hotelId", @@ -10417,7 +10119,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AvailableScriptLanguages LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ArticleCodes LOV" }, { "name": "includeInactiveFlag", @@ -10491,7 +10193,7 @@ } }, "204": { - "description": "AvailableScriptLanguagesLOV not found." + "description": "ArticleCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10541,11 +10243,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/awardCodes": { + "/listOfValues/hotels/{hotelId}/attractions": { "get": { - "summary": "Return list of values for hotel award codes", - "description": "Use this API to return the list of values for award codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAwardCodesLOV

", - "operationId": "getAwardCodesLOV", + "summary": "Fetch List Of Values for Attractions", + "description": "

OperationId:getAttractionsLOV

", + "operationId": "getAttractionsLOV", "parameters": [ { "name": "hotelId", @@ -10554,7 +10256,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AwardCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Attractions LOV" }, { "name": "includeInactiveFlag", @@ -10628,7 +10330,7 @@ } }, "204": { - "description": "AwardCodesLOV not found." + "description": "AttractionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10678,11 +10380,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/awardCodesMultiHotel": { + "/listOfValues/hotels/{hotelId}/authorizer": { "get": { - "summary": "Return list of values for hotel award codes multi hotel", - "description": "Use this API to return the list of values for award codes multi hotel for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAwardCodesMultiHotelLOV

", - "operationId": "getAwardCodesMultiHotelLOV", + "summary": "Fetch List Of Values for Authorizer", + "description": "

OperationId:getAuthorizerLOV

", + "operationId": "getAuthorizerLOV", "parameters": [ { "name": "hotelId", @@ -10691,7 +10393,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AwardCodesMultiHotel LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Authorizer LOV" }, { "name": "includeInactiveFlag", @@ -10765,7 +10467,7 @@ } }, "204": { - "description": "AwardCodesMultiHotelLOV not found." + "description": "AuthorizerLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10815,11 +10517,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/awardMktgCodes": { + "/listOfValues/hotels/{hotelId}/availableProfileOwnerRooms": { "get": { - "summary": "Return list of values for hotel award marketing codes", - "description": "Use this API to return the list of values for award marketing codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAwardMktgCodesLOV

", - "operationId": "getAwardMktgCodesLOV", + "summary": "Fetch List Of Values for Available Profile Owner Rooms", + "description": "

OperationId:getAvailableProfileOwnerRoomsLOV

", + "operationId": "getAvailableProfileOwnerRoomsLOV", "parameters": [ { "name": "hotelId", @@ -10828,7 +10530,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AwardMktgCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AvailableProfileOwnerRooms LOV" }, { "name": "includeInactiveFlag", @@ -10902,7 +10604,7 @@ } }, "204": { - "description": "AwardMktgCodesLOV not found." + "description": "AvailableProfileOwnerRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10952,11 +10654,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bankAccounts": { + "/listOfValues/hotels/{hotelId}/availableScriptLanguages": { "get": { - "summary": "Return list of values for hotel bank accounts", - "description": "Use this API to return the list of values for bank accounts for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBankAccountsLOV

", - "operationId": "getBankAccountsLOV", + "summary": "Fetch List Of Values for Available Script Languages", + "description": "

OperationId:getAvailableScriptLanguagesLOV

", + "operationId": "getAvailableScriptLanguagesLOV", "parameters": [ { "name": "hotelId", @@ -10965,7 +10667,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BankAccounts LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AvailableScriptLanguages LOV" }, { "name": "includeInactiveFlag", @@ -11039,7 +10741,7 @@ } }, "204": { - "description": "BankAccountsLOV not found." + "description": "AvailableScriptLanguagesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11089,11 +10791,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bankAccountsForReports": { + "/listOfValues/hotels/{hotelId}/awardCodes": { "get": { - "summary": "Return list of values for hotel bank accounts for reports", - "description": "Use this API to return the list of values for bank accounts for reports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBankAccountsForReportsLOV

", - "operationId": "getBankAccountsForReportsLOV", + "summary": "Fetch List Of Values for Award Codes", + "description": "

OperationId:getAwardCodesLOV

", + "operationId": "getAwardCodesLOV", "parameters": [ { "name": "hotelId", @@ -11102,7 +10804,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BankAccountsForReports LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AwardCodes LOV" }, { "name": "includeInactiveFlag", @@ -11176,7 +10878,7 @@ } }, "204": { - "description": "BankAccountsForReportsLOV not found." + "description": "AwardCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11226,11 +10928,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/banquetPrintingMethod": { + "/listOfValues/hotels/{hotelId}/awardCodesMultiHotel": { "get": { - "summary": "Return list of values for hotel banquet printing methods", - "description": "Use this API to return the list of values for banquet printing methods for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBanquetPrintingMethodLOV

", - "operationId": "getBanquetPrintingMethodLOV", + "summary": "Fetch List Of Values for Award Codes Multi Hotel", + "description": "

OperationId:getAwardCodesMultiHotelLOV

", + "operationId": "getAwardCodesMultiHotelLOV", "parameters": [ { "name": "hotelId", @@ -11239,7 +10941,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BanquetPrintingMethod LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AwardCodesMultiHotel LOV" }, { "name": "includeInactiveFlag", @@ -11313,7 +11015,7 @@ } }, "204": { - "description": "BanquetPrintingMethodLOV not found." + "description": "AwardCodesMultiHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11363,25 +11065,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beforeIncomeAudit/{beforeIncomeAudit}/endOfDayReports": { + "/listOfValues/hotels/{hotelId}/awardMktgCodes": { "get": { - "summary": "Return list of values for hotel end of day reports", - "description": "Use this API to return the list of values for end of day reports for a specific property based on search criteria such as beforeIncomeAudit, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getEndOfDayReportsLOV

", - "operationId": "getEndOfDayReportsLOV", + "summary": "Fetch List Of Values for Award Mktg Codes", + "description": "

OperationId:getAwardMktgCodesLOV

", + "operationId": "getAwardMktgCodesLOV", "parameters": [ - { - "name": "beforeIncomeAudit", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'beforeIncomeAudit' which is required to fetch EndOfDayReports LOV", - "enum": [ - "Y", - "N" - ] - }, { "name": "hotelId", "in": "path", @@ -11389,7 +11078,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch EndOfDayReports LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AwardMktgCodes LOV" }, { "name": "includeInactiveFlag", @@ -11463,7 +11152,7 @@ } }, "204": { - "description": "EndOfDayReportsLOV not found." + "description": "AwardMktgCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11513,30 +11202,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/blockCodes": { + "/listOfValues/hotels/{hotelId}/bankAccounts": { "get": { - "summary": "Return list of values for hotel block codes", - "description": "Use this API to return the list of values for block codes for a specific property based on search criteria such as endDate, beginDate, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockCodesLOV

", - "operationId": "getBlockCodesLOV", + "summary": "Fetch List Of Values for Bank Accounts", + "description": "

OperationId:getBankAccountsLOV

", + "operationId": "getBankAccountsLOV", "parameters": [ - { - "name": "endDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'endDate' which is required to fetch BlockCodes LOV" - }, - { - "name": "beginDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'beginDate' which is required to fetch BlockCodes LOV" - }, { "name": "hotelId", "in": "path", @@ -11544,7 +11215,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BlockCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BankAccounts LOV" }, { "name": "includeInactiveFlag", @@ -11618,7 +11289,7 @@ } }, "204": { - "description": "BlockCodesLOV not found." + "description": "BankAccountsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11668,30 +11339,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/blockIds": { + "/listOfValues/hotels/{hotelId}/bankAccountsForReports": { "get": { - "summary": "Return list of values for hotel block Ids", - "description": "Use this API to return the list of values for block Ids for a specific property based on search criteria such as endDate, beginDate, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockIdsLOV

", - "operationId": "getBlockIdsLOV", + "summary": "Fetch List Of Values for Bank Accounts For Reports", + "description": "

OperationId:getBankAccountsForReportsLOV

", + "operationId": "getBankAccountsForReportsLOV", "parameters": [ - { - "name": "endDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'endDate' which is required to fetch BlockIds LOV" - }, - { - "name": "beginDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'beginDate' which is required to fetch BlockIds LOV" - }, { "name": "hotelId", "in": "path", @@ -11699,7 +11352,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BlockIds LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BankAccountsForReports LOV" }, { "name": "includeInactiveFlag", @@ -11773,7 +11426,7 @@ } }, "204": { - "description": "BlockIdsLOV not found." + "description": "BankAccountsForReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11823,43 +11476,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/negotiatedOnly/{negotiatedOnly}/blockRateCodes": { + "/listOfValues/hotels/{hotelId}/banquetPrintingMethod": { "get": { - "summary": "Return list of values for hotel block rate codes", - "description": "Use this API to return the list of values for block rate codes for a specific property based on search criteria such as negotiatedOnly, endDate, beginDate, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockRateCodesLOV

", - "operationId": "getBlockRateCodesLOV", + "summary": "Fetch List Of Values for Banquet Printing Method", + "description": "

OperationId:getBanquetPrintingMethodLOV

", + "operationId": "getBanquetPrintingMethodLOV", "parameters": [ - { - "name": "negotiatedOnly", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'negotiatedOnly' which is required to fetch BlockRateCodes LOV", - "enum": [ - "Y", - "N" - ] - }, - { - "name": "endDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'endDate' which is required to fetch BlockRateCodes LOV" - }, - { - "name": "beginDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'beginDate' which is required to fetch BlockRateCodes LOV" - }, { "name": "hotelId", "in": "path", @@ -11867,7 +11489,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BlockRateCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BanquetPrintingMethod LOV" }, { "name": "includeInactiveFlag", @@ -11941,7 +11563,7 @@ } }, "204": { - "description": "BlockRateCodesLOV not found." + "description": "BanquetPrintingMethodLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11991,29 +11613,24 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/resStatReportRateCode": { + "/listOfValues/hotels/{hotelId}/beforeIncomeAudit/{beforeIncomeAudit}/endOfDayReports": { "get": { - "summary": "Return list of values for hotel report rate codes", - "description": "Use this API to return the list of values for report rate codes for a specific property based on search criteria such as endDate, beginDate, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResStatReportRateCodeLOV

", - "operationId": "getResStatReportRateCodeLOV", + "summary": "Fetch List Of Values for End Of Day Reports", + "description": "

OperationId:getEndOfDayReportsLOV

", + "operationId": "getEndOfDayReportsLOV", "parameters": [ { - "name": "endDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'endDate' which is required to fetch ResStatReportRateCode LOV" - }, - { - "name": "beginDate", + "name": "beforeIncomeAudit", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'beginDate' which is required to fetch ResStatReportRateCode LOV" + "description": "Value of the parameter 'beforeIncomeAudit' which is required to fetch EndOfDayReports LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "hotelId", @@ -12022,7 +11639,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResStatReportRateCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch EndOfDayReports LOV" }, { "name": "includeInactiveFlag", @@ -12096,7 +11713,7 @@ } }, "204": { - "description": "ResStatReportRateCodeLOV not found." + "description": "EndOfDayReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12146,20 +11763,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/membershipId/{membershipId}/membershipPromotions": { + "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/blockCodes": { "get": { - "summary": "Return list of values for hotel membership promotions", - "description": "Use this API to return the list of values for membership promotions for a specific property based on search criteria such as membershipId, endDate, beginDate, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipPromotionsLOV

", - "operationId": "getMembershipPromotionsLOV", + "summary": "Fetch List Of Values for Block Codes", + "description": "

OperationId:getBlockCodesLOV

", + "operationId": "getBlockCodesLOV", "parameters": [ { - "name": "membershipId", + "name": "endDate", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'membershipId' which is required to fetch MembershipPromotions LOV" + "description": "Value of the parameter 'endDate' which is required to fetch BlockCodes LOV" }, { "name": "beginDate", @@ -12168,7 +11785,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'beginDate' which is required to fetch MembershipPromotions LOV" + "description": "Value of the parameter 'beginDate' which is required to fetch BlockCodes LOV" }, { "name": "hotelId", @@ -12177,7 +11794,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch MembershipPromotions LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BlockCodes LOV" }, { "name": "includeInactiveFlag", @@ -12251,7 +11868,7 @@ } }, "204": { - "description": "MembershipPromotionsLOV not found." + "description": "BlockCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12301,12 +11918,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/billingInstructions": { + "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/blockIds": { "get": { - "summary": "Return list of values for hotel billing instructions", - "description": "Use this API to return the list of values for billing instructions for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBillingInstructionsLOV

", - "operationId": "getBillingInstructionsLOV", + "summary": "Fetch List Of Values for Block Ids", + "description": "

OperationId:getBlockIdsLOV

", + "operationId": "getBlockIdsLOV", "parameters": [ + { + "name": "endDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'endDate' which is required to fetch BlockIds LOV" + }, + { + "name": "beginDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'beginDate' which is required to fetch BlockIds LOV" + }, { "name": "hotelId", "in": "path", @@ -12314,7 +11949,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BillingInstructions LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BlockIds LOV" }, { "name": "includeInactiveFlag", @@ -12388,7 +12023,7 @@ } }, "204": { - "description": "BillingInstructionsLOV not found." + "description": "BlockIdsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12438,12 +12073,43 @@ ] } }, - "/listOfValues/hotels/{hotelId}/blockCodesFinOperations": { + "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/negotiatedOnly/{negotiatedOnly}/blockRateCodes": { "get": { - "summary": "Return list of values for hotel block codes financial operations", - "description": "Use this API to return the list of values for hotel block codes financial operations for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockCodesFinOperationsLOV

", - "operationId": "getBlockCodesFinOperationsLOV", + "summary": "Fetch List Of Values for Block Rate Codes", + "description": "

OperationId:getBlockRateCodesLOV

", + "operationId": "getBlockRateCodesLOV", "parameters": [ + { + "name": "negotiatedOnly", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'negotiatedOnly' which is required to fetch BlockRateCodes LOV", + "enum": [ + "Y", + "N" + ] + }, + { + "name": "endDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'endDate' which is required to fetch BlockRateCodes LOV" + }, + { + "name": "beginDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'beginDate' which is required to fetch BlockRateCodes LOV" + }, { "name": "hotelId", "in": "path", @@ -12451,7 +12117,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BlockCodesFinOperations LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BlockRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -12525,7 +12191,7 @@ } }, "204": { - "description": "BlockCodesFinOperationsLOV not found." + "description": "BlockRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12575,12 +12241,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/blockEvents": { + "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/resStatReportRateCode": { "get": { - "summary": "Return list of values for hotel block events", - "description": "Use this API to return the list of values for hotel block events for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockEventsLOV

", - "operationId": "getBlockEventsLOV", + "summary": "Fetch List Of Values for Res Stat Report Rate Code", + "description": "

OperationId:getResStatReportRateCodeLOV

", + "operationId": "getResStatReportRateCodeLOV", "parameters": [ + { + "name": "endDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'endDate' which is required to fetch ResStatReportRateCode LOV" + }, + { + "name": "beginDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'beginDate' which is required to fetch ResStatReportRateCode LOV" + }, { "name": "hotelId", "in": "path", @@ -12588,7 +12272,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BlockEvents LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResStatReportRateCode LOV" }, { "name": "includeInactiveFlag", @@ -12662,7 +12346,7 @@ } }, "204": { - "description": "BlockEventsLOV not found." + "description": "ResStatReportRateCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12712,20 +12396,29 @@ ] } }, - "/listOfValues/hotels/{hotelId}/blockId/{blockId}/blockEventIds": { + "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/membershipId/{membershipId}/membershipPromotions": { "get": { - "summary": "Return list of values for hotel block event Ids", - "description": "Use this API to return the list of values for block event Ids for a specific property based on search criteria such as blockId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockEventIdsLOV

", - "operationId": "getBlockEventIdsLOV", + "summary": "Fetch List Of Values for Membership Promotions", + "description": "

OperationId:getMembershipPromotionsLOV

", + "operationId": "getMembershipPromotionsLOV", "parameters": [ { - "name": "blockId", + "name": "membershipId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'blockId' which is required to fetch BlockEventIds LOV" + "description": "Value of the parameter 'membershipId' which is required to fetch MembershipPromotions LOV" + }, + { + "name": "beginDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'beginDate' which is required to fetch MembershipPromotions LOV" }, { "name": "hotelId", @@ -12734,7 +12427,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BlockEventIds LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MembershipPromotions LOV" }, { "name": "includeInactiveFlag", @@ -12808,7 +12501,7 @@ } }, "204": { - "description": "BlockEventIdsLOV not found." + "description": "MembershipPromotionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12858,11 +12551,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/blockModeLov": { + "/listOfValues/hotels/{hotelId}/billingInstructions": { "get": { - "summary": "Return list of values for hotel block modes", - "description": "Use this API to return the list of values for block modes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockModeLovLOV

", - "operationId": "getBlockModeLovLOV", + "summary": "Fetch List Of Values for Billing Instructions", + "description": "

OperationId:getBillingInstructionsLOV

", + "operationId": "getBillingInstructionsLOV", "parameters": [ { "name": "hotelId", @@ -12871,7 +12564,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BlockModeLov LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BillingInstructions LOV" }, { "name": "includeInactiveFlag", @@ -12945,7 +12638,7 @@ } }, "204": { - "description": "BlockModeLovLOV not found." + "description": "BillingInstructionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12995,11 +12688,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/blockPaymentMethods": { + "/listOfValues/hotels/{hotelId}/blockCodesFinOperations": { "get": { - "summary": "Return list of values for hotel block payment methods", - "description": "Use this API to return the list of values for block payment methods for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockPaymentMethodsLOV

", - "operationId": "getBlockPaymentMethodsLOV", + "summary": "Fetch List Of Values for Block Codes Fin Operations", + "description": "

OperationId:getBlockCodesFinOperationsLOV

", + "operationId": "getBlockCodesFinOperationsLOV", "parameters": [ { "name": "hotelId", @@ -13008,7 +12701,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BlockPaymentMethods LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BlockCodesFinOperations LOV" }, { "name": "includeInactiveFlag", @@ -13082,7 +12775,7 @@ } }, "204": { - "description": "BlockPaymentMethodsLOV not found." + "description": "BlockCodesFinOperationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13132,30 +12825,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bookingChannels/{bookingChannelCode}/roomType/{roomType}/channelConfigRateCodes": { + "/listOfValues/hotels/{hotelId}/blockEvents": { "get": { - "summary": "Return list of values for hotel channel configuration rate codes", - "description": "Use this API to return the list of values for channel configuration rate codes for a specific property based on search criteria such as roomType, bookingChannelCode, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getChannelConfigRateCodesLOV

", - "operationId": "getChannelConfigRateCodesLOV", + "summary": "Fetch List Of Values for Block Events", + "description": "

OperationId:getBlockEventsLOV

", + "operationId": "getBlockEventsLOV", "parameters": [ - { - "name": "roomType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'roomType' which is required to fetch ChannelConfigRateCodes LOV" - }, - { - "name": "bookingChannelCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'bookingChannelCode' which is required to fetch ChannelConfigRateCodes LOV" - }, { "name": "hotelId", "in": "path", @@ -13163,7 +12838,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ChannelConfigRateCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BlockEvents LOV" }, { "name": "includeInactiveFlag", @@ -13237,7 +12912,7 @@ } }, "204": { - "description": "ChannelConfigRateCodesLOV not found." + "description": "BlockEventsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13287,20 +12962,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bookingStatus/{bookingStatus}/blockReservationTypes": { + "/listOfValues/hotels/{hotelId}/blockId/{blockId}/blockEventIds": { "get": { - "summary": "Return list of values for hotel block reservation types", - "description": "Use this API to return the list of values for block reservation types for a specific property based on search criteria such as bookingStatus, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBlockReservationTypesLOV

", - "operationId": "getBlockReservationTypesLOV", + "summary": "Fetch List Of Values for Block Event Ids", + "description": "

OperationId:getBlockEventIdsLOV

", + "operationId": "getBlockEventIdsLOV", "parameters": [ { - "name": "bookingStatus", + "name": "blockId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'bookingStatus' which is required to fetch BlockReservationTypes LOV" + "description": "Value of the parameter 'blockId' which is required to fetch BlockEventIds LOV" }, { "name": "hotelId", @@ -13309,7 +12984,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BlockReservationTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BlockEventIds LOV" }, { "name": "includeInactiveFlag", @@ -13383,7 +13058,7 @@ } }, "204": { - "description": "BlockReservationTypesLOV not found." + "description": "BlockEventIdsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13433,11 +13108,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bookingTypesIndividuals": { + "/listOfValues/hotels/{hotelId}/blockModeLov": { "get": { - "summary": "Return list of values for hotel booking types individuals", - "description": "Use this API to return the list of values for booking types individuals for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBookingTypesIndividualsLOV

", - "operationId": "getBookingTypesIndividualsLOV", + "summary": "Fetch List Of Values for Block Mode Lov", + "description": "

OperationId:getBlockModeLovLOV

", + "operationId": "getBlockModeLovLOV", "parameters": [ { "name": "hotelId", @@ -13446,7 +13121,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BookingTypesIndividuals LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BlockModeLov LOV" }, { "name": "includeInactiveFlag", @@ -13520,7 +13195,7 @@ } }, "204": { - "description": "BookingTypesIndividualsLOV not found." + "description": "BlockModeLovLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13570,21 +13245,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/breakOutId/{breakOutId}/hkTaskSheetsNo": { + "/listOfValues/hotels/{hotelId}/blockPaymentMethods": { "get": { - "summary": "Return list of values for hotel housekeeping task sheets no", - "description": "Use this API to return the list of values for housekeeping task sheets no for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHKTaskSheetsNoLOV

", - "operationId": "getHKTaskSheetsNoLOV", + "summary": "Fetch List Of Values for Block Payment Methods", + "description": "

OperationId:getBlockPaymentMethodsLOV

", + "operationId": "getBlockPaymentMethodsLOV", "parameters": [ - { - "name": "breakOutId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'breakOutId' which is required to fetch HKTaskSheetsNo LOV" - }, { "name": "hotelId", "in": "path", @@ -13592,7 +13258,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HKTaskSheetsNo LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BlockPaymentMethods LOV" }, { "name": "includeInactiveFlag", @@ -13666,7 +13332,7 @@ } }, "204": { - "description": "HKTaskSheetsNoLOV not found." + "description": "BlockPaymentMethodsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13716,158 +13382,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bucketType/{bucketType}/revenueBucketTrxCodes": { + "/listOfValues/hotels/{hotelId}/bookingChannels/{bookingChannelCode}/roomType/{roomType}/channelConfigRateCodes": { "get": { - "summary": "Return list of values for hotel revenue bucket transaction codes", - "description": "Use this API to return the list of values for revenue bucket transaction codes for a specific property based on search criteria such as bucketType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRevenueBucketTrxCodesLOV

", - "operationId": "getRevenueBucketTrxCodesLOV", + "summary": "Fetch List Of Values for Channel Config Rate Codes", + "description": "

OperationId:getChannelConfigRateCodesLOV

", + "operationId": "getChannelConfigRateCodesLOV", "parameters": [ { - "name": "bucketType", + "name": "roomType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'bucketType' which is required to fetch RevenueBucketTrxCodes LOV" + "description": "Value of the parameter 'roomType' which is required to fetch ChannelConfigRateCodes LOV" }, { - "name": "hotelId", + "name": "bookingChannelCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RevenueBucketTrxCodes LOV" - }, - { - "name": "includeInactiveFlag", - "in": "query", - "required": false, - "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", - "type": "boolean" - }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$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": "", - "schema": { - "$ref": "#/definitions/listOfValues" - } - }, - "204": { - "description": "RevenueBucketTrxCodesLOV 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" + "description": "Value of the parameter 'bookingChannelCode' which is required to fetch ChannelConfigRateCodes LOV" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/budgetForecastCodes": { - "get": { - "summary": "Return list of values for hotel budget forecast codes", - "description": "Use this API to return the list of values for budget forecast codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBudgetForecastCodesLOV

", - "operationId": "getBudgetForecastCodesLOV", - "parameters": [ { "name": "hotelId", "in": "path", @@ -13875,7 +13413,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BudgetForecastCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ChannelConfigRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -13949,7 +13487,7 @@ } }, "204": { - "description": "BudForecastCodesLOV not found." + "description": "ChannelConfigRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13999,12 +13537,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/budgetRateCodes": { + "/listOfValues/hotels/{hotelId}/bookingStatus/{bookingStatus}/blockReservationTypes": { "get": { - "summary": "Return list of values for hotel budget rate codes", - "description": "Use this API to return the list of values for budget rate codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBudgetRateCodesLOV

", - "operationId": "getBudgetRateCodesLOV", + "summary": "Fetch List Of Values for Block Reservation Types", + "description": "

OperationId:getBlockReservationTypesLOV

", + "operationId": "getBlockReservationTypesLOV", "parameters": [ + { + "name": "bookingStatus", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'bookingStatus' which is required to fetch BlockReservationTypes LOV" + }, { "name": "hotelId", "in": "path", @@ -14012,7 +13559,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BudgetRateCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BlockReservationTypes LOV" }, { "name": "includeInactiveFlag", @@ -14086,7 +13633,7 @@ } }, "204": { - "description": "BudRateCodesLOV not found." + "description": "BlockReservationTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14136,21 +13683,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/businessDate/{businessDate}/hkScheduledAttendants": { + "/listOfValues/hotels/{hotelId}/bookingTypesIndividuals": { "get": { - "summary": "Return list of values for hotel housekeeping scheduled attendants", - "description": "Use this API to return the list of values for housekeeping scheduled attendants for a specific property based on search criteria such as businessDate, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHKScheduledAttendantsLOV

", - "operationId": "getHKScheduledAttendantsLOV", + "summary": "Fetch List Of Values for Booking Types Individuals", + "description": "

OperationId:getBookingTypesIndividualsLOV

", + "operationId": "getBookingTypesIndividualsLOV", "parameters": [ - { - "name": "businessDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'businessDate' which is required to fetch HKScheduledAttendants LOV" - }, { "name": "hotelId", "in": "path", @@ -14158,7 +13696,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HKScheduledAttendants LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BookingTypesIndividuals LOV" }, { "name": "includeInactiveFlag", @@ -14232,7 +13770,7 @@ } }, "204": { - "description": "HKScheduledAttendantsLOV not found." + "description": "BookingTypesIndividualsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14282,149 +13820,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/campaignActivityTypes": { + "/listOfValues/hotels/{hotelId}/breakOutId/{breakOutId}/hkTaskSheetsNo": { "get": { - "summary": "Return list of values for hotel campaign activity types", - "description": "Use this API to return the list of values for campaign activity types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCampaignActivityTypesLOV

", - "operationId": "getCampaignActivityTypesLOV", + "summary": "Fetch List Of Values for HKTask Sheets No", + "description": "

OperationId:getHKTaskSheetsNoLOV

", + "operationId": "getHKTaskSheetsNoLOV", "parameters": [ { - "name": "hotelId", + "name": "breakOutId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CampaignActivityTypes LOV" - }, - { - "name": "includeInactiveFlag", - "in": "query", - "required": false, - "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", - "type": "boolean" - }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$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": "", - "schema": { - "$ref": "#/definitions/listOfValues" - } - }, - "204": { - "description": "CampaignActivityTypesLOV 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" + "description": "Value of the parameter 'breakOutId' which is required to fetch HKTaskSheetsNo LOV" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/cashRegisterId": { - "get": { - "summary": "Return list of values for hotel cash register ids", - "description": "Use this API to return the list of values for cash register ids for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCashRegisterIDLOV

", - "operationId": "getCashRegisterIDLOV", - "parameters": [ { "name": "hotelId", "in": "path", @@ -14432,7 +13842,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CashRegisterID LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HKTaskSheetsNo LOV" }, { "name": "includeInactiveFlag", @@ -14506,7 +13916,7 @@ } }, "204": { - "description": "CashRegisterIDLOV not found." + "description": "HKTaskSheetsNoLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14556,20 +13966,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeEventCodes": { + "/listOfValues/hotels/{hotelId}/bucketType/{bucketType}/revenueBucketTrxCodes": { "get": { - "summary": "Return list of values for hotel catering budget type event codes", - "description": "Use this API to return the list of values for catering budget type event codes for a specific property based on search criteria such as catBudgetType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCatBudgetTypeEventCodesLOV

", - "operationId": "getCatBudgetTypeEventCodesLOV", + "summary": "Fetch List Of Values for Revenue Bucket Trx Codes", + "description": "

OperationId:getRevenueBucketTrxCodesLOV

", + "operationId": "getRevenueBucketTrxCodesLOV", "parameters": [ { - "name": "catBudgetType", + "name": "bucketType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'catBudgetType' which is required to fetch CatBudgetTypeEventCodes LOV" + "description": "Value of the parameter 'bucketType' which is required to fetch RevenueBucketTrxCodes LOV" }, { "name": "hotelId", @@ -14578,7 +13988,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CatBudgetTypeEventCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RevenueBucketTrxCodes LOV" }, { "name": "includeInactiveFlag", @@ -14652,7 +14062,7 @@ } }, "204": { - "description": "CatBudTypeEventCodesLOV not found." + "description": "RevenueBucketTrxCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14702,21 +14112,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeMarketCodes": { + "/listOfValues/hotels/{hotelId}/budgetForecastCodes": { "get": { - "summary": "Return list of values for hotel catering budget type market codes", - "description": "Use this API to return the list of values for catering budget type market codes for a specific property based on search criteria such as catBudgetType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCatBudgetTypeMarketCodesLOV

", - "operationId": "getCatBudgetTypeMarketCodesLOV", + "summary": "Fetch List Of Values for Budget Forecast Codes", + "description": "

OperationId:getBudgetForecastCodesLOV

", + "operationId": "getBudgetForecastCodesLOV", "parameters": [ - { - "name": "catBudgetType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'catBudgetType' which is required to fetch CatBudgetTypeMarketCodes LOV" - }, { "name": "hotelId", "in": "path", @@ -14724,7 +14125,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CatBudgetTypeMarketCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BudgetForecastCodes LOV" }, { "name": "includeInactiveFlag", @@ -14798,7 +14199,7 @@ } }, "204": { - "description": "CatBudTypeMarketCodesLOV not found." + "description": "BudForecastCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14848,21 +14249,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeMealCodes": { + "/listOfValues/hotels/{hotelId}/budgetRateCodes": { "get": { - "summary": "Return list of values for hotel catering budget type meal codes", - "description": "Use this API to return the list of values for catering budget type meal codes for a specific property based on search criteria such as catBudgetType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCatBudgetTypeMealCodesLOV

", - "operationId": "getCatBudgetTypeMealCodesLOV", + "summary": "Fetch List Of Values for Budget Rate Codes", + "description": "

OperationId:getBudgetRateCodesLOV

", + "operationId": "getBudgetRateCodesLOV", "parameters": [ - { - "name": "catBudgetType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'catBudgetType' which is required to fetch CatBudgetTypeMealCodes LOV" - }, { "name": "hotelId", "in": "path", @@ -14870,7 +14262,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CatBudgetTypeMealCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BudgetRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -14944,7 +14336,7 @@ } }, "204": { - "description": "CatBudTypeMealCodesLOV not found." + "description": "BudRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14994,20 +14386,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeRevenueCodes": { + "/listOfValues/hotels/{hotelId}/businessDate/{businessDate}/hkScheduledAttendants": { "get": { - "summary": "Return list of values for hotel catering budget type revenue codes", - "description": "Use this API to return the list of values for catering budget type revenue codes for a specific property based on search criteria such as catBudgetType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCatBudgetTypeRevenueCodesLOV

", - "operationId": "getCatBudgetTypeRevenueCodesLOV", + "summary": "Fetch List Of Values for HKScheduled Attendants", + "description": "

OperationId:getHKScheduledAttendantsLOV

", + "operationId": "getHKScheduledAttendantsLOV", "parameters": [ { - "name": "catBudgetType", + "name": "businessDate", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'catBudgetType' which is required to fetch CatBudgetTypeRevenueCodes LOV" + "description": "Value of the parameter 'businessDate' which is required to fetch HKScheduledAttendants LOV" }, { "name": "hotelId", @@ -15016,7 +14408,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CatBudgetTypeRevenueCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HKScheduledAttendants LOV" }, { "name": "includeInactiveFlag", @@ -15090,7 +14482,7 @@ } }, "204": { - "description": "CatBudTypeRevenueCodesLOV not found." + "description": "HKScheduledAttendantsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15140,11 +14532,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/cateringPackagePriceCodes": { + "/listOfValues/hotels/{hotelId}/campaignActivityTypes": { "get": { - "summary": "Return list of values for hotel catering package price codes", - "description": "Use this API to return the list of values for catering package price codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCateringPackagePriceCodesLOV

", - "operationId": "getCateringPackagePriceCodesLOV", + "summary": "Fetch List Of Values for Campaign Activity Types", + "description": "

OperationId:getCampaignActivityTypesLOV

", + "operationId": "getCampaignActivityTypesLOV", "parameters": [ { "name": "hotelId", @@ -15153,7 +14545,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CateringPackagePriceCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CampaignActivityTypes LOV" }, { "name": "includeInactiveFlag", @@ -15227,7 +14619,7 @@ } }, "204": { - "description": "CateringPackagePriceCodesLOV not found." + "description": "CampaignActivityTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15277,21 +14669,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/channel/{channel}/bookingChannelRatePlans": { + "/listOfValues/hotels/{hotelId}/cashRegisterId": { "get": { - "summary": "Return list of values for hotel booking channel rate plans", - "description": "Use this API to return the list of values for booking channel rate plans for a specific property based on search criteria such as channel, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBookingChannelRatePlansLOV

", - "operationId": "getBookingChannelRatePlansLOV", + "summary": "Fetch List Of Values for Cash Register ID", + "description": "

OperationId:getCashRegisterIDLOV

", + "operationId": "getCashRegisterIDLOV", "parameters": [ - { - "name": "channel", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'channel' which is required to fetch BookingChannelRatePlans LOV" - }, { "name": "hotelId", "in": "path", @@ -15299,7 +14682,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BookingChannelRatePlans LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CashRegisterID LOV" }, { "name": "includeInactiveFlag", @@ -15373,7 +14756,7 @@ } }, "204": { - "description": "BookingChannelRatePlansLOV not found." + "description": "CashRegisterIDLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15423,12 +14806,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/channelCardTypeMappingCardType": { + "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeEventCodes": { "get": { - "summary": "Return list of values for hotel channel card type mappings", - "description": "Use this API to return the list of values for channel card type mappings for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getChannelCardTypeMappingCardTypeLOV

", - "operationId": "getChannelCardTypeMappingCardTypeLOV", + "summary": "Fetch List Of Values for Cat Budget Type Event Codes", + "description": "

OperationId:getCatBudgetTypeEventCodesLOV

", + "operationId": "getCatBudgetTypeEventCodesLOV", "parameters": [ + { + "name": "catBudgetType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'catBudgetType' which is required to fetch CatBudgetTypeEventCodes LOV" + }, { "name": "hotelId", "in": "path", @@ -15436,7 +14828,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ChannelCardTypeMappingCardType LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CatBudgetTypeEventCodes LOV" }, { "name": "includeInactiveFlag", @@ -15510,7 +14902,7 @@ } }, "204": { - "description": "ChannelCardTypeMappingCardTypeLOV not found." + "description": "CatBudTypeEventCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15560,149 +14952,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/channelCardTypeMappingGdsHost": { + "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeMarketCodes": { "get": { - "summary": "Return list of values for hotel channel card type mappings gds host", - "description": "Use this API to return the list of values for channel card type mappings gds host for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getChannelCardTypeMappingGdsHostLOV

", - "operationId": "getChannelCardTypeMappingGdsHostLOV", + "summary": "Fetch List Of Values for Cat Budget Type Market Codes", + "description": "

OperationId:getCatBudgetTypeMarketCodesLOV

", + "operationId": "getCatBudgetTypeMarketCodesLOV", "parameters": [ { - "name": "hotelId", + "name": "catBudgetType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ChannelCardTypeMappingGdsHost LOV" - }, - { - "name": "includeInactiveFlag", - "in": "query", - "required": false, - "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", - "type": "boolean" - }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$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": "", - "schema": { - "$ref": "#/definitions/listOfValues" - } - }, - "204": { - "description": "ChannelCardTypeMappingGdsHostLOV 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" + "description": "Value of the parameter 'catBudgetType' which is required to fetch CatBudgetTypeMarketCodes LOV" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/commissionCode": { - "get": { - "summary": "Return list of values for hotel commission codes", - "description": "Use this API to return the list of values for commission codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCommissionCodeLOV

", - "operationId": "getCommissionCodeLOV", - "parameters": [ { "name": "hotelId", "in": "path", @@ -15710,7 +14974,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CommissionCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CatBudgetTypeMarketCodes LOV" }, { "name": "includeInactiveFlag", @@ -15784,7 +15048,7 @@ } }, "204": { - "description": "CommissionCodeLOV not found." + "description": "CatBudTypeMarketCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15834,12 +15098,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/commissionTxnCodes": { + "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeMealCodes": { "get": { - "summary": "Return list of values for hotel commission transaction codes", - "description": "Use this API to return the list of values for commission tansaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCommissionTxnCodesLOV

", - "operationId": "getCommissionTxnCodesLOV", + "summary": "Fetch List Of Values for Cat Budget Type Meal Codes", + "description": "

OperationId:getCatBudgetTypeMealCodesLOV

", + "operationId": "getCatBudgetTypeMealCodesLOV", "parameters": [ + { + "name": "catBudgetType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'catBudgetType' which is required to fetch CatBudgetTypeMealCodes LOV" + }, { "name": "hotelId", "in": "path", @@ -15847,7 +15120,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CommissionTxnCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CatBudgetTypeMealCodes LOV" }, { "name": "includeInactiveFlag", @@ -15921,7 +15194,7 @@ } }, "204": { - "description": "CommissionTxnCodesLOV not found." + "description": "CatBudTypeMealCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15971,12 +15244,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/compAuthorizers": { + "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeRevenueCodes": { "get": { - "summary": "Return list of values for hotel comp authorizers", - "description": "Use this API to return the list of values for comp authorizers for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCompAuthorizersLOV

", - "operationId": "getCompAuthorizersLOV", + "summary": "Fetch List Of Values for Cat Budget Type Revenue Codes", + "description": "

OperationId:getCatBudgetTypeRevenueCodesLOV

", + "operationId": "getCatBudgetTypeRevenueCodesLOV", "parameters": [ + { + "name": "catBudgetType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'catBudgetType' which is required to fetch CatBudgetTypeRevenueCodes LOV" + }, { "name": "hotelId", "in": "path", @@ -15984,7 +15266,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CompAuthorizers LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CatBudgetTypeRevenueCodes LOV" }, { "name": "includeInactiveFlag", @@ -16058,7 +15340,7 @@ } }, "204": { - "description": "CompAuthorizersLOV not found." + "description": "CatBudTypeRevenueCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16108,11 +15390,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/compTypes": { + "/listOfValues/hotels/{hotelId}/catBudgetTypeMarketCodesLoad": { "get": { - "summary": "Return list of values for hotel comp types", - "description": "Use this API to return the list of values for comp types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCompTypesLOV

", - "operationId": "getCompTypesLOV", + "summary": "Fetch List Of Values for Cat Budget Type Market Codes", + "description": "

OperationId:getCatBudgetTypeMarketCodesLOV

", + "operationId": "getCatBudgetTypeMarketCodesLoadLOV", "parameters": [ { "name": "hotelId", @@ -16121,7 +15403,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CompTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CatBudgetTypeMarketCodesLoad LOV" }, { "name": "includeInactiveFlag", @@ -16195,7 +15477,7 @@ } }, "204": { - "description": "CompTypesLOV not found." + "description": "CatBudTypeMarketCodesLoadLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16245,11 +15527,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/companies": { + "/listOfValues/hotels/{hotelId}/cateringPackagePriceCodes": { "get": { - "summary": "Return list of values for hotel companies", - "description": "Use this API to return the list of values for companies for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCompaniesLOV

", - "operationId": "getCompaniesLOV", + "summary": "Fetch List Of Values for Catering Package Price Codes", + "description": "

OperationId:getCateringPackagePriceCodesLOV

", + "operationId": "getCateringPackagePriceCodesLOV", "parameters": [ { "name": "hotelId", @@ -16258,7 +15540,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Companies LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CateringPackagePriceCodes LOV" }, { "name": "includeInactiveFlag", @@ -16332,7 +15614,7 @@ } }, "204": { - "description": "CompaniesLOV not found." + "description": "CateringPackagePriceCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16382,12 +15664,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/confLetterReports": { + "/listOfValues/hotels/{hotelId}/channel/{channel}/bookingChannelRatePlans": { "get": { - "summary": "Return list of values for hotel confirmation letter reports", - "description": "Use this API to return the list of values for confirmation letter reports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getConfLetterReportsLOV

", - "operationId": "getConfLetterReportsLOV", + "summary": "Fetch List Of Values for Booking Channel Rate Plans", + "description": "

OperationId:getBookingChannelRatePlansLOV

", + "operationId": "getBookingChannelRatePlansLOV", "parameters": [ + { + "name": "channel", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'channel' which is required to fetch BookingChannelRatePlans LOV" + }, { "name": "hotelId", "in": "path", @@ -16395,7 +15686,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ConfLetterReports LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BookingChannelRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -16469,7 +15760,7 @@ } }, "204": { - "description": "ConfLetterReportsLOV not found." + "description": "BookingChannelRatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16519,21 +15810,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/configType/{configType}/exportMappingCodesToLink": { + "/listOfValues/hotels/{hotelId}/channelCardTypeMappingCardType": { "get": { - "summary": "Return list of values for hotel export mapping codes to link", - "description": "Use this API to return the list of values for export mapping codes to link for a specific property based on search criteria such as configType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getExportMappingCodesToLinkLOV

", - "operationId": "getExportMappingCodesToLinkLOV", + "summary": "Fetch List Of Values for Channel Card Type Mapping Card Type", + "description": "

OperationId:getChannelCardTypeMappingCardTypeLOV

", + "operationId": "getChannelCardTypeMappingCardTypeLOV", "parameters": [ - { - "name": "configType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'configType' which is required to fetch ExportMappingCodesToLink LOV" - }, { "name": "hotelId", "in": "path", @@ -16541,7 +15823,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ExportMappingCodesToLink LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ChannelCardTypeMappingCardType LOV" }, { "name": "includeInactiveFlag", @@ -16615,7 +15897,7 @@ } }, "204": { - "description": "ExportMappingCodesToLinkLOV not found." + "description": "ChannelCardTypeMappingCardTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16665,21 +15947,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/contactType/{contactType}/hotelContactCommMethod": { + "/listOfValues/hotels/{hotelId}/channelCardTypeMappingGdsHost": { "get": { - "summary": "Return list of values for hotel contact communication methods", - "description": "Use this API to return the list of values for hotel contact communication methods for a specific property based on search criteria such as contactType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHotelContactCommMethodLOV

", - "operationId": "getHotelContactCommMethodLOV", + "summary": "Fetch List Of Values for Channel Card Type Mapping Gds Host", + "description": "

OperationId:getChannelCardTypeMappingGdsHostLOV

", + "operationId": "getChannelCardTypeMappingGdsHostLOV", "parameters": [ - { - "name": "contactType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'contactType' which is required to fetch HotelContactCommMethod LOV" - }, { "name": "hotelId", "in": "path", @@ -16687,7 +15960,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HotelContactCommMethod LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ChannelCardTypeMappingGdsHost LOV" }, { "name": "includeInactiveFlag", @@ -16761,7 +16034,7 @@ } }, "204": { - "description": "HotelContactCommMethodLOV not found." + "description": "ChannelCardTypeMappingGdsHostLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16811,11 +16084,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/creditCardTypes": { + "/listOfValues/hotels/{hotelId}/commissionCode": { "get": { - "summary": "Return list of values for hotel credit card types", - "description": "Use this API to return the list of values for credit card types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCreditCardTypesLOV

", - "operationId": "getCreditCardTypesLOV", + "summary": "Fetch List Of Values for Commission Code", + "description": "

OperationId:getCommissionCodeLOV

", + "operationId": "getCommissionCodeLOV", "parameters": [ { "name": "hotelId", @@ -16824,7 +16097,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CreditCardTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CommissionCode LOV" }, { "name": "includeInactiveFlag", @@ -16898,7 +16171,7 @@ } }, "204": { - "description": "CreditCardTypesLOV not found." + "description": "CommissionCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16948,21 +16221,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/criteria/{criteria}/stageProfiles": { + "/listOfValues/hotels/{hotelId}/commissionTxnCodes": { "get": { - "summary": "Return list of values for hotel stage profiles", - "description": "Use this API to return the list of values for stage profiles for a specific property based on search criteria such as criteria, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getStageProfilesLOV

", - "operationId": "getStageProfilesLOV", + "summary": "Fetch List Of Values for Commission Txn Codes", + "description": "

OperationId:getCommissionTxnCodesLOV

", + "operationId": "getCommissionTxnCodesLOV", "parameters": [ - { - "name": "criteria", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'criteria' which is required to fetch StageProfiles LOV" - }, { "name": "hotelId", "in": "path", @@ -16970,7 +16234,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch StageProfiles LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CommissionTxnCodes LOV" }, { "name": "includeInactiveFlag", @@ -17044,7 +16308,7 @@ } }, "204": { - "description": "StageProfilesLOV not found." + "description": "CommissionTxnCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17094,56 +16358,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/currentRateCode/{currentRateCode}/currencyCode/{currencyCode}/daily/{daily}/tiered/{tiered}/configBaseRatePlans": { + "/listOfValues/hotels/{hotelId}/compAuthorizers": { "get": { - "summary": "Return list of values for hotel configuration base rate plans", - "description": "Use this API to return the list of values for configuration base rate plans for a specific property based on search criteria such as tiered, daily, currencyCode, currentRateCode, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getConfigBaseRatePlansLOV

", - "operationId": "getConfigBaseRatePlansLOV", + "summary": "Fetch List Of Values for Comp Authorizers", + "description": "

OperationId:getCompAuthorizersLOV

", + "operationId": "getCompAuthorizersLOV", "parameters": [ { - "name": "tiered", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'tiered' which is required to fetch ConfigBaseRatePlans LOV", - "enum": [ - "Y", - "N" - ] + "description": "Value of the parameter 'hotelId' which is required to fetch CompAuthorizers LOV" }, { - "name": "daily", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'daily' which is required to fetch ConfigBaseRatePlans LOV", - "enum": [ - "Y", - "N" - ] + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" }, { - "name": "currencyCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'currencyCode' which is required to fetch ConfigBaseRatePlans LOV" + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false }, { - "name": "currentRateCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'currentRateCode' which is required to fetch ConfigBaseRatePlans LOV" + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "CompAuthorizersLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/hotels/{hotelId}/compTypes": { + "get": { + "summary": "Fetch List Of Values for Comp Types", + "description": "

OperationId:getCompTypesLOV

", + "operationId": "getCompTypesLOV", + "parameters": [ { "name": "hotelId", "in": "path", @@ -17151,7 +16508,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ConfigBaseRatePlans LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CompTypes LOV" }, { "name": "includeInactiveFlag", @@ -17225,7 +16582,7 @@ } }, "204": { - "description": "ConfigBaseRatePlansLOV not found." + "description": "CompTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17275,47 +16632,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/currentRateCode/{currentRateCode}/tiered/{tiered}/daily/{daily}/configAdvDynamicBaseRatePlans": { + "/listOfValues/hotels/{hotelId}/companies": { "get": { - "summary": "Return list of values for hotel configuration advanced dynamic base rate plans", - "description": "Use this API to return the list of values for configuration advanced dynamic base rate plans for a specific property based on search criteria such as tiered, daily, currencyCode, currentRateCode, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getConfigAdvDynamicBaseRatePlansLOV

", - "operationId": "getConfigAdvDynamicBaseRatePlansLOV", + "summary": "Fetch List Of Values for Companies", + "description": "

OperationId:getCompaniesLOV

", + "operationId": "getCompaniesLOV", "parameters": [ - { - "name": "daily", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'daily' which is required to fetch ConfigAdvDynamicBaseRatePlans LOV", - "enum": [ - "Y", - "N" - ] - }, - { - "name": "tiered", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'tiered' which is required to fetch ConfigAdvDynamicBaseRatePlans LOV", - "enum": [ - "Y", - "N" - ] - }, - { - "name": "currentRateCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'currentRateCode' which is required to fetch ConfigAdvDynamicBaseRatePlans LOV" - }, { "name": "hotelId", "in": "path", @@ -17323,7 +16645,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ConfigAdvDynamicBaseRatePlans LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Companies LOV" }, { "name": "includeInactiveFlag", @@ -17397,7 +16719,7 @@ } }, "204": { - "description": "ConfigAdvDynamicBaseRatePlansLOV not found." + "description": "CompaniesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17447,11 +16769,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/customNumberConfigCodes": { + "/listOfValues/hotels/{hotelId}/confLetterReports": { "get": { - "summary": "Return list of values for hotel custom number configuration codes", - "description": "Use this API to return the list of values for custom number configuration codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCustomNumberConfigCodesLOV

", - "operationId": "getCustomNumberConfigCodesLOV", + "summary": "Fetch List Of Values for Conf Letter Reports", + "description": "

OperationId:getConfLetterReportsLOV

", + "operationId": "getConfLetterReportsLOV", "parameters": [ { "name": "hotelId", @@ -17460,7 +16782,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CustomNumberConfigCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ConfLetterReports LOV" }, { "name": "includeInactiveFlag", @@ -17534,7 +16856,7 @@ } }, "204": { - "description": "CustomNumberConfigCodesLOV not found." + "description": "ConfLetterReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17584,20 +16906,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/dbfLogo/{dbfLogo}/customRoomTranslation": { + "/listOfValues/hotels/{hotelId}/configType/{configType}/exportMappingCodesToLink": { "get": { - "summary": "Return list of values for hotel custom room translations", - "description": "Use this API to return the list of values for custom room translations for a specific property based on search criteria such as dbfLogo, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCustomRoomTranslationLOV

", - "operationId": "getCustomRoomTranslationLOV", + "summary": "Fetch List Of Values for Export Mapping Codes To Link", + "description": "

OperationId:getExportMappingCodesToLinkLOV

", + "operationId": "getExportMappingCodesToLinkLOV", "parameters": [ { - "name": "dbfLogo", + "name": "configType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'dbfLogo' which is required to fetch CustomRoomTranslation LOV" + "description": "Value of the parameter 'configType' which is required to fetch ExportMappingCodesToLink LOV" }, { "name": "hotelId", @@ -17606,7 +16928,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CustomRoomTranslation LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ExportMappingCodesToLink LOV" }, { "name": "includeInactiveFlag", @@ -17680,7 +17002,7 @@ } }, "204": { - "description": "CustomRoomTranslationLOV not found." + "description": "ExportMappingCodesToLinkLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17730,20 +17052,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/departmentId/{departmentId}/quickTexts": { + "/listOfValues/hotels/{hotelId}/contactType/{contactType}/hotelContactCommMethod": { "get": { - "summary": "Return list of values for hotel quick texts", - "description": "Use this API to return the list of values for quick texts for a specific property based on search criteria such as departmentId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getQuickTextsLOV

", - "operationId": "getQuickTextsLOV", + "summary": "Fetch List Of Values for Hotel Contact Comm Method", + "description": "

OperationId:getHotelContactCommMethodLOV

", + "operationId": "getHotelContactCommMethodLOV", "parameters": [ { - "name": "departmentId", + "name": "contactType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'departmentId' which is required to fetch QuickTexts LOV" + "description": "Value of the parameter 'contactType' which is required to fetch HotelContactCommMethod LOV" }, { "name": "hotelId", @@ -17752,7 +17074,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch QuickTexts LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HotelContactCommMethod LOV" }, { "name": "includeInactiveFlag", @@ -17826,7 +17148,7 @@ } }, "204": { - "description": "QuickTextsLOV not found." + "description": "HotelContactCommMethodLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17876,11 +17198,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/deviceLocations": { + "/listOfValues/hotels/{hotelId}/creditCardTypes": { "get": { - "summary": "Return list of values for hotel device locations", - "description": "Use this API to return the list of values for device locations for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getDeviceLocationsLOV

", - "operationId": "getDeviceLocationsLOV", + "summary": "Fetch List Of Values for Credit Card Types", + "description": "

OperationId:getCreditCardTypesLOV

", + "operationId": "getCreditCardTypesLOV", "parameters": [ { "name": "hotelId", @@ -17889,7 +17211,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch DeviceLocations LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CreditCardTypes LOV" }, { "name": "includeInactiveFlag", @@ -17963,7 +17285,7 @@ } }, "204": { - "description": "DeviceLocationsLOV not found." + "description": "CreditCardTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18013,12 +17335,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/dietaryPreferences": { + "/listOfValues/hotels/{hotelId}/criteria/{criteria}/stageProfiles": { "get": { - "summary": "Return list of values for hotel dietary preferences", - "description": "Use this API to return the list of values for dietary preferences for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getDietaryPreferencesLOV

", - "operationId": "getDietaryPreferencesLOV", + "summary": "Fetch List Of Values for Stage Profiles", + "description": "

OperationId:getStageProfilesLOV

", + "operationId": "getStageProfilesLOV", "parameters": [ + { + "name": "criteria", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'criteria' which is required to fetch StageProfiles LOV" + }, { "name": "hotelId", "in": "path", @@ -18026,7 +17357,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch DietaryPreferences LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch StageProfiles LOV" }, { "name": "includeInactiveFlag", @@ -18100,7 +17431,7 @@ } }, "204": { - "description": "DietaryPreferencesLOV not found." + "description": "StageProfilesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18150,12 +17481,56 @@ ] } }, - "/listOfValues/hotels/{hotelId}/eCoupon": { + "/listOfValues/hotels/{hotelId}/currentRateCode/{currentRateCode}/currencyCode/{currencyCode}/daily/{daily}/tiered/{tiered}/configBaseRatePlans": { "get": { - "summary": "Return list of values for hotel ecoupon", - "description": "Use this API to return the list of values for ecoupon for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getECouponLOV

", - "operationId": "getECouponLOV", + "summary": "Fetch List Of Values for Config Base Rate Plans", + "description": "

OperationId:getConfigBaseRatePlansLOV

", + "operationId": "getConfigBaseRatePlansLOV", "parameters": [ + { + "name": "tiered", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'tiered' which is required to fetch ConfigBaseRatePlans LOV", + "enum": [ + "Y", + "N" + ] + }, + { + "name": "daily", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'daily' which is required to fetch ConfigBaseRatePlans LOV", + "enum": [ + "Y", + "N" + ] + }, + { + "name": "currencyCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'currencyCode' which is required to fetch ConfigBaseRatePlans LOV" + }, + { + "name": "currentRateCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'currentRateCode' which is required to fetch ConfigBaseRatePlans LOV" + }, { "name": "hotelId", "in": "path", @@ -18163,7 +17538,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ECoupon LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ConfigBaseRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -18237,7 +17612,7 @@ } }, "204": { - "description": "ECouponLOV not found." + "description": "ConfigBaseRatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18287,12 +17662,47 @@ ] } }, - "/listOfValues/hotels/{hotelId}/eCouponRateCodes": { + "/listOfValues/hotels/{hotelId}/currentRateCode/{currentRateCode}/tiered/{tiered}/daily/{daily}/configAdvDynamicBaseRatePlans": { "get": { - "summary": "Return list of values for hotel ecoupon rate codes", - "description": "Use this API to return the list of values for ecoupon rate codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getECouponRateCodesLOV

", - "operationId": "getECouponRateCodesLOV", + "summary": "Fetch List Of Values for Config Adv Dynamic Base Rate Plans", + "description": "

OperationId:getConfigAdvDynamicBaseRatePlansLOV

", + "operationId": "getConfigAdvDynamicBaseRatePlansLOV", "parameters": [ + { + "name": "daily", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'daily' which is required to fetch ConfigAdvDynamicBaseRatePlans LOV", + "enum": [ + "Y", + "N" + ] + }, + { + "name": "tiered", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'tiered' which is required to fetch ConfigAdvDynamicBaseRatePlans LOV", + "enum": [ + "Y", + "N" + ] + }, + { + "name": "currentRateCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'currentRateCode' which is required to fetch ConfigAdvDynamicBaseRatePlans LOV" + }, { "name": "hotelId", "in": "path", @@ -18300,7 +17710,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ECouponRateCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ConfigAdvDynamicBaseRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -18374,7 +17784,7 @@ } }, "204": { - "description": "ECouponRateCodesLOV not found." + "description": "ConfigAdvDynamicBaseRatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18424,11 +17834,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/ecouponResvRoom": { + "/listOfValues/hotels/{hotelId}/customNumberConfigCodes": { "get": { - "summary": "Return list of values for hotel ecoupon reservation rooms", - "description": "Use this API to return the list of values for ecoupon reservation rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getEcouponResvRoomLOV

", - "operationId": "getEcouponResvRoomLOV", + "summary": "Fetch List Of Values for Custom Number Config Codes", + "description": "

OperationId:getCustomNumberConfigCodesLOV

", + "operationId": "getCustomNumberConfigCodesLOV", "parameters": [ { "name": "hotelId", @@ -18437,7 +17847,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch EcouponResvRoom LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CustomNumberConfigCodes LOV" }, { "name": "includeInactiveFlag", @@ -18511,7 +17921,7 @@ } }, "204": { - "description": "EcouponResvRoomLOV not found." + "description": "CustomNumberConfigCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18561,11 +17971,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/eventGroups": { + "/listOfValues/hotels/{hotelId}/cutoffScheduleCodes": { "get": { - "summary": "Return list of values for hotel event groups", - "description": "Use this API to return the list of values for event groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getEventGroupsLOV

", - "operationId": "getEventGroupsLOV", + "summary": "Fetch List Of Values for Cutoff Schedule Codes.", + "description": "

OperationId:getcutoffScheduleCodesLOV

", + "operationId": "getcutoffScheduleCodesLOV", "parameters": [ { "name": "hotelId", @@ -18574,7 +17984,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch EventGroups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch cutoffScheduleCodes LOV" }, { "name": "includeInactiveFlag", @@ -18648,7 +18058,7 @@ } }, "204": { - "description": "EventGroupsLOV not found." + "description": "cutoffScheduleCodes not found." }, "400": { "$ref": "#/responses/400" @@ -18698,12 +18108,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/eventLocations": { + "/listOfValues/hotels/{hotelId}/dbfLogo/{dbfLogo}/customRoomTranslation": { "get": { - "summary": "Return list of values for hotel event locations", - "description": "Use this API to return the list of values for event locations for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getEventLocationsLOV

", - "operationId": "getEventLocationsLOV", + "summary": "Fetch List Of Values for Custom Room Translation", + "description": "

OperationId:getCustomRoomTranslationLOV

", + "operationId": "getCustomRoomTranslationLOV", "parameters": [ + { + "name": "dbfLogo", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'dbfLogo' which is required to fetch CustomRoomTranslation LOV" + }, { "name": "hotelId", "in": "path", @@ -18711,7 +18130,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch EventLocations LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CustomRoomTranslation LOV" }, { "name": "includeInactiveFlag", @@ -18785,7 +18204,7 @@ } }, "204": { - "description": "EventLocationsLOV not found." + "description": "CustomRoomTranslationLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18835,20 +18254,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/exchangeType/{exchangeType}/currencyExchangeRates": { + "/listOfValues/hotels/{hotelId}/departmentId/{departmentId}/quickTexts": { "get": { - "summary": "Return list of values for hotel currency exchange rates", - "description": "Use this API to return the list of values for currency exchange rates for a specific property based on search criteria such as exchangeType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCurrencyExchangeRatesLOV

", - "operationId": "getCurrencyExchangeRatesLOV", + "summary": "Fetch List Of Values for Quick Texts", + "description": "

OperationId:getQuickTextsLOV

", + "operationId": "getQuickTextsLOV", "parameters": [ { - "name": "exchangeType", + "name": "departmentId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'exchangeType' which is required to fetch CurrencyExchangeRates LOV" + "description": "Value of the parameter 'departmentId' which is required to fetch QuickTexts LOV" }, { "name": "hotelId", @@ -18857,7 +18276,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CurrencyExchangeRates LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch QuickTexts LOV" }, { "name": "includeInactiveFlag", @@ -18931,7 +18350,7 @@ } }, "204": { - "description": "CurrencyExchangeRatesLOV not found." + "description": "QuickTextsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18981,11 +18400,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/exportMappingTypeCodes": { + "/listOfValues/hotels/{hotelId}/deviceLocations": { "get": { - "summary": "Return list of values for hotel export mapping type codes", - "description": "Use this API to return the list of values for export mapping type codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getExportMappingTypeCodesLOV

", - "operationId": "getExportMappingTypeCodesLOV", + "summary": "Fetch List Of Values for Device Locations", + "description": "

OperationId:getDeviceLocationsLOV

", + "operationId": "getDeviceLocationsLOV", "parameters": [ { "name": "hotelId", @@ -18994,7 +18413,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ExportMappingTypeCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch DeviceLocations LOV" }, { "name": "includeInactiveFlag", @@ -19068,7 +18487,7 @@ } }, "204": { - "description": "ExportMappingTypeCodesLOV not found." + "description": "DeviceLocationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19118,30 +18537,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/extSystem/{extSystem}/module/{module}/businessEventActionType": { + "/listOfValues/hotels/{hotelId}/dietaryPreferences": { "get": { - "summary": "Return list of values for hotel business event action types", - "description": "Use this API to return the list of values for business event action types for a specific property based on search criteria such as module, extSystem, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBusinessEventActionTypeLOV

", - "operationId": "getBusinessEventActionTypeLOV", + "summary": "Fetch List Of Values for Dietary Preferences", + "description": "

OperationId:getDietaryPreferencesLOV

", + "operationId": "getDietaryPreferencesLOV", "parameters": [ - { - "name": "module", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'module' which is required to fetch BusinessEventActionType LOV" - }, - { - "name": "extSystem", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'extSystem' which is required to fetch BusinessEventActionType LOV" - }, { "name": "hotelId", "in": "path", @@ -19149,7 +18550,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BusinessEventActionType LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch DietaryPreferences LOV" }, { "name": "includeInactiveFlag", @@ -19223,7 +18624,7 @@ } }, "204": { - "description": "BusinessEventActionTypeLOV not found." + "description": "DietaryPreferencesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19273,11 +18674,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/externalReferenceTypes": { + "/listOfValues/hotels/{hotelId}/eCoupon": { "get": { - "summary": "Return list of values for hotel external reference types", - "description": "Use this API to return the list of values for external reference types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getExternalReferenceTypesLOV

", - "operationId": "getExternalReferenceTypesLOV", + "summary": "Fetch List Of Values for ECoupon", + "description": "

OperationId:getECouponLOV

", + "operationId": "getECouponLOV", "parameters": [ { "name": "hotelId", @@ -19286,7 +18687,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ExternalReferenceTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ECoupon LOV" }, { "name": "includeInactiveFlag", @@ -19360,7 +18761,7 @@ } }, "204": { - "description": "ExternalReferenceTypesLOV not found." + "description": "ECouponLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19410,11 +18811,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/facilityCodes": { + "/listOfValues/hotels/{hotelId}/eCouponRateCodes": { "get": { - "summary": "Return list of values for hotel facility codes", - "description": "Use this API to return the list of values for facility codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFacilityCodesLOV

", - "operationId": "getFacilityCodesLOV", + "summary": "Fetch List Of Values for ECoupon Rate Codes", + "description": "

OperationId:getECouponRateCodesLOV

", + "operationId": "getECouponRateCodesLOV", "parameters": [ { "name": "hotelId", @@ -19423,7 +18824,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch FacilityCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ECouponRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -19497,7 +18898,7 @@ } }, "204": { - "description": "FacilityCodesLOV not found." + "description": "ECouponRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19547,21 +18948,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/facilityTask/{facilityTask}/facilityCodesReservation": { + "/listOfValues/hotels/{hotelId}/ecouponResvRoom": { "get": { - "summary": "Return list of values for hotel facility codes reservation", - "description": "Use this API to return the list of values for facility codes reservation for a specific property based on search criteria such as facilityTask, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFacilityCodesReservationLOV

", - "operationId": "getFacilityCodesReservationLOV", + "summary": "Fetch List Of Values for Ecoupon Resv Room", + "description": "

OperationId:getEcouponResvRoomLOV

", + "operationId": "getEcouponResvRoomLOV", "parameters": [ - { - "name": "facilityTask", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'facilityTask' which is required to fetch FacilityCodesReservation LOV" - }, { "name": "hotelId", "in": "path", @@ -19569,7 +18961,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch FacilityCodesReservation LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch EcouponResvRoom LOV" }, { "name": "includeInactiveFlag", @@ -19643,7 +19035,7 @@ } }, "204": { - "description": "FacilityCodesReservationLOV not found." + "description": "EcouponResvRoomLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19693,11 +19085,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/facilityTasks": { + "/listOfValues/hotels/{hotelId}/eventGroups": { "get": { - "summary": "Return list of values for hotel facility tasks", - "description": "Use this API to return the list of values for facility tasks for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFacilityTasksLOV

", - "operationId": "getFacilityTasksLOV", + "summary": "Fetch List Of Values for Event Groups", + "description": "

OperationId:getEventGroupsLOV

", + "operationId": "getEventGroupsLOV", "parameters": [ { "name": "hotelId", @@ -19706,7 +19098,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch FacilityTasks LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch EventGroups LOV" }, { "name": "includeInactiveFlag", @@ -19780,7 +19172,7 @@ } }, "204": { - "description": "FacilityTasksLOV not found." + "description": "EventGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19830,21 +19222,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fileGroup/{fileGroup}/availableExportTemplates": { + "/listOfValues/hotels/{hotelId}/eventLocations": { "get": { - "summary": "Return list of values for hotel available export templates", - "description": "Use this API to return the list of values for available export templates for a specific property based on search criteria such as fileGroup, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAvailableExportTemplatesLOV

", - "operationId": "getAvailableExportTemplatesLOV", + "summary": "Fetch List Of Values for Event Locations", + "description": "

OperationId:getEventLocationsLOV

", + "operationId": "getEventLocationsLOV", "parameters": [ - { - "name": "fileGroup", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'fileGroup' which is required to fetch AvailableExportTemplates LOV" - }, { "name": "hotelId", "in": "path", @@ -19852,7 +19235,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AvailableExportTemplates LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch EventLocations LOV" }, { "name": "includeInactiveFlag", @@ -19926,7 +19309,7 @@ } }, "204": { - "description": "AvailableExportTemplatesLOV not found." + "description": "EventLocationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19976,12 +19359,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fiscalPaymentMethods": { + "/listOfValues/hotels/{hotelId}/exchangeType/{exchangeType}/currencyExchangeRates": { "get": { - "summary": "Return list of values for hotel fiscal payment methods", - "description": "Use this API to return the list of values for fiscal payment methods for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFiscalPaymentMethodsLOV

", - "operationId": "getFiscalPaymentMethodsLOV", + "summary": "Fetch List Of Values for Currency Exchange Rates", + "description": "

OperationId:getCurrencyExchangeRatesLOV

", + "operationId": "getCurrencyExchangeRatesLOV", "parameters": [ + { + "name": "exchangeType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'exchangeType' which is required to fetch CurrencyExchangeRates LOV" + }, { "name": "hotelId", "in": "path", @@ -19989,7 +19381,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch FiscalPaymentMethods LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CurrencyExchangeRates LOV" }, { "name": "includeInactiveFlag", @@ -20063,7 +19455,7 @@ } }, "204": { - "description": "FiscalPaymentMethodsLOV not found." + "description": "CurrencyExchangeRatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20113,21 +19505,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fiscalYearId/{fiscalYearId}/repFiscalMonths": { + "/listOfValues/hotels/{hotelId}/exportMappingTypeCodes": { "get": { - "summary": "Return list of values for hotel rep fiscal months", - "description": "Use this API to return the list of values for rep fiscal months for a specific property based on search criteria such as fiscalYearId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepFiscalMonthsLOV

", - "operationId": "getRepFiscalMonthsLOV", + "summary": "Fetch List Of Values for Export Mapping Type Codes", + "description": "

OperationId:getExportMappingTypeCodesLOV

", + "operationId": "getExportMappingTypeCodesLOV", "parameters": [ - { - "name": "fiscalYearId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'fiscalYearId' which is required to fetch RepFiscalMonths LOV" - }, { "name": "hotelId", "in": "path", @@ -20135,7 +19518,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepFiscalMonths LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ExportMappingTypeCodes LOV" }, { "name": "includeInactiveFlag", @@ -20209,7 +19592,7 @@ } }, "204": { - "description": "RepFiscalMonthsLOV not found." + "description": "ExportMappingTypeCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20259,20 +19642,29 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fiscalYearId/{fiscalYearId}/repFiscalWeeks": { + "/listOfValues/hotels/{hotelId}/extSystem/{extSystem}/module/{module}/businessEventActionType": { "get": { - "summary": "Return list of values for hotel rep fiscal weeks", - "description": "Use this API to return the list of values for rep fiscal weeks for a specific property based on search criteria such as fiscalYearId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepFiscalWeeksLOV

", - "operationId": "getRepFiscalWeeksLOV", + "summary": "Fetch List Of Values for Business Event Action Type", + "description": "

OperationId:getBusinessEventActionTypeLOV

", + "operationId": "getBusinessEventActionTypeLOV", "parameters": [ { - "name": "fiscalYearId", + "name": "module", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'fiscalYearId' which is required to fetch RepFiscalWeeks LOV" + "description": "Value of the parameter 'module' which is required to fetch BusinessEventActionType LOV" + }, + { + "name": "extSystem", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'extSystem' which is required to fetch BusinessEventActionType LOV" }, { "name": "hotelId", @@ -20281,7 +19673,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepFiscalWeeks LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BusinessEventActionType LOV" }, { "name": "includeInactiveFlag", @@ -20355,7 +19747,7 @@ } }, "204": { - "description": "RepFiscalWeeksLOV not found." + "description": "BusinessEventActionTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20405,11 +19797,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fixedChargesTransactionCodes": { + "/listOfValues/hotels/{hotelId}/externalReferenceTypes": { "get": { - "summary": "Return list of values for hotel fixed charges transaction codes", - "description": "Use this API to return the list of values for fixed charges transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFixedChargesTransactionCodesLOV

", - "operationId": "getFixedChargesTransactionCodesLOV", + "summary": "Fetch List Of Values for External Reference Types", + "description": "

OperationId:getExternalReferenceTypesLOV

", + "operationId": "getExternalReferenceTypesLOV", "parameters": [ { "name": "hotelId", @@ -20418,7 +19810,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch FixedChargesTransactionCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ExternalReferenceTypes LOV" }, { "name": "includeInactiveFlag", @@ -20492,7 +19884,7 @@ } }, "204": { - "description": "FixedChargesTransactionCodesLOV not found." + "description": "ExternalReferenceTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20542,11 +19934,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/floors": { + "/listOfValues/hotels/{hotelId}/facilityCodes": { "get": { - "summary": "Return list of values for hotel floors", - "description": "Use this API to return the list of values for floors for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFloorsLOV

", - "operationId": "getFloorsLOV", + "summary": "Fetch List Of Values for Facility Codes", + "description": "

OperationId:getFacilityCodesLOV

", + "operationId": "getFacilityCodesLOV", "parameters": [ { "name": "hotelId", @@ -20555,7 +19947,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Floors LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch FacilityCodes LOV" }, { "name": "includeInactiveFlag", @@ -20629,7 +20021,7 @@ } }, "204": { - "description": "FloorsLOV not found." + "description": "FacilityCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20679,12 +20071,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/folioStyles": { + "/listOfValues/hotels/{hotelId}/facilityTask/{facilityTask}/facilityCodesReservation": { "get": { - "summary": "Return list of values for hotel folio styles", - "description": "Use this API to return the list of values for folio styles for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFolioStylesLOV

", - "operationId": "getFolioStylesLOV", + "summary": "Fetch List Of Values for Facility Codes Reservation", + "description": "

OperationId:getFacilityCodesReservationLOV

", + "operationId": "getFacilityCodesReservationLOV", "parameters": [ + { + "name": "facilityTask", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'facilityTask' which is required to fetch FacilityCodesReservation LOV" + }, { "name": "hotelId", "in": "path", @@ -20692,7 +20093,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch FolioStyles LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch FacilityCodesReservation LOV" }, { "name": "includeInactiveFlag", @@ -20766,7 +20167,7 @@ } }, "204": { - "description": "FolioStylesLOV not found." + "description": "FacilityCodesReservationLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20816,11 +20217,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/folioTypes": { + "/listOfValues/hotels/{hotelId}/facilityTasks": { "get": { - "summary": "Return list of values for hotel folio types", - "description": "Use this API to return the list of values for folio types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFolioTypesLOV

", - "operationId": "getFolioTypesLOV", + "summary": "Fetch List Of Values for Facility Tasks", + "description": "

OperationId:getFacilityTasksLOV

", + "operationId": "getFacilityTasksLOV", "parameters": [ { "name": "hotelId", @@ -20829,7 +20230,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch FolioTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch FacilityTasks LOV" }, { "name": "includeInactiveFlag", @@ -20903,7 +20304,7 @@ } }, "204": { - "description": "FolioTypesLOV not found." + "description": "FacilityTasksLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20953,12 +20354,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/forecastGroups": { + "/listOfValues/hotels/{hotelId}/fileGroup/{fileGroup}/availableExportTemplates": { "get": { - "summary": "Return list of values for hotel forecast groups", - "description": "Use this API to return the list of values for forecast groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getForecastGroupsLOV

", - "operationId": "getForecastGroupsLOV", + "summary": "Fetch List Of Values for Available Export Templates", + "description": "

OperationId:getAvailableExportTemplatesLOV

", + "operationId": "getAvailableExportTemplatesLOV", "parameters": [ + { + "name": "fileGroup", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'fileGroup' which is required to fetch AvailableExportTemplates LOV" + }, { "name": "hotelId", "in": "path", @@ -20966,7 +20376,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ForecastGroups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AvailableExportTemplates LOV" }, { "name": "includeInactiveFlag", @@ -21040,7 +20450,7 @@ } }, "204": { - "description": "ForecastGroupsLOV not found." + "description": "AvailableExportTemplatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21090,21 +20500,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fromDate/{fromDate}/taskBreakOut": { + "/listOfValues/hotels/{hotelId}/fiscalPaymentMethods": { "get": { - "summary": "Return list of values for hotel task break out", - "description": "Use this API to return the list of values for task break out for a specific property based on search criteria such as fromDate, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTaskBreakOutLOV

", - "operationId": "getTaskBreakOutLOV", + "summary": "Fetch List Of Values for Fiscal Payment Methods", + "description": "

OperationId:getFiscalPaymentMethodsLOV

", + "operationId": "getFiscalPaymentMethodsLOV", "parameters": [ - { - "name": "fromDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'fromDate' which is required to fetch TaskBreakOut LOV" - }, { "name": "hotelId", "in": "path", @@ -21112,7 +20513,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TaskBreakOut LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch FiscalPaymentMethods LOV" }, { "name": "includeInactiveFlag", @@ -21186,7 +20587,7 @@ } }, "204": { - "description": "TaskBreakOutLOV not found." + "description": "FiscalPaymentMethodsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21236,29 +20637,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fromDate/{fromDate}/toDate/{toDate}/repRoomsStat": { + "/listOfValues/hotels/{hotelId}/fiscalYearId/{fiscalYearId}/repFiscalMonths": { "get": { - "summary": "Return list of values for hotel rep rooms statistics", - "description": "Use this API to return the list of values for rep rooms statistics for a specific property based on search criteria such as toDate, fromDate, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepRoomsStatLOV

", - "operationId": "getRepRoomsStatLOV", + "summary": "Fetch List Of Values for Rep Fiscal Months", + "description": "

OperationId:getRepFiscalMonthsLOV

", + "operationId": "getRepFiscalMonthsLOV", "parameters": [ { - "name": "toDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'toDate' which is required to fetch RepRoomsStat LOV" - }, - { - "name": "fromDate", + "name": "fiscalYearId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'fromDate' which is required to fetch RepRoomsStat LOV" + "description": "Value of the parameter 'fiscalYearId' which is required to fetch RepFiscalMonths LOV" }, { "name": "hotelId", @@ -21267,7 +20659,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepRoomsStat LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepFiscalMonths LOV" }, { "name": "includeInactiveFlag", @@ -21341,7 +20733,7 @@ } }, "204": { - "description": "RepRoomsStatLOV not found." + "description": "RepFiscalMonthsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21391,20 +20783,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fromRoomClass/{fromRoomClass}/upsellToRoomClassEdit": { + "/listOfValues/hotels/{hotelId}/fiscalYearId/{fiscalYearId}/repFiscalWeeks": { "get": { - "summary": "Return list of values for hotel upsell to room class edit", - "description": "Use this API to return the list of values for upsell to room class edit for a specific property based on search criteria such as fromRoomClass, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellToRoomClassEditLOV

", - "operationId": "getUpsellToRoomClassEditLOV", + "summary": "Fetch List Of Values for Rep Fiscal Weeks", + "description": "

OperationId:getRepFiscalWeeksLOV

", + "operationId": "getRepFiscalWeeksLOV", "parameters": [ { - "name": "fromRoomClass", + "name": "fiscalYearId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'fromRoomClass' which is required to fetch UpsellToRoomClassEdit LOV" + "description": "Value of the parameter 'fiscalYearId' which is required to fetch RepFiscalWeeks LOV" }, { "name": "hotelId", @@ -21413,7 +20805,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellToRoomClassEdit LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepFiscalWeeks LOV" }, { "name": "includeInactiveFlag", @@ -21487,7 +20879,7 @@ } }, "204": { - "description": "UpsellToRoomClassEditLOV not found." + "description": "RepFiscalWeeksLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21537,11 +20929,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fromRoomNumber": { + "/listOfValues/hotels/{hotelId}/fixedChargesTransactionCodes": { "get": { - "summary": "Return list of values for hotel from room number", - "description": "Use this API to return the list of values for from room number for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFromRoomNumberLOV

", - "operationId": "getFromRoomNumberLOV", + "summary": "Fetch List Of Values for Fixed Charges Transaction Codes", + "description": "

OperationId:getFixedChargesTransactionCodesLOV

", + "operationId": "getFixedChargesTransactionCodesLOV", "parameters": [ { "name": "hotelId", @@ -21550,7 +20942,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch FromRoomNumber LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch FixedChargesTransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -21624,7 +21016,7 @@ } }, "204": { - "description": "FromRoomNumberLOV not found." + "description": "FixedChargesTransactionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21674,21 +21066,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fromRoomTypeLabel/{fromRoomTypeLabel}/upsellToRoomTypeEdit": { + "/listOfValues/hotels/{hotelId}/floors": { "get": { - "summary": "Return list of values for hotel upsell to room type edit", - "description": "Use this API to return the list of values for upsell to room type edit for a specific property based on search criteria such as fromRoomTypeLabel, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellToRoomTypeEditLOV

", - "operationId": "getUpsellToRoomTypeEditLOV", + "summary": "Fetch List Of Values for Floors", + "description": "

OperationId:getFloorsLOV

", + "operationId": "getFloorsLOV", "parameters": [ - { - "name": "fromRoomTypeLabel", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'fromRoomTypeLabel' which is required to fetch UpsellToRoomTypeEdit LOV" - }, { "name": "hotelId", "in": "path", @@ -21696,7 +21079,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellToRoomTypeEdit LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Floors LOV" }, { "name": "includeInactiveFlag", @@ -21770,7 +21153,7 @@ } }, "204": { - "description": "UpsellToRoomTypeEditLOV not found." + "description": "FloorsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21820,11 +21203,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/gemMenuItems": { + "/listOfValues/hotels/{hotelId}/folioStyles": { "get": { - "summary": "Return list of values for hotel gem menu items", - "description": "Use this API to return the list of values for gem menu items for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGemMenuItemsLOV

", - "operationId": "getGemMenuItemsLOV", + "summary": "Fetch List Of Values for Folio Styles", + "description": "

OperationId:getFolioStylesLOV

", + "operationId": "getFolioStylesLOV", "parameters": [ { "name": "hotelId", @@ -21833,7 +21216,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch GemMenuItems LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch FolioStyles LOV" }, { "name": "includeInactiveFlag", @@ -21907,7 +21290,7 @@ } }, "204": { - "description": "GemMenuItemsLOV not found." + "description": "FolioStylesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21957,11 +21340,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/genericReports": { + "/listOfValues/hotels/{hotelId}/folioTypes": { "get": { - "summary": "Return list of values for hotel generic reports", - "description": "Use this API to return the list of values for generic reports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGenericReportsLOV

", - "operationId": "getGenericReportsLOV", + "summary": "Fetch List Of Values for Folio Types", + "description": "

OperationId:getFolioTypesLOV

", + "operationId": "getFolioTypesLOV", "parameters": [ { "name": "hotelId", @@ -21970,7 +21353,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch GenericReports LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch FolioTypes LOV" }, { "name": "includeInactiveFlag", @@ -22044,7 +21427,7 @@ } }, "204": { - "description": "GenericReportsLOV not found." + "description": "FolioTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22094,11 +21477,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/groupArrivals": { + "/listOfValues/hotels/{hotelId}/forecastGroups": { "get": { - "summary": "Return list of values for hotel group arrivals", - "description": "Use this API to return the list of values for group arrivals for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGroupArrivalsLOV

", - "operationId": "getGroupArrivalsLOV", + "summary": "Fetch List Of Values for Forecast Groups", + "description": "

OperationId:getForecastGroupsLOV

", + "operationId": "getForecastGroupsLOV", "parameters": [ { "name": "hotelId", @@ -22107,7 +21490,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch GroupArrivals LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ForecastGroups LOV" }, { "name": "includeInactiveFlag", @@ -22181,7 +21564,7 @@ } }, "204": { - "description": "GroupArrivalsLOV not found." + "description": "ForecastGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22231,12 +21614,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/groups": { + "/listOfValues/hotels/{hotelId}/fromDate/{fromDate}/taskBreakOut": { "get": { - "summary": "Return list of values for hotel groups", - "description": "Use this API to return the list of values for groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGroupsLOV

", - "operationId": "getGroupsLOV", + "summary": "Fetch List Of Values for Task Break Out", + "description": "

OperationId:getTaskBreakOutLOV

", + "operationId": "getTaskBreakOutLOV", "parameters": [ + { + "name": "fromDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'fromDate' which is required to fetch TaskBreakOut LOV" + }, { "name": "hotelId", "in": "path", @@ -22244,7 +21636,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Groups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TaskBreakOut LOV" }, { "name": "includeInactiveFlag", @@ -22318,7 +21710,7 @@ } }, "204": { - "description": "GroupsLOV not found." + "description": "TaskBreakOutLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22368,12 +21760,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/guestMessagesMultiHotel": { + "/listOfValues/hotels/{hotelId}/fromDate/{fromDate}/toDate/{toDate}/repRoomsStat": { "get": { - "summary": "Return list of values for hotel guest messages multi hotel", - "description": "Use this API to return the list of values for guest messages multi hotel for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGuestMessagesMultiHotelLOV

", - "operationId": "getGuestMessagesMultiHotelLOV", + "summary": "Fetch List Of Values for Rep Rooms Stat", + "description": "

OperationId:getRepRoomsStatLOV

", + "operationId": "getRepRoomsStatLOV", "parameters": [ + { + "name": "toDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'toDate' which is required to fetch RepRoomsStat LOV" + }, + { + "name": "fromDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'fromDate' which is required to fetch RepRoomsStat LOV" + }, { "name": "hotelId", "in": "path", @@ -22381,7 +21791,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch GuestMessagesMultiHotel LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepRoomsStat LOV" }, { "name": "includeInactiveFlag", @@ -22455,7 +21865,7 @@ } }, "204": { - "description": "GuestMessagesMultiHotelLOV not found." + "description": "RepRoomsStatLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22505,12 +21915,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/guestMessagesQuickTexts": { + "/listOfValues/hotels/{hotelId}/fromRoomClass/{fromRoomClass}/upsellToRoomClassEdit": { "get": { - "summary": "Return list of values for hotel guest messages quick texts", - "description": "Use this API to return the list of values for guest messages quick texts for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGuestMessagesQuickTextsLOV

", - "operationId": "getGuestMessagesQuickTextsLOV", + "summary": "Fetch List Of Values for Upsell To Room Class Edit", + "description": "

OperationId:getUpsellToRoomClassEditLOV

", + "operationId": "getUpsellToRoomClassEditLOV", "parameters": [ + { + "name": "fromRoomClass", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'fromRoomClass' which is required to fetch UpsellToRoomClassEdit LOV" + }, { "name": "hotelId", "in": "path", @@ -22518,7 +21937,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch GuestMessagesQuickTexts LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellToRoomClassEdit LOV" }, { "name": "includeInactiveFlag", @@ -22592,7 +22011,7 @@ } }, "204": { - "description": "GuestMessagesQuickTextsLOV not found." + "description": "UpsellToRoomClassEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22642,11 +22061,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkAttendants": { + "/listOfValues/hotels/{hotelId}/fromRoomNumber": { "get": { - "summary": "Return list of values for hotel housekeeping attendants", - "description": "Use this API to return the list of values for housekeeping attendants for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHKAttendantsLOV

", - "operationId": "getHKAttendantsLOV", + "summary": "Fetch List Of Values for From Room Number", + "description": "

OperationId:getFromRoomNumberLOV

", + "operationId": "getFromRoomNumberLOV", "parameters": [ { "name": "hotelId", @@ -22655,7 +22074,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HKAttendants LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch FromRoomNumber LOV" }, { "name": "includeInactiveFlag", @@ -22729,7 +22148,7 @@ } }, "204": { - "description": "HKAttendantsLOV not found." + "description": "FromRoomNumberLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22779,12 +22198,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkAttendantsMobile": { + "/listOfValues/hotels/{hotelId}/fromRoomTypeLabel/{fromRoomTypeLabel}/upsellToRoomTypeEdit": { "get": { - "summary": "Return list of values for hotel housekeeping attendants mobile", - "description": "Use this API to return the list of values for housekeeping attendants mobile for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHKAttendantsMobileLOV

", - "operationId": "getHKAttendantsMobileLOV", + "summary": "Fetch List Of Values for Upsell To Room Type Edit", + "description": "

OperationId:getUpsellToRoomTypeEditLOV

", + "operationId": "getUpsellToRoomTypeEditLOV", "parameters": [ + { + "name": "fromRoomTypeLabel", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'fromRoomTypeLabel' which is required to fetch UpsellToRoomTypeEdit LOV" + }, { "name": "hotelId", "in": "path", @@ -22792,7 +22220,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HKAttendantsMobile LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellToRoomTypeEdit LOV" }, { "name": "includeInactiveFlag", @@ -22866,7 +22294,7 @@ } }, "204": { - "description": "HKAttendantsMobileLOV not found." + "description": "UpsellToRoomTypeEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22916,11 +22344,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkFloors": { + "/listOfValues/hotels/{hotelId}/gemMenuItems": { "get": { - "summary": "Return list of values for hotel housekeeping floors", - "description": "Use this API to return the list of values for housekeeping floors for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHkFloorsLOV

", - "operationId": "getHkFloorsLOV", + "summary": "Fetch List Of Values for Gem Menu Items", + "description": "

OperationId:getGemMenuItemsLOV

", + "operationId": "getGemMenuItemsLOV", "parameters": [ { "name": "hotelId", @@ -22929,7 +22357,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HkFloors LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch GemMenuItems LOV" }, { "name": "includeInactiveFlag", @@ -23003,7 +22431,7 @@ } }, "204": { - "description": "HkFloorsLOV not found." + "description": "GemMenuItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23053,11 +22481,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkRoomTypes": { + "/listOfValues/hotels/{hotelId}/genericReports": { "get": { - "summary": "Return list of values for hotel housekeeping room types", - "description": "Use this API to return the list of values for housekeeping room types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHkRoomTypesLOV

", - "operationId": "getHkRoomTypesLOV", + "summary": "Fetch List Of Values for Generic Reports", + "description": "

OperationId:getGenericReportsLOV

", + "operationId": "getGenericReportsLOV", "parameters": [ { "name": "hotelId", @@ -23066,7 +22494,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HkRoomTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch GenericReports LOV" }, { "name": "includeInactiveFlag", @@ -23140,7 +22568,7 @@ } }, "204": { - "description": "HkRoomTypesLOV not found." + "description": "GenericReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23190,11 +22618,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkRooms": { + "/listOfValues/hotels/{hotelId}/groupArrivals": { "get": { - "summary": "Return list of values for hotel housekeeping rooms", - "description": "Use this API to return the list of values for housekeeping rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHkRoomsLOV

", - "operationId": "getHkRoomsLOV", + "summary": "Fetch List Of Values for Group Arrivals", + "description": "

OperationId:getGroupArrivalsLOV

", + "operationId": "getGroupArrivalsLOV", "parameters": [ { "name": "hotelId", @@ -23203,7 +22631,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HkRooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch GroupArrivals LOV" }, { "name": "includeInactiveFlag", @@ -23277,7 +22705,7 @@ } }, "204": { - "description": "HkRoomsLOV not found." + "description": "GroupArrivalsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23327,11 +22755,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkTaskBreakOut": { + "/listOfValues/hotels/{hotelId}/groups": { "get": { - "summary": "Return list of values for hotel housekeeping task break out", - "description": "Use this API to return the list of values for housekeeping task break out for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHKTaskBreakOutLOV

", - "operationId": "getHKTaskBreakOutLOV", + "summary": "Fetch List Of Values for Groups", + "description": "

OperationId:getGroupsLOV

", + "operationId": "getGroupsLOV", "parameters": [ { "name": "hotelId", @@ -23340,7 +22768,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HKTaskBreakOut LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Groups LOV" }, { "name": "includeInactiveFlag", @@ -23414,7 +22842,7 @@ } }, "204": { - "description": "HKTaskBreakOutLOV not found." + "description": "GroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23464,11 +22892,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkTaskCodes": { + "/listOfValues/hotels/{hotelId}/guestMessagesMultiHotel": { "get": { - "summary": "Return list of values for hotel housekeeping task codes", - "description": "Use this API to return the list of values for housekeeping task codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHKTaskCodesLOV

", - "operationId": "getHKTaskCodesLOV", + "summary": "Fetch List Of Values for Guest Messages Multi Hotel", + "description": "

OperationId:getGuestMessagesMultiHotelLOV

", + "operationId": "getGuestMessagesMultiHotelLOV", "parameters": [ { "name": "hotelId", @@ -23477,7 +22905,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HKTaskCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch GuestMessagesMultiHotel LOV" }, { "name": "includeInactiveFlag", @@ -23551,7 +22979,7 @@ } }, "204": { - "description": "HKTaskCodesLOV not found." + "description": "GuestMessagesMultiHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23601,11 +23029,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkTaskTemplates": { + "/listOfValues/hotels/{hotelId}/guestMessagesQuickTexts": { "get": { - "summary": "Return list of values for hotel housekeeping task templates", - "description": "Use this API to return the list of values for housekeeping task templates for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHKTaskTemplatesLOV

", - "operationId": "getHKTaskTemplatesLOV", + "summary": "Fetch List Of Values for Guest Messages Quick Texts", + "description": "

OperationId:getGuestMessagesQuickTextsLOV

", + "operationId": "getGuestMessagesQuickTextsLOV", "parameters": [ { "name": "hotelId", @@ -23614,7 +23042,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HKTaskTemplates LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch GuestMessagesQuickTexts LOV" }, { "name": "includeInactiveFlag", @@ -23688,7 +23116,7 @@ } }, "204": { - "description": "HKTaskTemplatesLOV not found." + "description": "GuestMessagesQuickTextsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23738,11 +23166,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hotelEventTypes": { + "/listOfValues/hotels/{hotelId}/hkAttendants": { "get": { - "summary": "Return list of values for hotel event types", - "description": "Use this API to return the list of values for event types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHotelEventTypesLOV

", - "operationId": "getHotelEventTypesLOV", + "summary": "Fetch List Of Values for HKAttendants", + "description": "

OperationId:getHKAttendantsLOV

", + "operationId": "getHKAttendantsLOV", "parameters": [ { "name": "hotelId", @@ -23751,7 +23179,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HotelEventTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HKAttendants LOV" }, { "name": "includeInactiveFlag", @@ -23825,7 +23253,7 @@ } }, "204": { - "description": "HotelEventTypesLOV not found." + "description": "HKAttendantsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23875,11 +23303,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hotelInterfaceImportRooms": { + "/listOfValues/hotels/{hotelId}/hkAttendantsMobile": { "get": { - "summary": "Return list of values for hotel interface import rooms", - "description": "Use this API to return the list of values for interface import rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHotelInterfaceImportRoomsLOV

", - "operationId": "getHotelInterfaceImportRoomsLOV", + "summary": "Fetch List Of Values for HKAttendants Mobile", + "description": "

OperationId:getHKAttendantsMobileLOV

", + "operationId": "getHKAttendantsMobileLOV", "parameters": [ { "name": "hotelId", @@ -23888,7 +23316,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HotelInterfaceImportRooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HKAttendantsMobile LOV" }, { "name": "includeInactiveFlag", @@ -23962,7 +23390,7 @@ } }, "204": { - "description": "HotelInterfaceImportRoomsLOV not found." + "description": "HKAttendantsMobileLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24012,11 +23440,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hotelRateTier": { + "/listOfValues/hotels/{hotelId}/hkFloors": { "get": { - "summary": "Return list of values for hotel rate tiers", - "description": "Use this API to return the list of values for rate tiers for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHotelRateTierLOV

", - "operationId": "getHotelRateTierLOV", + "summary": "Fetch List Of Values for Hk Floors", + "description": "

OperationId:getHkFloorsLOV

", + "operationId": "getHkFloorsLOV", "parameters": [ { "name": "hotelId", @@ -24025,7 +23453,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HotelRateTier LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HkFloors LOV" }, { "name": "includeInactiveFlag", @@ -24099,7 +23527,7 @@ } }, "204": { - "description": "HotelRateTierLOV not found." + "description": "HkFloorsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24149,11 +23577,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/houseKeepingRooms": { + "/listOfValues/hotels/{hotelId}/hkRoomTypes": { "get": { - "summary": "Return list of values for hotel housekeeping rooms", - "description": "Use this API to return the list of values for housekeeping rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHouseKeepingRoomsLOV

", - "operationId": "getHouseKeepingRoomsLOV", + "summary": "Fetch List Of Values for Hk Room Types", + "description": "

OperationId:getHkRoomTypesLOV

", + "operationId": "getHkRoomTypesLOV", "parameters": [ { "name": "hotelId", @@ -24162,7 +23590,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HouseKeepingRooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HkRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -24236,7 +23664,7 @@ } }, "204": { - "description": "HouseKeepingRoomsLOV not found." + "description": "HkRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24286,11 +23714,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/houseKeepingSections": { + "/listOfValues/hotels/{hotelId}/hkRooms": { "get": { - "summary": "Return list of values for hotel housekeeping sections", - "description": "Use this API to return the list of values for housekeeping sections for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHouseKeepingSectionsLOV

", - "operationId": "getHouseKeepingSectionsLOV", + "summary": "Fetch List Of Values for Hk Rooms", + "description": "

OperationId:getHkRoomsLOV

", + "operationId": "getHkRoomsLOV", "parameters": [ { "name": "hotelId", @@ -24299,7 +23727,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HouseKeepingSections LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HkRooms LOV" }, { "name": "includeInactiveFlag", @@ -24373,7 +23801,7 @@ } }, "204": { - "description": "HouseKeepingSectionsLOV not found." + "description": "HkRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24423,11 +23851,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/housekeepingCreditRules": { + "/listOfValues/hotels/{hotelId}/hkTaskBreakOut": { "get": { - "summary": "Return list of values for hotel housekeeping credit rules", - "description": "Use this API to return the list of values for housekeeping credit rules for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHousekeepingCreditRulesLOV

", - "operationId": "getHousekeepingCreditRulesLOV", + "summary": "Fetch List Of Values for HKTask Break Out", + "description": "

OperationId:getHKTaskBreakOutLOV

", + "operationId": "getHKTaskBreakOutLOV", "parameters": [ { "name": "hotelId", @@ -24436,7 +23864,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HousekeepingCreditRules LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HKTaskBreakOut LOV" }, { "name": "includeInactiveFlag", @@ -24510,7 +23938,7 @@ } }, "204": { - "description": "HousekeepingCreditRulesLOV not found." + "description": "HKTaskBreakOutLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24560,30 +23988,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/ifcId/{ifcId}/category/{category}/ifcRightsView": { + "/listOfValues/hotels/{hotelId}/hkTaskCodes": { "get": { - "summary": "Return list of values for hotel interface rights view", - "description": "Use this API to return the list of values for interface rights view for a specific property based on search criteria such as category, ifcId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getIfcRightsViewLOV

", - "operationId": "getIfcRightsViewLOV", + "summary": "Fetch List Of Values for HKTask Codes", + "description": "

OperationId:getHKTaskCodesLOV

", + "operationId": "getHKTaskCodesLOV", "parameters": [ { - "name": "category", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'category' which is required to fetch IfcRightsView LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HKTaskCodes LOV" }, { - "name": "ifcId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'ifcId' which is required to fetch IfcRightsView LOV" + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "HKTaskCodesLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/hotels/{hotelId}/hkTaskTemplates": { + "get": { + "summary": "Fetch List Of Values for HKTask Templates", + "description": "

OperationId:getHKTaskTemplatesLOV

", + "operationId": "getHKTaskTemplatesLOV", + "parameters": [ { "name": "hotelId", "in": "path", @@ -24591,7 +24138,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch IfcRightsView LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HKTaskTemplates LOV" }, { "name": "includeInactiveFlag", @@ -24665,7 +24212,7 @@ } }, "204": { - "description": "IfcRightsViewLOV not found." + "description": "HKTaskTemplatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24715,11 +24262,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/imbalanceVerificationTypes": { + "/listOfValues/hotels/{hotelId}/hotelEventTypes": { "get": { - "summary": "Return list of values for hotel imbalance verification types", - "description": "Use this API to return the list of values for imbalance verification types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getImbalanceVerificationTypesLOV

", - "operationId": "getImbalanceVerificationTypesLOV", + "summary": "Fetch List Of Values for Hotel Event Types", + "description": "

OperationId:getHotelEventTypesLOV

", + "operationId": "getHotelEventTypesLOV", "parameters": [ { "name": "hotelId", @@ -24728,7 +24275,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ImbalanceVerificationTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HotelEventTypes LOV" }, { "name": "includeInactiveFlag", @@ -24802,7 +24349,7 @@ } }, "204": { - "description": "ImbalanceVerificationTypesLOV not found." + "description": "HotelEventTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24852,21 +24399,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/includeBlank/{includeBlank}/upsellOccupancyLevels": { + "/listOfValues/hotels/{hotelId}/hotelInterfaceImportRooms": { "get": { - "summary": "Return list of values for hotel upsell occupancy levels", - "description": "Use this API to return the list of values for upsell occupancy levels for a specific property based on search criteria such as includeBlank, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellOccupancyLevelsLOV

", - "operationId": "getUpsellOccupancyLevelsLOV", + "summary": "Fetch List Of Values for Hotel Interface Import Rooms", + "description": "

OperationId:getHotelInterfaceImportRoomsLOV

", + "operationId": "getHotelInterfaceImportRoomsLOV", "parameters": [ - { - "name": "includeBlank", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'includeBlank' which is required to fetch UpsellOccupancyLevels LOV" - }, { "name": "hotelId", "in": "path", @@ -24874,7 +24412,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellOccupancyLevels LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HotelInterfaceImportRooms LOV" }, { "name": "includeInactiveFlag", @@ -24948,7 +24486,7 @@ } }, "204": { - "description": "UpsellOccupancyLevelsLOV not found." + "description": "HotelInterfaceImportRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24998,25 +24536,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/includeInactive/{includeInactive}/sourceGroups": { + "/listOfValues/hotels/{hotelId}/hotelRateTier": { "get": { - "summary": "Return list of values for hotel source groups", - "description": "Use this API to return the list of values for source groups for a specific property based on search criteria such as includeInactive, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSourceGroupsLOV

", - "operationId": "getSourceGroupsLOV", + "summary": "Fetch List Of Values for Hotel Rate Tier", + "description": "

OperationId:getHotelRateTierLOV

", + "operationId": "getHotelRateTierLOV", "parameters": [ - { - "name": "includeInactive", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'includeInactive' which is required to fetch SourceGroups LOV", - "enum": [ - "Y", - "N" - ] - }, { "name": "hotelId", "in": "path", @@ -25024,7 +24549,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch SourceGroups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HotelRateTier LOV" }, { "name": "includeInactiveFlag", @@ -25098,7 +24623,7 @@ } }, "204": { - "description": "SourceGroupsLOV not found." + "description": "HotelRateTierLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25148,11 +24673,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceAutoBalance": { + "/listOfValues/hotels/{hotelId}/houseKeepingRooms": { "get": { - "summary": "Return list of values for hotel interface auto balance", - "description": "Use this API to return the list of values for interface auto balance for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceAutoBalanceLOV

", - "operationId": "getInterfaceAutoBalanceLOV", + "summary": "Fetch List Of Values for House Keeping Rooms", + "description": "

OperationId:getHouseKeepingRoomsLOV

", + "operationId": "getHouseKeepingRoomsLOV", "parameters": [ { "name": "hotelId", @@ -25161,7 +24686,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceAutoBalance LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HouseKeepingRooms LOV" }, { "name": "includeInactiveFlag", @@ -25235,7 +24760,7 @@ } }, "204": { - "description": "InterfaceAutoBalanceLOV not found." + "description": "HouseKeepingRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25285,11 +24810,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestMarketCode": { + "/listOfValues/hotels/{hotelId}/houseKeepingSections": { "get": { - "summary": "Return list of values for hotel interface data request market codes", - "description": "Use this API to return the list of values for interface data request market codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceDataRequestMarketCodeLOV

", - "operationId": "getInterfaceDataRequestMarketCodeLOV", + "summary": "Fetch List Of Values for House Keeping Sections", + "description": "

OperationId:getHouseKeepingSectionsLOV

", + "operationId": "getHouseKeepingSectionsLOV", "parameters": [ { "name": "hotelId", @@ -25298,7 +24823,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestMarketCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HouseKeepingSections LOV" }, { "name": "includeInactiveFlag", @@ -25372,7 +24897,7 @@ } }, "204": { - "description": "InterfaceDataRequestMarketCodeLOV not found." + "description": "HouseKeepingSectionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25422,11 +24947,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestMarketGroup": { + "/listOfValues/hotels/{hotelId}/housekeepingCreditRules": { "get": { - "summary": "Return list of values for hotel interface data request market groups", - "description": "Use this API to return the list of values for interface data request market groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceDataRequestMarketGroupLOV

", - "operationId": "getInterfaceDataRequestMarketGroupLOV", + "summary": "Fetch List Of Values for Housekeeping Credit Rules", + "description": "

OperationId:getHousekeepingCreditRulesLOV

", + "operationId": "getHousekeepingCreditRulesLOV", "parameters": [ { "name": "hotelId", @@ -25435,7 +24960,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestMarketGroup LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HousekeepingCreditRules LOV" }, { "name": "includeInactiveFlag", @@ -25509,7 +25034,7 @@ } }, "204": { - "description": "InterfaceDataRequestMarketGroupLOV not found." + "description": "HousekeepingCreditRulesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25559,12 +25084,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestRoomClass": { + "/listOfValues/hotels/{hotelId}/ifcId/{ifcId}/category/{category}/ifcRightsView": { "get": { - "summary": "Return list of values for hotel interface data request room classes", - "description": "Use this API to return the list of values for interface data request room classes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceDataRequestRoomClassLOV

", - "operationId": "getInterfaceDataRequestRoomClassLOV", + "summary": "Fetch List Of Values for Ifc Rights View", + "description": "

OperationId:getIfcRightsViewLOV

", + "operationId": "getIfcRightsViewLOV", "parameters": [ + { + "name": "category", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'category' which is required to fetch IfcRightsView LOV" + }, + { + "name": "ifcId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'ifcId' which is required to fetch IfcRightsView LOV" + }, { "name": "hotelId", "in": "path", @@ -25572,7 +25115,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestRoomClass LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch IfcRightsView LOV" }, { "name": "includeInactiveFlag", @@ -25646,7 +25189,7 @@ } }, "204": { - "description": "InterfaceDataRequestRoomClassLOV not found." + "description": "IfcRightsViewLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25696,11 +25239,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestRoomTypes": { + "/listOfValues/hotels/{hotelId}/imbalanceVerificationTypes": { "get": { - "summary": "Return list of values for hotel interface data request room types", - "description": "Use this API to return the list of values for interface data request room types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceDataRequestRoomTypesLOV

", - "operationId": "getInterfaceDataRequestRoomTypesLOV", + "summary": "Fetch List Of Values for Imbalance Verification Types", + "description": "

OperationId:getImbalanceVerificationTypesLOV

", + "operationId": "getImbalanceVerificationTypesLOV", "parameters": [ { "name": "hotelId", @@ -25709,7 +25252,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestRoomTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ImbalanceVerificationTypes LOV" }, { "name": "includeInactiveFlag", @@ -25783,7 +25326,7 @@ } }, "204": { - "description": "InterfaceDataRequestRoomTypesLOV not found." + "description": "ImbalanceVerificationTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25833,12 +25376,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestSourceCode": { + "/listOfValues/hotels/{hotelId}/includeBlank/{includeBlank}/upsellOccupancyLevels": { "get": { - "summary": "Return list of values for hotel interface data request source codes", - "description": "Use this API to return the list of values for interface data request source codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceDataRequestSourceCodeLOV

", - "operationId": "getInterfaceDataRequestSourceCodeLOV", + "summary": "Fetch List Of Values for Upsell Occupancy Levels", + "description": "

OperationId:getUpsellOccupancyLevelsLOV

", + "operationId": "getUpsellOccupancyLevelsLOV", "parameters": [ + { + "name": "includeBlank", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'includeBlank' which is required to fetch UpsellOccupancyLevels LOV" + }, { "name": "hotelId", "in": "path", @@ -25846,7 +25398,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestSourceCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellOccupancyLevels LOV" }, { "name": "includeInactiveFlag", @@ -25920,7 +25472,7 @@ } }, "204": { - "description": "InterfaceDataRequestSourceCodeLOV not found." + "description": "UpsellOccupancyLevelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25970,12 +25522,25 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestSourceGroup": { + "/listOfValues/hotels/{hotelId}/includeInactive/{includeInactive}/sourceGroups": { "get": { - "summary": "Return list of values for hotel interface data request source groups", - "description": "Use this API to return the list of values for interface data request source groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceDataRequestSourceGroupLOV

", - "operationId": "getInterfaceDataRequestSourceGroupLOV", + "summary": "Fetch List Of Values for Source Groups", + "description": "

OperationId:getSourceGroupsLOV

", + "operationId": "getSourceGroupsLOV", "parameters": [ + { + "name": "includeInactive", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'includeInactive' which is required to fetch SourceGroups LOV", + "enum": [ + "Y", + "N" + ] + }, { "name": "hotelId", "in": "path", @@ -25983,7 +25548,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestSourceGroup LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch SourceGroups LOV" }, { "name": "includeInactiveFlag", @@ -26057,7 +25622,7 @@ } }, "204": { - "description": "InterfaceDataRequestSourceGroupLOV not found." + "description": "SourceGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26107,11 +25672,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfacePseudoRoom": { + "/listOfValues/hotels/{hotelId}/interfaceAutoBalance": { "get": { - "summary": "Return list of values for hotel interface pseudo rooms", - "description": "Use this API to return the list of values for interface pseudo rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfacePseudoRoomLOV

", - "operationId": "getInterfacePseudoRoomLOV", + "summary": "Fetch List Of Values for Interface Auto Balance", + "description": "

OperationId:getInterfaceAutoBalanceLOV

", + "operationId": "getInterfaceAutoBalanceLOV", "parameters": [ { "name": "hotelId", @@ -26120,7 +25685,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfacePseudoRoom LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceAutoBalance LOV" }, { "name": "includeInactiveFlag", @@ -26194,7 +25759,7 @@ } }, "204": { - "description": "InterfacePseudoRoomLOV not found." + "description": "InterfaceAutoBalanceLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26244,11 +25809,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceResyncFunctionSpace": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestMarketCode": { "get": { - "summary": "Return list of values for hotel interface resync function spaces", - "description": "Use this API to return the list of values for interface resync function spaces for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceResyncFunctionSpaceLOV

", - "operationId": "getInterfaceResyncFunctionSpaceLOV", + "summary": "Fetch List Of Values for Interface Data Request Market Code", + "description": "

OperationId:getInterfaceDataRequestMarketCodeLOV

", + "operationId": "getInterfaceDataRequestMarketCodeLOV", "parameters": [ { "name": "hotelId", @@ -26257,7 +25822,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceResyncFunctionSpace LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestMarketCode LOV" }, { "name": "includeInactiveFlag", @@ -26331,7 +25896,7 @@ } }, "204": { - "description": "InterfaceResyncFunctionSpaceLOV not found." + "description": "InterfaceDataRequestMarketCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26381,11 +25946,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceResyncOwnerContract": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestMarketGroup": { "get": { - "summary": "Return list of values for hotel interface resync owner contracts", - "description": "Use this API to return the list of values for interface resync owner contracts for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceResyncOwnerContractLOV

", - "operationId": "getInterfaceResyncOwnerContractLOV", + "summary": "Fetch List Of Values for Interface Data Request Market Group", + "description": "

OperationId:getInterfaceDataRequestMarketGroupLOV

", + "operationId": "getInterfaceDataRequestMarketGroupLOV", "parameters": [ { "name": "hotelId", @@ -26394,7 +25959,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceResyncOwnerContract LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestMarketGroup LOV" }, { "name": "includeInactiveFlag", @@ -26468,7 +26033,7 @@ } }, "204": { - "description": "InterfaceResyncOwnerContractLOV not found." + "description": "InterfaceDataRequestMarketGroupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26518,11 +26083,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceResyncOwnerContractRoom": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestRoomClass": { "get": { - "summary": "Return list of values for hotel interface resync owner contract rooms", - "description": "Use this API to return the list of values for interface resync owner contract rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceResyncOwnerContractRoomLOV

", - "operationId": "getInterfaceResyncOwnerContractRoomLOV", + "summary": "Fetch List Of Values for Interface Data Request Room Class", + "description": "

OperationId:getInterfaceDataRequestRoomClassLOV

", + "operationId": "getInterfaceDataRequestRoomClassLOV", "parameters": [ { "name": "hotelId", @@ -26531,7 +26096,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceResyncOwnerContractRoom LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestRoomClass LOV" }, { "name": "includeInactiveFlag", @@ -26605,7 +26170,7 @@ } }, "204": { - "description": "InterfaceResyncOwnerContractRoomLOV not found." + "description": "InterfaceDataRequestRoomClassLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26655,11 +26220,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceResyncProducts": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestRoomTypes": { "get": { - "summary": "Return list of values for hotel interface resync products", - "description": "Use this API to return the list of values for interface resync products for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceResyncProductsLOV

", - "operationId": "getInterfaceResyncProductsLOV", + "summary": "Fetch List Of Values for Interface Data Request Room Types", + "description": "

OperationId:getInterfaceDataRequestRoomTypesLOV

", + "operationId": "getInterfaceDataRequestRoomTypesLOV", "parameters": [ { "name": "hotelId", @@ -26668,7 +26233,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceResyncProducts LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -26742,7 +26307,7 @@ } }, "204": { - "description": "InterfaceResyncProductsLOV not found." + "description": "InterfaceDataRequestRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26792,11 +26357,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceTrxCodesAllCharges": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestSourceCode": { "get": { - "summary": "Return list of values for hotel interface tansaction codes all charges", - "description": "Use this API to return the list of values for interface transaction codes all charges for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceTrxCodesAllChargesLOV

", - "operationId": "getInterfaceTrxCodesAllChargesLOV", + "summary": "Fetch List Of Values for Interface Data Request Source Code", + "description": "

OperationId:getInterfaceDataRequestSourceCodeLOV

", + "operationId": "getInterfaceDataRequestSourceCodeLOV", "parameters": [ { "name": "hotelId", @@ -26805,7 +26370,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceTrxCodesAllCharges LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestSourceCode LOV" }, { "name": "includeInactiveFlag", @@ -26879,7 +26444,7 @@ } }, "204": { - "description": "InterfaceTrxCodesAllChargesLOV not found." + "description": "InterfaceDataRequestSourceCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26929,11 +26494,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceTrxCodesMinibar": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestSourceGroup": { "get": { - "summary": "Return list of values for hotel interface transaction codes minibar", - "description": "Use this API to return the list of values for interface tansaction codes minibar for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceTrxCodesMinibarLOV

", - "operationId": "getInterfaceTrxCodesMinibarLOV", + "summary": "Fetch List Of Values for Interface Data Request Source Group", + "description": "

OperationId:getInterfaceDataRequestSourceGroupLOV

", + "operationId": "getInterfaceDataRequestSourceGroupLOV", "parameters": [ { "name": "hotelId", @@ -26942,7 +26507,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceTrxCodesMinibar LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceDataRequestSourceGroup LOV" }, { "name": "includeInactiveFlag", @@ -27016,7 +26581,7 @@ } }, "204": { - "description": "InterfaceTrxCodesMinibarLOV not found." + "description": "InterfaceDataRequestSourceGroupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27066,30 +26631,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceType/{interfaceType}/interfaceRowId/{interfaceRowId}/allowedHotelInterfaceRights": { + "/listOfValues/hotels/{hotelId}/interfacePseudoRoom": { "get": { - "summary": "Return list of values for hotel allowed hotel interface rights", - "description": "Use this API to return the list of values for allowed hotel interface rights for a specific property based on search criteria such as interfaceRowId, interfaceType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAllowedHotelInterfaceRightsLOV

", - "operationId": "getAllowedHotelInterfaceRightsLOV", + "summary": "Fetch List Of Values for Interface Pseudo Room", + "description": "

OperationId:getInterfacePseudoRoomLOV

", + "operationId": "getInterfacePseudoRoomLOV", "parameters": [ - { - "name": "interfaceRowId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'interfaceRowId' which is required to fetch AllowedHotelInterfaceRights LOV" - }, - { - "name": "interfaceType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'interfaceType' which is required to fetch AllowedHotelInterfaceRights LOV" - }, { "name": "hotelId", "in": "path", @@ -27097,7 +26644,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AllowedHotelInterfaceRights LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfacePseudoRoom LOV" }, { "name": "includeInactiveFlag", @@ -27171,7 +26718,7 @@ } }, "204": { - "description": "AllowedHotelInterfaceRightsLOV not found." + "description": "InterfacePseudoRoomLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27221,11 +26768,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/invItemsClasses": { + "/listOfValues/hotels/{hotelId}/interfaceResyncFunctionSpace": { "get": { - "summary": "Return list of values for hotel inventory item classes", - "description": "Use this API to return the list of values for inventory item classes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInvItemsClassesLOV

", - "operationId": "getInvItemsClassesLOV", + "summary": "Fetch List Of Values for Interface Resync Function Space", + "description": "

OperationId:getInterfaceResyncFunctionSpaceLOV

", + "operationId": "getInterfaceResyncFunctionSpaceLOV", "parameters": [ { "name": "hotelId", @@ -27234,7 +26781,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InvItemsClasses LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceResyncFunctionSpace LOV" }, { "name": "includeInactiveFlag", @@ -27308,7 +26855,7 @@ } }, "204": { - "description": "InvItemsClassesLOV not found." + "description": "InterfaceResyncFunctionSpaceLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27358,11 +26905,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/invItemsPools": { + "/listOfValues/hotels/{hotelId}/interfaceResyncOwnerContract": { "get": { - "summary": "Return list of values for hotel inventory item pools", - "description": "Use this API to return the list of values for inventory item pools for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInvItemsPoolsLOV

", - "operationId": "getInvItemsPoolsLOV", + "summary": "Fetch List Of Values for Interface Resync Owner Contract", + "description": "

OperationId:getInterfaceResyncOwnerContractLOV

", + "operationId": "getInterfaceResyncOwnerContractLOV", "parameters": [ { "name": "hotelId", @@ -27371,7 +26918,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InvItemsPools LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceResyncOwnerContract LOV" }, { "name": "includeInactiveFlag", @@ -27445,7 +26992,7 @@ } }, "204": { - "description": "InvItemsPoolsLOV not found." + "description": "InterfaceResyncOwnerContractLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27495,11 +27042,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/inventoryItemTemplateItems": { + "/listOfValues/hotels/{hotelId}/interfaceResyncOwnerContractRoom": { "get": { - "summary": "Return list of values for hotel inventory item template items", - "description": "Use this API to return the list of values for inventory item template items for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInventoryItemTemplateItemsLOV

", - "operationId": "getInventoryItemTemplateItemsLOV", + "summary": "Fetch List Of Values for Interface Resync Owner Contract Room", + "description": "

OperationId:getInterfaceResyncOwnerContractRoomLOV

", + "operationId": "getInterfaceResyncOwnerContractRoomLOV", "parameters": [ { "name": "hotelId", @@ -27508,7 +27055,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InventoryItemTemplateItems LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceResyncOwnerContractRoom LOV" }, { "name": "includeInactiveFlag", @@ -27582,7 +27129,7 @@ } }, "204": { - "description": "InventoryItemTemplateItemsLOV not found." + "description": "InterfaceResyncOwnerContractRoomLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27632,11 +27179,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/itemClasses": { + "/listOfValues/hotels/{hotelId}/interfaceResyncProducts": { "get": { - "summary": "Return list of values for hotel inventory item classes", - "description": "Use this API to return the list of values for inventory item classes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getItemClassesLOV

", - "operationId": "getItemClassesLOV", + "summary": "Fetch List Of Values for Interface Resync Products", + "description": "

OperationId:getInterfaceResyncProductsLOV

", + "operationId": "getInterfaceResyncProductsLOV", "parameters": [ { "name": "hotelId", @@ -27645,7 +27192,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ItemClasses LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceResyncProducts LOV" }, { "name": "includeInactiveFlag", @@ -27719,7 +27266,7 @@ } }, "204": { - "description": "ItemClassesLOV not found." + "description": "InterfaceResyncProductsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27769,11 +27316,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/itemCodes": { + "/listOfValues/hotels/{hotelId}/interfaceTrxCodesAllCharges": { "get": { - "summary": "Return list of values for hotel inventory item codes", - "description": "Use this API to return the list of values for inventory item codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getItemCodesLOV

", - "operationId": "getItemCodesLOV", + "summary": "Fetch List Of Values for Interface Trx Codes All Charges", + "description": "

OperationId:getInterfaceTrxCodesAllChargesLOV

", + "operationId": "getInterfaceTrxCodesAllChargesLOV", "parameters": [ { "name": "hotelId", @@ -27782,7 +27329,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ItemCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceTrxCodesAllCharges LOV" }, { "name": "includeInactiveFlag", @@ -27856,7 +27403,7 @@ } }, "204": { - "description": "ItemCodesLOV not found." + "description": "InterfaceTrxCodesAllChargesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27906,21 +27453,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/itemId/{itemId}/inventoryItemAttributes": { + "/listOfValues/hotels/{hotelId}/interfaceTrxCodesMinibar": { "get": { - "summary": "Return list of values for hotel inventory item attributes", - "description": "Use this API to return the list of values for inventory item attributes for a specific property based on search criteria such as itemId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInventoryItemAttributesLOV

", - "operationId": "getInventoryItemAttributesLOV", + "summary": "Fetch List Of Values for Interface Trx Codes Minibar", + "description": "

OperationId:getInterfaceTrxCodesMinibarLOV

", + "operationId": "getInterfaceTrxCodesMinibarLOV", "parameters": [ - { - "name": "itemId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'itemId' which is required to fetch InventoryItemAttributes LOV" - }, { "name": "hotelId", "in": "path", @@ -27928,7 +27466,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InventoryItemAttributes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceTrxCodesMinibar LOV" }, { "name": "includeInactiveFlag", @@ -28002,7 +27540,7 @@ } }, "204": { - "description": "InventoryItemAttributesLOV not found." + "description": "InterfaceTrxCodesMinibarLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28052,166 +27590,29 @@ ] } }, - "/listOfValues/hotels/{hotelId}/itemId/{itemId}/inventoryItemRates": { + "/listOfValues/hotels/{hotelId}/interfaceType/{interfaceType}/interfaceRowId/{interfaceRowId}/allowedHotelInterfaceRights": { "get": { - "summary": "Return list of values for hotel inventory item rates", - "description": "Use this API to return the list of values for inventory item rates for a specific property based on search criteria such as itemId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInventoryItemRatesLOV

", - "operationId": "getInventoryItemRatesLOV", + "summary": "Fetch List Of Values for Allowed Hotel Interface Rights", + "description": "

OperationId:getAllowedHotelInterfaceRightsLOV

", + "operationId": "getAllowedHotelInterfaceRightsLOV", "parameters": [ { - "name": "itemId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'itemId' which is required to fetch InventoryItemRates LOV" - }, - { - "name": "hotelId", + "name": "interfaceRowId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InventoryItemRates LOV" - }, - { - "name": "includeInactiveFlag", - "in": "query", - "required": false, - "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", - "type": "boolean" - }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$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": "", - "schema": { - "$ref": "#/definitions/listOfValues" - } - }, - "204": { - "description": "InventoryItemRatesLOV 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" + "description": "Value of the parameter 'interfaceRowId' which is required to fetch AllowedHotelInterfaceRights LOV" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/itemId/{itemId}/itemPriceCode": { - "get": { - "summary": "Return list of values for hotel inventory item price codes", - "description": "Use this API to return the list of values for inventory item price codes for a specific property based on search criteria such as itemId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getItemPriceCodeLOV

", - "operationId": "getItemPriceCodeLOV", - "parameters": [ { - "name": "itemId", + "name": "interfaceType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'itemId' which is required to fetch ItemPriceCode LOV" + "description": "Value of the parameter 'interfaceType' which is required to fetch AllowedHotelInterfaceRights LOV" }, { "name": "hotelId", @@ -28220,7 +27621,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ItemPriceCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AllowedHotelInterfaceRights LOV" }, { "name": "includeInactiveFlag", @@ -28294,7 +27695,7 @@ } }, "204": { - "description": "ItemPriceCodeLOV not found." + "description": "AllowedHotelInterfaceRightsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28344,21 +27745,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/itemId/{itemId}/itemVendor": { + "/listOfValues/hotels/{hotelId}/invItemsClasses": { "get": { - "summary": "Return list of values for hotel inventory item vendors", - "description": "Use this API to return the list of values for inventory item vendors for a specific property based on search criteria such as itemId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getItemVendorLOV

", - "operationId": "getItemVendorLOV", + "summary": "Fetch List Of Values for Inv Items Classes", + "description": "

OperationId:getInvItemsClassesLOV

", + "operationId": "getInvItemsClassesLOV", "parameters": [ - { - "name": "itemId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'itemId' which is required to fetch ItemVendor LOV" - }, { "name": "hotelId", "in": "path", @@ -28366,7 +27758,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ItemVendor LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InvItemsClasses LOV" }, { "name": "includeInactiveFlag", @@ -28440,7 +27832,7 @@ } }, "204": { - "description": "ItemVendorLOV not found." + "description": "InvItemsClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28490,11 +27882,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/jobTitles": { + "/listOfValues/hotels/{hotelId}/invItemsPools": { "get": { - "summary": "Return list of values for hotel job titles", - "description": "Use this API to return the list of values for job titles for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getJobTitlesLOV

", - "operationId": "getJobTitlesLOV", + "summary": "Fetch List Of Values for Inv Items Pools", + "description": "

OperationId:getInvItemsPoolsLOV

", + "operationId": "getInvItemsPoolsLOV", "parameters": [ { "name": "hotelId", @@ -28503,7 +27895,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch JobTitles LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InvItemsPools LOV" }, { "name": "includeInactiveFlag", @@ -28577,7 +27969,7 @@ } }, "204": { - "description": "JobTitlesLOV not found." + "description": "InvItemsPoolsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28627,11 +28019,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/keyOptions": { + "/listOfValues/hotels/{hotelId}/inventoryItemTemplateItems": { "get": { - "summary": "Return list of values for hotel key options", - "description": "Use this API to return the list of values for key options for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getKeyOptionsLOV

", - "operationId": "getKeyOptionsLOV", + "summary": "Fetch List Of Values for Inventory Item Template Items", + "description": "

OperationId:getInventoryItemTemplateItemsLOV

", + "operationId": "getInventoryItemTemplateItemsLOV", "parameters": [ { "name": "hotelId", @@ -28640,7 +28032,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch KeyOptions LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InventoryItemTemplateItems LOV" }, { "name": "includeInactiveFlag", @@ -28714,7 +28106,7 @@ } }, "204": { - "description": "KeyOptionsLOV not found." + "description": "InventoryItemTemplateItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28764,11 +28156,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/licenses": { + "/listOfValues/hotels/{hotelId}/itemClasses": { "get": { - "summary": "Return list of values for hotel licenses", - "description": "Use this API to return the list of values for licenses for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getLicensesLOV

", - "operationId": "getLicensesLOV", + "summary": "Fetch List Of Values for Item Classes", + "description": "

OperationId:getItemClassesLOV

", + "operationId": "getItemClassesLOV", "parameters": [ { "name": "hotelId", @@ -28777,7 +28169,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Licenses LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ItemClasses LOV" }, { "name": "includeInactiveFlag", @@ -28851,7 +28243,7 @@ } }, "204": { - "description": "LicensesLOV not found." + "description": "ItemClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28901,11 +28293,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/locatorQuickTexts": { + "/listOfValues/hotels/{hotelId}/itemCodes": { "get": { - "summary": "Return list of values for hotel locator quick texts", - "description": "Use this API to return the list of values for locator quick texts for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getLocatorQuickTextsLOV

", - "operationId": "getLocatorQuickTextsLOV", + "summary": "Fetch List Of Values for Item Codes", + "description": "

OperationId:getItemCodesLOV

", + "operationId": "getItemCodesLOV", "parameters": [ { "name": "hotelId", @@ -28914,7 +28306,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch LocatorQuickTexts LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ItemCodes LOV" }, { "name": "includeInactiveFlag", @@ -28988,7 +28380,7 @@ } }, "204": { - "description": "LocatorQuickTextsLOV not found." + "description": "ItemCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29038,20 +28430,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/logo/{logo}/hotelInterfaceDataLineTypes": { + "/listOfValues/hotels/{hotelId}/itemId/{itemId}/inventoryItemAttributes": { "get": { - "summary": "Return list of values for hotel interface data line types", - "description": "Use this API to return the list of values for interface data line types for a specific property based on search criteria such as logo, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHotelInterfaceDataLineTypesLOV

", - "operationId": "getHotelInterfaceDataLineTypesLOV", + "summary": "Fetch List Of Values for Inventory Item Attributes", + "description": "

OperationId:getInventoryItemAttributesLOV

", + "operationId": "getInventoryItemAttributesLOV", "parameters": [ { - "name": "logo", + "name": "itemId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'logo' which is required to fetch HotelInterfaceDataLineTypes LOV" + "description": "Value of the parameter 'itemId' which is required to fetch InventoryItemAttributes LOV" }, { "name": "hotelId", @@ -29060,7 +28452,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HotelInterfaceDataLineTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InventoryItemAttributes LOV" }, { "name": "includeInactiveFlag", @@ -29134,7 +28526,7 @@ } }, "204": { - "description": "HotelInterfaceDataLineTypesLOV not found." + "description": "InventoryItemAttributesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29184,20 +28576,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/logo/{logo}/interfaceRevenueCode": { + "/listOfValues/hotels/{hotelId}/itemId/{itemId}/inventoryItemRates": { "get": { - "summary": "Return list of values for hotel interface revenue codes", - "description": "Use this API to return the list of values for interface revenue codes for a specific property based on search criteria such as logo, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceRevenueCodeLOV

", - "operationId": "getInterfaceRevenueCodeLOV", + "summary": "Fetch List Of Values for Inventory Item Rates", + "description": "

OperationId:getInventoryItemRatesLOV

", + "operationId": "getInventoryItemRatesLOV", "parameters": [ { - "name": "logo", + "name": "itemId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'logo' which is required to fetch InterfaceRevenueCode LOV" + "description": "Value of the parameter 'itemId' which is required to fetch InventoryItemRates LOV" }, { "name": "hotelId", @@ -29206,7 +28598,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceRevenueCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InventoryItemRates LOV" }, { "name": "includeInactiveFlag", @@ -29280,7 +28672,7 @@ } }, "204": { - "description": "InterfaceRevenueCodeLOV not found." + "description": "InventoryItemRatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29330,12 +28722,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/managerReportDetails": { + "/listOfValues/hotels/{hotelId}/itemId/{itemId}/itemPriceCode": { "get": { - "summary": "Return list of values for hotel manager report details", - "description": "Use this API to return the list of values for manager report details for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getManagerReportDetailsLOV

", - "operationId": "getManagerReportDetailsLOV", + "summary": "Fetch List Of Values for Item Price Code", + "description": "

OperationId:getItemPriceCodeLOV

", + "operationId": "getItemPriceCodeLOV", "parameters": [ + { + "name": "itemId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'itemId' which is required to fetch ItemPriceCode LOV" + }, { "name": "hotelId", "in": "path", @@ -29343,7 +28744,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ManagerReportDetails LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ItemPriceCode LOV" }, { "name": "includeInactiveFlag", @@ -29417,7 +28818,7 @@ } }, "204": { - "description": "ManagerReportDetailsLOV not found." + "description": "ItemPriceCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29467,12 +28868,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/managersReports": { + "/listOfValues/hotels/{hotelId}/itemId/{itemId}/itemVendor": { "get": { - "summary": "Return list of values for hotel manager reports", - "description": "Use this API to return the list of values for manager reports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getManagersReportsLOV

", - "operationId": "getManagersReportsLOV", + "summary": "Fetch List Of Values for Item Vendor", + "description": "

OperationId:getItemVendorLOV

", + "operationId": "getItemVendorLOV", "parameters": [ + { + "name": "itemId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'itemId' which is required to fetch ItemVendor LOV" + }, { "name": "hotelId", "in": "path", @@ -29480,7 +28890,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ManagersReports LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ItemVendor LOV" }, { "name": "includeInactiveFlag", @@ -29554,7 +28964,7 @@ } }, "204": { - "description": "ManagersReportsLOV not found." + "description": "ItemVendorLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29604,11 +29014,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/marketGroups": { + "/listOfValues/hotels/{hotelId}/jobTitles": { "get": { - "summary": "Return list of values for hotel market groups", - "description": "Use this API to return the list of values for market groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMarketGroupsLOV

", - "operationId": "getMarketGroupsLOV", + "summary": "Fetch List Of Values for Job Titles", + "description": "

OperationId:getJobTitlesLOV

", + "operationId": "getJobTitlesLOV", "parameters": [ { "name": "hotelId", @@ -29617,7 +29027,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch MarketGroups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch JobTitles LOV" }, { "name": "includeInactiveFlag", @@ -29691,7 +29101,7 @@ } }, "204": { - "description": "MarketGroupsLOV not found." + "description": "JobTitlesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29741,11 +29151,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/marketSegment": { + "/listOfValues/hotels/{hotelId}/keyOptions": { "get": { - "summary": "Return list of values for hotel market segments", - "description": "Use this API to return the list of values for market segments for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMarketSegmentLOV

", - "operationId": "getMarketSegmentLOV", + "summary": "Fetch List Of Values for Key Options", + "description": "

OperationId:getKeyOptionsLOV

", + "operationId": "getKeyOptionsLOV", "parameters": [ { "name": "hotelId", @@ -29754,7 +29164,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch MarketSegment LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch KeyOptions LOV" }, { "name": "includeInactiveFlag", @@ -29828,7 +29238,7 @@ } }, "204": { - "description": "MarketSegmentLOV not found." + "description": "KeyOptionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29878,11 +29288,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/masterBlock": { + "/listOfValues/hotels/{hotelId}/licenses": { "get": { - "summary": "Return list of values for hotel master blocks", - "description": "Use this API to return the list of values for master blocks for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMasterBlockLOV

", - "operationId": "getMasterBlockLOV", + "summary": "Fetch List Of Values for Licenses", + "description": "

OperationId:getLicensesLOV

", + "operationId": "getLicensesLOV", "parameters": [ { "name": "hotelId", @@ -29891,7 +29301,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch MasterBlock LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Licenses LOV" }, { "name": "includeInactiveFlag", @@ -29965,7 +29375,7 @@ } }, "204": { - "description": "MasterBlockLOV not found." + "description": "LicensesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30015,11 +29425,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipAwardFinTrx": { + "/listOfValues/hotels/{hotelId}/locatorQuickTexts": { "get": { - "summary": "Return list of values for hotel membership award financial transactions", - "description": "Use this API to return the list of values for membership award financial transactions for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipAwardFinTrxLOV

", - "operationId": "getMembershipAwardFinTrxLOV", + "summary": "Fetch List Of Values for Locator Quick Texts", + "description": "

OperationId:getLocatorQuickTextsLOV

", + "operationId": "getLocatorQuickTextsLOV", "parameters": [ { "name": "hotelId", @@ -30028,7 +29438,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch MembershipAwardFinTrx LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch LocatorQuickTexts LOV" }, { "name": "includeInactiveFlag", @@ -30102,7 +29512,7 @@ } }, "204": { - "description": "MembershipAwardFinTrxLOV not found." + "description": "LocatorQuickTextsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30152,12 +29562,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipAwardProducts": { + "/listOfValues/hotels/{hotelId}/logo/{logo}/hotelInterfaceDataLineTypes": { "get": { - "summary": "Return list of values for hotel membership award products", - "description": "Use this API to return the list of values for membership award products for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipAwardProductsLOV

", - "operationId": "getMembershipAwardProductsLOV", + "summary": "Fetch List Of Values for Hotel Interface Data Line Types", + "description": "

OperationId:getHotelInterfaceDataLineTypesLOV

", + "operationId": "getHotelInterfaceDataLineTypesLOV", "parameters": [ + { + "name": "logo", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'logo' which is required to fetch HotelInterfaceDataLineTypes LOV" + }, { "name": "hotelId", "in": "path", @@ -30165,7 +29584,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch MembershipAwardProducts LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HotelInterfaceDataLineTypes LOV" }, { "name": "includeInactiveFlag", @@ -30239,7 +29658,7 @@ } }, "204": { - "description": "MembershipAwardProductsLOV not found." + "description": "HotelInterfaceDataLineTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30289,12 +29708,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipAwardRateCodes": { + "/listOfValues/hotels/{hotelId}/logo/{logo}/hotelInterfaceIfcRooms": { "get": { - "summary": "Return list of values for hotel membership award rate codes", - "description": "Use this API to return the list of values for membership award rate codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipAwardRateCodesLOV

", - "operationId": "getMembershipAwardRateCodesLOV", + "summary": "Fetch List Of Values for Hotel Interface Data Line Types", + "description": "

OperationId:getHotelInterfaceIfcRoomsLOV

", + "operationId": "getHotelInterfaceIfcRoomsLOV", "parameters": [ + { + "name": "logo", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'logo' which is required to fetch HotelInterfaceIfcRooms LOV" + }, { "name": "hotelId", "in": "path", @@ -30302,7 +29730,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch MembershipAwardRateCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HotelInterfaceIfcRooms LOV" }, { "name": "includeInactiveFlag", @@ -30376,7 +29804,7 @@ } }, "204": { - "description": "MembershipAwardRateCodesLOV not found." + "description": "HotelInterfaceIfcRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30426,12 +29854,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipAwardUpgradeRoom": { + "/listOfValues/hotels/{hotelId}/logo/{logo}/interfaceRevenueCode": { "get": { - "summary": "Return list of values for hotel membership award upgrade rooms", - "description": "Use this API to return the list of values for membership award upgrade rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipAwardUpgradeRoomLOV

", - "operationId": "getMembershipAwardUpgradeRoomLOV", + "summary": "Fetch List Of Values for Interface Revenue Code", + "description": "

OperationId:getInterfaceRevenueCodeLOV

", + "operationId": "getInterfaceRevenueCodeLOV", "parameters": [ + { + "name": "logo", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'logo' which is required to fetch InterfaceRevenueCode LOV" + }, { "name": "hotelId", "in": "path", @@ -30439,7 +29876,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch MembershipAwardUpgradeRoom LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InterfaceRevenueCode LOV" }, { "name": "includeInactiveFlag", @@ -30513,7 +29950,7 @@ } }, "204": { - "description": "MembershipAwardUpgradeRoomLOV not found." + "description": "InterfaceRevenueCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30563,11 +30000,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipAwardUpgradeRoomGroup": { + "/listOfValues/hotels/{hotelId}/managerReportDetails": { "get": { - "summary": "Return list of values for hotel membership award upgrade room groups", - "description": "Use this API to return the list of values for membership award upgrade room groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipAwardUpgradeRoomGroupLOV

", - "operationId": "getMembershipAwardUpgradeRoomGroupLOV", + "summary": "Fetch List Of Values for Manager Report Details", + "description": "

OperationId:getManagerReportDetailsLOV

", + "operationId": "getManagerReportDetailsLOV", "parameters": [ { "name": "hotelId", @@ -30576,7 +30013,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch MembershipAwardUpgradeRoomGroup LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ManagerReportDetails LOV" }, { "name": "includeInactiveFlag", @@ -30650,7 +30087,7 @@ } }, "204": { - "description": "MembershipAwardUpgradeRoomGroupLOV not found." + "description": "ManagerReportDetailsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30700,21 +30137,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipType/{membershipType}/awardPayment": { + "/listOfValues/hotels/{hotelId}/managersReports": { "get": { - "summary": "Return list of values for hotel award payments", - "description": "Use this API to return the list of values for award payments for a specific property based on search criteria such as membershipType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAwardPaymentLOV

", - "operationId": "getAwardPaymentLOV", + "summary": "Fetch List Of Values for Managers Reports", + "description": "

OperationId:getManagersReportsLOV

", + "operationId": "getManagersReportsLOV", "parameters": [ - { - "name": "membershipType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'membershipType' which is required to fetch AwardPayment LOV" - }, { "name": "hotelId", "in": "path", @@ -30722,7 +30150,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AwardPayment LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ManagersReports LOV" }, { "name": "includeInactiveFlag", @@ -30796,7 +30224,7 @@ } }, "204": { - "description": "AwardPaymentLOV not found." + "description": "ManagersReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30846,11 +30274,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/menuClasses": { + "/listOfValues/hotels/{hotelId}/marketGroups": { "get": { - "summary": "Return list of values for hotel menu classes", - "description": "Use this API to return the list of values for menu classes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMenuClassesLOV

", - "operationId": "getMenuClassesLOV", + "summary": "Fetch List Of Values for Market Groups", + "description": "

OperationId:getMarketGroupsLOV

", + "operationId": "getMarketGroupsLOV", "parameters": [ { "name": "hotelId", @@ -30859,7 +30287,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch MenuClasses LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MarketGroups LOV" }, { "name": "includeInactiveFlag", @@ -30933,7 +30361,7 @@ } }, "204": { - "description": "MenuClassesLOV not found." + "description": "MarketGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30983,11 +30411,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/menuItems": { + "/listOfValues/hotels/{hotelId}/marketSegment": { "get": { - "summary": "Return list of values for hotel menu items", - "description": "Use this API to return the list of values for menu items for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMenuItemsLOV

", - "operationId": "getMenuItemsLOV", + "summary": "Fetch List Of Values for Market Segment", + "description": "

OperationId:getMarketSegmentLOV

", + "operationId": "getMarketSegmentLOV", "parameters": [ { "name": "hotelId", @@ -30996,7 +30424,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch MenuItems LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MarketSegment LOV" }, { "name": "includeInactiveFlag", @@ -31070,7 +30498,7 @@ } }, "204": { - "description": "MenuItemsLOV not found." + "description": "MarketSegmentLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31120,39 +30548,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/module/{module}/extSystem/{extSystem}/databaseId/{databaseId}/businessEventActionTypeExtDB": { + "/listOfValues/hotels/{hotelId}/masterBlock": { "get": { - "summary": "Return list of values for hotel business event action type external databases", - "description": "Use this API to return the list of values for business event action type external databases for a specific property based on search criteria such as databaseId, extSystem, module, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getBusinessEventActionTypeExtDBLOV

", - "operationId": "getBusinessEventActionTypeExtDBLOV", + "summary": "Fetch List Of Values for Master Block", + "description": "

OperationId:getMasterBlockLOV

", + "operationId": "getMasterBlockLOV", "parameters": [ - { - "name": "databaseId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'databaseId' which is required to fetch BusinessEventActionTypeExtDB LOV" - }, - { - "name": "extSystem", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'extSystem' which is required to fetch BusinessEventActionTypeExtDB LOV" - }, - { - "name": "module", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'module' which is required to fetch BusinessEventActionTypeExtDB LOV" - }, { "name": "hotelId", "in": "path", @@ -31160,7 +30561,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch BusinessEventActionTypeExtDB LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MasterBlock LOV" }, { "name": "includeInactiveFlag", @@ -31234,7 +30635,7 @@ } }, "204": { - "description": "BusinessEventActionTypeExtDBLOV not found." + "description": "MasterBlockLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31284,30 +30685,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/moduleName/{moduleName}/method/{method}/format": { + "/listOfValues/hotels/{hotelId}/membershipAwardFinTrx": { "get": { - "summary": "Return list of values for hotel formats", - "description": "Use this API to return the list of values for formats for a specific property based on search criteria such as method, moduleName, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFormatLOV

", - "operationId": "getFormatLOV", + "summary": "Fetch List Of Values for Membership Award Fin Trx", + "description": "

OperationId:getMembershipAwardFinTrxLOV

", + "operationId": "getMembershipAwardFinTrxLOV", "parameters": [ - { - "name": "method", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'method' which is required to fetch Format LOV" - }, - { - "name": "moduleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'moduleName' which is required to fetch Format LOV" - }, { "name": "hotelId", "in": "path", @@ -31315,7 +30698,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Format LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MembershipAwardFinTrx LOV" }, { "name": "includeInactiveFlag", @@ -31389,7 +30772,7 @@ } }, "204": { - "description": "FormatLOV not found." + "description": "MembershipAwardFinTrxLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31439,39 +30822,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/nights/{nights}/arrivalDate/{arrivalDate}/roomCategory/{roomCategory}/testUpsellRulesRateCode": { + "/listOfValues/hotels/{hotelId}/membershipAwardProducts": { "get": { - "summary": "Return list of values for hotel test upsell rule rate codes", - "description": "Use this API to return the list of values for test upsell rule rate codes for a specific property based on search criteria such as roomCategory, arrivalDate, nights, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTestUpsellRulesRateCodeLOV

", - "operationId": "getTestUpsellRulesRateCodeLOV", + "summary": "Fetch List Of Values for Membership Award Products", + "description": "

OperationId:getMembershipAwardProductsLOV

", + "operationId": "getMembershipAwardProductsLOV", "parameters": [ - { - "name": "roomCategory", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'roomCategory' which is required to fetch TestUpsellRulesRateCode LOV" - }, - { - "name": "arrivalDate", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'arrivalDate' which is required to fetch TestUpsellRulesRateCode LOV" - }, - { - "name": "nights", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'nights' which is required to fetch TestUpsellRulesRateCode LOV" - }, { "name": "hotelId", "in": "path", @@ -31479,7 +30835,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TestUpsellRulesRateCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MembershipAwardProducts LOV" }, { "name": "includeInactiveFlag", @@ -31553,7 +30909,7 @@ } }, "204": { - "description": "TestUpsellRulesRateCodeLOV not found." + "description": "MembershipAwardProductsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31603,11 +30959,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/osaActivityTypes": { + "/listOfValues/hotels/{hotelId}/membershipAwardRateCodes": { "get": { - "summary": "Return list of values for hotel OSAActivity types", - "description": "Use this API to return the list of values for OSAActivity types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getOSAActivityTypesLOV

", - "operationId": "getOSAActivityTypesLOV", + "summary": "Fetch List Of Values for Membership Award Rate Codes", + "description": "

OperationId:getMembershipAwardRateCodesLOV

", + "operationId": "getMembershipAwardRateCodesLOV", "parameters": [ { "name": "hotelId", @@ -31616,7 +30972,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch OSAActivityTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MembershipAwardRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -31690,7 +31046,7 @@ } }, "204": { - "description": "OSAActivityTypesLOV not found." + "description": "MembershipAwardRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31740,11 +31096,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/oxiInterfaceReferences": { + "/listOfValues/hotels/{hotelId}/membershipAwardUpgradeRoom": { "get": { - "summary": "Return list of values for hotel OXIInterface references", - "description": "Use this API to return the list of values for OXIInterface references for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getOXIInterfaceReferencesLOV

", - "operationId": "getOXIInterfaceReferencesLOV", + "summary": "Fetch List Of Values for Membership Award Upgrade Room", + "description": "

OperationId:getMembershipAwardUpgradeRoomLOV

", + "operationId": "getMembershipAwardUpgradeRoomLOV", "parameters": [ { "name": "hotelId", @@ -31753,7 +31109,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch OXIInterfaceReferences LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MembershipAwardUpgradeRoom LOV" }, { "name": "includeInactiveFlag", @@ -31827,7 +31183,7 @@ } }, "204": { - "description": "OXIInterfaceReferencesLOV not found." + "description": "MembershipAwardUpgradeRoomLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31877,11 +31233,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/oxiInterfaceResorts": { + "/listOfValues/hotels/{hotelId}/membershipAwardUpgradeRoomGroup": { "get": { - "summary": "Return list of values for hotel OXIInterface resorts", - "description": "Use this API to return the list of values for OXIInterface resorts for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getOXIInterfaceResortsLOV

", - "operationId": "getOXIInterfaceResortsLOV", + "summary": "Fetch List Of Values for Membership Award Upgrade Room Group", + "description": "

OperationId:getMembershipAwardUpgradeRoomGroupLOV

", + "operationId": "getMembershipAwardUpgradeRoomGroupLOV", "parameters": [ { "name": "hotelId", @@ -31890,7 +31246,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch OXIInterfaceResorts LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MembershipAwardUpgradeRoomGroup LOV" }, { "name": "includeInactiveFlag", @@ -31964,7 +31320,7 @@ } }, "204": { - "description": "OXIInterfaceResortsLOV not found." + "description": "MembershipAwardUpgradeRoomGroupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32014,12 +31370,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/oxiInterfaces": { + "/listOfValues/hotels/{hotelId}/membershipType/{membershipType}/awardPayment": { "get": { - "summary": "Return list of values for hotel OXIInterfaces", - "description": "Use this API to return the list of values for OXIInterfaces for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getOXIInterfacesLOV

", - "operationId": "getOXIInterfacesLOV", + "summary": "Fetch List Of Values for Award Payment", + "description": "

OperationId:getAwardPaymentLOV

", + "operationId": "getAwardPaymentLOV", "parameters": [ + { + "name": "membershipType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'membershipType' which is required to fetch AwardPayment LOV" + }, { "name": "hotelId", "in": "path", @@ -32027,7 +31392,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch OXIInterfaces LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AwardPayment LOV" }, { "name": "includeInactiveFlag", @@ -32101,7 +31466,7 @@ } }, "204": { - "description": "OXIInterfacesLOV not found." + "description": "AwardPaymentLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32151,11 +31516,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/packForecastGroupCode": { + "/listOfValues/hotels/{hotelId}/menuClasses": { "get": { - "summary": "Return list of values for hotel pack forecast group codes", - "description": "Use this API to return the list of values for pack forecast group codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPackForecastGroupCodeLOV

", - "operationId": "getPackForecastGroupCodeLOV", + "summary": "Fetch List Of Values for Menu Classes", + "description": "

OperationId:getMenuClassesLOV

", + "operationId": "getMenuClassesLOV", "parameters": [ { "name": "hotelId", @@ -32164,7 +31529,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PackForecastGroupCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MenuClasses LOV" }, { "name": "includeInactiveFlag", @@ -32238,7 +31603,7 @@ } }, "204": { - "description": "PackForecastGroupCodeLOV not found." + "description": "MenuClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32288,11 +31653,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/paymentMethods": { + "/listOfValues/hotels/{hotelId}/menuItems": { "get": { - "summary": "Return list of values for hotel payment methods", - "description": "Use this API to return the list of values for payment methods for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPaymentMethodsLOV

", - "operationId": "getPaymentMethodsLOV", + "summary": "Fetch List Of Values for Menu Items", + "description": "

OperationId:getMenuItemsLOV

", + "operationId": "getMenuItemsLOV", "parameters": [ { "name": "hotelId", @@ -32301,7 +31666,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PaymentMethods LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MenuItems LOV" }, { "name": "includeInactiveFlag", @@ -32375,7 +31740,7 @@ } }, "204": { - "description": "PaymentMethodsLOV not found." + "description": "MenuItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32425,149 +31790,39 @@ ] } }, - "/listOfValues/hotels/{hotelId}/paymentTypes": { + "/listOfValues/hotels/{hotelId}/module/{module}/extSystem/{extSystem}/databaseId/{databaseId}/businessEventActionTypeExtDB": { "get": { - "summary": "Return list of values for hotel payment types", - "description": "Use this API to return the list of values for payment types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPaymentTypesLOV

", - "operationId": "getPaymentTypesLOV", + "summary": "Fetch List Of Values for Business Event Action Type Ext DB", + "description": "

OperationId:getBusinessEventActionTypeExtDBLOV

", + "operationId": "getBusinessEventActionTypeExtDBLOV", "parameters": [ { - "name": "hotelId", + "name": "databaseId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PaymentTypes LOV" - }, - { - "name": "includeInactiveFlag", - "in": "query", - "required": false, - "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", - "type": "boolean" - }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$ref": "#/parameters/x-hotelid" + "description": "Value of the parameter 'databaseId' which is required to fetch BusinessEventActionTypeExtDB LOV" }, { - "$ref": "#/parameters/x-externalsystem" + "name": "extSystem", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'extSystem' which is required to fetch BusinessEventActionTypeExtDB LOV" }, { - "$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": "", - "schema": { - "$ref": "#/definitions/listOfValues" - } - }, - "204": { - "description": "PaymentTypesLOV 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" + "name": "module", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'module' which is required to fetch BusinessEventActionTypeExtDB LOV" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/periodSetup": { - "get": { - "summary": "Return list of values for hotel period setups", - "description": "Use this API to return the list of values for period setups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPeriodSetupLOV

", - "operationId": "getPeriodSetupLOV", - "parameters": [ { "name": "hotelId", "in": "path", @@ -32575,7 +31830,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PeriodSetup LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch BusinessEventActionTypeExtDB LOV" }, { "name": "includeInactiveFlag", @@ -32649,7 +31904,7 @@ } }, "204": { - "description": "PeriodSetupLOV not found." + "description": "BusinessEventActionTypeExtDBLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32699,12 +31954,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/periodsSetup": { + "/listOfValues/hotels/{hotelId}/moduleName/{moduleName}/method/{method}/format": { "get": { - "summary": "Return list of values for hotel periods setups", - "description": "Use this API to return the list of values for periods setups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPeriodsSetupLOV

", - "operationId": "getPeriodsSetupLOV", + "summary": "Fetch List Of Values for Format", + "description": "

OperationId:getFormatLOV

", + "operationId": "getFormatLOV", "parameters": [ + { + "name": "method", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'method' which is required to fetch Format LOV" + }, + { + "name": "moduleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'moduleName' which is required to fetch Format LOV" + }, { "name": "hotelId", "in": "path", @@ -32712,7 +31985,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PeriodsSetup LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Format LOV" }, { "name": "includeInactiveFlag", @@ -32786,7 +32059,7 @@ } }, "204": { - "description": "PeriodsSetupLOV not found." + "description": "FormatLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32836,20 +32109,38 @@ ] } }, - "/listOfValues/hotels/{hotelId}/policyType/{policyType}/depositCancelRules": { + "/listOfValues/hotels/{hotelId}/nights/{nights}/arrivalDate/{arrivalDate}/roomCategory/{roomCategory}/testUpsellRulesRateCode": { "get": { - "summary": "Return list of values for hotel deposit cancel rules", - "description": "Use this API to return the list of values for deposit cancel rules for a specific property based on search criteria such as policyType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getDepositCancelRulesLOV

", - "operationId": "getDepositCancelRulesLOV", + "summary": "Fetch List Of Values for Test Upsell Rules Rate Code", + "description": "

OperationId:getTestUpsellRulesRateCodeLOV

", + "operationId": "getTestUpsellRulesRateCodeLOV", "parameters": [ { - "name": "policyType", + "name": "roomCategory", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'policyType' which is required to fetch DepositCancelRules LOV" + "description": "Value of the parameter 'roomCategory' which is required to fetch TestUpsellRulesRateCode LOV" + }, + { + "name": "arrivalDate", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'arrivalDate' which is required to fetch TestUpsellRulesRateCode LOV" + }, + { + "name": "nights", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'nights' which is required to fetch TestUpsellRulesRateCode LOV" }, { "name": "hotelId", @@ -32858,7 +32149,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch DepositCancelRules LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TestUpsellRulesRateCode LOV" }, { "name": "includeInactiveFlag", @@ -32932,7 +32223,7 @@ } }, "204": { - "description": "DepositCancelRulesLOV not found." + "description": "TestUpsellRulesRateCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32982,12 +32273,25 @@ ] } }, - "/listOfValues/hotels/{hotelId}/postingRoom": { + "/listOfValues/hotels/{hotelId}/operaLDAPUsersOnly/{operaLDAPUsersOnly}/applicationUserNames": { "get": { - "summary": "Return list of values for hotel posting rooms", - "description": "Use this API to return the list of values for posting rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPostingRoomLOV

", - "operationId": "getPostingRoomLOV", + "summary": "Fetch List Of Values for Application User Names", + "description": "

OperationId:getApplicationUserNamesLOV

", + "operationId": "getApplicationUserNamesLOV", "parameters": [ + { + "name": "operaLDAPUsersOnly", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'operaLDAPUsersOnly' which is required to fetch ApplicationUserNames LOV", + "enum": [ + "Y", + "N" + ] + }, { "name": "hotelId", "in": "path", @@ -32995,7 +32299,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PostingRoom LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ApplicationUserNames LOV" }, { "name": "includeInactiveFlag", @@ -33069,7 +32373,7 @@ } }, "204": { - "description": "PostingRoomLOV not found." + "description": "ApplicationUserNamesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33119,12 +32423,25 @@ ] } }, - "/listOfValues/hotels/{hotelId}/postingTransactionCodes": { + "/listOfValues/hotels/{hotelId}/operaLDAPUsersOnly/{operaLDAPUsersOnly}/applicationUsers": { "get": { - "summary": "Return list of values for hotel posting transaction codes", - "description": "Use this API to return the list of values for posting transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPostingTransactionCodesLOV

", - "operationId": "getPostingTransactionCodesLOV", + "summary": "Fetch List Of Values for Application Users", + "description": "

OperationId:getApplicationUsersLOV

", + "operationId": "getApplicationUsersLOV", "parameters": [ + { + "name": "operaLDAPUsersOnly", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'operaLDAPUsersOnly' which is required to fetch ApplicationUsers LOV", + "enum": [ + "Y", + "N" + ] + }, { "name": "hotelId", "in": "path", @@ -33132,7 +32449,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PostingTransactionCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ApplicationUsers LOV" }, { "name": "includeInactiveFlag", @@ -33206,7 +32523,7 @@ } }, "204": { - "description": "PostingTransactionCodesLOV not found." + "description": "ApplicationUsersLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33256,11 +32573,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/prepaidCardInterfaces": { + "/listOfValues/hotels/{hotelId}/osaActivityTypes": { "get": { - "summary": "Return list of values for hotel prepaid card interfaces", - "description": "Use this API to return the list of values for prepaid card interfaces for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPrepaidCardInterfacesLOV

", - "operationId": "getPrepaidCardInterfacesLOV", + "summary": "Fetch List Of Values for OSAActivity Types", + "description": "

OperationId:getOSAActivityTypesLOV

", + "operationId": "getOSAActivityTypesLOV", "parameters": [ { "name": "hotelId", @@ -33269,7 +32586,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PrepaidCardInterfaces LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch OSAActivityTypes LOV" }, { "name": "includeInactiveFlag", @@ -33343,7 +32660,7 @@ } }, "204": { - "description": "PrepaidCardInterfacesLOV not found." + "description": "OSAActivityTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33393,11 +32710,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/priorities": { + "/listOfValues/hotels/{hotelId}/oxiInterfaceReferences": { "get": { - "summary": "Return list of values for hotel priorities", - "description": "Use this API to return the list of values for priorities for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPrioritiesLOV

", - "operationId": "getPrioritiesLOV", + "summary": "Fetch List Of Values for OXIInterface References", + "description": "

OperationId:getOXIInterfaceReferencesLOV

", + "operationId": "getOXIInterfaceReferencesLOV", "parameters": [ { "name": "hotelId", @@ -33406,7 +32723,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Priorities LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch OXIInterfaceReferences LOV" }, { "name": "includeInactiveFlag", @@ -33480,7 +32797,7 @@ } }, "204": { - "description": "PrioritiesLOV not found." + "description": "OXIInterfaceReferencesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33530,21 +32847,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/profiles/{profileId}/profileIdentifications": { + "/listOfValues/hotels/{hotelId}/oxiInterfaceResorts": { "get": { - "summary": "Return list of values for hotel profile identifications", - "description": "Use this API to return the list of values for profile identifications for a specific property based on search criteria such as profileId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getProfileIdentificationsLOV

", - "operationId": "getProfileIdentificationsLOV", + "summary": "Fetch List Of Values for OXIInterface Resorts", + "description": "

OperationId:getOXIInterfaceResortsLOV

", + "operationId": "getOXIInterfaceResortsLOV", "parameters": [ - { - "name": "profileId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'profileId' which is required to fetch ProfileIdentifications LOV" - }, { "name": "hotelId", "in": "path", @@ -33552,7 +32860,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ProfileIdentifications LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch OXIInterfaceResorts LOV" }, { "name": "includeInactiveFlag", @@ -33626,7 +32934,7 @@ } }, "204": { - "description": "ProfileIdentificationsLOV not found." + "description": "OXIInterfaceResortsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33676,21 +32984,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/promoCode/{promoCode}/promoRates": { + "/listOfValues/hotels/{hotelId}/oxiInterfaces": { "get": { - "summary": "Return list of values for hotel promotion rates", - "description": "Use this API to return the list of values for promotion rates for a specific property based on search criteria such as promoCode, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPromoRatesLOV

", - "operationId": "getPromoRatesLOV", + "summary": "Fetch List Of Values for OXIInterfaces", + "description": "

OperationId:getOXIInterfacesLOV

", + "operationId": "getOXIInterfacesLOV", "parameters": [ - { - "name": "promoCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'promoCode' which is required to fetch PromoRates LOV" - }, { "name": "hotelId", "in": "path", @@ -33698,7 +32997,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PromoRates LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch OXIInterfaces LOV" }, { "name": "includeInactiveFlag", @@ -33772,7 +33071,7 @@ } }, "204": { - "description": "PromoRatesLOV not found." + "description": "OXIInterfacesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33822,11 +33121,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/promoGroups": { + "/listOfValues/hotels/{hotelId}/packForecastGroupCode": { "get": { - "summary": "Return list of values for hotel promotion groups", - "description": "Use this API to return the list of values for promotion groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPromoGroupsLOV

", - "operationId": "getPromoGroupsLOV", + "summary": "Fetch List Of Values for Pack Forecast Group Code", + "description": "

OperationId:getPackForecastGroupCodeLOV

", + "operationId": "getPackForecastGroupCodeLOV", "parameters": [ { "name": "hotelId", @@ -33835,7 +33134,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PromoGroups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PackForecastGroupCode LOV" }, { "name": "includeInactiveFlag", @@ -33909,7 +33208,7 @@ } }, "204": { - "description": "PromoGroupsLOV not found." + "description": "PackForecastGroupCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33959,11 +33258,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/propertyAmenities": { + "/listOfValues/hotels/{hotelId}/paymentMethods": { "get": { - "summary": "Return list of values for hotel property amenities", - "description": "Use this API to return the list of values for property amenities for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPropertyAmenitiesLOV

", - "operationId": "getPropertyAmenitiesLOV", + "summary": "Fetch List Of Values for Payment Methods", + "description": "

OperationId:getPaymentMethodsLOV

", + "operationId": "getPaymentMethodsLOV", "parameters": [ { "name": "hotelId", @@ -33972,7 +33271,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PropertyAmenities LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PaymentMethods LOV" }, { "name": "includeInactiveFlag", @@ -34046,7 +33345,7 @@ } }, "204": { - "description": "PropertyAmenitiesLOV not found." + "description": "PaymentMethodsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34096,11 +33395,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCategories": { + "/listOfValues/hotels/{hotelId}/paymentTypes": { "get": { - "summary": "Return list of values for hotel rate categories", - "description": "Use this API to return the list of values for rate categories for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRateCategoriesLOV

", - "operationId": "getRateCategoriesLOV", + "summary": "Fetch List Of Values for Payment Types", + "description": "

OperationId:getPaymentTypesLOV

", + "operationId": "getPaymentTypesLOV", "parameters": [ { "name": "hotelId", @@ -34109,7 +33408,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RateCategories LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PaymentTypes LOV" }, { "name": "includeInactiveFlag", @@ -34183,7 +33482,7 @@ } }, "204": { - "description": "RateCategoriesLOV not found." + "description": "PaymentTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34233,21 +33532,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCode/{rateCode}/ratePlansForYieldAsConfig": { + "/listOfValues/hotels/{hotelId}/periodSetup": { "get": { - "summary": "Return list of values for hotel rate plans for yield as configuration", - "description": "Use this API to return the list of values for rate plans for yield as configuration for a specific property based on search criteria such as rateCode, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRatePlansForYieldAsConfigLOV

", - "operationId": "getRatePlansForYieldAsConfigLOV", + "summary": "Fetch List Of Values for Period Setup", + "description": "

OperationId:getPeriodSetupLOV

", + "operationId": "getPeriodSetupLOV", "parameters": [ - { - "name": "rateCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'rateCode' which is required to fetch RatePlansForYieldAsConfig LOV" - }, { "name": "hotelId", "in": "path", @@ -34255,7 +33545,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RatePlansForYieldAsConfig LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PeriodSetup LOV" }, { "name": "includeInactiveFlag", @@ -34329,7 +33619,7 @@ } }, "204": { - "description": "RatePlansForYieldAsConfigLOV not found." + "description": "PeriodSetupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34379,11 +33669,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCodeGlobalDescEdit": { + "/listOfValues/hotels/{hotelId}/periodsSetup": { "get": { - "summary": "Return list of values for hotel rate code global description edit", - "description": "Use this API to return the list of values for rate code global description edit for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRateCodeGlobalDescEditLOV

", - "operationId": "getRateCodeGlobalDescEditLOV", + "summary": "Fetch List Of Values for Periods Setup", + "description": "

OperationId:getPeriodsSetupLOV

", + "operationId": "getPeriodsSetupLOV", "parameters": [ { "name": "hotelId", @@ -34392,7 +33682,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RateCodeGlobalDescEdit LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PeriodsSetup LOV" }, { "name": "includeInactiveFlag", @@ -34466,7 +33756,7 @@ } }, "204": { - "description": "RateCodeGlobalDescEditLOV not found." + "description": "PeriodsSetupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34516,20 +33806,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/rateCodesByType": { + "/listOfValues/hotels/{hotelId}/policyType/{policyType}/depositCancelRules": { "get": { - "summary": "Return list of values for hotel rate codes by type", - "description": "Use this API to return the list of values for rate codes by type for a specific property based on search criteria such as rateCodeType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRateCodesByTypeLOV

", - "operationId": "getRateCodesByTypeLOV", + "summary": "Fetch List Of Values for Deposit Cancel Rules", + "description": "

OperationId:getDepositCancelRulesLOV

", + "operationId": "getDepositCancelRulesLOV", "parameters": [ { - "name": "rateCodeType", + "name": "policyType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'rateCodeType' which is required to fetch RateCodesByType LOV" + "description": "Value of the parameter 'policyType' which is required to fetch DepositCancelRules LOV" }, { "name": "hotelId", @@ -34538,7 +33828,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RateCodesByType LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch DepositCancelRules LOV" }, { "name": "includeInactiveFlag", @@ -34612,7 +33902,7 @@ } }, "204": { - "description": "RateCodesByTypeLOV not found." + "description": "DepositCancelRulesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34662,21 +33952,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/ratePlanForMassRate": { + "/listOfValues/hotels/{hotelId}/postingRoom": { "get": { - "summary": "Return list of values for hotel rate plans for mass rate", - "description": "Use this API to return the list of values for rate plans for mass rate for a specific property based on search criteria such as rateCodeType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRatePlanForMassRateLOV

", - "operationId": "getRatePlanForMassRateLOV", + "summary": "Fetch List Of Values for Posting Room", + "description": "

OperationId:getPostingRoomLOV

", + "operationId": "getPostingRoomLOV", "parameters": [ - { - "name": "rateCodeType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'rateCodeType' which is required to fetch RatePlanForMassRate LOV" - }, { "name": "hotelId", "in": "path", @@ -34684,7 +33965,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RatePlanForMassRate LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PostingRoom LOV" }, { "name": "includeInactiveFlag", @@ -34758,7 +34039,7 @@ } }, "204": { - "description": "RatePlanForMassRateLOV not found." + "description": "PostingRoomLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34808,11 +34089,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCodesValid": { + "/listOfValues/hotels/{hotelId}/postingTransactionCodes": { "get": { - "summary": "Return list of values for hotel valid rate codes", - "description": "Use this API to return the list of values for valid rate codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRateCodesValidLOV

", - "operationId": "getRateCodesValidLOV", + "summary": "Fetch List Of Values for Posting Transaction Codes", + "description": "

OperationId:getPostingTransactionCodesLOV

", + "operationId": "getPostingTransactionCodesLOV", "parameters": [ { "name": "hotelId", @@ -34821,7 +34102,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RateCodesValid LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PostingTransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -34895,7 +34176,7 @@ } }, "204": { - "description": "RateCodesValidLOV not found." + "description": "PostingTransactionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34945,11 +34226,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCommissionCodes": { + "/listOfValues/hotels/{hotelId}/prepaidCardInterfaces": { "get": { - "summary": "Return list of values for hotel rate commission codes", - "description": "Use this API to return the list of values for rate commission codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRateCommissionCodesLOV

", - "operationId": "getRateCommissionCodesLOV", + "summary": "Fetch List Of Values for Prepaid Card Interfaces", + "description": "

OperationId:getPrepaidCardInterfacesLOV

", + "operationId": "getPrepaidCardInterfacesLOV", "parameters": [ { "name": "hotelId", @@ -34958,7 +34239,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RateCommissionCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PrepaidCardInterfaces LOV" }, { "name": "includeInactiveFlag", @@ -35032,7 +34313,7 @@ } }, "204": { - "description": "RateCommissionCodesLOV not found." + "description": "PrepaidCardInterfacesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35082,11 +34363,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateConfigCurrencies": { + "/listOfValues/hotels/{hotelId}/priorities": { "get": { - "summary": "Return list of values for hotel rate configuration currencies", - "description": "Use this API to return the list of values for rate configuration currencies for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRateConfigCurrenciesLOV

", - "operationId": "getRateConfigCurrenciesLOV", + "summary": "Fetch List Of Values for Priorities", + "description": "

OperationId:getPrioritiesLOV

", + "operationId": "getPrioritiesLOV", "parameters": [ { "name": "hotelId", @@ -35095,7 +34376,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RateConfigCurrencies LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Priorities LOV" }, { "name": "includeInactiveFlag", @@ -35169,7 +34450,7 @@ } }, "204": { - "description": "RateConfigCurrenciesLOV not found." + "description": "PrioritiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35219,12 +34500,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateGroups": { + "/listOfValues/hotels/{hotelId}/profiles/{profileId}/profileIdentifications": { "get": { - "summary": "Return list of values for hotel rate groups", - "description": "Use this API to return the list of values for rate groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRateGroupsLOV

", - "operationId": "getRateGroupsLOV", + "summary": "Fetch List Of Values for Profile Identifications", + "description": "

OperationId:getProfileIdentificationsLOV

", + "operationId": "getProfileIdentificationsLOV", "parameters": [ + { + "name": "profileId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'profileId' which is required to fetch ProfileIdentifications LOV" + }, { "name": "hotelId", "in": "path", @@ -35232,7 +34522,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RateGroups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ProfileIdentifications LOV" }, { "name": "includeInactiveFlag", @@ -35306,7 +34596,7 @@ } }, "204": { - "description": "RateGroupsLOV not found." + "description": "ProfileIdentificationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35356,20 +34646,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/ratePlanCodes/{ratePlanCodes}/roomTypesForMassRate": { + "/listOfValues/hotels/{hotelId}/promoCode/{promoCode}/promoRates": { "get": { - "summary": "Return list of values for hotel room types for mass rate", - "description": "Use this API to return the list of values for room types for mass rate for a specific property based on search criteria such as ratePlanCodes, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomTypesForMassRateLOV

", - "operationId": "getRoomTypesForMassRateLOV", + "summary": "Fetch List Of Values for Promo Rates", + "description": "

OperationId:getPromoRatesLOV

", + "operationId": "getPromoRatesLOV", "parameters": [ { - "name": "ratePlanCodes", + "name": "promoCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'ratePlanCodes' which is required to fetch RoomTypesForMassRate LOV" + "description": "Value of the parameter 'promoCode' which is required to fetch PromoRates LOV" }, { "name": "hotelId", @@ -35378,7 +34668,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomTypesForMassRate LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PromoRates LOV" }, { "name": "includeInactiveFlag", @@ -35452,7 +34742,7 @@ } }, "204": { - "description": "RoomTypesForMassRateLOV not found." + "description": "PromoRatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35502,11 +34792,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/ratePlans": { + "/listOfValues/hotels/{hotelId}/promoGroups": { "get": { - "summary": "Return list of values for hotel rate plans", - "description": "Use this API to return the list of values for rate plans for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRatePlansLOV

", - "operationId": "getRatePlansLOV", + "summary": "Fetch List Of Values for Promo Groups", + "description": "

OperationId:getPromoGroupsLOV

", + "operationId": "getPromoGroupsLOV", "parameters": [ { "name": "hotelId", @@ -35515,7 +34805,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RatePlans LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PromoGroups LOV" }, { "name": "includeInactiveFlag", @@ -35589,7 +34879,7 @@ } }, "204": { - "description": "RatePlansLOV not found." + "description": "PromoGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35639,21 +34929,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/relModuleName/{relModuleName}/applicationModules": { + "/listOfValues/hotels/{hotelId}/propertyAmenities": { "get": { - "summary": "Return list of values for hotel application modules", - "description": "Use this API to return the list of values for application modules for a specific property based on search criteria such as relModuleName, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getApplicationModulesLOV

", - "operationId": "getApplicationModulesLOV", + "summary": "Fetch List Of Values for Property Amenities", + "description": "

OperationId:getPropertyAmenitiesLOV

", + "operationId": "getPropertyAmenitiesLOV", "parameters": [ - { - "name": "relModuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'relModuleName' which is required to fetch ApplicationModules LOV" - }, { "name": "hotelId", "in": "path", @@ -35661,7 +34942,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ApplicationModules LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PropertyAmenities LOV" }, { "name": "includeInactiveFlag", @@ -35735,7 +35016,7 @@ } }, "204": { - "description": "ApplicationModulesLOV not found." + "description": "PropertyAmenitiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35785,11 +35066,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repBlockCodesParamOff": { + "/listOfValues/hotels/{hotelId}/rateCategories": { "get": { - "summary": "Return list of values for hotel rep block codes parameter off", - "description": "Use this API to return the list of values for rep block codes parameter off for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepBlockCodesParamOffLOV

", - "operationId": "getRepBlockCodesParamOffLOV", + "summary": "Fetch List Of Values for Rate Categories", + "description": "

OperationId:getRateCategoriesLOV

", + "operationId": "getRateCategoriesLOV", "parameters": [ { "name": "hotelId", @@ -35798,7 +35079,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepBlockCodesParamOff LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RateCategories LOV" }, { "name": "includeInactiveFlag", @@ -35872,7 +35153,7 @@ } }, "204": { - "description": "RepBlockCodesParamOffLOV not found." + "description": "RateCategoriesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35922,12 +35203,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repBlockCodesParamOn": { + "/listOfValues/hotels/{hotelId}/rateCode/{rateCode}/ratePlansForYieldAsConfig": { "get": { - "summary": "Return list of values for hotel rep block codes parameter on", - "description": "Use this API to return the list of values for rep block codes parameter on for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepBlockCodesParamOnLOV

", - "operationId": "getRepBlockCodesParamOnLOV", + "summary": "Fetch List Of Values for Rate Plans For Yield As Config", + "description": "

OperationId:getRatePlansForYieldAsConfigLOV

", + "operationId": "getRatePlansForYieldAsConfigLOV", "parameters": [ + { + "name": "rateCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'rateCode' which is required to fetch RatePlansForYieldAsConfig LOV" + }, { "name": "hotelId", "in": "path", @@ -35935,7 +35225,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepBlockCodesParamOn LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RatePlansForYieldAsConfig LOV" }, { "name": "includeInactiveFlag", @@ -36009,7 +35299,7 @@ } }, "204": { - "description": "RepBlockCodesParamOnLOV not found." + "description": "RatePlansForYieldAsConfigLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36059,11 +35349,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repCashiers": { + "/listOfValues/hotels/{hotelId}/rateCodeGlobalDescEdit": { "get": { - "summary": "Return list of values for hotel rep cashiers", - "description": "Use this API to return the list of values for rep cashiers for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepCashiersLOV

", - "operationId": "getRepCashiersLOV", + "summary": "Fetch List Of Values for Rate Code Global Desc Edit", + "description": "

OperationId:getRateCodeGlobalDescEditLOV

", + "operationId": "getRateCodeGlobalDescEditLOV", "parameters": [ { "name": "hotelId", @@ -36072,7 +35362,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepCashiers LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RateCodeGlobalDescEdit LOV" }, { "name": "includeInactiveFlag", @@ -36146,7 +35436,7 @@ } }, "204": { - "description": "RepCashiersLOV not found." + "description": "RateCodeGlobalDescEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36196,12 +35486,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repContactList": { + "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/rateCodesByType": { "get": { - "summary": "Return list of values for hotel rep contact lists", - "description": "Use this API to return the list of values for rep contact lists for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepContactListLOV

", - "operationId": "getRepContactListLOV", + "summary": "Fetch List Of Values for Rate Codes By Type", + "description": "

OperationId:getRateCodesByTypeLOV

", + "operationId": "getRateCodesByTypeLOV", "parameters": [ + { + "name": "rateCodeType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'rateCodeType' which is required to fetch RateCodesByType LOV" + }, { "name": "hotelId", "in": "path", @@ -36209,7 +35508,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepContactList LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RateCodesByType LOV" }, { "name": "includeInactiveFlag", @@ -36283,7 +35582,7 @@ } }, "204": { - "description": "RepContactListLOV not found." + "description": "RateCodesByTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36333,12 +35632,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repCurrencies": { + "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/ratePlanForMassRate": { "get": { - "summary": "Return list of values for hotel rep currencies", - "description": "Use this API to return the list of values for rep currencies for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepCurrenciesLOV

", - "operationId": "getRepCurrenciesLOV", + "summary": "Fetch List Of Values for Rate Plan For Mass Rate", + "description": "

OperationId:getRatePlanForMassRateLOV

", + "operationId": "getRatePlanForMassRateLOV", "parameters": [ + { + "name": "rateCodeType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'rateCodeType' which is required to fetch RatePlanForMassRate LOV" + }, { "name": "hotelId", "in": "path", @@ -36346,7 +35654,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepCurrencies LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RatePlanForMassRate LOV" }, { "name": "includeInactiveFlag", @@ -36420,7 +35728,7 @@ } }, "204": { - "description": "RepCurrenciesLOV not found." + "description": "RatePlanForMassRateLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36470,11 +35778,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repDepartments": { + "/listOfValues/hotels/{hotelId}/rateCodesValid": { "get": { - "summary": "Return list of values for hotel rep departments", - "description": "Use this API to return the list of values for rep departments for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepDepartmentsLOV

", - "operationId": "getRepDepartmentsLOV", + "summary": "Fetch List Of Values for Rate Codes Valid", + "description": "

OperationId:getRateCodesValidLOV

", + "operationId": "getRateCodesValidLOV", "parameters": [ { "name": "hotelId", @@ -36483,7 +35791,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepDepartments LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RateCodesValid LOV" }, { "name": "includeInactiveFlag", @@ -36557,7 +35865,7 @@ } }, "204": { - "description": "RepDepartmentsLOV not found." + "description": "RateCodesValidLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36607,11 +35915,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repFiscalYears": { + "/listOfValues/hotels/{hotelId}/rateCommissionCodes": { "get": { - "summary": "Return list of values for hotel rep fiscal years", - "description": "Use this API to return the list of values for rep fiscal years for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepFiscalYearsLOV

", - "operationId": "getRepFiscalYearsLOV", + "summary": "Fetch List Of Values for Rate Commission Codes", + "description": "

OperationId:getRateCommissionCodesLOV

", + "operationId": "getRateCommissionCodesLOV", "parameters": [ { "name": "hotelId", @@ -36620,7 +35928,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepFiscalYears LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RateCommissionCodes LOV" }, { "name": "includeInactiveFlag", @@ -36694,7 +36002,7 @@ } }, "204": { - "description": "RepFiscalYearsLOV not found." + "description": "RateCommissionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36744,11 +36052,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repForeignCurrencies": { + "/listOfValues/hotels/{hotelId}/rateConfigCurrencies": { "get": { - "summary": "Return list of values for hotel rep foreign currencies", - "description": "Use this API to return the list of values for rep foreign currencies for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepForeignCurrenciesLOV

", - "operationId": "getRepForeignCurrenciesLOV", + "summary": "Fetch List Of Values for Rate Config Currencies", + "description": "

OperationId:getRateConfigCurrenciesLOV

", + "operationId": "getRateConfigCurrenciesLOV", "parameters": [ { "name": "hotelId", @@ -36757,7 +36065,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepForeignCurrencies LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RateConfigCurrencies LOV" }, { "name": "includeInactiveFlag", @@ -36831,7 +36139,7 @@ } }, "204": { - "description": "RepForeignCurrenciesLOV not found." + "description": "RateConfigCurrenciesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36881,11 +36189,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repGroups": { + "/listOfValues/hotels/{hotelId}/rateGroups": { "get": { - "summary": "Return list of values for hotel rep groups", - "description": "Use this API to return the list of values for rep groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepGroupsLOV

", - "operationId": "getRepGroupsLOV", + "summary": "Fetch List Of Values for Rate Groups", + "description": "

OperationId:getRateGroupsLOV

", + "operationId": "getRateGroupsLOV", "parameters": [ { "name": "hotelId", @@ -36894,7 +36202,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepGroups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RateGroups LOV" }, { "name": "includeInactiveFlag", @@ -36968,7 +36276,7 @@ } }, "204": { - "description": "RepGroupsLOV not found." + "description": "RateGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37018,12 +36326,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repInventoryItemPools": { + "/listOfValues/hotels/{hotelId}/ratePlanCodes/{ratePlanCodes}/roomTypesForMassRate": { "get": { - "summary": "Return list of values for hotel rep inventory item pools", - "description": "Use this API to return the list of values for rep inventory item pools for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepInventoryItemPoolsLOV

", - "operationId": "getRepInventoryItemPoolsLOV", + "summary": "Fetch List Of Values for Room Types For Mass Rate", + "description": "

OperationId:getRoomTypesForMassRateLOV

", + "operationId": "getRoomTypesForMassRateLOV", "parameters": [ + { + "name": "ratePlanCodes", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'ratePlanCodes' which is required to fetch RoomTypesForMassRate LOV" + }, { "name": "hotelId", "in": "path", @@ -37031,7 +36348,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepInventoryItemPools LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomTypesForMassRate LOV" }, { "name": "includeInactiveFlag", @@ -37105,7 +36422,7 @@ } }, "204": { - "description": "RepInventoryItemPoolsLOV not found." + "description": "RoomTypesForMassRateLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37155,11 +36472,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repMarketCodes": { + "/listOfValues/hotels/{hotelId}/ratePlans": { "get": { - "summary": "Return list of values for hotel rep market codes", - "description": "Use this API to return the list of values for rep market codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepMarketCodesLOV

", - "operationId": "getRepMarketCodesLOV", + "summary": "Fetch List Of Values for Rate Plans", + "description": "

OperationId:getRatePlansLOV

", + "operationId": "getRatePlansLOV", "parameters": [ { "name": "hotelId", @@ -37168,7 +36485,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepMarketCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RatePlans LOV" }, { "name": "includeInactiveFlag", @@ -37242,7 +36559,7 @@ } }, "204": { - "description": "RepMarketCodesLOV not found." + "description": "RatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37292,12 +36609,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repRoomStatuses": { + "/listOfValues/hotels/{hotelId}/relModuleName/{relModuleName}/applicationModules": { "get": { - "summary": "Return list of values for hotel rep room statuses", - "description": "Use this API to return the list of values for rep room statuses for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepRoomStatusesLOV

", - "operationId": "getRepRoomStatusesLOV", + "summary": "Fetch List Of Values for Application Modules", + "description": "

OperationId:getApplicationModulesLOV

", + "operationId": "getApplicationModulesLOV", "parameters": [ + { + "name": "relModuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'relModuleName' which is required to fetch ApplicationModules LOV" + }, { "name": "hotelId", "in": "path", @@ -37305,7 +36631,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepRoomStatuses LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ApplicationModules LOV" }, { "name": "includeInactiveFlag", @@ -37379,7 +36705,7 @@ } }, "204": { - "description": "RepRoomStatusesLOV not found." + "description": "ApplicationModulesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37429,11 +36755,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repRoomTypes": { + "/listOfValues/hotels/{hotelId}/repBlockCodesParamOff": { "get": { - "summary": "Return list of values for hotel rep room types", - "description": "Use this API to return the list of values forrep room types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepRoomTypesLOV

", - "operationId": "getRepRoomTypesLOV", + "summary": "Fetch List Of Values for Rep Block Codes Param Off", + "description": "

OperationId:getRepBlockCodesParamOffLOV

", + "operationId": "getRepBlockCodesParamOffLOV", "parameters": [ { "name": "hotelId", @@ -37442,7 +36768,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepRoomTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepBlockCodesParamOff LOV" }, { "name": "includeInactiveFlag", @@ -37516,7 +36842,7 @@ } }, "204": { - "description": "RepRoomTypesLOV not found." + "description": "RepBlockCodesParamOffLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37566,11 +36892,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repRooms": { + "/listOfValues/hotels/{hotelId}/repBlockCodesParamOn": { "get": { - "summary": "Return list of values for hotel rep rooms", - "description": "Use this API to return the list of values for rep rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepRoomsLOV

", - "operationId": "getRepRoomsLOV", + "summary": "Fetch List Of Values for Rep Block Codes Param On", + "description": "

OperationId:getRepBlockCodesParamOnLOV

", + "operationId": "getRepBlockCodesParamOnLOV", "parameters": [ { "name": "hotelId", @@ -37579,7 +36905,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepRooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepBlockCodesParamOn LOV" }, { "name": "includeInactiveFlag", @@ -37653,7 +36979,7 @@ } }, "204": { - "description": "RepRoomsLOV not found." + "description": "RepBlockCodesParamOnLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37703,11 +37029,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repServiceRequestCodes": { + "/listOfValues/hotels/{hotelId}/repCashiers": { "get": { - "summary": "Return list of values for hotel rep service request codes", - "description": "Use this API to return the list of values for rep service request codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepServiceRequestCodesLOV

", - "operationId": "getRepServiceRequestCodesLOV", + "summary": "Fetch List Of Values for Rep Cashiers", + "description": "

OperationId:getRepCashiersLOV

", + "operationId": "getRepCashiersLOV", "parameters": [ { "name": "hotelId", @@ -37716,7 +37042,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepServiceRequestCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepCashiers LOV" }, { "name": "includeInactiveFlag", @@ -37790,7 +37116,7 @@ } }, "204": { - "description": "RepServiceRequestCodesLOV not found." + "description": "RepCashiersLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37840,11 +37166,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repTransactionCodes": { + "/listOfValues/hotels/{hotelId}/repContactList": { "get": { - "summary": "Return list of values for hotel rep transaction codes", - "description": "Use this API to return the list of values for rep transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepTransactionCodesLOV

", - "operationId": "getRepTransactionCodesLOV", + "summary": "Fetch List Of Values for Rep Contact List", + "description": "

OperationId:getRepContactListLOV

", + "operationId": "getRepContactListLOV", "parameters": [ { "name": "hotelId", @@ -37853,7 +37179,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepTransactionCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepContactList LOV" }, { "name": "includeInactiveFlag", @@ -37927,7 +37253,7 @@ } }, "204": { - "description": "RepTransactionCodesLOV not found." + "description": "RepContactListLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37977,11 +37303,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repTraveAgtCalendarYear": { + "/listOfValues/hotels/{hotelId}/repCurrencies": { "get": { - "summary": "Return list of values for hotel rep travel agent calendar years", - "description": "Use this API to return the list of values for rep travel agent calendar years for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepTraveAgtCalendarYearLOV

", - "operationId": "getRepTraveAgtCalendarYearLOV", + "summary": "Fetch List Of Values for Rep Currencies", + "description": "

OperationId:getRepCurrenciesLOV

", + "operationId": "getRepCurrenciesLOV", "parameters": [ { "name": "hotelId", @@ -37990,7 +37316,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RepTraveAgtCalendarYear LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepCurrencies LOV" }, { "name": "includeInactiveFlag", @@ -38064,7 +37390,7 @@ } }, "204": { - "description": "RepTraveAgtCalendarYearLOV not found." + "description": "RepCurrenciesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38114,11 +37440,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationBasedBlocks": { + "/listOfValues/hotels/{hotelId}/repDepartments": { "get": { - "summary": "Return list of values for hotel reservation based blocks", - "description": "Use this API to return the list of values for reservation based blocks for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getReservationBasedBlocksLOV

", - "operationId": "getReservationBasedBlocksLOV", + "summary": "Fetch List Of Values for Rep Departments", + "description": "

OperationId:getRepDepartmentsLOV

", + "operationId": "getRepDepartmentsLOV", "parameters": [ { "name": "hotelId", @@ -38127,7 +37453,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ReservationBasedBlocks LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepDepartments LOV" }, { "name": "includeInactiveFlag", @@ -38201,7 +37527,7 @@ } }, "204": { - "description": "ReservationBasedBlocksLOV not found." + "description": "RepDepartmentsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38251,11 +37577,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationBasedProfiles": { + "/listOfValues/hotels/{hotelId}/repFiscalYears": { "get": { - "summary": "Return list of values for hotel reservation based profiles", - "description": "Use this API to return the list of values for reservation based profiles for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getReservationBasedProfilesLOV

", - "operationId": "getReservationBasedProfilesLOV", + "summary": "Fetch List Of Values for Rep Fiscal Years", + "description": "

OperationId:getRepFiscalYearsLOV

", + "operationId": "getRepFiscalYearsLOV", "parameters": [ { "name": "hotelId", @@ -38264,7 +37590,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ReservationBasedProfiles LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepFiscalYears LOV" }, { "name": "includeInactiveFlag", @@ -38338,7 +37664,7 @@ } }, "204": { - "description": "ReservationBasedProfilesLOV not found." + "description": "RepFiscalYearsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38388,11 +37714,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationPreferences": { + "/listOfValues/hotels/{hotelId}/repForeignCurrencies": { "get": { - "summary": "Return list of values for hotel reservation preferences", - "description": "Use this API to return the list of values for reservation preferences for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getReservationPreferencesLOV

", - "operationId": "getReservationPreferencesLOV", + "summary": "Fetch List Of Values for Rep Foreign Currencies", + "description": "

OperationId:getRepForeignCurrenciesLOV

", + "operationId": "getRepForeignCurrenciesLOV", "parameters": [ { "name": "hotelId", @@ -38401,7 +37727,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ReservationPreferences LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepForeignCurrencies LOV" }, { "name": "includeInactiveFlag", @@ -38475,7 +37801,7 @@ } }, "204": { - "description": "ReservationPreferencesLOV not found." + "description": "RepForeignCurrenciesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38525,11 +37851,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationStatusesHotel": { + "/listOfValues/hotels/{hotelId}/repGroups": { "get": { - "summary": "Return list of values for hotel reservation statuses", - "description": "Use this API to return the list of values for reservation statuses for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getReservationStatusesHotelLOV

", - "operationId": "getReservationStatusesHotelLOV", + "summary": "Fetch List Of Values for Rep Groups", + "description": "

OperationId:getRepGroupsLOV

", + "operationId": "getRepGroupsLOV", "parameters": [ { "name": "hotelId", @@ -38538,7 +37864,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ReservationStatusesHotel LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepGroups LOV" }, { "name": "includeInactiveFlag", @@ -38612,7 +37938,7 @@ } }, "204": { - "description": "ReservationStatusesHotelLOV not found." + "description": "RepGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38662,11 +37988,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortAirports": { + "/listOfValues/hotels/{hotelId}/repInventoryItemPools": { "get": { - "summary": "Return list of values for hotel resort airports", - "description": "Use this API to return the list of values for resort airports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResortAirportsLOV

", - "operationId": "getResortAirportsLOV", + "summary": "Fetch List Of Values for Rep Inventory Item Pools", + "description": "

OperationId:getRepInventoryItemPoolsLOV

", + "operationId": "getRepInventoryItemPoolsLOV", "parameters": [ { "name": "hotelId", @@ -38675,7 +38001,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResortAirports LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepInventoryItemPools LOV" }, { "name": "includeInactiveFlag", @@ -38749,7 +38075,7 @@ } }, "204": { - "description": "ResortAirportsLOV not found." + "description": "RepInventoryItemPoolsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38799,11 +38125,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortCROs": { + "/listOfValues/hotels/{hotelId}/repMarketCodes": { "get": { - "summary": "Return list of values for hotel resort CROs", - "description": "Use this API to return the list of values for resort CROs for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResortCROsLOV

", - "operationId": "getResortCROsLOV", + "summary": "Fetch List Of Values for Rep Market Codes", + "description": "

OperationId:getRepMarketCodesLOV

", + "operationId": "getRepMarketCodesLOV", "parameters": [ { "name": "hotelId", @@ -38812,7 +38138,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResortCROs LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepMarketCodes LOV" }, { "name": "includeInactiveFlag", @@ -38886,7 +38212,7 @@ } }, "204": { - "description": "ResortCROsLOV not found." + "description": "RepMarketCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38936,11 +38262,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortGuaranteeCodes": { + "/listOfValues/hotels/{hotelId}/repRoomStatuses": { "get": { - "summary": "Return list of values for hotel resort guarantee codes", - "description": "Use this API to return the list of values for resort guarantee codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResortGuaranteeCodesLOV

", - "operationId": "getResortGuaranteeCodesLOV", + "summary": "Fetch List Of Values for Rep Room Statuses", + "description": "

OperationId:getRepRoomStatusesLOV

", + "operationId": "getRepRoomStatusesLOV", "parameters": [ { "name": "hotelId", @@ -38949,7 +38275,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResortGuaranteeCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepRoomStatuses LOV" }, { "name": "includeInactiveFlag", @@ -39023,7 +38349,7 @@ } }, "204": { - "description": "ResortGuaranteeCodesLOV not found." + "description": "RepRoomStatusesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39073,11 +38399,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortMarketCodes": { + "/listOfValues/hotels/{hotelId}/repRoomTypes": { "get": { - "summary": "Return list of values for hotel resort market codes", - "description": "Use this API to return the list of values for resort market codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResortMarketCodesLOV

", - "operationId": "getResortMarketCodesLOV", + "summary": "Fetch List Of Values for Rep Room Types", + "description": "

OperationId:getRepRoomTypesLOV

", + "operationId": "getRepRoomTypesLOV", "parameters": [ { "name": "hotelId", @@ -39086,7 +38412,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResortMarketCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -39160,7 +38486,7 @@ } }, "204": { - "description": "ResortMarketCodesLOV not found." + "description": "RepRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39210,21 +38536,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortNameId/{resortNameId}/stagedProfilePreferences": { + "/listOfValues/hotels/{hotelId}/repRooms": { "get": { - "summary": "Return list of values for hotel staged profile preferences", - "description": "Use this API to return the list of values for staged profile preferences for a specific property based on search criteria such as resortNameId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getStagedProfilePreferencesLOV

", - "operationId": "getStagedProfilePreferencesLOV", + "summary": "Fetch List Of Values for Rep Rooms", + "description": "

OperationId:getRepRoomsLOV

", + "operationId": "getRepRoomsLOV", "parameters": [ - { - "name": "resortNameId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'resortNameId' which is required to fetch StagedProfilePreferences LOV" - }, { "name": "hotelId", "in": "path", @@ -39232,7 +38549,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch StagedProfilePreferences LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepRooms LOV" }, { "name": "includeInactiveFlag", @@ -39306,7 +38623,7 @@ } }, "204": { - "description": "StagedProfilePreferencesLOV not found." + "description": "RepRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39356,11 +38673,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRateClasses": { + "/listOfValues/hotels/{hotelId}/repServiceRequestCodes": { "get": { - "summary": "Return list of values for hotel resort rate classes", - "description": "Use this API to return the list of values for resort rate classes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResortRateClassesLOV

", - "operationId": "getResortRateClassesLOV", + "summary": "Fetch List Of Values for Rep Service Request Codes", + "description": "

OperationId:getRepServiceRequestCodesLOV

", + "operationId": "getRepServiceRequestCodesLOV", "parameters": [ { "name": "hotelId", @@ -39369,7 +38686,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResortRateClasses LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepServiceRequestCodes LOV" }, { "name": "includeInactiveFlag", @@ -39443,7 +38760,7 @@ } }, "204": { - "description": "ResortRateClassesLOV not found." + "description": "RepServiceRequestCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39493,11 +38810,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRestrictionStatuses": { + "/listOfValues/hotels/{hotelId}/repTransactionCodes": { "get": { - "summary": "Return list of values for hotel resort restriction statuses", - "description": "Use this API to return the list of values for resort restriction statuses for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResortRestrictionStatusesLOV

", - "operationId": "getResortRestrictionStatusesLOV", + "summary": "Fetch List Of Values for Rep Transaction Codes", + "description": "

OperationId:getRepTransactionCodesLOV

", + "operationId": "getRepTransactionCodesLOV", "parameters": [ { "name": "hotelId", @@ -39506,7 +38823,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResortRestrictionStatuses LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepTransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -39580,7 +38897,7 @@ } }, "204": { - "description": "ResortRestrictionStatusesLOV not found." + "description": "RepTransactionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39630,11 +38947,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRoomNumbers": { + "/listOfValues/hotels/{hotelId}/repTraveAgtCalendarYear": { "get": { - "summary": "Return list of values for hotel resort room numbers", - "description": "Use this API to return the list of values for resort room numbers for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResortRoomNumbersLOV

", - "operationId": "getResortRoomNumbersLOV", + "summary": "Fetch List Of Values for Rep Trave Agt Calendar Year", + "description": "

OperationId:getRepTraveAgtCalendarYearLOV

", + "operationId": "getRepTraveAgtCalendarYearLOV", "parameters": [ { "name": "hotelId", @@ -39643,7 +38960,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResortRoomNumbers LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RepTraveAgtCalendarYear LOV" }, { "name": "includeInactiveFlag", @@ -39717,7 +39034,7 @@ } }, "204": { - "description": "ResortRoomNumbersLOV not found." + "description": "RepTraveAgtCalendarYearLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39767,11 +39084,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRoomTypes": { + "/listOfValues/hotels/{hotelId}/reportTextConfiguration": { "get": { - "summary": "Return list of values for hotel resort room types", - "description": "Use this API to return the list of values for resort room types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResortRoomTypesLOV

", - "operationId": "getResortRoomTypesLOV", + "summary": "Fetch List Of Values for Report Text Configuration", + "description": "

OperationId:getReportTextConfigurationLOV

", + "operationId": "getReportTextConfigurationLOV", "parameters": [ { "name": "hotelId", @@ -39780,7 +39097,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResortRoomTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ReportTextConfiguration LOV" }, { "name": "includeInactiveFlag", @@ -39854,7 +39171,7 @@ } }, "204": { - "description": "ResortRoomTypesLOV not found." + "description": "ReportTextConfigurationLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39904,11 +39221,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortTransportationLabels": { + "/listOfValues/hotels/{hotelId}/reservationBasedBlocks": { "get": { - "summary": "Return list of values for hotel resort transportation labels", - "description": "Use this API to return the list of values for resort transportation labels for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResortTransportationLabelsLOV

", - "operationId": "getResortTransportationLabelsLOV", + "summary": "Fetch List Of Values for Reservation Based Blocks", + "description": "

OperationId:getReservationBasedBlocksLOV

", + "operationId": "getReservationBasedBlocksLOV", "parameters": [ { "name": "hotelId", @@ -39917,7 +39234,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResortTransportationLabels LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ReservationBasedBlocks LOV" }, { "name": "includeInactiveFlag", @@ -39991,7 +39308,7 @@ } }, "204": { - "description": "ResortTransportationLabelsLOV not found." + "description": "ReservationBasedBlocksLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40041,11 +39358,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resourceItemClasses": { + "/listOfValues/hotels/{hotelId}/reservationBasedProfiles": { "get": { - "summary": "Return list of values for hotel resource item classes", - "description": "Use this API to return the list of values for resource item classes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResourceItemClassesLOV

", - "operationId": "getResourceItemClassesLOV", + "summary": "Fetch List Of Values for Reservation Based Profiles", + "description": "

OperationId:getReservationBasedProfilesLOV

", + "operationId": "getReservationBasedProfilesLOV", "parameters": [ { "name": "hotelId", @@ -40054,7 +39371,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResourceItemClasses LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ReservationBasedProfiles LOV" }, { "name": "includeInactiveFlag", @@ -40128,7 +39445,7 @@ } }, "204": { - "description": "ResourceItemClassesLOV not found." + "description": "ReservationBasedProfilesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40178,11 +39495,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesCodes": { + "/listOfValues/hotels/{hotelId}/reservationPreferences": { "get": { - "summary": "Return list of values for hotel reservation auto attach rule codes", - "description": "Use this API to return the list of values for reservation auto attach rule codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResvAutoAttachRulesCodesLOV

", - "operationId": "getResvAutoAttachRulesCodesLOV", + "summary": "Fetch List Of Values for Reservation Preferences", + "description": "

OperationId:getReservationPreferencesLOV

", + "operationId": "getReservationPreferencesLOV", "parameters": [ { "name": "hotelId", @@ -40191,7 +39508,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResvAutoAttachRulesCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ReservationPreferences LOV" }, { "name": "includeInactiveFlag", @@ -40265,7 +39582,7 @@ } }, "204": { - "description": "ResvAutoAttachRulesCodesLOV not found." + "description": "ReservationPreferencesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40315,11 +39632,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesRuleType": { + "/listOfValues/hotels/{hotelId}/reservationStatusesHotel": { "get": { - "summary": "Return list of values for hotel reservation auto attach rule types", - "description": "Use this API to return the list of values for reservation auto attach rule types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResvAutoAttachRulesRuleTypeLOV

", - "operationId": "getResvAutoAttachRulesRuleTypeLOV", + "summary": "Fetch List Of Values for Reservation Statuses Hotel", + "description": "

OperationId:getReservationStatusesHotelLOV

", + "operationId": "getReservationStatusesHotelLOV", "parameters": [ { "name": "hotelId", @@ -40328,7 +39645,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResvAutoAttachRulesRuleType LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ReservationStatusesHotel LOV" }, { "name": "includeInactiveFlag", @@ -40402,7 +39719,7 @@ } }, "204": { - "description": "ResvAutoAttachRulesRuleTypeLOV not found." + "description": "ReservationStatusesHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40452,11 +39769,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvBasedProfiles": { + "/listOfValues/hotels/{hotelId}/resortAirports": { "get": { - "summary": "Return list of values for hotel reservation based profiles", - "description": "Use this API to return the list of values for reservation based profiles for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResvBasedProfilesLOV

", - "operationId": "getResvBasedProfilesLOV", + "summary": "Fetch List Of Values for Resort Airports", + "description": "

OperationId:getResortAirportsLOV

", + "operationId": "getResortAirportsLOV", "parameters": [ { "name": "hotelId", @@ -40465,7 +39782,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResvBasedProfiles LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResortAirports LOV" }, { "name": "includeInactiveFlag", @@ -40539,7 +39856,7 @@ } }, "204": { - "description": "ResvBasedProfilesLOV not found." + "description": "ResortAirportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40589,21 +39906,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/reservationTickets": { + "/listOfValues/hotels/{hotelId}/resortCROs": { "get": { - "summary": "Return list of values for hotel reservation tickets", - "description": "Use this API to return the list of values for reservation tickets for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getReservationTicketsLOV

", - "operationId": "getReservationTicketsLOV", + "summary": "Fetch List Of Values for Resort CROs", + "description": "

OperationId:getResortCROsLOV

", + "operationId": "getResortCROsLOV", "parameters": [ - { - "name": "resvNameId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'resvNameId' which is required to fetch ReservationTickets LOV" - }, { "name": "hotelId", "in": "path", @@ -40611,7 +39919,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ReservationTickets LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResortCROs LOV" }, { "name": "includeInactiveFlag", @@ -40685,7 +39993,7 @@ } }, "204": { - "description": "ReservationTicketsLOV not found." + "description": "ResortCROsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40735,21 +40043,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/resvTransactionDiversionCodes": { + "/listOfValues/hotels/{hotelId}/resortGuaranteeCodes": { "get": { - "summary": "Return list of values for hotel reservation transaction diversion codes", - "description": "Use this API to return the list of values for reservation transaction diversion codes for a specific property based on search criteria such as resvNameId, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResvTransactionDiversionCodesLOV

", - "operationId": "getResvTransactionDiversionCodesLOV", + "summary": "Fetch List Of Values for Resort Guarantee Codes", + "description": "

OperationId:getResortGuaranteeCodesLOV

", + "operationId": "getResortGuaranteeCodesLOV", "parameters": [ - { - "name": "resvNameId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'resvNameId' which is required to fetch ResvTransactionDiversionCodes LOV" - }, { "name": "hotelId", "in": "path", @@ -40757,7 +40056,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResvTransactionDiversionCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResortGuaranteeCodes LOV" }, { "name": "includeInactiveFlag", @@ -40831,7 +40130,7 @@ } }, "204": { - "description": "ResvTransactionDiversionCodesLOV not found." + "description": "ResortGuaranteeCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40881,11 +40180,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/revenueTypeMappingSpace": { + "/listOfValues/hotels/{hotelId}/resortMarketCodes": { "get": { - "summary": "Return list of values for hotel revenue type mapping space", - "description": "Use this API to return the list of values for revenue type mapping space for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRevenueTypeMappingSpaceLOV

", - "operationId": "getRevenueTypeMappingSpaceLOV", + "summary": "Fetch List Of Values for Resort Market Codes", + "description": "

OperationId:getResortMarketCodesLOV

", + "operationId": "getResortMarketCodesLOV", "parameters": [ { "name": "hotelId", @@ -40894,7 +40193,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RevenueTypeMappingSpace LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResortMarketCodes LOV" }, { "name": "includeInactiveFlag", @@ -40968,7 +40267,7 @@ } }, "204": { - "description": "RevenueTypeMappingSpaceLOV not found." + "description": "ResortMarketCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41018,12 +40317,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/revenueTypeMappingTrxCodes": { + "/listOfValues/hotels/{hotelId}/resortNameId/{resortNameId}/stagedProfilePreferences": { "get": { - "summary": "Return list of values for hotel revenue type mapping transaction codes", - "description": "Use this API to return the list of values for revenue type mapping transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRevenueTypeMappingTrxCodesLOV

", - "operationId": "getRevenueTypeMappingTrxCodesLOV", + "summary": "Fetch List Of Values for Staged Profile Preferences", + "description": "

OperationId:getStagedProfilePreferencesLOV

", + "operationId": "getStagedProfilePreferencesLOV", "parameters": [ + { + "name": "resortNameId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'resortNameId' which is required to fetch StagedProfilePreferences LOV" + }, { "name": "hotelId", "in": "path", @@ -41031,7 +40339,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RevenueTypeMappingTrxCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch StagedProfilePreferences LOV" }, { "name": "includeInactiveFlag", @@ -41105,7 +40413,7 @@ } }, "204": { - "description": "RevenueTypeMappingTrxCodesLOV not found." + "description": "StagedProfilePreferencesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41155,25 +40463,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roleWithDepartment/{roleWithDepartment}/userRoles": { + "/listOfValues/hotels/{hotelId}/resortRateClasses": { "get": { - "summary": "Return list of values for hotel user roles", - "description": "Use this API to return the list of values for user roles for a specific property based on search criteria such as roleWithDepartment, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUserRolesLOV

", - "operationId": "getUserRolesLOV", + "summary": "Fetch List Of Values for Resort Rate Classes", + "description": "

OperationId:getResortRateClassesLOV

", + "operationId": "getResortRateClassesLOV", "parameters": [ - { - "name": "roleWithDepartment", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'roleWithDepartment' which is required to fetch UserRoles LOV", - "enum": [ - "Y", - "N" - ] - }, { "name": "hotelId", "in": "path", @@ -41181,7 +40476,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UserRoles LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResortRateClasses LOV" }, { "name": "includeInactiveFlag", @@ -41255,7 +40550,7 @@ } }, "204": { - "description": "UserRolesLOV not found." + "description": "ResortRateClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41305,21 +40600,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/room/{room}/assignRooms": { + "/listOfValues/hotels/{hotelId}/resortRestrictionStatuses": { "get": { - "summary": "Return list of values for hotel assign rooms", - "description": "Use this API to return the list of values for assign rooms for a specific property based on search criteria such as room, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAssignRoomsLOV

", - "operationId": "getAssignRoomsLOV", + "summary": "Fetch List Of Values for Resort Restriction Statuses", + "description": "

OperationId:getResortRestrictionStatusesLOV

", + "operationId": "getResortRestrictionStatusesLOV", "parameters": [ - { - "name": "room", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'room' which is required to fetch AssignRooms LOV" - }, { "name": "hotelId", "in": "path", @@ -41327,7 +40613,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AssignRooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResortRestrictionStatuses LOV" }, { "name": "includeInactiveFlag", @@ -41401,7 +40687,7 @@ } }, "204": { - "description": "AssignRoomsLOV not found." + "description": "ResortRestrictionStatusesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41451,21 +40737,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/room/{room}/eventSetupStyles": { + "/listOfValues/hotels/{hotelId}/resortRoomNumbers": { "get": { - "summary": "Return list of values for hotel event setup styles", - "description": "Use this API to return the list of values for event setup styles for a specific property based on search criteria such as room, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getEventSetupStylesLOV

", - "operationId": "getEventSetupStylesLOV", + "summary": "Fetch List Of Values for Resort Room Numbers", + "description": "

OperationId:getResortRoomNumbersLOV

", + "operationId": "getResortRoomNumbersLOV", "parameters": [ - { - "name": "room", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'room' which is required to fetch EventSetupStyles LOV" - }, { "name": "hotelId", "in": "path", @@ -41473,7 +40750,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch EventSetupStyles LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResortRoomNumbers LOV" }, { "name": "includeInactiveFlag", @@ -41547,7 +40824,7 @@ } }, "204": { - "description": "EventSetupStylesLOV not found." + "description": "ResortRoomNumbersLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41597,21 +40874,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/room/{room}/roomRates": { + "/listOfValues/hotels/{hotelId}/resortRoomTypes": { "get": { - "summary": "Return list of values for hotel room rates", - "description": "Use this API to return the list of values for room rates for a specific property based on search criteria such as room, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomRatesLOV

", - "operationId": "getRoomRatesLOV", + "summary": "Fetch List Of Values for Resort Room Types", + "description": "

OperationId:getResortRoomTypesLOV

", + "operationId": "getResortRoomTypesLOV", "parameters": [ { - "name": "room", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'room' which is required to fetch RoomRates LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResortRoomTypes LOV" }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "ResortRoomTypesLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/hotels/{hotelId}/resortTransportationLabels": { + "get": { + "summary": "Fetch List Of Values for Resort Transportation Labels", + "description": "

OperationId:getResortTransportationLabelsLOV

", + "operationId": "getResortTransportationLabelsLOV", + "parameters": [ { "name": "hotelId", "in": "path", @@ -41619,7 +41024,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomRates LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResortTransportationLabels LOV" }, { "name": "includeInactiveFlag", @@ -41693,7 +41098,7 @@ } }, "204": { - "description": "RoomRatesLOV not found." + "description": "ResortTransportationLabelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41743,21 +41148,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/room/{room}/roomsKeyCreation": { + "/listOfValues/hotels/{hotelId}/resourceItemClasses": { "get": { - "summary": "Fetch List Of Values for Rooms Key Creation", - "description": "

OperationId:getRoomsKeyCreationLOV

", - "operationId": "getRoomsKeyCreationLOV", + "summary": "Fetch List Of Values for Resource Item Classes", + "description": "

OperationId:getResourceItemClassesLOV

", + "operationId": "getResourceItemClassesLOV", "parameters": [ - { - "name": "room", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'room' which is required to fetch RoomsKeyCreation LOV" - }, { "name": "hotelId", "in": "path", @@ -41765,7 +41161,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomsKeyCreation LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResourceItemClasses LOV" }, { "name": "includeInactiveFlag", @@ -41839,7 +41235,7 @@ } }, "204": { - "description": "RoomsKeyCreationLOV not found." + "description": "ResourceItemClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41889,11 +41285,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomClassCategories": { + "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesCodes": { "get": { - "summary": "Return list of values for hotel room class categories", - "description": "Use this API to return the list of values for room class categories for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomClassCategoriesLOV

", - "operationId": "getRoomClassCategoriesLOV", + "summary": "Fetch List Of Values for Resv Auto Attach Rules Codes", + "description": "

OperationId:getResvAutoAttachRulesCodesLOV

", + "operationId": "getResvAutoAttachRulesCodesLOV", "parameters": [ { "name": "hotelId", @@ -41902,7 +41298,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomClassCategories LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResvAutoAttachRulesCodes LOV" }, { "name": "includeInactiveFlag", @@ -41976,7 +41372,7 @@ } }, "204": { - "description": "RoomClassCategoriesLOV not found." + "description": "ResvAutoAttachRulesCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42026,11 +41422,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomClasses": { + "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesRuleType": { "get": { - "summary": "Return list of values for hotel room classes", - "description": "Use this API to return the list of values for room classes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomClassesLOV

", - "operationId": "getRoomClassesLOV", + "summary": "Fetch List Of Values for Resv Auto Attach Rules Rule Type", + "description": "

OperationId:getResvAutoAttachRulesRuleTypeLOV

", + "operationId": "getResvAutoAttachRulesRuleTypeLOV", "parameters": [ { "name": "hotelId", @@ -42039,7 +41435,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomClasses LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResvAutoAttachRulesRuleType LOV" }, { "name": "includeInactiveFlag", @@ -42113,7 +41509,7 @@ } }, "204": { - "description": "RoomClassesLOV not found." + "description": "ResvAutoAttachRulesRuleTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42163,11 +41559,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomFeatures": { + "/listOfValues/hotels/{hotelId}/resvBasedProfiles": { "get": { - "summary": "Return list of values for hotel room features", - "description": "Use this API to return the list of values for room features for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomFeaturesLOV

", - "operationId": "getRoomFeaturesLOV", + "summary": "Fetch List Of Values for Resv Based Profiles", + "description": "

OperationId:getResvBasedProfilesLOV

", + "operationId": "getResvBasedProfilesLOV", "parameters": [ { "name": "hotelId", @@ -42176,7 +41572,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomFeatures LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResvBasedProfiles LOV" }, { "name": "includeInactiveFlag", @@ -42250,7 +41646,7 @@ } }, "204": { - "description": "RoomFeaturesLOV not found." + "description": "ResvBasedProfilesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42300,149 +41696,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomHoldConditions": { + "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/reservationTickets": { "get": { - "summary": "Return list of values for hotel room hold conditions", - "description": "Use this API to return the list of values for room hold conditions for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomHoldConditionsLOV

", - "operationId": "getRoomHoldConditionsLOV", + "summary": "Fetch List Of Values for Reservation Tickets", + "description": "

OperationId:getReservationTicketsLOV

", + "operationId": "getReservationTicketsLOV", "parameters": [ { - "name": "hotelId", + "name": "resvNameId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomHoldConditions LOV" - }, - { - "name": "includeInactiveFlag", - "in": "query", - "required": false, - "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", - "type": "boolean" - }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$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": "", - "schema": { - "$ref": "#/definitions/listOfValues" - } - }, - "204": { - "description": "RoomHoldConditionsLOV 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" + "description": "Value of the parameter 'resvNameId' which is required to fetch ReservationTickets LOV" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/roomMaintenance": { - "get": { - "summary": "Return list of values for hotel room maintenance", - "description": "Use this API to return the list of values for room maintenance for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomMaintenanceLOV

", - "operationId": "getRoomMaintenanceLOV", - "parameters": [ { "name": "hotelId", "in": "path", @@ -42450,7 +41718,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomMaintenance LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ReservationTickets LOV" }, { "name": "includeInactiveFlag", @@ -42524,7 +41792,7 @@ } }, "204": { - "description": "RoomMaintenanceLOV not found." + "description": "ReservationTicketsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42574,20 +41842,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomNumber/{roomNumber}/connectingSuites": { + "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/resvTransactionDiversionCodes": { "get": { - "summary": "Return list of values for hotel connecting suites", - "description": "Use this API to return the list of values for connecting suites for a specific property based on search criteria such as roomNumber, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getConnectingSuitesLOV

", - "operationId": "getConnectingSuitesLOV", + "summary": "Fetch List Of Values for Resv Transaction Diversion Codes", + "description": "

OperationId:getResvTransactionDiversionCodesLOV

", + "operationId": "getResvTransactionDiversionCodesLOV", "parameters": [ { - "name": "roomNumber", + "name": "resvNameId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'roomNumber' which is required to fetch ConnectingSuites LOV" + "description": "Value of the parameter 'resvNameId' which is required to fetch ResvTransactionDiversionCodes LOV" }, { "name": "hotelId", @@ -42596,7 +41864,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ConnectingSuites LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResvTransactionDiversionCodes LOV" }, { "name": "includeInactiveFlag", @@ -42670,7 +41938,7 @@ } }, "204": { - "description": "ConnectingSuitesLOV not found." + "description": "ResvTransactionDiversionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42720,21 +41988,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomPool/{roomPool}/roomPoolRoomTypes": { + "/listOfValues/hotels/{hotelId}/revenueTypeMappingSpace": { "get": { - "summary": "Return list of values for hotel room pool room types", - "description": "Use this API to return the list of values for room pool room types for a specific property based on search criteria such as roomPool, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomPoolRoomTypesLOV

", - "operationId": "getRoomPoolRoomTypesLOV", + "summary": "Fetch List Of Values for Revenue Type Mapping Space", + "description": "

OperationId:getRevenueTypeMappingSpaceLOV

", + "operationId": "getRevenueTypeMappingSpaceLOV", "parameters": [ - { - "name": "roomPool", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'roomPool' which is required to fetch RoomPoolRoomTypes LOV" - }, { "name": "hotelId", "in": "path", @@ -42742,7 +42001,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomPoolRoomTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RevenueTypeMappingSpace LOV" }, { "name": "includeInactiveFlag", @@ -42816,7 +42075,7 @@ } }, "204": { - "description": "RoomPoolRoomTypesLOV not found." + "description": "RevenueTypeMappingSpaceLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42866,11 +42125,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomPools": { + "/listOfValues/hotels/{hotelId}/revenueTypeMappingTrxCodes": { "get": { - "summary": "Return list of values for hotel room pools", - "description": "Use this API to return the list of values for room pools for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomPoolsLOV

", - "operationId": "getRoomPoolsLOV", + "summary": "Fetch List Of Values for Revenue Type Mapping Trx Codes", + "description": "

OperationId:getRevenueTypeMappingTrxCodesLOV

", + "operationId": "getRevenueTypeMappingTrxCodesLOV", "parameters": [ { "name": "hotelId", @@ -42879,7 +42138,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomPools LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RevenueTypeMappingTrxCodes LOV" }, { "name": "includeInactiveFlag", @@ -42953,7 +42212,7 @@ } }, "204": { - "description": "RoomPoolsLOV not found." + "description": "RevenueTypeMappingTrxCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43003,12 +42262,25 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomRevenueTrxCodes": { + "/listOfValues/hotels/{hotelId}/roleWithDepartment/{roleWithDepartment}/userRoles": { "get": { - "summary": "Return list of values for hotel room revenue transaction codes", - "description": "Use this API to return the list of values for room revenue transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomRevenueTrxCodesLOV

", - "operationId": "getRoomRevenueTrxCodesLOV", + "summary": "Fetch List Of Values for User Roles", + "description": "

OperationId:getUserRolesLOV

", + "operationId": "getUserRolesLOV", "parameters": [ + { + "name": "roleWithDepartment", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'roleWithDepartment' which is required to fetch UserRoles LOV", + "enum": [ + "Y", + "N" + ] + }, { "name": "hotelId", "in": "path", @@ -43016,7 +42288,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomRevenueTrxCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UserRoles LOV" }, { "name": "includeInactiveFlag", @@ -43090,7 +42362,7 @@ } }, "204": { - "description": "RoomRevenueTrxCodesLOV not found." + "description": "UserRolesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43140,12 +42412,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomRotationGroups": { + "/listOfValues/hotels/{hotelId}/room/{room}/assignRooms": { "get": { - "summary": "Return list of values for hotel room rotation groups", - "description": "Use this API to return the list of values for room rotation groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomRotationGroupsLOV

", - "operationId": "getRoomRotationGroupsLOV", + "summary": "Fetch List Of Values for Assign Rooms", + "description": "

OperationId:getAssignRoomsLOV

", + "operationId": "getAssignRoomsLOV", "parameters": [ + { + "name": "room", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'room' which is required to fetch AssignRooms LOV" + }, { "name": "hotelId", "in": "path", @@ -43153,7 +42434,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomRotationGroups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AssignRooms LOV" }, { "name": "includeInactiveFlag", @@ -43227,7 +42508,7 @@ } }, "204": { - "description": "RoomRotationGroupsLOV not found." + "description": "AssignRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43277,149 +42558,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomRotationUnitGrades": { + "/listOfValues/hotels/{hotelId}/room/{room}/eventSetupStyles": { "get": { - "summary": "Return list of values for hotel room rotation unit grades", - "description": "Use this API to return the list of values for room rotation unit grades for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomRotationUnitGradesLOV

", - "operationId": "getRoomRotationUnitGradesLOV", + "summary": "Fetch List Of Values for Event Setup Styles", + "description": "

OperationId:getEventSetupStylesLOV

", + "operationId": "getEventSetupStylesLOV", "parameters": [ { - "name": "hotelId", + "name": "room", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomRotationUnitGrades LOV" - }, - { - "name": "includeInactiveFlag", - "in": "query", - "required": false, - "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", - "type": "boolean" - }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$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": "", - "schema": { - "$ref": "#/definitions/listOfValues" - } - }, - "204": { - "description": "RoomRotationUnitGradesLOV 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" + "description": "Value of the parameter 'room' which is required to fetch EventSetupStyles LOV" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/roomSpecials": { - "get": { - "summary": "Return list of values for hotel room specials", - "description": "Use this API to return the list of values for room specials for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomSpecialsLOV

", - "operationId": "getRoomSpecialsLOV", - "parameters": [ { "name": "hotelId", "in": "path", @@ -43427,7 +42580,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomSpecials LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch EventSetupStyles LOV" }, { "name": "includeInactiveFlag", @@ -43501,7 +42654,7 @@ } }, "204": { - "description": "RoomSpecialsLOV not found." + "description": "EventSetupStylesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43551,38 +42704,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomType/{roomType}/arrival/{arrival}/departure/{departure}/roomingListHKRooms": { + "/listOfValues/hotels/{hotelId}/room/{room}/roomRates": { "get": { - "summary": "Return list of values for hotel rooming list housekeeping rooms", - "description": "Use this API to return the list of values for rooming list housekeeping rooms for a specific property based on search criteria such as departure, arrival, roomType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomingListHKRoomsLOV

", - "operationId": "getRoomingListHKRoomsLOV", + "summary": "Fetch List Of Values for Room Rates", + "description": "

OperationId:getRoomRatesLOV

", + "operationId": "getRoomRatesLOV", "parameters": [ { - "name": "departure", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'departure' which is required to fetch RoomingListHKRooms LOV" - }, - { - "name": "arrival", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'arrival' which is required to fetch RoomingListHKRooms LOV" - }, - { - "name": "roomType", + "name": "room", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'roomType' which is required to fetch RoomingListHKRooms LOV" + "description": "Value of the parameter 'room' which is required to fetch RoomRates LOV" }, { "name": "hotelId", @@ -43591,7 +42726,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomingListHKRooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomRates LOV" }, { "name": "includeInactiveFlag", @@ -43665,7 +42800,7 @@ } }, "204": { - "description": "RoomingListHKRoomsLOV not found." + "description": "RoomRatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43715,20 +42850,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomType/{roomType}/availableRoomTypeComponents": { + "/listOfValues/hotels/{hotelId}/room/{room}/roomsKeyCreation": { "get": { - "summary": "Return list of values for hotel available room type components", - "description": "Use this API to return the list of values for available room type components for a specific property based on search criteria such as roomType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAvailableRoomTypeComponentsLOV

", - "operationId": "getAvailableRoomTypeComponentsLOV", + "summary": "Fetch List Of Values for Rooms Key Creation", + "description": "

OperationId:getRoomsKeyCreationLOV

", + "operationId": "getRoomsKeyCreationLOV", "parameters": [ { - "name": "roomType", + "name": "room", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'roomType' which is required to fetch AvailableRoomTypeComponents LOV" + "description": "Value of the parameter 'room' which is required to fetch RoomsKeyCreation LOV" }, { "name": "hotelId", @@ -43737,7 +42872,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AvailableRoomTypeComponents LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomsKeyCreation LOV" }, { "name": "includeInactiveFlag", @@ -43811,7 +42946,7 @@ } }, "204": { - "description": "AvailableRoomTypeComponentsLOV not found." + "description": "RoomsKeyCreationLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43861,30 +42996,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomType/{roomType}/roomNumber/{roomNumber}/availableRoomComponents": { + "/listOfValues/hotels/{hotelId}/roomClassCategories": { "get": { - "summary": "Return list of values for hotel available room components", - "description": "Use this API to return the list of values for available room components for a specific property based on search criteria such as roomNumber, roomType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAvailableRoomComponentsLOV

", - "operationId": "getAvailableRoomComponentsLOV", + "summary": "Fetch List Of Values for Room Class Categories", + "description": "

OperationId:getRoomClassCategoriesLOV

", + "operationId": "getRoomClassCategoriesLOV", "parameters": [ - { - "name": "roomNumber", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'roomNumber' which is required to fetch AvailableRoomComponents LOV" - }, - { - "name": "roomType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'roomType' which is required to fetch AvailableRoomComponents LOV" - }, { "name": "hotelId", "in": "path", @@ -43892,7 +43009,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AvailableRoomComponents LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomClassCategories LOV" }, { "name": "includeInactiveFlag", @@ -43966,7 +43083,7 @@ } }, "204": { - "description": "AvailableRoomComponentsLOV not found." + "description": "RoomClassCategoriesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44016,21 +43133,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomTypeLabel/{roomTypeLabel}/facilityTasksRoomType": { + "/listOfValues/hotels/{hotelId}/roomClasses": { "get": { - "summary": "Return list of values for hotel facility tasks room types", - "description": "Use this API to return the list of values for facility tasks room types for a specific property based on search criteria such as roomTypeLabel, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFacilityTasksRoomTypeLOV

", - "operationId": "getFacilityTasksRoomTypeLOV", + "summary": "Fetch List Of Values for Room Classes", + "description": "

OperationId:getRoomClassesLOV

", + "operationId": "getRoomClassesLOV", "parameters": [ - { - "name": "roomTypeLabel", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'roomTypeLabel' which is required to fetch FacilityTasksRoomType LOV" - }, { "name": "hotelId", "in": "path", @@ -44038,7 +43146,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch FacilityTasksRoomType LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomClasses LOV" }, { "name": "includeInactiveFlag", @@ -44112,7 +43220,7 @@ } }, "204": { - "description": "FacilityTasksRoomTypeLOV not found." + "description": "RoomClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44162,11 +43270,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomTypePool": { + "/listOfValues/hotels/{hotelId}/roomFeatures": { "get": { - "summary": "Return list of values for hotel room type pools", - "description": "Use this API to return the list of values for room type pools for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomTypePoolLOV

", - "operationId": "getRoomTypePoolLOV", + "summary": "Fetch List Of Values for Room Features", + "description": "

OperationId:getRoomFeaturesLOV

", + "operationId": "getRoomFeaturesLOV", "parameters": [ { "name": "hotelId", @@ -44175,7 +43283,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomTypePool LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomFeatures LOV" }, { "name": "includeInactiveFlag", @@ -44249,7 +43357,7 @@ } }, "204": { - "description": "RoomTypePoolLOV not found." + "description": "RoomFeaturesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44299,11 +43407,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomTypes": { + "/listOfValues/hotels/{hotelId}/roomHoldConditions": { "get": { - "summary": "Return list of values for hotel room types", - "description": "Use this API to return the list of values for room types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomTypesLOV

", - "operationId": "getRoomTypesLOV", + "summary": "Fetch List Of Values for Room Hold Conditions", + "description": "

OperationId:getRoomHoldConditionsLOV

", + "operationId": "getRoomHoldConditionsLOV", "parameters": [ { "name": "hotelId", @@ -44312,7 +43420,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomHoldConditions LOV" }, { "name": "includeInactiveFlag", @@ -44386,7 +43494,7 @@ } }, "204": { - "description": "RoomTypesLOV not found." + "description": "RoomHoldConditionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44436,11 +43544,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rooms": { + "/listOfValues/hotels/{hotelId}/roomMaintenance": { "get": { - "summary": "Return list of values for hotel rooms", - "description": "Use this API to return the list of values for rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomsLOV

", - "operationId": "getRoomsLOV", + "summary": "Fetch List Of Values for Room Maintenance", + "description": "

OperationId:getRoomMaintenanceLOV

", + "operationId": "getRoomMaintenanceLOV", "parameters": [ { "name": "hotelId", @@ -44449,7 +43557,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Rooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomMaintenance LOV" }, { "name": "includeInactiveFlag", @@ -44523,7 +43631,7 @@ } }, "204": { - "description": "RoomsLOV not found." + "description": "RoomMaintenanceLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44573,12 +43681,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomsKeyGeneration": { + "/listOfValues/hotels/{hotelId}/roomNumber/{roomNumber}/connectingSuites": { "get": { - "summary": "Return list of values for hotel rooms key generation", - "description": "Use this API to return the list of values for rooms key generation for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomsKeyGenerationLOV

", - "operationId": "getRoomsKeyGenerationLOV", + "summary": "Fetch List Of Values for Connecting Suites", + "description": "

OperationId:getConnectingSuitesLOV

", + "operationId": "getConnectingSuitesLOV", "parameters": [ + { + "name": "roomNumber", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'roomNumber' which is required to fetch ConnectingSuites LOV" + }, { "name": "hotelId", "in": "path", @@ -44586,7 +43703,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomsKeyGeneration LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ConnectingSuites LOV" }, { "name": "includeInactiveFlag", @@ -44660,7 +43777,7 @@ } }, "204": { - "description": "RoomsKeyGenerationLOV not found." + "description": "ConnectingSuitesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44710,12 +43827,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/routingInstructions": { + "/listOfValues/hotels/{hotelId}/roomPool/{roomPool}/roomPoolRoomTypes": { "get": { - "summary": "Return list of values for hotel routing instructions", - "description": "Use this API to return the list of values for routing instructions for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoutingInstructionsLOV

", - "operationId": "getRoutingInstructionsLOV", + "summary": "Fetch List Of Values for Room Pool Room Types", + "description": "

OperationId:getRoomPoolRoomTypesLOV

", + "operationId": "getRoomPoolRoomTypesLOV", "parameters": [ + { + "name": "roomPool", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'roomPool' which is required to fetch RoomPoolRoomTypes LOV" + }, { "name": "hotelId", "in": "path", @@ -44723,7 +43849,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoutingInstructions LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomPoolRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -44797,7 +43923,7 @@ } }, "204": { - "description": "RoutingInstructionsLOV not found." + "description": "RoomPoolRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44847,11 +43973,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/salesManagerGoalPeriod": { + "/listOfValues/hotels/{hotelId}/roomPools": { "get": { - "summary": "Return list of values for hotel sales manager goal periods", - "description": "Use this API to return the list of values for sales manager goal periods for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSalesManagerGoalPeriodLOV

", - "operationId": "getSalesManagerGoalPeriodLOV", + "summary": "Fetch List Of Values for Room Pools", + "description": "

OperationId:getRoomPoolsLOV

", + "operationId": "getRoomPoolsLOV", "parameters": [ { "name": "hotelId", @@ -44860,7 +43986,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch SalesManagerGoalPeriod LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomPools LOV" }, { "name": "includeInactiveFlag", @@ -44934,7 +44060,7 @@ } }, "204": { - "description": "SalesManagerGoalPeriodLOV not found." + "description": "RoomPoolsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44984,11 +44110,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/scheduledReportsExport": { + "/listOfValues/hotels/{hotelId}/roomRevenueTrxCodes": { "get": { - "summary": "Return list of values for hotel scheduled report exports", - "description": "Use this API to return the list of values for scheduled report exports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getScheduledReportsExportLOV

", - "operationId": "getScheduledReportsExportLOV", + "summary": "Fetch List Of Values for Room Revenue Trx Codes", + "description": "

OperationId:getRoomRevenueTrxCodesLOV

", + "operationId": "getRoomRevenueTrxCodesLOV", "parameters": [ { "name": "hotelId", @@ -44997,7 +44123,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ScheduledReportsExport LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomRevenueTrxCodes LOV" }, { "name": "includeInactiveFlag", @@ -45071,7 +44197,7 @@ } }, "204": { - "description": "ScheduledReportsExportLOV not found." + "description": "RoomRevenueTrxCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45121,21 +44247,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/sectionType/{sectionType}/sitePlanSectionTypeLinks": { + "/listOfValues/hotels/{hotelId}/roomRotationGroups": { "get": { - "summary": "Return list of values for hotel site plan section type links", - "description": "Use this API to return the list of values for site plan section type links for a specific property based on search criteria such as sectionType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSitePlanSectionTypeLinksLOV

", - "operationId": "getSitePlanSectionTypeLinksLOV", + "summary": "Fetch List Of Values for Room Rotation Groups", + "description": "

OperationId:getRoomRotationGroupsLOV

", + "operationId": "getRoomRotationGroupsLOV", "parameters": [ - { - "name": "sectionType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'sectionType' which is required to fetch SitePlanSectionTypeLinks LOV" - }, { "name": "hotelId", "in": "path", @@ -45143,7 +44260,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch SitePlanSectionTypeLinks LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomRotationGroups LOV" }, { "name": "includeInactiveFlag", @@ -45217,7 +44334,7 @@ } }, "204": { - "description": "SitePlanSectionTypeLinksLOV not found." + "description": "RoomRotationGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45267,34 +44384,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/sell/{sell}/exchangeType/{exchangeType}/foreignCurrencies": { + "/listOfValues/hotels/{hotelId}/roomRotationUnitGrades": { "get": { - "summary": "Return list of values for hotel foreign currencies", - "description": "Use this API to return the list of values for foreign currencies for a specific property based on search criteria such as exchangeType, sell, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getForeignCurrenciesLOV

", - "operationId": "getForeignCurrenciesLOV", + "summary": "Fetch List Of Values for Room Rotation Unit Grades", + "description": "

OperationId:getRoomRotationUnitGradesLOV

", + "operationId": "getRoomRotationUnitGradesLOV", "parameters": [ - { - "name": "exchangeType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'exchangeType' which is required to fetch ForeignCurrencies LOV" - }, - { - "name": "sell", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'sell' which is required to fetch ForeignCurrencies LOV", - "enum": [ - "Y", - "N" - ] - }, { "name": "hotelId", "in": "path", @@ -45302,7 +44397,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ForeignCurrencies LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomRotationUnitGrades LOV" }, { "name": "includeInactiveFlag", @@ -45376,7 +44471,7 @@ } }, "204": { - "description": "ForeignCurrenciesLOV not found." + "description": "RoomRotationUnitGradesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45426,30 +44521,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/inventoryItems": { + "/listOfValues/hotels/{hotelId}/roomSpecials": { "get": { - "summary": "Return list of values for hotel inventory items", - "description": "Use this API to return the list of values for inventory items for a specific property based on search criteria such as sellInEvent, sellInReservation, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInventoryItemsLOV

", - "operationId": "getInventoryItemsLOV", + "summary": "Fetch List Of Values for Room Specials", + "description": "

OperationId:getRoomSpecialsLOV

", + "operationId": "getRoomSpecialsLOV", "parameters": [ - { - "name": "sellInEvent", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'sellInEvent' which is required to fetch InventoryItems LOV" - }, - { - "name": "sellInReservation", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'sellInReservation' which is required to fetch InventoryItems LOV" - }, { "name": "hotelId", "in": "path", @@ -45457,7 +44534,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InventoryItems LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomSpecials LOV" }, { "name": "includeInactiveFlag", @@ -45531,7 +44608,7 @@ } }, "204": { - "description": "InventoryItemsLOV not found." + "description": "RoomSpecialsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45581,29 +44658,38 @@ ] } }, - "/listOfValues/hotels/{hotelId}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/resortInventoryItems": { + "/listOfValues/hotels/{hotelId}/roomType/{roomType}/arrival/{arrival}/departure/{departure}/roomingListHKRooms": { "get": { - "summary": "Return list of values for hotel resort inventory items", - "description": "Use this API to return the list of values for resort inventory items for a specific property based on search criteria such as sellInEvent, sellInReservation, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getResortInventoryItemsLOV

", - "operationId": "getResortInventoryItemsLOV", + "summary": "Fetch List Of Values for Rooming List HKRooms", + "description": "

OperationId:getRoomingListHKRoomsLOV

", + "operationId": "getRoomingListHKRoomsLOV", "parameters": [ { - "name": "sellInEvent", + "name": "departure", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'sellInEvent' which is required to fetch ResortInventoryItems LOV" + "description": "Value of the parameter 'departure' which is required to fetch RoomingListHKRooms LOV" }, { - "name": "sellInReservation", + "name": "arrival", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'sellInReservation' which is required to fetch ResortInventoryItems LOV" + "description": "Value of the parameter 'arrival' which is required to fetch RoomingListHKRooms LOV" + }, + { + "name": "roomType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'roomType' which is required to fetch RoomingListHKRooms LOV" }, { "name": "hotelId", @@ -45612,7 +44698,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResortInventoryItems LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomingListHKRooms LOV" }, { "name": "includeInactiveFlag", @@ -45686,7 +44772,7 @@ } }, "204": { - "description": "ResortInventoryItemsLOV not found." + "description": "RoomingListHKRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45736,12 +44822,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/serviceRequestCodes": { + "/listOfValues/hotels/{hotelId}/roomType/{roomType}/availableRoomTypeComponents": { "get": { - "summary": "Return list of values for hotel service request codes", - "description": "Use this API to return the list of values for service request codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getServiceRequestCodesLOV

", - "operationId": "getServiceRequestCodesLOV", + "summary": "Fetch List Of Values for Available Room Type Components", + "description": "

OperationId:getAvailableRoomTypeComponentsLOV

", + "operationId": "getAvailableRoomTypeComponentsLOV", "parameters": [ + { + "name": "roomType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'roomType' which is required to fetch AvailableRoomTypeComponents LOV" + }, { "name": "hotelId", "in": "path", @@ -45749,7 +44844,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ServiceRequestCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AvailableRoomTypeComponents LOV" }, { "name": "includeInactiveFlag", @@ -45823,7 +44918,7 @@ } }, "204": { - "description": "ServiceRequestCodesLOV not found." + "description": "AvailableRoomTypeComponentsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45873,12 +44968,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/setupStyles": { + "/listOfValues/hotels/{hotelId}/roomType/{roomType}/roomNumber/{roomNumber}/availableRoomComponents": { "get": { - "summary": "Return list of values for hotel setup styles", - "description": "Use this API to return the list of values for setup styles for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSetupStylesLOV

", - "operationId": "getSetupStylesLOV", + "summary": "Fetch List Of Values for Available Room Components", + "description": "

OperationId:getAvailableRoomComponentsLOV

", + "operationId": "getAvailableRoomComponentsLOV", "parameters": [ + { + "name": "roomNumber", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'roomNumber' which is required to fetch AvailableRoomComponents LOV" + }, + { + "name": "roomType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'roomType' which is required to fetch AvailableRoomComponents LOV" + }, { "name": "hotelId", "in": "path", @@ -45886,7 +44999,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch SetupStyles LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AvailableRoomComponents LOV" }, { "name": "includeInactiveFlag", @@ -45960,7 +45073,7 @@ } }, "204": { - "description": "SetupStylesLOV not found." + "description": "AvailableRoomComponentsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46010,12 +45123,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/shiftReports": { + "/listOfValues/hotels/{hotelId}/roomTypeLabel/{roomTypeLabel}/facilityTasksRoomType": { "get": { - "summary": "Return list of values for hotel shift reports", - "description": "Use this API to return the list of values for shift reports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getShiftReportsLOV

", - "operationId": "getShiftReportsLOV", + "summary": "Fetch List Of Values for Facility Tasks Room Type", + "description": "

OperationId:getFacilityTasksRoomTypeLOV

", + "operationId": "getFacilityTasksRoomTypeLOV", "parameters": [ + { + "name": "roomTypeLabel", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'roomTypeLabel' which is required to fetch FacilityTasksRoomType LOV" + }, { "name": "hotelId", "in": "path", @@ -46023,7 +45145,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ShiftReports LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch FacilityTasksRoomType LOV" }, { "name": "includeInactiveFlag", @@ -46097,7 +45219,7 @@ } }, "204": { - "description": "ShiftReportsLOV not found." + "description": "FacilityTasksRoomTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46147,21 +45269,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/siteType/{siteType}/sitePlans": { + "/listOfValues/hotels/{hotelId}/roomTypePool": { "get": { - "summary": "Return list of values for hotel site plans", - "description": "Use this API to return the list of values for site plans for a specific property based on search criteria such as siteType, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSitePlansLOV

", - "operationId": "getSitePlansLOV", + "summary": "Fetch List Of Values for Room Type Pool", + "description": "

OperationId:getRoomTypePoolLOV

", + "operationId": "getRoomTypePoolLOV", "parameters": [ - { - "name": "siteType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'siteType' which is required to fetch SitePlans LOV" - }, { "name": "hotelId", "in": "path", @@ -46169,7 +45282,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch SitePlans LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomTypePool LOV" }, { "name": "includeInactiveFlag", @@ -46243,7 +45356,7 @@ } }, "204": { - "description": "SitePlansLOV not found." + "description": "RoomTypePoolLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46293,11 +45406,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/snapshotTypes": { + "/listOfValues/hotels/{hotelId}/roomTypes": { "get": { - "summary": "Fetch List Of Values for Snapshot Types", - "description": "

OperationId:getSnapshotTypesLOV

", - "operationId": "getSnapshotTypesLOV", + "summary": "Fetch List Of Values for Room Types", + "description": "

OperationId:getRoomTypesLOV

", + "operationId": "getRoomTypesLOV", "parameters": [ { "name": "hotelId", @@ -46306,7 +45419,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch SnapshotTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -46380,7 +45493,7 @@ } }, "204": { - "description": "SnapshotTypesLOV not found." + "description": "RoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46430,21 +45543,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/space/{space}/cateringSetupStyles": { + "/listOfValues/hotels/{hotelId}/rooms": { "get": { - "summary": "Return list of values for hotel catering setup styles", - "description": "Use this API to return the list of values for catering setup styles for a specific property based on search criteria such as space, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCateringSetupStylesLOV

", - "operationId": "getCateringSetupStylesLOV", + "summary": "Fetch List Of Values for Rooms", + "description": "

OperationId:getRoomsLOV

", + "operationId": "getRoomsLOV", "parameters": [ - { - "name": "space", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'space' which is required to fetch CateringSetupStyles LOV" - }, { "name": "hotelId", "in": "path", @@ -46452,7 +45556,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CateringSetupStyles LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Rooms LOV" }, { "name": "includeInactiveFlag", @@ -46526,7 +45630,7 @@ } }, "204": { - "description": "CateringSetupStylesLOV not found." + "description": "RoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46576,21 +45680,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/space/{space}/eventRateCode": { + "/listOfValues/hotels/{hotelId}/roomsKeyGeneration": { "get": { - "summary": "Return list of values for hotel event rate codes", - "description": "Use this API to return the list of values for event rate codes for a specific property based on search criteria such as space, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getEventRateCodeLOV

", - "operationId": "getEventRateCodeLOV", + "summary": "Fetch List Of Values for Rooms Key Generation", + "description": "

OperationId:getRoomsKeyGenerationLOV

", + "operationId": "getRoomsKeyGenerationLOV", "parameters": [ - { - "name": "space", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'space' which is required to fetch EventRateCode LOV" - }, { "name": "hotelId", "in": "path", @@ -46598,7 +45693,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch EventRateCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomsKeyGeneration LOV" }, { "name": "includeInactiveFlag", @@ -46672,7 +45767,7 @@ } }, "204": { - "description": "EventRateCodeLOV not found." + "description": "RoomsKeyGenerationLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46722,11 +45817,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/spaces": { + "/listOfValues/hotels/{hotelId}/routingInstructions": { "get": { - "summary": "Return list of values for hotel spaces", - "description": "Use this API to return the list of values for spaces for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSpacesLOV

", - "operationId": "getSpacesLOV", + "summary": "Fetch List Of Values for Routing Instructions", + "description": "

OperationId:getRoutingInstructionsLOV

", + "operationId": "getRoutingInstructionsLOV", "parameters": [ { "name": "hotelId", @@ -46735,7 +45830,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Spaces LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoutingInstructions LOV" }, { "name": "includeInactiveFlag", @@ -46809,7 +45904,7 @@ } }, "204": { - "description": "SpacesLOV not found." + "description": "RoutingInstructionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46859,11 +45954,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/specialRequests": { + "/listOfValues/hotels/{hotelId}/salesManagerGoalPeriod": { "get": { - "summary": "Return list of values for hotel special requests", - "description": "Use this API to return the list of values for special requests for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSpecialRequestsLOV

", - "operationId": "getSpecialRequestsLOV", + "summary": "Fetch List Of Values for Sales Manager Goal Period", + "description": "

OperationId:getSalesManagerGoalPeriodLOV

", + "operationId": "getSalesManagerGoalPeriodLOV", "parameters": [ { "name": "hotelId", @@ -46872,7 +45967,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch SpecialRequests LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch SalesManagerGoalPeriod LOV" }, { "name": "includeInactiveFlag", @@ -46946,7 +46041,7 @@ } }, "204": { - "description": "SpecialRequestsLOV not found." + "description": "SalesManagerGoalPeriodLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46996,11 +46091,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/specials": { + "/listOfValues/hotels/{hotelId}/scheduledReportsExport": { "get": { - "summary": "Return list of values for hotel specials", - "description": "Use this API to return the list of values for specials for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSpecialsLOV

", - "operationId": "getSpecialsLOV", + "summary": "Fetch List Of Values for Scheduled Reports Export", + "description": "

OperationId:getScheduledReportsExportLOV

", + "operationId": "getScheduledReportsExportLOV", "parameters": [ { "name": "hotelId", @@ -47009,7 +46104,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Specials LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ScheduledReportsExport LOV" }, { "name": "includeInactiveFlag", @@ -47083,7 +46178,7 @@ } }, "204": { - "description": "SpecialsLOV not found." + "description": "ScheduledReportsExportLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47133,12 +46228,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/storedValueRedeemTrx": { + "/listOfValues/hotels/{hotelId}/sectionType/{sectionType}/sitePlanSectionTypeLinks": { "get": { - "summary": "Return list of values for hotel stored value redeem transactions", - "description": "Use this API to return the list of values for stored value redeem transactions for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getStoredValueRedeemTrxLOV

", - "operationId": "getStoredValueRedeemTrxLOV", + "summary": "Fetch List Of Values for Site Plan Section Type Links", + "description": "

OperationId:getSitePlanSectionTypeLinksLOV

", + "operationId": "getSitePlanSectionTypeLinksLOV", "parameters": [ + { + "name": "sectionType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'sectionType' which is required to fetch SitePlanSectionTypeLinks LOV" + }, { "name": "hotelId", "in": "path", @@ -47146,7 +46250,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch StoredValueRedeemTrx LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch SitePlanSectionTypeLinks LOV" }, { "name": "includeInactiveFlag", @@ -47220,7 +46324,7 @@ } }, "204": { - "description": "StoredValueRedeemTrxLOV not found." + "description": "SitePlanSectionTypeLinksLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47270,12 +46374,34 @@ ] } }, - "/listOfValues/hotels/{hotelId}/summaryRefreshLog": { + "/listOfValues/hotels/{hotelId}/sell/{sell}/exchangeType/{exchangeType}/foreignCurrencies": { "get": { - "summary": "Return list of values for hotel summary refresh logs", - "description": "Use this API to return the list of values for summary refresh logs for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSummaryRefreshLogLOV

", - "operationId": "getSummaryRefreshLogLOV", + "summary": "Fetch List Of Values for Foreign Currencies", + "description": "

OperationId:getForeignCurrenciesLOV

", + "operationId": "getForeignCurrenciesLOV", "parameters": [ + { + "name": "exchangeType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'exchangeType' which is required to fetch ForeignCurrencies LOV" + }, + { + "name": "sell", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'sell' which is required to fetch ForeignCurrencies LOV", + "enum": [ + "Y", + "N" + ] + }, { "name": "hotelId", "in": "path", @@ -47283,7 +46409,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch SummaryRefreshLog LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ForeignCurrencies LOV" }, { "name": "includeInactiveFlag", @@ -47357,7 +46483,7 @@ } }, "204": { - "description": "SummaryRefreshLogLOV not found." + "description": "ForeignCurrenciesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47407,20 +46533,29 @@ ] } }, - "/listOfValues/hotels/{hotelId}/superBlock/{superBlock}/subBlock": { + "/listOfValues/hotels/{hotelId}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/inventoryItems": { "get": { - "summary": "Return list of values for hotel sub blocks", - "description": "Use this API to return the list of values for sub blocks for a specific property based on search criteria such as superBlock, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSubBlockLOV

", - "operationId": "getSubBlockLOV", + "summary": "Fetch List Of Values for Inventory Items", + "description": "

OperationId:getInventoryItemsLOV

", + "operationId": "getInventoryItemsLOV", "parameters": [ { - "name": "superBlock", + "name": "sellInEvent", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'superBlock' which is required to fetch SubBlock LOV" + "description": "Value of the parameter 'sellInEvent' which is required to fetch InventoryItems LOV" + }, + { + "name": "sellInReservation", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'sellInReservation' which is required to fetch InventoryItems LOV" }, { "name": "hotelId", @@ -47429,7 +46564,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch SubBlock LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch InventoryItems LOV" }, { "name": "includeInactiveFlag", @@ -47503,7 +46638,7 @@ } }, "204": { - "description": "SubBlockLOV not found." + "description": "InventoryItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47553,12 +46688,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/synchronizeRateCodes": { + "/listOfValues/hotels/{hotelId}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/resortInventoryItems": { "get": { - "summary": "Return list of values for hotel synchronize rate codes", - "description": "Use this API to return the list of values for synchronize rate codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSynchronizeRateCodesLOV

", - "operationId": "getSynchronizeRateCodesLOV", + "summary": "Fetch List Of Values for Resort Inventory Items", + "description": "

OperationId:getResortInventoryItemsLOV

", + "operationId": "getResortInventoryItemsLOV", "parameters": [ + { + "name": "sellInEvent", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'sellInEvent' which is required to fetch ResortInventoryItems LOV" + }, + { + "name": "sellInReservation", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'sellInReservation' which is required to fetch ResortInventoryItems LOV" + }, { "name": "hotelId", "in": "path", @@ -47566,7 +46719,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch SynchronizeRateCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResortInventoryItems LOV" }, { "name": "includeInactiveFlag", @@ -47640,7 +46793,7 @@ } }, "204": { - "description": "SynchronizeRateCodesLOV not found." + "description": "ResortInventoryItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47690,30 +46843,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/taskCode/{taskCode}/taskSheetNo/{taskSheetNo}/taskSheetRooms": { + "/listOfValues/hotels/{hotelId}/serviceRequestCodes": { "get": { - "summary": "Return list of values for hotel task sheet rooms", - "description": "Use this API to return the list of values for task sheet rooms for a specific property based on search criteria such as taskSheetNo, taskCode, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTaskSheetRoomsLOV

", - "operationId": "getTaskSheetRoomsLOV", + "summary": "Fetch List Of Values for Service Request Codes", + "description": "

OperationId:getServiceRequestCodesLOV

", + "operationId": "getServiceRequestCodesLOV", "parameters": [ - { - "name": "taskSheetNo", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'taskSheetNo' which is required to fetch TaskSheetRooms LOV" - }, - { - "name": "taskCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'taskCode' which is required to fetch TaskSheetRooms LOV" - }, { "name": "hotelId", "in": "path", @@ -47721,7 +46856,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TaskSheetRooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ServiceRequestCodes LOV" }, { "name": "includeInactiveFlag", @@ -47795,7 +46930,7 @@ } }, "204": { - "description": "TaskSheetRoomsLOV not found." + "description": "ServiceRequestCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47845,21 +46980,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/taxCode/{taxCode}/taxTransactionCode": { + "/listOfValues/hotels/{hotelId}/setupStyles": { "get": { - "summary": "Return list of values for hotel tax transaction code", - "description": "Use this API to return the list of values for tax transaction code for a specific property based on search criteria such as taxCode, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTaxTransactionCodeLOV

", - "operationId": "getTaxTransactionCodeLOV", + "summary": "Fetch List Of Values for Setup Styles", + "description": "

OperationId:getSetupStylesLOV

", + "operationId": "getSetupStylesLOV", "parameters": [ - { - "name": "taxCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'taxCode' which is required to fetch TaxTransactionCode LOV" - }, { "name": "hotelId", "in": "path", @@ -47867,7 +46993,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TaxTransactionCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch SetupStyles LOV" }, { "name": "includeInactiveFlag", @@ -47941,7 +47067,7 @@ } }, "204": { - "description": "TaxTransactionCodeLOV not found." + "description": "SetupStylesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47991,11 +47117,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/taxTypes": { + "/listOfValues/hotels/{hotelId}/shiftReports": { "get": { - "summary": "Return list of values for hotel tax types", - "description": "Use this API to return the list of values for tax types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTaxTypesLOV

", - "operationId": "getTaxTypesLOV", + "summary": "Fetch List Of Values for Shift Reports", + "description": "

OperationId:getShiftReportsLOV

", + "operationId": "getShiftReportsLOV", "parameters": [ { "name": "hotelId", @@ -48004,7 +47130,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TaxTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ShiftReports LOV" }, { "name": "includeInactiveFlag", @@ -48078,7 +47204,7 @@ } }, "204": { - "description": "TaxTypesLOV not found." + "description": "ShiftReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48128,12 +47254,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/telephoneCategory": { + "/listOfValues/hotels/{hotelId}/siteType/{siteType}/sitePlans": { "get": { - "summary": "Return list of values for hotel telephone categories", - "description": "Use this API to return the list of values for telephone categories for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTelephoneCategoryLOV

", - "operationId": "getTelephoneCategoryLOV", + "summary": "Fetch List Of Values for Site Plans", + "description": "

OperationId:getSitePlansLOV

", + "operationId": "getSitePlansLOV", "parameters": [ + { + "name": "siteType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'siteType' which is required to fetch SitePlans LOV" + }, { "name": "hotelId", "in": "path", @@ -48141,7 +47276,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TelephoneCategory LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch SitePlans LOV" }, { "name": "includeInactiveFlag", @@ -48215,7 +47350,7 @@ } }, "204": { - "description": "TelephoneCategoryLOV not found." + "description": "SitePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48265,34 +47400,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/tiered/{tiered}/currentRateCode/{currentRateCode}/configDynamicBaseRatePlans": { + "/listOfValues/hotels/{hotelId}/snapshotTypes": { "get": { - "summary": "Return list of values for hotel configuration dynamic base rate plans", - "description": "Use this API to return the list of values for configuration dynamic base rate plans for a specific property based on search criteria such as currentRateCode, tiered, hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getConfigDynamicBaseRatePlansLOV

", - "operationId": "getConfigDynamicBaseRatePlansLOV", + "summary": "Fetch List Of Values for Snapshot Types", + "description": "

OperationId:getSnapshotTypesLOV

", + "operationId": "getSnapshotTypesLOV", "parameters": [ - { - "name": "currentRateCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'currentRateCode' which is required to fetch ConfigDynamicBaseRatePlans LOV" - }, - { - "name": "tiered", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'tiered' which is required to fetch ConfigDynamicBaseRatePlans LOV", - "enum": [ - "Y", - "N" - ] - }, { "name": "hotelId", "in": "path", @@ -48300,7 +47413,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ConfigDynamicBaseRatePlans LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch SnapshotTypes LOV" }, { "name": "includeInactiveFlag", @@ -48374,7 +47487,7 @@ } }, "204": { - "description": "ConfigDynamicBaseRatePlansLOV not found." + "description": "SnapshotTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48424,12 +47537,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionAdjustmentReasonCodes": { + "/listOfValues/hotels/{hotelId}/space/{space}/cateringSetupStyles": { "get": { - "summary": "Return list of values for hotel transaction adjustment reason codes", - "description": "Use this API to return the list of values for transaction adjustment reason codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTransactionAdjustmentReasonCodesLOV

", - "operationId": "getTransactionAdjustmentReasonCodesLOV", + "summary": "Fetch List Of Values for Catering Setup Styles", + "description": "

OperationId:getCateringSetupStylesLOV

", + "operationId": "getCateringSetupStylesLOV", "parameters": [ + { + "name": "space", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'space' which is required to fetch CateringSetupStyles LOV" + }, { "name": "hotelId", "in": "path", @@ -48437,7 +47559,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TransactionAdjustmentReasonCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CateringSetupStyles LOV" }, { "name": "includeInactiveFlag", @@ -48511,7 +47633,7 @@ } }, "204": { - "description": "TransactionAdjustmentReasonCodesLOV not found." + "description": "CateringSetupStylesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48561,12 +47683,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionCodes": { + "/listOfValues/hotels/{hotelId}/space/{space}/eventRateCode": { "get": { - "summary": "Return list of values for hotel transaction codes", - "description": "Use this API to return the list of values for transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTransactionCodesLOV

", - "operationId": "getTransactionCodesLOV", + "summary": "Fetch List Of Values for Event Rate Code", + "description": "

OperationId:getEventRateCodeLOV

", + "operationId": "getEventRateCodeLOV", "parameters": [ + { + "name": "space", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'space' which is required to fetch EventRateCode LOV" + }, { "name": "hotelId", "in": "path", @@ -48574,7 +47705,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TransactionCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch EventRateCode LOV" }, { "name": "includeInactiveFlag", @@ -48648,7 +47779,7 @@ } }, "204": { - "description": "TransactionCodesLOV not found." + "description": "EventRateCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48698,11 +47829,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionCodesConsumption": { + "/listOfValues/hotels/{hotelId}/spaces": { "get": { - "summary": "Return list of values for hotel transaction codes consumption", - "description": "Use this API to return the list of values for transaction codes consumption for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTransactionCodesConsumptionLOV

", - "operationId": "getTransactionCodesConsumptionLOV", + "summary": "Fetch List Of Values for Spaces", + "description": "

OperationId:getSpacesLOV

", + "operationId": "getSpacesLOV", "parameters": [ { "name": "hotelId", @@ -48711,7 +47842,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TransactionCodesConsumption LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Spaces LOV" }, { "name": "includeInactiveFlag", @@ -48785,7 +47916,7 @@ } }, "204": { - "description": "TransactionCodesConsumptionLOV not found." + "description": "SpacesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48835,11 +47966,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionCodesPayment": { + "/listOfValues/hotels/{hotelId}/specialRequests": { "get": { - "summary": "Return list of values for hotel transaction codes payment", - "description": "Use this API to return the list of values for transaction codes payment for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTransactionCodesPaymentLOV

", - "operationId": "getTransactionCodesPaymentLOV", + "summary": "Fetch List Of Values for Special Requests", + "description": "

OperationId:getSpecialRequestsLOV

", + "operationId": "getSpecialRequestsLOV", "parameters": [ { "name": "hotelId", @@ -48848,7 +47979,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TransactionCodesPayment LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch SpecialRequests LOV" }, { "name": "includeInactiveFlag", @@ -48922,7 +48053,7 @@ } }, "204": { - "description": "TransactionCodesPaymentLOV not found." + "description": "SpecialRequestsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48972,11 +48103,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionDeleteReasonCodes": { + "/listOfValues/hotels/{hotelId}/specials": { "get": { - "summary": "Return list of values for hotel transaction delete reason codes", - "description": "Use this API to return the list of values for transaction delete reason codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTransactionDeleteReasonCodesLOV

", - "operationId": "getTransactionDeleteReasonCodesLOV", + "summary": "Fetch List Of Values for Specials", + "description": "

OperationId:getSpecialsLOV

", + "operationId": "getSpecialsLOV", "parameters": [ { "name": "hotelId", @@ -48985,7 +48116,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TransactionDeleteReasonCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Specials LOV" }, { "name": "includeInactiveFlag", @@ -49059,7 +48190,7 @@ } }, "204": { - "description": "TransactionDeleteReasonCodesLOV not found." + "description": "SpecialsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49109,11 +48240,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionDiversionRuleRooms": { + "/listOfValues/hotels/{hotelId}/storedValueRedeemTrx": { "get": { - "summary": "Return list of values for hotel transaction diversion rule rooms", - "description": "Use this API to return the list of values for transaction diversion rule rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTransactionDiversionRuleRoomsLOV

", - "operationId": "getTransactionDiversionRuleRoomsLOV", + "summary": "Fetch List Of Values for Stored Value Redeem Trx", + "description": "

OperationId:getStoredValueRedeemTrxLOV

", + "operationId": "getStoredValueRedeemTrxLOV", "parameters": [ { "name": "hotelId", @@ -49122,7 +48253,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TransactionDiversionRuleRooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch StoredValueRedeemTrx LOV" }, { "name": "includeInactiveFlag", @@ -49196,7 +48327,7 @@ } }, "204": { - "description": "TransactionDiversionRuleRoomsLOV not found." + "description": "StoredValueRedeemTrxLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49246,11 +48377,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionGroups": { + "/listOfValues/hotels/{hotelId}/summaryRefreshLog": { "get": { - "summary": "Return list of values for hotel transaction groups", - "description": "Use this API to return the list of values for transaction groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTransactionGroupsLOV

", - "operationId": "getTransactionGroupsLOV", + "summary": "Fetch List Of Values for Summary Refresh Log", + "description": "

OperationId:getSummaryRefreshLogLOV

", + "operationId": "getSummaryRefreshLogLOV", "parameters": [ { "name": "hotelId", @@ -49259,7 +48390,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TransactionGroups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch SummaryRefreshLog LOV" }, { "name": "includeInactiveFlag", @@ -49333,7 +48464,7 @@ } }, "204": { - "description": "TransactionGroupsLOV not found." + "description": "SummaryRefreshLogLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49383,12 +48514,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionSubgroups": { + "/listOfValues/hotels/{hotelId}/superBlock/{superBlock}/subBlock": { "get": { - "summary": "Return list of values for hotel transaction subgroups", - "description": "Use this API to return the list of values for transaction subgroups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTransactionSubgroupsLOV

", - "operationId": "getTransactionSubgroupsLOV", + "summary": "Fetch List Of Values for Sub Block", + "description": "

OperationId:getSubBlockLOV

", + "operationId": "getSubBlockLOV", "parameters": [ + { + "name": "superBlock", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'superBlock' which is required to fetch SubBlock LOV" + }, { "name": "hotelId", "in": "path", @@ -49396,7 +48536,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TransactionSubgroups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch SubBlock LOV" }, { "name": "includeInactiveFlag", @@ -49470,7 +48610,7 @@ } }, "204": { - "description": "TransactionSubgroupsLOV not found." + "description": "SubBlockLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49520,11 +48660,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transportTypes": { + "/listOfValues/hotels/{hotelId}/synchronizeRateCodes": { "get": { - "summary": "Return list of values for hotel transport types", - "description": "Use this API to return the list of values for transport types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTransportTypesLOV

", - "operationId": "getTransportTypesLOV", + "summary": "Fetch List Of Values for Synchronize Rate Codes", + "description": "

OperationId:getSynchronizeRateCodesLOV

", + "operationId": "getSynchronizeRateCodesLOV", "parameters": [ { "name": "hotelId", @@ -49533,7 +48673,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TransportTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch SynchronizeRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -49607,7 +48747,7 @@ } }, "204": { - "description": "TransportTypesLOV not found." + "description": "SynchronizeRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49657,149 +48797,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transportTypesHotel": { + "/listOfValues/hotels/{hotelId}/taskCode/{taskCode}/taskSheetNo/{taskSheetNo}/taskSheetRooms": { "get": { - "summary": "Return list of values for hotel transport types", - "description": "Use this API to return the list of values for transport types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTransportTypesLOV

", - "operationId": "getTransportTypesHotelLOV", + "summary": "Fetch List Of Values for Task Sheet Rooms", + "description": "

OperationId:getTaskSheetRoomsLOV

", + "operationId": "getTaskSheetRoomsLOV", "parameters": [ { - "name": "hotelId", + "name": "taskSheetNo", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TransportTypesHotel LOV" - }, - { - "name": "includeInactiveFlag", - "in": "query", - "required": false, - "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", - "type": "boolean" - }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$ref": "#/parameters/x-hotelid" - }, - { - "$ref": "#/parameters/x-externalsystem" + "description": "Value of the parameter 'taskSheetNo' which is required to fetch TaskSheetRooms LOV" }, { - "$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": "", - "schema": { - "$ref": "#/definitions/listOfValues" - } - }, - "204": { - "description": "TransportTypesHotelLOV 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" + "name": "taskCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'taskCode' which is required to fetch TaskSheetRooms LOV" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/travelAgentSource": { - "get": { - "summary": "Return list of values for hotel travel agent source reservations", - "description": "Use this API to return the list of values for travel agent sources for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTravelAgentSourceLOV

", - "operationId": "getTravelAgentSourceLOV", - "parameters": [ { "name": "hotelId", "in": "path", @@ -49807,7 +48828,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TravelAgentSource LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TaskSheetRooms LOV" }, { "name": "includeInactiveFlag", @@ -49881,7 +48902,7 @@ } }, "204": { - "description": "TravelAgentSourceLOV not found." + "description": "TaskSheetRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49931,12 +48952,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/travelAgentSourceResv": { + "/listOfValues/hotels/{hotelId}/taxCode/{taxCode}/taxTransactionCode": { "get": { - "summary": "Return list of values for hotel travel agent source reservations", - "description": "Use this API to return the list of values for travel agent source reservations for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTravelAgentSourceResvLOV

", - "operationId": "getTravelAgentSourceResvLOV", + "summary": "Fetch List Of Values for Tax Transaction Code", + "description": "

OperationId:getTaxTransactionCodeLOV

", + "operationId": "getTaxTransactionCodeLOV", "parameters": [ + { + "name": "taxCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'taxCode' which is required to fetch TaxTransactionCode LOV" + }, { "name": "hotelId", "in": "path", @@ -49944,7 +48974,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TravelAgentSourceResv LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TaxTransactionCode LOV" }, { "name": "includeInactiveFlag", @@ -50018,7 +49048,7 @@ } }, "204": { - "description": "TravelAgentSourceResvLOV not found." + "description": "TaxTransactionCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50068,11 +49098,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/turnawayCodes": { + "/listOfValues/hotels/{hotelId}/taxTypes": { "get": { - "summary": "Return list of values for hotel turnaway codes", - "description": "Use this API to return the list of values for turnaway codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTurnawayCodesLOV

", - "operationId": "getTurnawayCodesLOV", + "summary": "Fetch List Of Values for Tax Types", + "description": "

OperationId:getTaxTypesLOV

", + "operationId": "getTaxTypesLOV", "parameters": [ { "name": "hotelId", @@ -50081,7 +49111,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TurnawayCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TaxTypes LOV" }, { "name": "includeInactiveFlag", @@ -50155,7 +49185,7 @@ } }, "204": { - "description": "TurnawayCodesLOV not found." + "description": "TaxTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50205,11 +49235,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellDefaultTrxCode": { + "/listOfValues/hotels/{hotelId}/telephoneCategory": { "get": { - "summary": "Return list of values for hotel upsell default transaction code", - "description": "Use this API to return the list of values for upsell default transaction code for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellDefaultTrxCodeLOV

", - "operationId": "getUpsellDefaultTrxCodeLOV", + "summary": "Fetch List Of Values for Telephone Category", + "description": "

OperationId:getTelephoneCategoryLOV

", + "operationId": "getTelephoneCategoryLOV", "parameters": [ { "name": "hotelId", @@ -50218,7 +49248,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellDefaultTrxCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TelephoneCategory LOV" }, { "name": "includeInactiveFlag", @@ -50292,7 +49322,7 @@ } }, "204": { - "description": "UpsellDefaultTrxCodeLOV not found." + "description": "TelephoneCategoryLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50342,12 +49372,34 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellFromRoomClassEdit": { + "/listOfValues/hotels/{hotelId}/tiered/{tiered}/currentRateCode/{currentRateCode}/configDynamicBaseRatePlans": { "get": { - "summary": "Return list of values for hotel upsell from room class edit", - "description": "Use this API to return the list of values for upsell from room class edit for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellFromRoomClassEditLOV

", - "operationId": "getUpsellFromRoomClassEditLOV", + "summary": "Fetch List Of Values for Config Dynamic Base Rate Plans", + "description": "

OperationId:getConfigDynamicBaseRatePlansLOV

", + "operationId": "getConfigDynamicBaseRatePlansLOV", "parameters": [ + { + "name": "currentRateCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'currentRateCode' which is required to fetch ConfigDynamicBaseRatePlans LOV" + }, + { + "name": "tiered", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'tiered' which is required to fetch ConfigDynamicBaseRatePlans LOV", + "enum": [ + "Y", + "N" + ] + }, { "name": "hotelId", "in": "path", @@ -50355,7 +49407,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellFromRoomClassEdit LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ConfigDynamicBaseRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -50429,7 +49481,7 @@ } }, "204": { - "description": "UpsellFromRoomClassEditLOV not found." + "description": "ConfigDynamicBaseRatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50479,11 +49531,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellFromRoomTypeEdit": { + "/listOfValues/hotels/{hotelId}/transactionAdjustmentReasonCodes": { "get": { - "summary": "Return list of values for hotel upsell from room type edit", - "description": "Use this API to return the list of values for upsell from room type edit for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellFromRoomTypeEditLOV

", - "operationId": "getUpsellFromRoomTypeEditLOV", + "summary": "Fetch List Of Values for Transaction Adjustment Reason Codes", + "description": "

OperationId:getTransactionAdjustmentReasonCodesLOV

", + "operationId": "getTransactionAdjustmentReasonCodesLOV", "parameters": [ { "name": "hotelId", @@ -50492,7 +49544,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellFromRoomTypeEdit LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TransactionAdjustmentReasonCodes LOV" }, { "name": "includeInactiveFlag", @@ -50566,7 +49618,7 @@ } }, "204": { - "description": "UpsellFromRoomTypeEditLOV not found." + "description": "TransactionAdjustmentReasonCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50616,11 +49668,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellHierarchyLevels": { + "/listOfValues/hotels/{hotelId}/transactionCodes": { "get": { - "summary": "Return list of values for hotel upsell hierarchy levels", - "description": "Use this API to return the list of values for upsell hierarchy levels for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellHierarchyLevelsLOV

", - "operationId": "getUpsellHierarchyLevelsLOV", + "summary": "Fetch List Of Values for Transaction Codes", + "description": "

OperationId:getTransactionCodesLOV

", + "operationId": "getTransactionCodesLOV", "parameters": [ { "name": "hotelId", @@ -50629,7 +49681,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellHierarchyLevels LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -50703,7 +49755,7 @@ } }, "204": { - "description": "UpsellHierarchyLevelsLOV not found." + "description": "TransactionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50753,11 +49805,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRateCategoriesEdit": { + "/listOfValues/hotels/{hotelId}/transactionCodesConsumption": { "get": { - "summary": "Return list of values for hotel upsell rate categories edit", - "description": "Use this API to return the list of values for upsell rate categories edit for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellRateCategoriesEditLOV

", - "operationId": "getUpsellRateCategoriesEditLOV", + "summary": "Fetch List Of Values for Transaction Codes Consumption", + "description": "

OperationId:getTransactionCodesConsumptionLOV

", + "operationId": "getTransactionCodesConsumptionLOV", "parameters": [ { "name": "hotelId", @@ -50766,7 +49818,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRateCategoriesEdit LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TransactionCodesConsumption LOV" }, { "name": "includeInactiveFlag", @@ -50840,7 +49892,7 @@ } }, "204": { - "description": "UpsellRateCategoriesEditLOV not found." + "description": "TransactionCodesConsumptionLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50890,11 +49942,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRateCodes": { + "/listOfValues/hotels/{hotelId}/transactionCodesPayment": { "get": { - "summary": "Return list of values for hotel upsell rate codes", - "description": "Use this API to return the list of values for upsell rate codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellRateCodesLOV

", - "operationId": "getUpsellRateCodesLOV", + "summary": "Fetch List Of Values for Transaction Codes Payment", + "description": "

OperationId:getTransactionCodesPaymentLOV

", + "operationId": "getTransactionCodesPaymentLOV", "parameters": [ { "name": "hotelId", @@ -50903,7 +49955,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRateCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TransactionCodesPayment LOV" }, { "name": "includeInactiveFlag", @@ -50977,7 +50029,7 @@ } }, "204": { - "description": "UpsellRateCodesLOV not found." + "description": "TransactionCodesPaymentLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51027,11 +50079,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRoomClassView": { + "/listOfValues/hotels/{hotelId}/transactionDeleteReasonCodes": { "get": { - "summary": "Return list of values for hotel upsell room class view", - "description": "Use this API to return the list of values for upsell room class view for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellRoomClassViewLOV

", - "operationId": "getUpsellRoomClassViewLOV", + "summary": "Fetch List Of Values for Transaction Delete Reason Codes", + "description": "

OperationId:getTransactionDeleteReasonCodesLOV

", + "operationId": "getTransactionDeleteReasonCodesLOV", "parameters": [ { "name": "hotelId", @@ -51040,7 +50092,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRoomClassView LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TransactionDeleteReasonCodes LOV" }, { "name": "includeInactiveFlag", @@ -51114,7 +50166,7 @@ } }, "204": { - "description": "UpsellRoomClassViewLOV not found." + "description": "TransactionDeleteReasonCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51164,11 +50216,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRoomTypeView": { + "/listOfValues/hotels/{hotelId}/transactionDiversionRuleRooms": { "get": { - "summary": "Return list of values for hotel upsell room type view", - "description": "Use this API to return the list of values for upsell room type view for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellRoomTypeViewLOV

", - "operationId": "getUpsellRoomTypeViewLOV", + "summary": "Fetch List Of Values for Transaction Diversion Rule Rooms", + "description": "

OperationId:getTransactionDiversionRuleRoomsLOV

", + "operationId": "getTransactionDiversionRuleRoomsLOV", "parameters": [ { "name": "hotelId", @@ -51177,7 +50229,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRoomTypeView LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TransactionDiversionRuleRooms LOV" }, { "name": "includeInactiveFlag", @@ -51251,7 +50303,7 @@ } }, "204": { - "description": "UpsellRoomTypeViewLOV not found." + "description": "TransactionDiversionRuleRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51301,11 +50353,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRule": { + "/listOfValues/hotels/{hotelId}/transactionGroups": { "get": { - "summary": "Return list of values for hotel upsell rules", - "description": "Use this API to return the list of values for upsell rules for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellRuleLOV

", - "operationId": "getUpsellRuleLOV", + "summary": "Fetch List Of Values for Transaction Groups", + "description": "

OperationId:getTransactionGroupsLOV

", + "operationId": "getTransactionGroupsLOV", "parameters": [ { "name": "hotelId", @@ -51314,7 +50366,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRule LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TransactionGroups LOV" }, { "name": "includeInactiveFlag", @@ -51388,7 +50440,7 @@ } }, "204": { - "description": "UpsellRuleLOV not found." + "description": "TransactionGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51438,11 +50490,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellTrxCodes": { + "/listOfValues/hotels/{hotelId}/transactionSubgroups": { "get": { - "summary": "Return list of values for hotel upsell transaction codes", - "description": "Use this API to return the list of values for upsell transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellTrxCodesLOV

", - "operationId": "getUpsellTrxCodesLOV", + "summary": "Fetch List Of Values for Transaction Subgroups", + "description": "

OperationId:getTransactionSubgroupsLOV

", + "operationId": "getTransactionSubgroupsLOV", "parameters": [ { "name": "hotelId", @@ -51451,7 +50503,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellTrxCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TransactionSubgroups LOV" }, { "name": "includeInactiveFlag", @@ -51525,7 +50577,7 @@ } }, "204": { - "description": "UpsellTrxCodesLOV not found." + "description": "TransactionSubgroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51575,11 +50627,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/userLogActivityGroups": { + "/listOfValues/hotels/{hotelId}/transportTypes": { "get": { - "summary": "Return list of values for hotel user log activity groups", - "description": "Use this API to return the list of values for user log activity groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUserLogActivityGroupsLOV

", - "operationId": "getUserLogActivityGroupsLOV", + "summary": "Fetch List Of Values for Transport Types", + "description": "

OperationId:getTransportTypesLOV

", + "operationId": "getTransportTypesLOV", "parameters": [ { "name": "hotelId", @@ -51588,7 +50640,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UserLogActivityGroups LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TransportTypes LOV" }, { "name": "includeInactiveFlag", @@ -51662,7 +50714,7 @@ } }, "204": { - "description": "UserLogActivityGroupsLOV not found." + "description": "TransportTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51712,11 +50764,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/yearSetup": { + "/listOfValues/hotels/{hotelId}/transportTypesHotel": { "get": { - "summary": "Return list of values for hotel year setup", - "description": "Use this API to return the list of values for user hotel year setup for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getYearSetupLOV

", - "operationId": "getYearSetupLOV", + "summary": "Fetch List Of Values for Transport Types Hotel", + "description": "

OperationId:getTransportTypesHotelLOV

", + "operationId": "getTransportTypesHotelLOV", "parameters": [ { "name": "hotelId", @@ -51725,7 +50777,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch YearSetup LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TransportTypesHotel LOV" }, { "name": "includeInactiveFlag", @@ -51799,7 +50851,7 @@ } }, "204": { - "description": "YearSetupLOV not found." + "description": "TransportTypesHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51849,11 +50901,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/yieldMarkets": { + "/listOfValues/hotels/{hotelId}/travelAgentSource": { "get": { - "summary": "Return list of values for hotel yield markets", - "description": "Use this API to return the list of values for yield markets for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getYieldMarketsLOV

", - "operationId": "getYieldMarketsLOV", + "summary": "Fetch List Of Values for Travel Agent Source", + "description": "

OperationId:getTravelAgentSourceLOV

", + "operationId": "getTravelAgentSourceLOV", "parameters": [ { "name": "hotelId", @@ -51862,7 +50914,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch YieldMarkets LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TravelAgentSource LOV" }, { "name": "includeInactiveFlag", @@ -51936,7 +50988,7 @@ } }, "204": { - "description": "YieldMarketsLOV not found." + "description": "TravelAgentSourceLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51986,20 +51038,20 @@ ] } }, - "/listOfValues/includeDayUse/{includeDayUse}/roomReservationStatus": { + "/listOfValues/hotels/{hotelId}/travelAgentSourceResv": { "get": { - "summary": "Return list of values for room reservation status", - "description": "Use this API to return the list of values for room reservation status based on search criteria such as includeDayUse, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomReservationStatusLOV

", - "operationId": "getRoomReservationStatusLOV", + "summary": "Fetch List Of Values for Travel Agent Source Resv", + "description": "

OperationId:getTravelAgentSourceResvLOV

", + "operationId": "getTravelAgentSourceResvLOV", "parameters": [ { - "name": "includeDayUse", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'includeDayUse' which is required to fetch RoomReservationStatus LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TravelAgentSourceResv LOV" }, { "name": "includeInactiveFlag", @@ -52073,7 +51125,7 @@ } }, "204": { - "description": "RoomReservationStatusLOV not found." + "description": "TravelAgentSourceResvLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52123,24 +51175,20 @@ ] } }, - "/listOfValues/includeGlobals/{includeGlobals}/templatePreferences": { + "/listOfValues/hotels/{hotelId}/turnawayCodes": { "get": { - "summary": "Return list of values for preference templates", - "description": "Use this API to return the list of values for preference templates based on search criteria such as includeGlobals, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTemplatePreferencesLOV

", - "operationId": "getTemplatePreferencesLOV", + "summary": "Fetch List Of Values for Turnaway Codes", + "description": "

OperationId:getTurnawayCodesLOV

", + "operationId": "getTurnawayCodesLOV", "parameters": [ { - "name": "includeGlobals", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'includeGlobals' which is required to fetch TemplatePreferences LOV", - "enum": [ - "Y", - "N" - ] + "description": "Value of the parameter 'hotelId' which is required to fetch TurnawayCodes LOV" }, { "name": "includeInactiveFlag", @@ -52214,7 +51262,7 @@ } }, "204": { - "description": "TemplatePreferencesLOV not found." + "description": "TurnawayCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52264,24 +51312,20 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateMarketCodes": { + "/listOfValues/hotels/{hotelId}/upsellDefaultTrxCode": { "get": { - "summary": "Return list of values for market code templates", - "description": "Use this API to return the list of values for market code templates based on search criteria such as includeInactive, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTemplateMarketCodesLOV

", - "operationId": "getTemplateMarketCodesLOV", + "summary": "Fetch List Of Values for Upsell Default Trx Code", + "description": "

OperationId:getUpsellDefaultTrxCodeLOV

", + "operationId": "getUpsellDefaultTrxCodeLOV", "parameters": [ { - "name": "includeInactive", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateMarketCodes LOV", - "enum": [ - "Y", - "N" - ] + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellDefaultTrxCode LOV" }, { "name": "includeInactiveFlag", @@ -52355,7 +51399,7 @@ } }, "204": { - "description": "TemplateMarketCodesLOV not found." + "description": "UpsellDefaultTrxCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52405,24 +51449,20 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateMarketGroups": { + "/listOfValues/hotels/{hotelId}/upsellFromRoomClassEdit": { "get": { - "summary": "Return list of values for market group templates", - "description": "Use this API to return the list of values for market group templates based on search criteria such as includeInactive, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTemplateMarketGroupsLOV

", - "operationId": "getTemplateMarketGroupsLOV", + "summary": "Fetch List Of Values for Upsell From Room Class Edit", + "description": "

OperationId:getUpsellFromRoomClassEditLOV

", + "operationId": "getUpsellFromRoomClassEditLOV", "parameters": [ { - "name": "includeInactive", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateMarketGroups LOV", - "enum": [ - "Y", - "N" - ] + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellFromRoomClassEdit LOV" }, { "name": "includeInactiveFlag", @@ -52496,7 +51536,7 @@ } }, "204": { - "description": "TemplateMarketGroupsLOV not found." + "description": "UpsellFromRoomClassEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52546,24 +51586,20 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateRoomClasses": { + "/listOfValues/hotels/{hotelId}/upsellFromRoomTypeEdit": { "get": { - "summary": "Return list of values for room class templates", - "description": "Use this API to return the list of values for room class templates based on search criteria such as includeInactive, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTemplateRoomClassesLOV

", - "operationId": "getTemplateRoomClassesLOV", + "summary": "Fetch List Of Values for Upsell From Room Type Edit", + "description": "

OperationId:getUpsellFromRoomTypeEditLOV

", + "operationId": "getUpsellFromRoomTypeEditLOV", "parameters": [ { - "name": "includeInactive", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateRoomClasses LOV", - "enum": [ - "Y", - "N" - ] + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellFromRoomTypeEdit LOV" }, { "name": "includeInactiveFlag", @@ -52637,7 +51673,7 @@ } }, "204": { - "description": "TemplateRoomClassesLOV not found." + "description": "UpsellFromRoomTypeEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52687,24 +51723,20 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateSourceCodes": { + "/listOfValues/hotels/{hotelId}/upsellHierarchyLevels": { "get": { - "summary": "Return list of values for source code templates", - "description": "Use this API to return the list of values for source code templates based on search criteria such as includeInactive, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTemplateSourceCodesLOV

", - "operationId": "getTemplateSourceCodesLOV", + "summary": "Fetch List Of Values for Upsell Hierarchy Levels", + "description": "

OperationId:getUpsellHierarchyLevelsLOV

", + "operationId": "getUpsellHierarchyLevelsLOV", "parameters": [ { - "name": "includeInactive", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateSourceCodes LOV", - "enum": [ - "Y", - "N" - ] + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellHierarchyLevels LOV" }, { "name": "includeInactiveFlag", @@ -52778,7 +51810,7 @@ } }, "204": { - "description": "TemplateSourceCodesLOV not found." + "description": "UpsellHierarchyLevelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52828,24 +51860,20 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateSourceGroups": { + "/listOfValues/hotels/{hotelId}/upsellRateCategoriesEdit": { "get": { - "summary": "Return list of values for source group templates", - "description": "Use this API to return the list of values for source group templates based on search criteria such as includeInactive, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTemplateSourceGroupsLOV

", - "operationId": "getTemplateSourceGroupsLOV", + "summary": "Fetch List Of Values for Upsell Rate Categories Edit", + "description": "

OperationId:getUpsellRateCategoriesEditLOV

", + "operationId": "getUpsellRateCategoriesEditLOV", "parameters": [ { - "name": "includeInactive", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateSourceGroups LOV", - "enum": [ - "Y", - "N" - ] + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRateCategoriesEdit LOV" }, { "name": "includeInactiveFlag", @@ -52919,7 +51947,7 @@ } }, "204": { - "description": "TemplateSourceGroupsLOV not found." + "description": "UpsellRateCategoriesEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52969,20 +51997,20 @@ ] } }, - "/listOfValues/interfaceId/{interfaceId}/allRevenueTypes": { + "/listOfValues/hotels/{hotelId}/upsellRateCodes": { "get": { - "summary": "Return list of values for all revenue types", - "description": "Use this API to return the list of values for all revenue types based on search criteria such as interfaceId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAllRevenueTypesLOV

", - "operationId": "getAllRevenueTypesLOV", + "summary": "Fetch List Of Values for Upsell Rate Codes", + "description": "

OperationId:getUpsellRateCodesLOV

", + "operationId": "getUpsellRateCodesLOV", "parameters": [ { - "name": "interfaceId", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'interfaceId' which is required to fetch AllRevenueTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -53056,7 +52084,7 @@ } }, "204": { - "description": "AllRevenueTypesLOV not found." + "description": "UpsellRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53106,20 +52134,20 @@ ] } }, - "/listOfValues/interfaceId/{interfaceId}/oxiResorts": { + "/listOfValues/hotels/{hotelId}/upsellRoomClassView": { "get": { - "summary": "Return list of values for OXIResorts", - "description": "Use this API to return the list of values for OXIResorts based on search criteria such as interfaceId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getOXIResortsLOV

", - "operationId": "getOXIResortsLOV", + "summary": "Fetch List Of Values for Upsell Room Class View", + "description": "

OperationId:getUpsellRoomClassViewLOV

", + "operationId": "getUpsellRoomClassViewLOV", "parameters": [ { - "name": "interfaceId", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'interfaceId' which is required to fetch OXIResorts LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRoomClassView LOV" }, { "name": "includeInactiveFlag", @@ -53193,7 +52221,7 @@ } }, "204": { - "description": "OXIResortsLOV not found." + "description": "UpsellRoomClassViewLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53243,29 +52271,20 @@ ] } }, - "/listOfValues/interfaceType/{interfaceType}/databaseId/{databaseId}/externalDatabaseAvailableResorts": { + "/listOfValues/hotels/{hotelId}/upsellRoomTypeView": { "get": { - "summary": "Return list of values for external database available resorts", - "description": "Use this API to return the list of values for external database available resorts based on search criteria such as databaseId, interfaceType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getExternalDatabaseAvailableResortsLOV

", - "operationId": "getExternalDatabaseAvailableResortsLOV", + "summary": "Fetch List Of Values for Upsell Room Type View", + "description": "

OperationId:getUpsellRoomTypeViewLOV

", + "operationId": "getUpsellRoomTypeViewLOV", "parameters": [ { - "name": "databaseId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'databaseId' which is required to fetch ExternalDatabaseAvailableResorts LOV" - }, - { - "name": "interfaceType", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'interfaceType' which is required to fetch ExternalDatabaseAvailableResorts LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRoomTypeView LOV" }, { "name": "includeInactiveFlag", @@ -53339,7 +52358,7 @@ } }, "204": { - "description": "ExternalDatabaseAvailableResortsLOV not found." + "description": "UpsellRoomTypeViewLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53389,47 +52408,20 @@ ] } }, - "/listOfValues/levelCode/{levelCode}/levelType/{levelType}/settingName/{settingName}/channelCode/{channelCode}/channelParameters": { + "/listOfValues/hotels/{hotelId}/upsellRule": { "get": { - "summary": "Return list of values for channel parameters", - "description": "Use this API to return the list of values for channel parameters based on search criteria such as channelCode, settingName, levelType, levelCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getChannelParametersLOV

", - "operationId": "getChannelParametersLOV", + "summary": "Fetch List Of Values for Upsell Rule", + "description": "

OperationId:getUpsellRuleLOV

", + "operationId": "getUpsellRuleLOV", "parameters": [ { - "name": "channelCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'channelCode' which is required to fetch ChannelParameters LOV" - }, - { - "name": "settingName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'settingName' which is required to fetch ChannelParameters LOV" - }, - { - "name": "levelType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'levelType' which is required to fetch ChannelParameters LOV" - }, - { - "name": "levelCode", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'levelCode' which is required to fetch ChannelParameters LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRule LOV" }, { "name": "includeInactiveFlag", @@ -53503,7 +52495,7 @@ } }, "204": { - "description": "ChannelParametersLOV not found." + "description": "UpsellRuleLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53553,29 +52545,20 @@ ] } }, - "/listOfValues/levelCode/{levelCode}/settingName/{settingName}/applicationSettings": { + "/listOfValues/hotels/{hotelId}/upsellTrxCodes": { "get": { - "summary": "Return list of values for application settings", - "description": "Use this API to return the list of values for application settings based on search criteria such as settingName, levelCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getApplicationSettingsLOV

", - "operationId": "getApplicationSettingsLOV", + "summary": "Fetch List Of Values for Upsell Trx Codes", + "description": "

OperationId:getUpsellTrxCodesLOV

", + "operationId": "getUpsellTrxCodesLOV", "parameters": [ { - "name": "settingName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'settingName' which is required to fetch ApplicationSettings LOV" - }, - { - "name": "levelCode", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'levelCode' which is required to fetch ApplicationSettings LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellTrxCodes LOV" }, { "name": "includeInactiveFlag", @@ -53649,7 +52632,7 @@ } }, "204": { - "description": "ApplicationSettingsLOV not found." + "description": "UpsellTrxCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53699,20 +52682,20 @@ ] } }, - "/listOfValues/levelCode/{levelCode}/taskSheetDept": { + "/listOfValues/hotels/{hotelId}/userLogActivityGroups": { "get": { - "summary": "Return list of values for task sheet departments", - "description": "Use this API to return the list of values for task sheet departments based on search criteria such as levelCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTaskSheetDeptLOV

", - "operationId": "getTaskSheetDeptLOV", + "summary": "Fetch List Of Values for User Log Activity Groups", + "description": "

OperationId:getUserLogActivityGroupsLOV

", + "operationId": "getUserLogActivityGroupsLOV", "parameters": [ { - "name": "levelCode", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'levelCode' which is required to fetch TaskSheetDept LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UserLogActivityGroups LOV" }, { "name": "includeInactiveFlag", @@ -53786,7 +52769,7 @@ } }, "204": { - "description": "TaskSheetDeptLOV not found." + "description": "UserLogActivityGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53836,29 +52819,20 @@ ] } }, - "/listOfValues/locationType/{locationType}/location/{location}/distributionTemplates": { + "/listOfValues/hotels/{hotelId}/yearSetup": { "get": { - "summary": "Return list of values for distribution templates", - "description": "Use this API to return the list of values for distribution templates based on search criteria such as location, locationType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getDistributionTemplatesLOV

", - "operationId": "getDistributionTemplatesLOV", + "summary": "Fetch List Of Values for Year Setup", + "description": "

OperationId:getYearSetupLOV

", + "operationId": "getYearSetupLOV", "parameters": [ { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'location' which is required to fetch DistributionTemplates LOV" - }, - { - "name": "locationType", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'locationType' which is required to fetch DistributionTemplates LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch YearSetup LOV" }, { "name": "includeInactiveFlag", @@ -53932,7 +52906,7 @@ } }, "204": { - "description": "DistributionTemplatesLOV not found." + "description": "YearSetupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53982,20 +52956,20 @@ ] } }, - "/listOfValues/membershipId/{membershipId}/membershipStatementBatchList": { + "/listOfValues/hotels/{hotelId}/yieldMarkets": { "get": { - "summary": "Return list of values for membership statement batch list", - "description": "Use this API to return the list of values for membership statement batch list based on search criteria such as membershipId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipStatementBatchListLOV

", - "operationId": "getMembershipStatementBatchListLOV", + "summary": "Fetch List Of Values for Yield Markets", + "description": "

OperationId:getYieldMarketsLOV

", + "operationId": "getYieldMarketsLOV", "parameters": [ { - "name": "membershipId", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'membershipId' which is required to fetch MembershipStatementBatchList LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch YieldMarkets LOV" }, { "name": "includeInactiveFlag", @@ -54069,7 +53043,7 @@ } }, "204": { - "description": "MembershipStatementBatchListLOV not found." + "description": "YieldMarketsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54119,20 +53093,20 @@ ] } }, - "/listOfValues/membershipId/{membershipId}/membershipTotalPointsAvailable": { + "/listOfValues/includeDayUse/{includeDayUse}/roomReservationStatus": { "get": { - "summary": "Return list of values for membership total points available", - "description": "Use this API to return the list of values for membership total points available based on search criteria such as membershipId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipTotalPointsAvailableLOV

", - "operationId": "getMembershipTotalPointsAvailableLOV", + "summary": "Fetch List Of Values for Room Reservation Status", + "description": "

OperationId:getRoomReservationStatusLOV

", + "operationId": "getRoomReservationStatusLOV", "parameters": [ { - "name": "membershipId", + "name": "includeDayUse", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'membershipId' which is required to fetch MembershipTotalPointsAvailable LOV" + "description": "Value of the parameter 'includeDayUse' which is required to fetch RoomReservationStatus LOV" }, { "name": "includeInactiveFlag", @@ -54206,7 +53180,7 @@ } }, "204": { - "description": "MembershipTotalPointsAvailableLOV not found." + "description": "RoomReservationStatusLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54256,20 +53230,24 @@ ] } }, - "/listOfValues/membershipLevel/{membershipLevel}/membershipCardFeeAmount": { + "/listOfValues/includeGlobals/{includeGlobals}/templatePreferences": { "get": { - "summary": "Return list of values for membership card fee amounts", - "description": "Use this API to return the list of values for membership card fee amounts based on search criteria such as membershipLevel, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipCardFeeAmountLOV

", - "operationId": "getMembershipCardFeeAmountLOV", + "summary": "Fetch List Of Values for Template Preferences", + "description": "

OperationId:getTemplatePreferencesLOV

", + "operationId": "getTemplatePreferencesLOV", "parameters": [ { - "name": "membershipLevel", + "name": "includeGlobals", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'membershipLevel' which is required to fetch MembershipCardFeeAmount LOV" + "description": "Value of the parameter 'includeGlobals' which is required to fetch TemplatePreferences LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -54343,7 +53321,7 @@ } }, "204": { - "description": "MembershipCardFeeAmountLOV not found." + "description": "TemplatePreferencesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54393,29 +53371,165 @@ ] } }, - "/listOfValues/membershipLevelRank/{membershipLevelRank}/membershipType/{membershipType}/membershipMaxDowngradeLevel": { + "/listOfValues/includeInactive/{includeInactive}/templateMarketCodes": { "get": { - "summary": "Return list of values for membership max downgrade level", - "description": "Use this API to return the list of values for membership max downgrade level based on search criteria such as membershipType, membershipLevelRank, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipMaxDowngradeLevelLOV

", - "operationId": "getMembershipMaxDowngradeLevelLOV", + "summary": "Fetch List Of Values for Template Market Codes", + "description": "

OperationId:getTemplateMarketCodesLOV

", + "operationId": "getTemplateMarketCodesLOV", "parameters": [ { - "name": "membershipType", + "name": "includeInactive", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'membershipType' which is required to fetch MembershipMaxDowngradeLevel LOV" + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateMarketCodes LOV", + "enum": [ + "Y", + "N" + ] }, { - "name": "membershipLevelRank", + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "TemplateMarketCodesLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/includeInactive/{includeInactive}/templateMarketGroups": { + "get": { + "summary": "Fetch List Of Values for Template Market Groups", + "description": "

OperationId:getTemplateMarketGroupsLOV

", + "operationId": "getTemplateMarketGroupsLOV", + "parameters": [ + { + "name": "includeInactive", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'membershipLevelRank' which is required to fetch MembershipMaxDowngradeLevel LOV" + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateMarketGroups LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -54489,7 +53603,7 @@ } }, "204": { - "description": "MembershipMaxDowngradeLevelLOV not found." + "description": "TemplateMarketGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54539,20 +53653,24 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/membershipBenefitProgram": { + "/listOfValues/includeInactive/{includeInactive}/templateRoomClasses": { "get": { - "summary": "Return list of values for membership benefit programs", - "description": "Use this API to return the list of values for membership benefit programs based on search criteria such as membershipType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipBenefitProgramLOV

", - "operationId": "getMembershipBenefitProgramLOV", + "summary": "Fetch List Of Values for Template Room Classes", + "description": "

OperationId:getTemplateRoomClassesLOV

", + "operationId": "getTemplateRoomClassesLOV", "parameters": [ { - "name": "membershipType", + "name": "includeInactive", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'membershipType' which is required to fetch MembershipBenefitProgram LOV" + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateRoomClasses LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -54626,7 +53744,7 @@ } }, "204": { - "description": "MembershipBenefitProgramLOV not found." + "description": "TemplateRoomClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54676,20 +53794,24 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/membershipBenefits": { + "/listOfValues/includeInactive/{includeInactive}/templateSourceCodes": { "get": { - "summary": "Return list of values for membership benefits", - "description": "Use this API to return the list of values for membership benefits based on search criteria such as membershipType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipBenefitsLOV

", - "operationId": "getMembershipBenefitsLOV", + "summary": "Fetch List Of Values for Template Source Codes", + "description": "

OperationId:getTemplateSourceCodesLOV

", + "operationId": "getTemplateSourceCodesLOV", "parameters": [ { - "name": "membershipType", + "name": "includeInactive", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'membershipType' which is required to fetch MembershipBenefits LOV" + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateSourceCodes LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -54763,7 +53885,7 @@ } }, "204": { - "description": "MembershipBenefitsLOV not found." + "description": "TemplateSourceCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54813,20 +53935,24 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/membershipPointsRuleCodes": { + "/listOfValues/includeInactive/{includeInactive}/templateSourceGroups": { "get": { - "summary": "Return list of values for membership points rule codes", - "description": "Use this API to return the list of values for membership points rule codes based on search criteria such as membershipType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipPointsRuleCodesLOV

", - "operationId": "getMembershipPointsRuleCodesLOV", + "summary": "Fetch List Of Values for Template Source Groups", + "description": "

OperationId:getTemplateSourceGroupsLOV

", + "operationId": "getTemplateSourceGroupsLOV", "parameters": [ { - "name": "membershipType", + "name": "includeInactive", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'membershipType' which is required to fetch MembershipPointsRuleCodes LOV" + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateSourceGroups LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -54900,7 +54026,7 @@ } }, "204": { - "description": "MembershipPointsRuleCodesLOV not found." + "description": "TemplateSourceGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54950,20 +54076,20 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/upsellMembershipLevelsOnly": { + "/listOfValues/interfaceId/{interfaceId}/allRevenueTypes": { "get": { - "summary": "Return list of values for upsell membership levels only", - "description": "Use this API to return the list of values for upsell membership levels only based on search criteria such as membershipType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUpsellMembershipLevelsOnlyLOV

", - "operationId": "getUpsellMembershipLevelsOnlyLOV", + "summary": "Fetch List Of Values for All Revenue Types", + "description": "

OperationId:getAllRevenueTypesLOV

", + "operationId": "getAllRevenueTypesLOV", "parameters": [ { - "name": "membershipType", + "name": "interfaceId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'membershipType' which is required to fetch UpsellMembershipLevelsOnly LOV" + "description": "Value of the parameter 'interfaceId' which is required to fetch AllRevenueTypes LOV" }, { "name": "includeInactiveFlag", @@ -55037,7 +54163,7 @@ } }, "204": { - "description": "UpsellMembershipLevelsOnlyLOV not found." + "description": "AllRevenueTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55087,20 +54213,20 @@ ] } }, - "/listOfValues/menuClassId/{menuClassId}/menu": { + "/listOfValues/interfaceId/{interfaceId}/oxiResorts": { "get": { - "summary": "Return list of values for menus", - "description": "Use this API to return the list of values for menus based on search criteria such as menuClassId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMenuLOV

", - "operationId": "getMenuLOV", + "summary": "Fetch List Of Values for OXIResorts", + "description": "

OperationId:getOXIResortsLOV

", + "operationId": "getOXIResortsLOV", "parameters": [ { - "name": "menuClassId", + "name": "interfaceId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'menuClassId' which is required to fetch Menu LOV" + "description": "Value of the parameter 'interfaceId' which is required to fetch OXIResorts LOV" }, { "name": "includeInactiveFlag", @@ -55174,7 +54300,7 @@ } }, "204": { - "description": "MenuLOV not found." + "description": "OXIResortsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55224,20 +54350,29 @@ ] } }, - "/listOfValues/mode/{mode}/folioGroupingTransactionCodes": { + "/listOfValues/interfaceType/{interfaceType}/databaseId/{databaseId}/externalDatabaseAvailableResorts": { "get": { - "summary": "Return list of values for folio grouping transaction codes", - "description": "Use this API to return the list of values for folio grouping transaction codes based on search criteria such as mode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFolioGroupingTransactionCodesLOV

", - "operationId": "getFolioGroupingTransactionCodesLOV", + "summary": "Fetch List Of Values for External Database Available Resorts", + "description": "

OperationId:getExternalDatabaseAvailableResortsLOV

", + "operationId": "getExternalDatabaseAvailableResortsLOV", "parameters": [ { - "name": "mode", + "name": "databaseId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'mode' which is required to fetch FolioGroupingTransactionCodes LOV" + "description": "Value of the parameter 'databaseId' which is required to fetch ExternalDatabaseAvailableResorts LOV" + }, + { + "name": "interfaceType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'interfaceType' which is required to fetch ExternalDatabaseAvailableResorts LOV" }, { "name": "includeInactiveFlag", @@ -55311,7 +54446,7 @@ } }, "204": { - "description": "FolioGroupingTransactionCodesLOV not found." + "description": "ExternalDatabaseAvailableResortsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55361,20 +54496,47 @@ ] } }, - "/listOfValues/module/{module}/actionTypes": { + "/listOfValues/levelCode/{levelCode}/levelType/{levelType}/settingName/{settingName}/channelCode/{channelCode}/channelParameters": { "get": { - "summary": "Return list of values for action types", - "description": "Use this API to return the list of values for action types based on search criteria such as module, includeInactiveFlag, parameterName, parameterValue.

OperationId:getActionTypesLOV

", - "operationId": "getActionTypesLOV", + "summary": "Fetch List Of Values for Channel Parameters", + "description": "

OperationId:getChannelParametersLOV

", + "operationId": "getChannelParametersLOV", "parameters": [ { - "name": "module", + "name": "channelCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'module' which is required to fetch ActionTypes LOV" + "description": "Value of the parameter 'channelCode' which is required to fetch ChannelParameters LOV" + }, + { + "name": "settingName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'settingName' which is required to fetch ChannelParameters LOV" + }, + { + "name": "levelType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'levelType' which is required to fetch ChannelParameters LOV" + }, + { + "name": "levelCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'levelCode' which is required to fetch ChannelParameters LOV" }, { "name": "includeInactiveFlag", @@ -55448,7 +54610,7 @@ } }, "204": { - "description": "ActionTypesLOV not found." + "description": "ChannelParametersLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55498,29 +54660,29 @@ ] } }, - "/listOfValues/moduleId/{moduleId}/parameterName/{parameter}/reportsGeneric": { + "/listOfValues/levelCode/{levelCode}/settingName/{settingName}/applicationSettings": { "get": { - "summary": "Return list of values for generic reports", - "description": "Use this API to return the list of values for generic reports based on search criteria such as parameter, moduleId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getReportsGenericLOV

", - "operationId": "getReportsGenericLOV", + "summary": "Fetch List Of Values for Application Settings", + "description": "

OperationId:getApplicationSettingsLOV

", + "operationId": "getApplicationSettingsLOV", "parameters": [ { - "name": "parameter", + "name": "settingName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'parameter' which is required to fetch ReportsGeneric LOV" + "description": "Value of the parameter 'settingName' which is required to fetch ApplicationSettings LOV" }, { - "name": "moduleId", + "name": "levelCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'moduleId' which is required to fetch ReportsGeneric LOV" + "description": "Value of the parameter 'levelCode' which is required to fetch ApplicationSettings LOV" }, { "name": "includeInactiveFlag", @@ -55594,7 +54756,7 @@ } }, "204": { - "description": "ReportsGenericLOV not found." + "description": "ApplicationSettingsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55644,20 +54806,20 @@ ] } }, - "/listOfValues/moduleName/{moduleName}/configReports": { + "/listOfValues/levelCode/{levelCode}/taskSheetDept": { "get": { - "summary": "Return list of values for configuration reports", - "description": "Use this API to return the list of values for configuration reports based on search criteria such as moduleName, includeInactiveFlag, parameterName, parameterValue.

OperationId:getConfigReportsLOV

", - "operationId": "getConfigReportsLOV", + "summary": "Fetch List Of Values for Task Sheet Dept", + "description": "

OperationId:getTaskSheetDeptLOV

", + "operationId": "getTaskSheetDeptLOV", "parameters": [ { - "name": "moduleName", + "name": "levelCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'moduleName' which is required to fetch ConfigReports LOV" + "description": "Value of the parameter 'levelCode' which is required to fetch TaskSheetDept LOV" }, { "name": "includeInactiveFlag", @@ -55731,7 +54893,7 @@ } }, "204": { - "description": "ConfigReportsLOV not found." + "description": "TaskSheetDeptLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55781,20 +54943,29 @@ ] } }, - "/listOfValues/moduleName/{moduleName}/udfMappings": { + "/listOfValues/locationType/{locationType}/location/{location}/distributionTemplates": { "get": { - "summary": "Return list of values for user defined field mappings", - "description": "Use this API to return the list of values for user defined field mappings based on search criteria such as moduleName, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUDFMappingsLOV

", - "operationId": "getUDFMappingsLOV", + "summary": "Fetch List Of Values for Distribution Templates", + "description": "

OperationId:getDistributionTemplatesLOV

", + "operationId": "getDistributionTemplatesLOV", "parameters": [ { - "name": "moduleName", + "name": "location", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'moduleName' which is required to fetch UDFMappings LOV" + "description": "Value of the parameter 'location' which is required to fetch DistributionTemplates LOV" + }, + { + "name": "locationType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'locationType' which is required to fetch DistributionTemplates LOV" }, { "name": "includeInactiveFlag", @@ -55868,7 +55039,7 @@ } }, "204": { - "description": "UDFMappingsLOV not found." + "description": "DistributionTemplatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55918,20 +55089,20 @@ ] } }, - "/listOfValues/nameType/{nameType}/profileEnrollmentMatchCriteria": { + "/listOfValues/membershipId/{membershipId}/membershipStatementBatchList": { "get": { - "summary": "Return list of values for profile enrollment match criteria", - "description": "Use this API to return the list of values for profile enrollment match criteria based on search criteria such as nameType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getProfileEnrollmentMatchCriteriaLOV

", - "operationId": "getProfileEnrollmentMatchCriteriaLOV", + "summary": "Fetch List Of Values for Membership Statement Batch List", + "description": "

OperationId:getMembershipStatementBatchListLOV

", + "operationId": "getMembershipStatementBatchListLOV", "parameters": [ { - "name": "nameType", + "name": "membershipId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'nameType' which is required to fetch ProfileEnrollmentMatchCriteria LOV" + "description": "Value of the parameter 'membershipId' which is required to fetch MembershipStatementBatchList LOV" }, { "name": "includeInactiveFlag", @@ -56005,7 +55176,7 @@ } }, "204": { - "description": "ProfileEnrollmentMatchCriteriaLOV not found." + "description": "MembershipStatementBatchListLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56055,20 +55226,20 @@ ] } }, - "/listOfValues/nameType/{nameType}/profileEnrollmentRuleDoNotMergeCriteria": { + "/listOfValues/membershipId/{membershipId}/membershipTotalPointsAvailable": { "get": { - "summary": "Return list of values for profile enrollment rule do not merge criteria", - "description": "Use this API to return the list of values for profile enrollment rule do not merge criteria based on search criteria such as nameType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getProfileEnrollmentRuleDoNotMergeCriteriaLOV

", - "operationId": "getProfileEnrollmentRuleDoNotMergeCriteriaLOV", + "summary": "Fetch List Of Values for Membership Total Points Available", + "description": "

OperationId:getMembershipTotalPointsAvailableLOV

", + "operationId": "getMembershipTotalPointsAvailableLOV", "parameters": [ { - "name": "nameType", + "name": "membershipId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'nameType' which is required to fetch ProfileEnrollmentRuleDoNotMergeCriteria LOV" + "description": "Value of the parameter 'membershipId' which is required to fetch MembershipTotalPointsAvailable LOV" }, { "name": "includeInactiveFlag", @@ -56142,7 +55313,7 @@ } }, "204": { - "description": "ProfileEnrollmentRuleDoNotMergeCriteriaLOV not found." + "description": "MembershipTotalPointsAvailableLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56192,20 +55363,20 @@ ] } }, - "/listOfValues/nameType/{nameType}/profileEnrollmentRuleFilterCriteria": { + "/listOfValues/membershipLevel/{membershipLevel}/membershipCardFeeAmount": { "get": { - "summary": "Return list of values for profile enrollment rule filter criteria", - "description": "Use this API to return the list of values for profile enrollment rule filter criteria based on search criteria such as nameType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getProfileEnrollmentRuleFilterCriteriaLOV

", - "operationId": "getProfileEnrollmentRuleFilterCriteriaLOV", + "summary": "Fetch List Of Values for Membership Card Fee Amount", + "description": "

OperationId:getMembershipCardFeeAmountLOV

", + "operationId": "getMembershipCardFeeAmountLOV", "parameters": [ { - "name": "nameType", + "name": "membershipLevel", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'nameType' which is required to fetch ProfileEnrollmentRuleFilterCriteria LOV" + "description": "Value of the parameter 'membershipLevel' which is required to fetch MembershipCardFeeAmount LOV" }, { "name": "includeInactiveFlag", @@ -56279,7 +55450,7 @@ } }, "204": { - "description": "ProfileEnrollmentRuleFilterCriteriaLOV not found." + "description": "MembershipCardFeeAmountLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56329,33 +55500,29 @@ ] } }, - "/listOfValues/newEvent/{newEvent}/waitList/{waitList}/cateringEventStatus": { + "/listOfValues/membershipLevelRank/{membershipLevelRank}/membershipType/{membershipType}/membershipMaxDowngradeLevel": { "get": { - "summary": "Return list of values for catering event status", - "description": "Use this API to return the list of values for catering event status based on search criteria such as waitList, newEvent, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCateringEventStatusLOV

", - "operationId": "getCateringEventStatusLOV", + "summary": "Fetch List Of Values for Membership Max Downgrade Level", + "description": "

OperationId:getMembershipMaxDowngradeLevelLOV

", + "operationId": "getMembershipMaxDowngradeLevelLOV", "parameters": [ { - "name": "waitList", + "name": "membershipType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'waitList' which is required to fetch CateringEventStatus LOV" + "description": "Value of the parameter 'membershipType' which is required to fetch MembershipMaxDowngradeLevel LOV" }, { - "name": "newEvent", + "name": "membershipLevelRank", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'newEvent' which is required to fetch CateringEventStatus LOV", - "enum": [ - "Y", - "N" - ] + "description": "Value of the parameter 'membershipLevelRank' which is required to fetch MembershipMaxDowngradeLevel LOV" }, { "name": "includeInactiveFlag", @@ -56429,7 +55596,7 @@ } }, "204": { - "description": "CateringEventStatusLOV not found." + "description": "MembershipMaxDowngradeLevelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56479,20 +55646,20 @@ ] } }, - "/listOfValues/number/{number}/autoNumberGenerator": { + "/listOfValues/membershipType/{membershipType}/membershipBenefitProgram": { "get": { - "summary": "Return list of values for auto number generator", - "description": "Use this API to return the list of values for auto number generator based on search criteria such as number, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAutoNumberGeneratorLOV

", - "operationId": "getAutoNumberGeneratorLOV", + "summary": "Fetch List Of Values for Membership Benefit Program", + "description": "

OperationId:getMembershipBenefitProgramLOV

", + "operationId": "getMembershipBenefitProgramLOV", "parameters": [ { - "name": "number", + "name": "membershipType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'number' which is required to fetch AutoNumberGenerator LOV" + "description": "Value of the parameter 'membershipType' which is required to fetch MembershipBenefitProgram LOV" }, { "name": "includeInactiveFlag", @@ -56566,7 +55733,7 @@ } }, "204": { - "description": "AutoNumberGeneratorLOV not found." + "description": "MembershipBenefitProgramLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56616,20 +55783,20 @@ ] } }, - "/listOfValues/operaParam/{operaParam}/profileNameValidationsType": { + "/listOfValues/membershipType/{membershipType}/membershipBenefits": { "get": { - "summary": "Return list of values for profile name validation types", - "description": "Use this API to return the list of values for profile name validation types based on search criteria such as number, includeInactiveFlag, parameterName, parameterValue.

OperationId:getProfileNameValidationsTypeLOV

", - "operationId": "getProfileNameValidationsTypeLOV", + "summary": "Fetch List Of Values for Membership Benefits", + "description": "

OperationId:getMembershipBenefitsLOV

", + "operationId": "getMembershipBenefitsLOV", "parameters": [ { - "name": "operaParam", + "name": "membershipType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'operaParam' which is required to fetch ProfileNameValidationsType LOV" + "description": "Value of the parameter 'membershipType' which is required to fetch MembershipBenefits LOV" }, { "name": "includeInactiveFlag", @@ -56703,7 +55870,7 @@ } }, "204": { - "description": "ProfileNameValidationsTypeLOV not found." + "description": "MembershipBenefitsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56753,29 +55920,20 @@ ] } }, - "/listOfValues/outboundType/{outboundType}/protocol/{protocol}/outboundServiceNames": { + "/listOfValues/membershipType/{membershipType}/membershipPointsRuleCodes": { "get": { - "summary": "Return list of values for service names", - "description": "Use this API to return the list of values for service names based on search criteria such as protocol, outboundType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getServiceNameLOV

", - "operationId": "getServiceNameLOV", + "summary": "Fetch List Of Values for Membership Points Rule Codes", + "description": "

OperationId:getMembershipPointsRuleCodesLOV

", + "operationId": "getMembershipPointsRuleCodesLOV", "parameters": [ { - "name": "protocol", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'protocol' which is required to fetch ServiceName LOV" - }, - { - "name": "outboundType", + "name": "membershipType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'outboundType' which is required to fetch ServiceName LOV" + "description": "Value of the parameter 'membershipType' which is required to fetch MembershipPointsRuleCodes LOV" }, { "name": "includeInactiveFlag", @@ -56849,7 +56007,7 @@ } }, "204": { - "description": "ServiceNameLOV not found." + "description": "MembershipPointsRuleCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56899,29 +56057,20 @@ ] } }, - "/listOfValues/parameterName/{parameter}/chainCode/{chainCode}/parameterActiveUnderChain": { + "/listOfValues/membershipType/{membershipType}/upsellMembershipLevelsOnly": { "get": { - "summary": "Return list of values for parameter active under chain", - "description": "Use this API to return the list of values for parameter active under chain based on search criteria such as chainCode, parameter, includeInactiveFlag, parameterName, parameterValue.

OperationId:getParameterActiveUnderChainLOV

", - "operationId": "getParameterActiveUnderChainLOV", + "summary": "Fetch List Of Values for Upsell Membership Levels Only", + "description": "

OperationId:getUpsellMembershipLevelsOnlyLOV

", + "operationId": "getUpsellMembershipLevelsOnlyLOV", "parameters": [ { - "name": "chainCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'chainCode' which is required to fetch ParameterActiveUnderChain LOV" - }, - { - "name": "parameter", + "name": "membershipType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'parameter' which is required to fetch ParameterActiveUnderChain LOV" + "description": "Value of the parameter 'membershipType' which is required to fetch UpsellMembershipLevelsOnly LOV" }, { "name": "includeInactiveFlag", @@ -56995,7 +56144,7 @@ } }, "204": { - "description": "ParameterActiveUnderChainLOV not found." + "description": "UpsellMembershipLevelsOnlyLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57045,20 +56194,20 @@ ] } }, - "/listOfValues/period/{period}/repCalendarYears": { + "/listOfValues/menuClassId/{menuClassId}/menu": { "get": { - "summary": "Return list of values for rep calendar years", - "description": "Use this API to return the list of values for rep calendar years based on search criteria such as period, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepCalendarYearsLOV

", - "operationId": "getRepCalendarYearsLOV", + "summary": "Fetch List Of Values for Menu", + "description": "

OperationId:getMenuLOV

", + "operationId": "getMenuLOV", "parameters": [ { - "name": "period", + "name": "menuClassId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'period' which is required to fetch RepCalendarYears LOV" + "description": "Value of the parameter 'menuClassId' which is required to fetch Menu LOV" }, { "name": "includeInactiveFlag", @@ -57132,7 +56281,7 @@ } }, "204": { - "description": "RepCalendarYearsLOV not found." + "description": "MenuLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57182,20 +56331,20 @@ ] } }, - "/listOfValues/pkgId/{pkgId}/cateringPackageRevenueEventType": { + "/listOfValues/mode/{mode}/folioGroupingTransactionCodes": { "get": { - "summary": "Return list of values for catering package revenue event types", - "description": "Use this API to return the list of values for catering package revenue event types based on search criteria such as pkgId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCateringPackageRevenueEventTypeLOV

", - "operationId": "getCateringPackageRevenueEventTypeLOV", + "summary": "Fetch List Of Values for Folio Grouping Transaction Codes", + "description": "

OperationId:getFolioGroupingTransactionCodesLOV

", + "operationId": "getFolioGroupingTransactionCodesLOV", "parameters": [ { - "name": "pkgId", + "name": "mode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'pkgId' which is required to fetch CateringPackageRevenueEventType LOV" + "description": "Value of the parameter 'mode' which is required to fetch FolioGroupingTransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -57269,7 +56418,7 @@ } }, "204": { - "description": "CateringPackageRevenueEventTypeLOV not found." + "description": "FolioGroupingTransactionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57319,20 +56468,20 @@ ] } }, - "/listOfValues/pkgLinkId/{pkgLinkId}/cateringPackageRevenueConfigEventType": { + "/listOfValues/module/{module}/actionTypes": { "get": { - "summary": "Return list of values for catering package revenue config event types", - "description": "Use this API to return the list of values for catering package revenue config event types based on search criteria such as pkgLinkId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCateringPackageRevenueConfigEventTypeLOV

", - "operationId": "getCateringPackageRevenueConfigEventTypeLOV", + "summary": "Fetch List Of Values for Action Types", + "description": "

OperationId:getActionTypesLOV

", + "operationId": "getActionTypesLOV", "parameters": [ { - "name": "pkgLinkId", + "name": "module", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'pkgLinkId' which is required to fetch CateringPackageRevenueConfigEventType LOV" + "description": "Value of the parameter 'module' which is required to fetch ActionTypes LOV" }, { "name": "includeInactiveFlag", @@ -57406,7 +56555,7 @@ } }, "204": { - "description": "CateringPackageRevenueConfigEventTypeLOV not found." + "description": "ActionTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57456,20 +56605,29 @@ ] } }, - "/listOfValues/policyType/{policyType}/depositCancelRulesMultiHotel": { + "/listOfValues/moduleId/{moduleId}/parameterName/{parameter}/reportsGeneric": { "get": { - "summary": "Return list of values for deposit cancel rules multi hotel", - "description": "Use this API to return the list of values for deposit cancel rules multi hotel based on search criteria such as policyType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getDepositCancelRulesMultiHotelLOV

", - "operationId": "getDepositCancelRulesMultiHotelLOV", + "summary": "Fetch List Of Values for Reports Generic", + "description": "

OperationId:getReportsGenericLOV

", + "operationId": "getReportsGenericLOV", "parameters": [ { - "name": "policyType", + "name": "parameter", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'policyType' which is required to fetch DepositCancelRulesMultiHotel LOV" + "description": "Value of the parameter 'parameter' which is required to fetch ReportsGeneric LOV" + }, + { + "name": "moduleId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'moduleId' which is required to fetch ReportsGeneric LOV" }, { "name": "includeInactiveFlag", @@ -57543,7 +56701,7 @@ } }, "204": { - "description": "DepositCancelRulesMultiHotelLOV not found." + "description": "ReportsGenericLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57593,20 +56751,20 @@ ] } }, - "/listOfValues/policyType/{policyType}/templatePolicyCodes": { + "/listOfValues/moduleName/{moduleName}/configReports": { "get": { - "summary": "Return list of values for policy code templates", - "description": "Use this API to return the list of values for policy code templates based on search criteria such as policyType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTemplatePolicyCodesLOV

", - "operationId": "getTemplatePolicyCodesLOV", + "summary": "Fetch List Of Values for Config Reports", + "description": "

OperationId:getConfigReportsLOV

", + "operationId": "getConfigReportsLOV", "parameters": [ { - "name": "policyType", + "name": "moduleName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'policyType' which is required to fetch TemplatePolicyCodes LOV" + "description": "Value of the parameter 'moduleName' which is required to fetch ConfigReports LOV" }, { "name": "includeInactiveFlag", @@ -57680,7 +56838,7 @@ } }, "204": { - "description": "TemplatePolicyCodesLOV not found." + "description": "ConfigReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57730,20 +56888,20 @@ ] } }, - "/listOfValues/preferenceGroup/{preferenceGroup}/preferencesMultiHotels": { + "/listOfValues/moduleName/{moduleName}/udfMappings": { "get": { - "summary": "Return list of values for preferences multi hotels", - "description": "Use this API to return the list of values for preferences multi hotels based on search criteria such as preferenceGroup, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPreferencesMultiHotelsLOV

", - "operationId": "getPreferencesMultiHotelsLOV", + "summary": "Fetch List Of Values for UDFMappings", + "description": "

OperationId:getUDFMappingsLOV

", + "operationId": "getUDFMappingsLOV", "parameters": [ { - "name": "preferenceGroup", + "name": "moduleName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'preferenceGroup' which is required to fetch PreferencesMultiHotels LOV" + "description": "Value of the parameter 'moduleName' which is required to fetch UDFMappings LOV" }, { "name": "includeInactiveFlag", @@ -57817,7 +56975,7 @@ } }, "204": { - "description": "PreferencesMultiHotelsLOV not found." + "description": "UDFMappingsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57867,20 +57025,20 @@ ] } }, - "/listOfValues/profiles/{profileId}/claimMembershipDetails": { + "/listOfValues/nameType/{nameType}/profileEnrollmentMatchCriteria": { "get": { - "summary": "Return list of values for claim membership details", - "description": "Use this API to return the list of values for claim membership details based on search criteria such as profileId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getClaimMembershipDetailsLOV

", - "operationId": "getClaimMembershipDetailsLOV", + "summary": "Fetch List Of Values for Profile Enrollment Match Criteria", + "description": "

OperationId:getProfileEnrollmentMatchCriteriaLOV

", + "operationId": "getProfileEnrollmentMatchCriteriaLOV", "parameters": [ { - "name": "profileId", + "name": "nameType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'profileId' which is required to fetch ClaimMembershipDetails LOV" + "description": "Value of the parameter 'nameType' which is required to fetch ProfileEnrollmentMatchCriteria LOV" }, { "name": "includeInactiveFlag", @@ -57954,7 +57112,7 @@ } }, "204": { - "description": "ClaimMembershipDetailsLOV not found." + "description": "ProfileEnrollmentMatchCriteriaLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58004,20 +57162,20 @@ ] } }, - "/listOfValues/profiles/{profileId}/hotelsForARProfile": { + "/listOfValues/nameType/{nameType}/profileEnrollmentRuleDoNotMergeCriteria": { "get": { - "summary": "Return list of values for hotels for account receivable profiles", - "description": "Use this API to return the list of values for hotels for account receivable profiles based on search criteria such as profileId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getHotelsForARProfileLOV

", - "operationId": "getHotelsForARProfileLOV", + "summary": "Fetch List Of Values for Profile Enrollment Rule Do Not Merge Criteria", + "description": "

OperationId:getProfileEnrollmentRuleDoNotMergeCriteriaLOV

", + "operationId": "getProfileEnrollmentRuleDoNotMergeCriteriaLOV", "parameters": [ { - "name": "profileId", + "name": "nameType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'profileId' which is required to fetch HotelsForARProfile LOV" + "description": "Value of the parameter 'nameType' which is required to fetch ProfileEnrollmentRuleDoNotMergeCriteria LOV" }, { "name": "includeInactiveFlag", @@ -58091,7 +57249,7 @@ } }, "204": { - "description": "HotelsForARProfileLOV not found." + "description": "ProfileEnrollmentRuleDoNotMergeCriteriaLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58141,20 +57299,20 @@ ] } }, - "/listOfValues/profiles/{profileId}/membershipTransferPoints": { + "/listOfValues/nameType/{nameType}/profileEnrollmentRuleFilterCriteria": { "get": { - "summary": "Return list of values for membership transfer points", - "description": "Use this API to return the list of values for hotels for membership transfer points based on search criteria such as profileId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMembershipTransferPointsLOV

", - "operationId": "getMembershipTransferPointsLOV", + "summary": "Fetch List Of Values for Profile Enrollment Rule Filter Criteria", + "description": "

OperationId:getProfileEnrollmentRuleFilterCriteriaLOV

", + "operationId": "getProfileEnrollmentRuleFilterCriteriaLOV", "parameters": [ { - "name": "profileId", + "name": "nameType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'profileId' which is required to fetch MembershipTransferPoints LOV" + "description": "Value of the parameter 'nameType' which is required to fetch ProfileEnrollmentRuleFilterCriteria LOV" }, { "name": "includeInactiveFlag", @@ -58228,7 +57386,7 @@ } }, "204": { - "description": "MembershipTransferPointsLOV not found." + "description": "ProfileEnrollmentRuleFilterCriteriaLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58278,20 +57436,33 @@ ] } }, - "/listOfValues/profiles/{profileId}/negotiatedRateHotels": { + "/listOfValues/newEvent/{newEvent}/waitList/{waitList}/cateringEventStatus": { "get": { - "summary": "Return list of values for negotiated rate hotels", - "description": "Use this API to return the list of values for negotiated rate hotels based on search criteria such as profileId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getNegotiatedRateHotelsLOV

", - "operationId": "getNegotiatedRateHotelsLOV", + "summary": "Fetch List Of Values for Catering Event Status", + "description": "

OperationId:getCateringEventStatusLOV

", + "operationId": "getCateringEventStatusLOV", "parameters": [ { - "name": "profileId", + "name": "waitList", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'profileId' which is required to fetch NegotiatedRateHotels LOV" + "description": "Value of the parameter 'waitList' which is required to fetch CateringEventStatus LOV" + }, + { + "name": "newEvent", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'newEvent' which is required to fetch CateringEventStatus LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -58365,7 +57536,7 @@ } }, "204": { - "description": "NegotiatedRateHotelsLOV not found." + "description": "CateringEventStatusLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58415,20 +57586,20 @@ ] } }, - "/listOfValues/profiles/{profileId}/profileCommunications": { + "/listOfValues/number/{number}/autoNumberGenerator": { "get": { - "summary": "Return list of values for profile communications", - "description": "Use this API to return the list of values for profile communications based on search criteria such as profileId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getProfileCommunicationsLOV

", - "operationId": "getProfileCommunicationsLOV", + "summary": "Fetch List Of Values for Auto Number Generator", + "description": "

OperationId:getAutoNumberGeneratorLOV

", + "operationId": "getAutoNumberGeneratorLOV", "parameters": [ { - "name": "profileId", + "name": "number", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'profileId' which is required to fetch ProfileCommunications LOV" + "description": "Value of the parameter 'number' which is required to fetch AutoNumberGenerator LOV" }, { "name": "includeInactiveFlag", @@ -58502,7 +57673,7 @@ } }, "204": { - "description": "ProfileCommunicationsLOV not found." + "description": "AutoNumberGeneratorLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58552,29 +57723,20 @@ ] } }, - "/listOfValues/profiles/{profileId}/taxTypeCheck/{taxTypeCheck}/profileHotels": { + "/listOfValues/operaParam/{operaParam}/profileNameValidationsType": { "get": { - "summary": "Return list of values for profile hotels", - "description": "Use this API to return the list of values for profile hotels based on search criteria such as taxTypeCheck, profileId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getProfileHotelsLOV

", - "operationId": "getProfileHotelsLOV", + "summary": "Fetch List Of Values for Profile Name Validations Type", + "description": "

OperationId:getProfileNameValidationsTypeLOV

", + "operationId": "getProfileNameValidationsTypeLOV", "parameters": [ { - "name": "taxTypeCheck", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'taxTypeCheck' which is required to fetch ProfileHotels LOV" - }, - { - "name": "profileId", + "name": "operaParam", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'profileId' which is required to fetch ProfileHotels LOV" + "description": "Value of the parameter 'operaParam' which is required to fetch ProfileNameValidationsType LOV" }, { "name": "includeInactiveFlag", @@ -58648,7 +57810,7 @@ } }, "204": { - "description": "ProfileHotelsLOV not found." + "description": "ProfileNameValidationsTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58698,20 +57860,29 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyClassesCopy": { + "/listOfValues/outboundType/{outboundType}/protocol/{protocol}/outboundServiceNames": { "get": { - "summary": "Return list of values for hotel room hierarchy classes copy", - "description": "Use this API to return the list of values for room hierarchy classes copy for a specific property based on search criteria such as property, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomHierarchyClassesCopyLOV

", - "operationId": "getRoomHierarchyClassesCopyLOV", + "summary": "Fetch List Of Values for Service Name", + "description": "

OperationId:getServiceNameLOV

", + "operationId": "getServiceNameLOV", "parameters": [ { - "name": "property", + "name": "protocol", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'property' which is required to fetch RoomHierarchyClassesCopy LOV" + "description": "Value of the parameter 'protocol' which is required to fetch ServiceName LOV" + }, + { + "name": "outboundType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'outboundType' which is required to fetch ServiceName LOV" }, { "name": "includeInactiveFlag", @@ -58785,7 +57956,7 @@ } }, "204": { - "description": "RoomHierarchyClassesCopyLOV not found." + "description": "ServiceNameLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58835,20 +58006,29 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyRoomClasses": { + "/listOfValues/parameterName/{parameter}/chainCode/{chainCode}/parameterActiveUnderChain": { "get": { - "summary": "Return list of values for hotel room hierarchy room classes", - "description": "Use this API to return the list of values for room hierarchy room classes for a specific property based on search criteria such as property, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomHierarchyRoomClassesLOV

", - "operationId": "getRoomHierarchyRoomClassesLOV", + "summary": "Fetch List Of Values for Parameter Active Under Chain", + "description": "

OperationId:getParameterActiveUnderChainLOV

", + "operationId": "getParameterActiveUnderChainLOV", "parameters": [ { - "name": "property", + "name": "chainCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'property' which is required to fetch RoomHierarchyRoomClasses LOV" + "description": "Value of the parameter 'chainCode' which is required to fetch ParameterActiveUnderChain LOV" + }, + { + "name": "parameter", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'parameter' which is required to fetch ParameterActiveUnderChain LOV" }, { "name": "includeInactiveFlag", @@ -58922,7 +58102,7 @@ } }, "204": { - "description": "RoomHierarchyRoomClassesLOV not found." + "description": "ParameterActiveUnderChainLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58972,20 +58152,20 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyRoomTypes": { + "/listOfValues/period/{period}/repCalendarYears": { "get": { - "summary": "Return list of values for hotel room hierarchy room types", - "description": "Use this API to return the list of values for room hierarchy room types for a specific property based on search criteria such as property, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomHierarchyRoomTypesLOV

", - "operationId": "getRoomHierarchyRoomTypesLOV", + "summary": "Fetch List Of Values for Rep Calendar Years", + "description": "

OperationId:getRepCalendarYearsLOV

", + "operationId": "getRepCalendarYearsLOV", "parameters": [ { - "name": "property", + "name": "period", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'property' which is required to fetch RoomHierarchyRoomTypes LOV" + "description": "Value of the parameter 'period' which is required to fetch RepCalendarYears LOV" }, { "name": "includeInactiveFlag", @@ -59059,7 +58239,7 @@ } }, "204": { - "description": "RoomHierarchyRoomTypesLOV not found." + "description": "RepCalendarYearsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59109,20 +58289,20 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyTypesCopy": { + "/listOfValues/pkgId/{pkgId}/cateringPackageRevenueEventType": { "get": { - "summary": "Return list of values for hotel room hierarchy types copy", - "description": "Use this API to return the list of values for room hierarchy types copy for a specific property based on search criteria such as property, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRoomHierarchyTypesCopyLOV

", - "operationId": "getRoomHierarchyTypesCopyLOV", + "summary": "Fetch List Of Values for Catering Package Revenue Event Type", + "description": "

OperationId:getCateringPackageRevenueEventTypeLOV

", + "operationId": "getCateringPackageRevenueEventTypeLOV", "parameters": [ { - "name": "property", + "name": "pkgId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'property' which is required to fetch RoomHierarchyTypesCopy LOV" + "description": "Value of the parameter 'pkgId' which is required to fetch CateringPackageRevenueEventType LOV" }, { "name": "includeInactiveFlag", @@ -59196,7 +58376,7 @@ } }, "204": { - "description": "RoomHierarchyTypesCopyLOV not found." + "description": "CateringPackageRevenueEventTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59246,20 +58426,20 @@ ] } }, - "/listOfValues/propertyList/{propertyList}/repRatePlans": { + "/listOfValues/pkgLinkId/{pkgLinkId}/cateringPackageRevenueConfigEventType": { "get": { - "summary": "Return list of values for rep rate plans", - "description": "Use this API to return the list of values for rep rate plans based on search criteria such as propertyList, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepRatePlansLOV

", - "operationId": "getRepRatePlansLOV", + "summary": "Fetch List Of Values for Catering Package Revenue Config Event Type", + "description": "

OperationId:getCateringPackageRevenueConfigEventTypeLOV

", + "operationId": "getCateringPackageRevenueConfigEventTypeLOV", "parameters": [ { - "name": "propertyList", + "name": "pkgLinkId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'propertyList' which is required to fetch RepRatePlans LOV" + "description": "Value of the parameter 'pkgLinkId' which is required to fetch CateringPackageRevenueConfigEventType LOV" }, { "name": "includeInactiveFlag", @@ -59333,7 +58513,7 @@ } }, "204": { - "description": "RepRatePlansLOV not found." + "description": "CateringPackageRevenueConfigEventTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59383,29 +58563,20 @@ ] } }, - "/listOfValues/radioType/{radioType}/hotels/{hotelId}/cateringPackageCodes": { + "/listOfValues/policyType/{policyType}/depositCancelRulesMultiHotel": { "get": { - "summary": "Return list of values for hotel catering package codes", - "description": "Use this API to return the list of values for catering package codes for a specific property based on search criteria such as hotelId, radioType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCateringPackageCodesLOV

", - "operationId": "getCateringPackageCodesLOV", + "summary": "Fetch List Of Values for Deposit Cancel Rules Multi Hotel", + "description": "

OperationId:getDepositCancelRulesMultiHotelLOV

", + "operationId": "getDepositCancelRulesMultiHotelLOV", "parameters": [ { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CateringPackageCodes LOV" - }, - { - "name": "radioType", + "name": "policyType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'radioType' which is required to fetch CateringPackageCodes LOV" + "description": "Value of the parameter 'policyType' which is required to fetch DepositCancelRulesMultiHotel LOV" }, { "name": "includeInactiveFlag", @@ -59479,7 +58650,7 @@ } }, "204": { - "description": "CateringPackageCodesLOV not found." + "description": "DepositCancelRulesMultiHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59529,29 +58700,20 @@ ] } }, - "/listOfValues/rateCode/{rateCode}/profiles/{profileId}/negotiatedRatesHotels": { + "/listOfValues/policyType/{policyType}/templatePolicyCodes": { "get": { - "summary": "Return list of values for negotiated rate hotels", - "description": "Use this API to return the list of values for negotiated rate hotels based on search criteria such as profileId, rateCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getNegotiatedRatesHotelsLOV

", - "operationId": "getNegotiatedRatesHotelsLOV", + "summary": "Fetch List Of Values for Template Policy Codes", + "description": "

OperationId:getTemplatePolicyCodesLOV

", + "operationId": "getTemplatePolicyCodesLOV", "parameters": [ { - "name": "profileId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'profileId' which is required to fetch NegotiatedRatesHotels LOV" - }, - { - "name": "rateCode", + "name": "policyType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'rateCode' which is required to fetch NegotiatedRatesHotels LOV" + "description": "Value of the parameter 'policyType' which is required to fetch TemplatePolicyCodes LOV" }, { "name": "includeInactiveFlag", @@ -59625,7 +58787,7 @@ } }, "204": { - "description": "NegotiatedRatesHotelsLOV not found." + "description": "TemplatePolicyCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59675,29 +58837,20 @@ ] } }, - "/listOfValues/roleLevel/{roleLevel}/levelCode/{levelCode}/rolesForLevel": { + "/listOfValues/preferenceGroup/{preferenceGroup}/preferencesMultiHotels": { "get": { - "summary": "Return list of values for roles for level", - "description": "Use this API to return the list of values for roles for level based on search criteria such as levelCode, roleLevel, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRolesForLevelLOV

", - "operationId": "getRolesForLevelLOV", + "summary": "Fetch List Of Values for Preferences Multi Hotels", + "description": "

OperationId:getPreferencesMultiHotelsLOV

", + "operationId": "getPreferencesMultiHotelsLOV", "parameters": [ { - "name": "levelCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'levelCode' which is required to fetch RolesForLevel LOV" - }, - { - "name": "roleLevel", + "name": "preferenceGroup", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'roleLevel' which is required to fetch RolesForLevel LOV" + "description": "Value of the parameter 'preferenceGroup' which is required to fetch PreferencesMultiHotels LOV" }, { "name": "includeInactiveFlag", @@ -59771,7 +58924,7 @@ } }, "204": { - "description": "RolesForLevelLOV not found." + "description": "PreferencesMultiHotelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59821,38 +58974,20 @@ ] } }, - "/listOfValues/roles/{roles}/chainCode/{chainCode}/actionTask/{actionTask}/organizations": { + "/listOfValues/profiles/{profileId}/claimMembershipDetails": { "get": { - "summary": "Return list of values for organizations", - "description": "Use this API to return the list of values for organizations based on search criteria such as actionTask, chainCode, roles, includeInactiveFlag, parameterName, parameterValue.

OperationId:getOrganizationsLOV

", - "operationId": "getOrganizationsLOV", + "summary": "Fetch List Of Values for Claim Membership Details", + "description": "

OperationId:getClaimMembershipDetailsLOV

", + "operationId": "getClaimMembershipDetailsLOV", "parameters": [ { - "name": "actionTask", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'actionTask' which is required to fetch Organizations LOV" - }, - { - "name": "chainCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'chainCode' which is required to fetch Organizations LOV" - }, - { - "name": "roles", + "name": "profileId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'roles' which is required to fetch Organizations LOV" + "description": "Value of the parameter 'profileId' which is required to fetch ClaimMembershipDetails LOV" }, { "name": "includeInactiveFlag", @@ -59926,7 +59061,7 @@ } }, "204": { - "description": "OrganizationsLOV not found." + "description": "ClaimMembershipDetailsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59976,24 +59111,20 @@ ] } }, - "/listOfValues/salesFormat/{salesFormat}/addressFormatElements": { + "/listOfValues/profiles/{profileId}/hotelsForARProfile": { "get": { - "summary": "Return list of values for address format elements", - "description": "Use this API to return the list of values for address format elements based on search criteria such as salesFormat, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAddressFormatElementsLOV

", - "operationId": "getAddressFormatElementsLOV", + "summary": "Fetch List Of Values for Hotels For ARProfile", + "description": "

OperationId:getHotelsForARProfileLOV

", + "operationId": "getHotelsForARProfileLOV", "parameters": [ { - "name": "salesFormat", + "name": "profileId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'salesFormat' which is required to fetch AddressFormatElements LOV", - "enum": [ - "Y", - "N" - ] + "description": "Value of the parameter 'profileId' which is required to fetch HotelsForARProfile LOV" }, { "name": "includeInactiveFlag", @@ -60067,7 +59198,7 @@ } }, "204": { - "description": "AddressFormatElementsLOV not found." + "description": "HotelsForARProfileLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60117,20 +59248,20 @@ ] } }, - "/listOfValues/shiftGroupId/{shiftGroupId}/shiftReportsNoParam": { + "/listOfValues/profiles/{profileId}/membershipTransferPoints": { "get": { - "summary": "Return list of values for shift reports no parameter", - "description": "Use this API to return the list of values for shift reports no parameter based on search criteria such as shiftGroupId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getShiftReportsNoParamLOV

", - "operationId": "getShiftReportsNoParamLOV", + "summary": "Fetch List Of Values for Membership Transfer Points", + "description": "

OperationId:getMembershipTransferPointsLOV

", + "operationId": "getMembershipTransferPointsLOV", "parameters": [ { - "name": "shiftGroupId", + "name": "profileId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'shiftGroupId' which is required to fetch ShiftReportsNoParam LOV" + "description": "Value of the parameter 'profileId' which is required to fetch MembershipTransferPoints LOV" }, { "name": "includeInactiveFlag", @@ -60204,7 +59335,7 @@ } }, "204": { - "description": "ShiftReportsNoParamLOV not found." + "description": "MembershipTransferPointsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60254,20 +59385,20 @@ ] } }, - "/listOfValues/siteType/{siteType}/sitePlanSectionTypes": { + "/listOfValues/profiles/{profileId}/negotiatedRateHotels": { "get": { - "summary": "Return list of values for site plan section types", - "description": "Use this API to return the list of values for site plan section types based on search criteria such as siteType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getSitePlanSectionTypesLOV

", - "operationId": "getSitePlanSectionTypesLOV", + "summary": "Fetch List Of Values for Negotiated Rate Hotels", + "description": "

OperationId:getNegotiatedRateHotelsLOV

", + "operationId": "getNegotiatedRateHotelsLOV", "parameters": [ { - "name": "siteType", + "name": "profileId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'siteType' which is required to fetch SitePlanSectionTypes LOV" + "description": "Value of the parameter 'profileId' which is required to fetch NegotiatedRateHotels LOV" }, { "name": "includeInactiveFlag", @@ -60341,7 +59472,7 @@ } }, "204": { - "description": "SitePlanSectionTypesLOV not found." + "description": "NegotiatedRateHotelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60391,20 +59522,20 @@ ] } }, - "/listOfValues/sourceId/{sourceId}/globalAlertFieldQuery": { + "/listOfValues/profiles/{profileId}/profileCommunications": { "get": { - "summary": "Return list of values for global alert field queries", - "description": "Use this API to return the list of values for global alert field queries based on search criteria such as sourceId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGlobalAlertFieldQueryLOV

", - "operationId": "getGlobalAlertFieldQueryLOV", + "summary": "Fetch List Of Values for Profile Communications", + "description": "

OperationId:getProfileCommunicationsLOV

", + "operationId": "getProfileCommunicationsLOV", "parameters": [ { - "name": "sourceId", + "name": "profileId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'sourceId' which is required to fetch GlobalAlertFieldQuery LOV" + "description": "Value of the parameter 'profileId' which is required to fetch ProfileCommunications LOV" }, { "name": "includeInactiveFlag", @@ -60478,7 +59609,7 @@ } }, "204": { - "description": "GlobalAlertFieldQueryLOV not found." + "description": "ProfileCommunicationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60528,47 +59659,29 @@ ] } }, - "/listOfValues/sourceIdIn/{sourceIdIn}/fieldType/{fieldType}/fieldName/{fieldName}/tableName/{tableName}/globalAlertOperator": { + "/listOfValues/profiles/{profileId}/taxTypeCheck/{taxTypeCheck}/profileHotels": { "get": { - "summary": "Return list of values for global alert operators", - "description": "Use this API to return the list of values for global alert operators based on search criteria such as tableName, fieldName, fieldType, sourceIdIn, includeInactiveFlag, parameterName, parameterValue.

OperationId:getGlobalAlertOperatorLOV

", - "operationId": "getGlobalAlertOperatorLOV", + "summary": "Fetch List Of Values for Profile Hotels", + "description": "

OperationId:getProfileHotelsLOV

", + "operationId": "getProfileHotelsLOV", "parameters": [ { - "name": "tableName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'tableName' which is required to fetch GlobalAlertOperator LOV" - }, - { - "name": "fieldName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'fieldName' which is required to fetch GlobalAlertOperator LOV" - }, - { - "name": "fieldType", + "name": "taxTypeCheck", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'fieldType' which is required to fetch GlobalAlertOperator LOV" + "description": "Value of the parameter 'taxTypeCheck' which is required to fetch ProfileHotels LOV" }, { - "name": "sourceIdIn", + "name": "profileId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'sourceIdIn' which is required to fetch GlobalAlertOperator LOV" + "description": "Value of the parameter 'profileId' which is required to fetch ProfileHotels LOV" }, { "name": "includeInactiveFlag", @@ -60642,7 +59755,7 @@ } }, "204": { - "description": "GlobalAlertOperatorLOV not found." + "description": "ProfileHotelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60692,20 +59805,20 @@ ] } }, - "/listOfValues/sourceIdIn/{sourceIdIn}/mailGeneric": { + "/listOfValues/property/{property}/roomHierarchyClassesCopy": { "get": { - "summary": "Return list of values for generic mail", - "description": "Use this API to return the list of values for generic mail based on search criteria such as sourceIdIn, includeInactiveFlag, parameterName, parameterValue.

OperationId:getMailGenericLOV

", - "operationId": "getMailGenericLOV", + "summary": "Fetch List Of Values for Room Hierarchy Classes Copy", + "description": "

OperationId:getRoomHierarchyClassesCopyLOV

", + "operationId": "getRoomHierarchyClassesCopyLOV", "parameters": [ { - "name": "sourceIdIn", + "name": "property", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'sourceIdIn' which is required to fetch MailGeneric LOV" + "description": "Value of the parameter 'property' which is required to fetch RoomHierarchyClassesCopy LOV" }, { "name": "includeInactiveFlag", @@ -60779,7 +59892,7 @@ } }, "204": { - "description": "MailGenericLOV not found." + "description": "RoomHierarchyClassesCopyLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60829,20 +59942,20 @@ ] } }, - "/listOfValues/subscriber/{subscriber}/publisherProperties": { + "/listOfValues/property/{property}/roomHierarchyRoomClasses": { "get": { - "summary": "Return list of values for publisher properties", - "description": "Use this API to return the list of values for publisher properties based on search criteria such as subscriber, includeInactiveFlag, parameterName, parameterValue.

OperationId:getPublisherPropertiesLOV

", - "operationId": "getPublisherPropertiesLOV", + "summary": "Fetch List Of Values for Room Hierarchy Room Classes", + "description": "

OperationId:getRoomHierarchyRoomClassesLOV

", + "operationId": "getRoomHierarchyRoomClassesLOV", "parameters": [ { - "name": "subscriber", + "name": "property", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'subscriber' which is required to fetch PublisherProperties LOV" + "description": "Value of the parameter 'property' which is required to fetch RoomHierarchyRoomClasses LOV" }, { "name": "includeInactiveFlag", @@ -60916,7 +60029,7 @@ } }, "204": { - "description": "PublisherPropertiesLOV not found." + "description": "RoomHierarchyRoomClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60966,20 +60079,20 @@ ] } }, - "/listOfValues/tableName/{tableName}/interfaceTabColumns": { + "/listOfValues/property/{property}/roomHierarchyRoomTypes": { "get": { - "summary": "Return list of values for interface tab columns", - "description": "Use this API to return the list of values for interface tab columns based on search criteria such as tableName, includeInactiveFlag, parameterName, parameterValue.

OperationId:getInterfaceTabColumnsLOV

", - "operationId": "getInterfaceTabColumnsLOV", + "summary": "Fetch List Of Values for Room Hierarchy Room Types", + "description": "

OperationId:getRoomHierarchyRoomTypesLOV

", + "operationId": "getRoomHierarchyRoomTypesLOV", "parameters": [ { - "name": "tableName", + "name": "property", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'tableName' which is required to fetch InterfaceTabColumns LOV" + "description": "Value of the parameter 'property' which is required to fetch RoomHierarchyRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -61053,7 +60166,7 @@ } }, "204": { - "description": "InterfaceTabColumnsLOV not found." + "description": "RoomHierarchyRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61103,29 +60216,20 @@ ] } }, - "/listOfValues/tableName/{tableName}/traceGroup/{traceGroup}/autoTraceExpressionFields": { + "/listOfValues/property/{property}/roomHierarchyTypesCopy": { "get": { - "summary": "Return list of values for auto trace expression fields", - "description": "Use this API to return the list of values for auto trace expression fields based on search criteria such as traceGroup, tableName, includeInactiveFlag, parameterName, parameterValue.

OperationId:getAutoTraceExpressionFieldsLOV

", - "operationId": "getAutoTraceExpressionFieldsLOV", + "summary": "Fetch List Of Values for Room Hierarchy Types Copy", + "description": "

OperationId:getRoomHierarchyTypesCopyLOV

", + "operationId": "getRoomHierarchyTypesCopyLOV", "parameters": [ { - "name": "traceGroup", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'traceGroup' which is required to fetch AutoTraceExpressionFields LOV" - }, - { - "name": "tableName", + "name": "property", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'tableName' which is required to fetch AutoTraceExpressionFields LOV" + "description": "Value of the parameter 'property' which is required to fetch RoomHierarchyTypesCopy LOV" }, { "name": "includeInactiveFlag", @@ -61199,7 +60303,7 @@ } }, "204": { - "description": "AutoTraceExpressionFieldsLOV not found." + "description": "RoomHierarchyTypesCopyLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61249,20 +60353,20 @@ ] } }, - "/listOfValues/templateCode/{templateCode}/templateFiscalFolioParameters": { + "/listOfValues/propertyList/{propertyList}/repRatePlans": { "get": { - "summary": "Return list of values for fiscal folio parameter templates", - "description": "Use this API to return the list of values for fiscal folio parameter templates based on search criteria such as templateCode, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTemplateFiscalFolioParametersLOV

", - "operationId": "getTemplateFiscalFolioParametersLOV", + "summary": "Fetch List Of Values for Rep Rate Plans", + "description": "

OperationId:getRepRatePlansLOV

", + "operationId": "getRepRatePlansLOV", "parameters": [ { - "name": "templateCode", + "name": "propertyList", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'templateCode' which is required to fetch TemplateFiscalFolioParameters LOV" + "description": "Value of the parameter 'propertyList' which is required to fetch RepRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -61336,7 +60440,7 @@ } }, "204": { - "description": "TemplateFiscalFolioParametersLOV not found." + "description": "RepRatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61386,20 +60490,29 @@ ] } }, - "/listOfValues/type/{type}/arrangementCodesNumber": { + "/listOfValues/radioType/{radioType}/hotels/{hotelId}/cateringPackageCodes": { "get": { - "summary": "Return list of values for arrangement code numbers", - "description": "Use this API to return the list of values for arrangement code numbers based on search criteria such as type, includeInactiveFlag, parameterName, parameterValue.

OperationId:getArrangementCodesNumberLOV

", - "operationId": "getArrangementCodesNumberLOV", + "summary": "Fetch List Of Values for Catering Package Codes", + "description": "

OperationId:getCateringPackageCodesLOV

", + "operationId": "getCateringPackageCodesLOV", "parameters": [ { - "name": "type", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'type' which is required to fetch ArrangementCodesNumber LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CateringPackageCodes LOV" + }, + { + "name": "radioType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'radioType' which is required to fetch CateringPackageCodes LOV" }, { "name": "includeInactiveFlag", @@ -61473,7 +60586,7 @@ } }, "204": { - "description": "ArrangementCodesNumberLOV not found." + "description": "CateringPackageCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61523,20 +60636,29 @@ ] } }, - "/listOfValues/type/{type}/enrollmentMatchCommunicationType": { + "/listOfValues/rateCode/{rateCode}/profiles/{profileId}/negotiatedRatesHotels": { "get": { - "summary": "Return list of values for enrollment match communication types", - "description": "Use this API to return the list of values for enrollment match communication types based on search criteria such as type, includeInactiveFlag, parameterName, parameterValue.

OperationId:getEnrollmentMatchCommunicationTypeLOV

", - "operationId": "getEnrollmentMatchCommunicationTypeLOV", + "summary": "Fetch List Of Values for Negotiated Rates Hotels", + "description": "

OperationId:getNegotiatedRatesHotelsLOV

", + "operationId": "getNegotiatedRatesHotelsLOV", "parameters": [ { - "name": "type", + "name": "profileId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'type' which is required to fetch EnrollmentMatchCommunicationType LOV" + "description": "Value of the parameter 'profileId' which is required to fetch NegotiatedRatesHotels LOV" + }, + { + "name": "rateCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'rateCode' which is required to fetch NegotiatedRatesHotels LOV" }, { "name": "includeInactiveFlag", @@ -61610,7 +60732,7 @@ } }, "204": { - "description": "EnrollmentMatchCommunicationTypeLOV not found." + "description": "NegotiatedRatesHotelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61660,20 +60782,29 @@ ] } }, - "/listOfValues/type/{type}/folioGroupingCodes": { + "/listOfValues/roleLevel/{roleLevel}/levelCode/{levelCode}/rolesForLevel": { "get": { - "summary": "Return list of values for folio grouping codes", - "description": "Use this API to return the list of values for folio grouping codes based on search criteria such as type, includeInactiveFlag, parameterName, parameterValue.

OperationId:getFolioGroupingCodesLOV

", - "operationId": "getFolioGroupingCodesLOV", + "summary": "Fetch List Of Values for Roles For Level", + "description": "

OperationId:getRolesForLevelLOV

", + "operationId": "getRolesForLevelLOV", "parameters": [ { - "name": "type", + "name": "levelCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'type' which is required to fetch FolioGroupingCodes LOV" + "description": "Value of the parameter 'levelCode' which is required to fetch RolesForLevel LOV" + }, + { + "name": "roleLevel", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'roleLevel' which is required to fetch RolesForLevel LOV" }, { "name": "includeInactiveFlag", @@ -61747,7 +60878,7 @@ } }, "204": { - "description": "FolioGroupingCodesLOV not found." + "description": "RolesForLevelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61797,20 +60928,38 @@ ] } }, - "/listOfValues/type/{type}/revenueBuckets": { + "/listOfValues/roles/{roles}/chainCode/{chainCode}/actionTask/{actionTask}/organizations": { "get": { - "summary": "Return list of values for revenue buckets", - "description": "Use this API to return the list of values for revenue buckets based on search criteria such as type, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRevenueBucketsLOV

", - "operationId": "getRevenueBucketsLOV", + "summary": "Fetch List Of Values for Organizations", + "description": "

OperationId:getOrganizationsLOV

", + "operationId": "getOrganizationsLOV", "parameters": [ { - "name": "type", + "name": "actionTask", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'type' which is required to fetch RevenueBuckets LOV" + "description": "Value of the parameter 'actionTask' which is required to fetch Organizations LOV" + }, + { + "name": "chainCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'chainCode' which is required to fetch Organizations LOV" + }, + { + "name": "roles", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'roles' which is required to fetch Organizations LOV" }, { "name": "includeInactiveFlag", @@ -61884,7 +61033,7 @@ } }, "204": { - "description": "RevenueBucketsLOV not found." + "description": "OrganizationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61934,20 +61083,24 @@ ] } }, - "/listOfValues/type/{type}/trxCodeArrangement": { + "/listOfValues/salesFormat/{salesFormat}/addressFormatElements": { "get": { - "summary": "Return list of values for transaction code arrangements", - "description": "Use this API to return the list of values for transaction code arrangements based on search criteria such as type, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTrxCodeArrangementLOV

", - "operationId": "getTrxCodeArrangementLOV", + "summary": "Fetch List Of Values for Address Format Elements", + "description": "

OperationId:getAddressFormatElementsLOV

", + "operationId": "getAddressFormatElementsLOV", "parameters": [ { - "name": "type", + "name": "salesFormat", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'type' which is required to fetch TrxCodeArrangement LOV" + "description": "Value of the parameter 'salesFormat' which is required to fetch AddressFormatElements LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -62021,7 +61174,7 @@ } }, "204": { - "description": "TrxCodeArrangementLOV not found." + "description": "AddressFormatElementsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -62071,29 +61224,121 @@ ] } }, - "/listOfValues/udfType/{udfType}/udfCategory/{udfCategory}/udfAttributes": { - "get": { - "summary": "Return list of values for user defined field attributes", - "description": "Use this API to return the list of values for user defined field attributes based on search criteria such as udfCategory, udfType, includeInactiveFlag, parameterName, parameterValue.

OperationId:getUdfAttributesLOV

", - "operationId": "getUdfAttributesLOV", + "/listOfValues/searchPostingTransactionCodes": { + "post": { + "summary": "Fetch List Of Values for Posting Transaction Codes", + "description": "

OperationId:searchPostingTransactionCodesLOV

", + "operationId": "searchPostingTransactionCodesLOV", "parameters": [ { - "name": "udfCategory", - "in": "path", + "name": "listOfValuesCriteria", + "in": "body", "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'udfCategory' which is required to fetch UdfAttributes LOV" + "schema": { + "allOf": [ + { + "$ref": "#/definitions/listOfValuesCriteria" + } + ] + } }, { - "name": "udfType", + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "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": [ + "LOV" + ] + } + }, + "/listOfValues/shiftGroupId/{shiftGroupId}/shiftReportsNoParam": { + "get": { + "summary": "Fetch List Of Values for Shift Reports No Param", + "description": "

OperationId:getShiftReportsNoParamLOV

", + "operationId": "getShiftReportsNoParamLOV", + "parameters": [ + { + "name": "shiftGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'udfType' which is required to fetch UdfAttributes LOV" + "description": "Value of the parameter 'shiftGroupId' which is required to fetch ShiftReportsNoParam LOV" }, { "name": "includeInactiveFlag", @@ -62167,7 +61412,7 @@ } }, "204": { - "description": "UdfAttributesLOV not found." + "description": "ShiftReportsNoParamLOV not found." }, "400": { "$ref": "#/responses/400" @@ -62217,20 +61462,20 @@ ] } }, - "/listOfValues/userId/{userId}/croUsers": { + "/listOfValues/siteType/{siteType}/sitePlanSectionTypes": { "get": { - "summary": "Return list of values for cro users", - "description": "Use this API to return the list of values for cro users based on search criteria such as userId, includeInactiveFlag, parameterName, parameterValue.

OperationId:getCroUsersLOV

", - "operationId": "getCroUsersLOV", + "summary": "Fetch List Of Values for Site Plan Section Types", + "description": "

OperationId:getSitePlanSectionTypesLOV

", + "operationId": "getSitePlanSectionTypesLOV", "parameters": [ { - "name": "userId", + "name": "siteType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'userId' which is required to fetch CroUsers LOV" + "description": "Value of the parameter 'siteType' which is required to fetch SitePlanSectionTypes LOV" }, { "name": "includeInactiveFlag", @@ -62304,7 +61549,7 @@ } }, "204": { - "description": "CroUsersLOV not found." + "description": "SitePlanSectionTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -62354,24 +61599,60 @@ ] } }, - "/listOfValues/validate": { - "put": { - "summary": "Validate list of values", - "description": "Use this API to validate the the list of values based on search criteria such as validateListOfValues.

OperationId:validateListOfValues


This API is deprecated.

", - "operationId": "validateListOfValues", - "deprecated": true, + "/listOfValues/sourceId/{sourceId}/globalAlertFieldQuery": { + "get": { + "summary": "Fetch List Of Values for Global Alert Field Query", + "description": "

OperationId:getGlobalAlertFieldQueryLOV

", + "operationId": "getGlobalAlertFieldQueryLOV", "parameters": [ { - "name": "validateListOfValues", - "in": "body", + "name": "sourceId", + "in": "path", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/validateListOfValues" - } - ] - } + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'sourceId' which is required to fetch GlobalAlertFieldQuery LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { "$ref": "#/parameters/authKey" @@ -62397,17 +61678,16 @@ "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": "", "schema": { - "$ref": "#/definitions/validateListOfValuesDetails" + "$ref": "#/definitions/listOfValues" } }, + "204": { + "description": "GlobalAlertFieldQueryLOV not found." + }, "400": { "$ref": "#/responses/400" }, @@ -62456,20 +61736,47 @@ ] } }, - "/listOfValues/view/{view}/traceDateCalc": { + "/listOfValues/sourceIdIn/{sourceIdIn}/fieldType/{fieldType}/fieldName/{fieldName}/tableName/{tableName}/globalAlertOperator": { "get": { - "summary": "Return list of values for trace date calculations", - "description": "Use this API to return the list of values for trace date calculations based on search criteria such as view, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTraceDateCalcLOV

", - "operationId": "getTraceDateCalcLOV", + "summary": "Fetch List Of Values for Global Alert Operator", + "description": "

OperationId:getGlobalAlertOperatorLOV

", + "operationId": "getGlobalAlertOperatorLOV", "parameters": [ { - "name": "view", + "name": "tableName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'view' which is required to fetch TraceDateCalc LOV" + "description": "Value of the parameter 'tableName' which is required to fetch GlobalAlertOperator LOV" + }, + { + "name": "fieldName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'fieldName' which is required to fetch GlobalAlertOperator LOV" + }, + { + "name": "fieldType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'fieldType' which is required to fetch GlobalAlertOperator LOV" + }, + { + "name": "sourceIdIn", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'sourceIdIn' which is required to fetch GlobalAlertOperator LOV" }, { "name": "includeInactiveFlag", @@ -62543,7 +61850,7 @@ } }, "204": { - "description": "TraceDateCalcLOV not found." + "description": "GlobalAlertOperatorLOV not found." }, "400": { "$ref": "#/responses/400" @@ -62593,20 +61900,20 @@ ] } }, - "/listOfValues/view/{view}/traceField": { + "/listOfValues/sourceIdIn/{sourceIdIn}/mailGeneric": { "get": { - "summary": "Return list of values for trace fields", - "description": "Use this API to return the list of values for trace fields based on search criteria such as view, includeInactiveFlag, parameterName, parameterValue.

OperationId:getTraceFieldLOV

", - "operationId": "getTraceFieldLOV", + "summary": "Fetch List Of Values for Mail Generic", + "description": "

OperationId:getMailGenericLOV

", + "operationId": "getMailGenericLOV", "parameters": [ { - "name": "view", + "name": "sourceIdIn", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'view' which is required to fetch TraceField LOV" + "description": "Value of the parameter 'sourceIdIn' which is required to fetch MailGeneric LOV" }, { "name": "includeInactiveFlag", @@ -62680,7 +61987,7 @@ } }, "204": { - "description": "TraceFieldLOV not found." + "description": "MailGenericLOV not found." }, "400": { "$ref": "#/responses/400" @@ -62730,20 +62037,29 @@ ] } }, - "/listOfValues/year/{year}/repCalendarMonths": { + "/listOfValues/stationery/{stationery}/section/{section}/qrMergeCodes": { "get": { - "summary": "Return list of values for rep calendar months", - "description": "Use this API to return the list of values for rep calendar months based on search criteria such as year, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepCalendarMonthsLOV

", - "operationId": "getRepCalendarMonthsLOV", + "summary": "Fetch List Of Values for QrMergeCodes", + "description": "

OperationId:getQrMergeCodesLOV

", + "operationId": "getQrMergeCodesLOV", "parameters": [ { - "name": "year", + "name": "stationery", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'year' which is required to fetch RepCalendarMonths LOV" + "description": "Value of the parameter 'stationery' which is required to fetch QrMergeCodesLOV" + }, + { + "name": "section", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'section' which is required to fetch QrMergeCodesLOV" }, { "name": "includeInactiveFlag", @@ -62817,7 +62133,7 @@ } }, "204": { - "description": "RepCalendarMonthsLOV not found." + "description": "QrMergeCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -62867,20 +62183,20 @@ ] } }, - "/listOfValues/year/{year}/repCalendarWeeks": { + "/listOfValues/stationery/{stationery}/stationerySection": { "get": { - "summary": "Return list of values for rep calendar weeks", - "description": "Use this API to return the list of values for rep calendar weeks based on search criteria such as year, includeInactiveFlag, parameterName, parameterValue.

OperationId:getRepCalendarWeeksLOV

", - "operationId": "getRepCalendarWeeksLOV", + "summary": "Fetch List Of Values for Stationery Section", + "description": "

OperationId:getStationerySectionLOV

", + "operationId": "getStationerySectionLOV", "parameters": [ { - "name": "year", + "name": "stationery", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'year' which is required to fetch RepCalendarWeeks LOV" + "description": "Value of the parameter 'stationery' which is required to fetch StationerySection LOV" }, { "name": "includeInactiveFlag", @@ -62954,7 +62270,7 @@ } }, "204": { - "description": "RepCalendarWeeksLOV not found." + "description": "StationerySectionLOV not found." }, "400": { "$ref": "#/responses/400" @@ -63004,20 +62320,2195 @@ ] } }, - "/listOfValues/year/{year}/statisticsYears": { + "/listOfValues/subscriber/{subscriber}/publisherProperties": { "get": { - "summary": "Return list of values for statistics years", - "description": "Use this API to return the list of values for statistics years based on search criteria such as year, includeInactiveFlag, parameterName, parameterValue.

OperationId:getStatisticsYearsLOV

", - "operationId": "getStatisticsYearsLOV", + "summary": "Fetch List Of Values for Publisher Properties", + "description": "

OperationId:getPublisherPropertiesLOV

", + "operationId": "getPublisherPropertiesLOV", "parameters": [ { - "name": "year", + "name": "subscriber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'year' which is required to fetch StatisticsYears LOV" + "description": "Value of the parameter 'subscriber' which is required to fetch PublisherProperties LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "PublisherPropertiesLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/tableName/{tableName}/interfaceTabColumns": { + "get": { + "summary": "Fetch List Of Values for Interface Tab Columns", + "description": "

OperationId:getInterfaceTabColumnsLOV

", + "operationId": "getInterfaceTabColumnsLOV", + "parameters": [ + { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'tableName' which is required to fetch InterfaceTabColumns LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "InterfaceTabColumnsLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/tableName/{tableName}/traceGroup/{traceGroup}/autoTraceExpressionFields": { + "get": { + "summary": "Fetch List Of Values for Auto Trace Expression Fields", + "description": "

OperationId:getAutoTraceExpressionFieldsLOV

", + "operationId": "getAutoTraceExpressionFieldsLOV", + "parameters": [ + { + "name": "traceGroup", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'traceGroup' which is required to fetch AutoTraceExpressionFields LOV" + }, + { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'tableName' which is required to fetch AutoTraceExpressionFields LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "AutoTraceExpressionFieldsLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/templateCode/{templateCode}/templateFiscalFolioParameters": { + "get": { + "summary": "Fetch List Of Values for Template Fiscal Folio Parameters", + "description": "

OperationId:getTemplateFiscalFolioParametersLOV

", + "operationId": "getTemplateFiscalFolioParametersLOV", + "parameters": [ + { + "name": "templateCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'templateCode' which is required to fetch TemplateFiscalFolioParameters LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "TemplateFiscalFolioParametersLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/type/{type}/arrangementCodesNumber": { + "get": { + "summary": "Fetch List Of Values for Arrangement Codes Number", + "description": "

OperationId:getArrangementCodesNumberLOV

", + "operationId": "getArrangementCodesNumberLOV", + "parameters": [ + { + "name": "type", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'type' which is required to fetch ArrangementCodesNumber LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "ArrangementCodesNumberLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/type/{type}/enrollmentMatchCommunicationType": { + "get": { + "summary": "Fetch List Of Values for Enrollment Match Communication Type", + "description": "

OperationId:getEnrollmentMatchCommunicationTypeLOV

", + "operationId": "getEnrollmentMatchCommunicationTypeLOV", + "parameters": [ + { + "name": "type", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'type' which is required to fetch EnrollmentMatchCommunicationType LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "EnrollmentMatchCommunicationTypeLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/type/{type}/folioGroupingCodes": { + "get": { + "summary": "Fetch List Of Values for Folio Grouping Codes", + "description": "

OperationId:getFolioGroupingCodesLOV

", + "operationId": "getFolioGroupingCodesLOV", + "parameters": [ + { + "name": "type", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'type' which is required to fetch FolioGroupingCodes LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "FolioGroupingCodesLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/type/{type}/revenueBuckets": { + "get": { + "summary": "Fetch List Of Values for Revenue Buckets", + "description": "

OperationId:getRevenueBucketsLOV

", + "operationId": "getRevenueBucketsLOV", + "parameters": [ + { + "name": "type", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'type' which is required to fetch RevenueBuckets LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "RevenueBucketsLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/type/{type}/trxCodeArrangement": { + "get": { + "summary": "Fetch List Of Values for Trx Code Arrangement", + "description": "

OperationId:getTrxCodeArrangementLOV

", + "operationId": "getTrxCodeArrangementLOV", + "parameters": [ + { + "name": "type", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'type' which is required to fetch TrxCodeArrangement LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "TrxCodeArrangementLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/udfType/{udfType}/udfCategory/{udfCategory}/udfAttributes": { + "get": { + "summary": "Fetch List Of Values for Udf Attributes", + "description": "

OperationId:getUdfAttributesLOV

", + "operationId": "getUdfAttributesLOV", + "parameters": [ + { + "name": "udfCategory", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'udfCategory' which is required to fetch UdfAttributes LOV" + }, + { + "name": "udfType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'udfType' which is required to fetch UdfAttributes LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "UdfAttributesLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/userId/{userId}/croUsers": { + "get": { + "summary": "Fetch List Of Values for Cro Users", + "description": "

OperationId:getCroUsersLOV

", + "operationId": "getCroUsersLOV", + "parameters": [ + { + "name": "userId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'userId' which is required to fetch CroUsers LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "CroUsersLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/validate": { + "put": { + "summary": "Validate List Of Values", + "description": "

OperationId:validateListOfValues


This API is deprecated.

", + "operationId": "validateListOfValues", + "deprecated": true, + "parameters": [ + { + "name": "validateListOfValues", + "in": "body", + "required": true, + "schema": { + "allOf": [ + { + "$ref": "#/definitions/validateListOfValues" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/validateListOfValuesDetails" + } + }, + "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": [ + "LOV" + ] + } + }, + "/listOfValues/view/{view}/traceDateCalc": { + "get": { + "summary": "Fetch List Of Values for Trace Date Calc", + "description": "

OperationId:getTraceDateCalcLOV

", + "operationId": "getTraceDateCalcLOV", + "parameters": [ + { + "name": "view", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'view' which is required to fetch TraceDateCalc LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "TraceDateCalcLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/view/{view}/traceField": { + "get": { + "summary": "Fetch List Of Values for Trace Field", + "description": "

OperationId:getTraceFieldLOV

", + "operationId": "getTraceFieldLOV", + "parameters": [ + { + "name": "view", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'view' which is required to fetch TraceField LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "TraceFieldLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/year/{year}/repCalendarMonths": { + "get": { + "summary": "Fetch List Of Values for Rep Calendar Months", + "description": "

OperationId:getRepCalendarMonthsLOV

", + "operationId": "getRepCalendarMonthsLOV", + "parameters": [ + { + "name": "year", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'year' which is required to fetch RepCalendarMonths LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "RepCalendarMonthsLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/year/{year}/repCalendarWeeks": { + "get": { + "summary": "Fetch List Of Values for Rep Calendar Weeks", + "description": "

OperationId:getRepCalendarWeeksLOV

", + "operationId": "getRepCalendarWeeksLOV", + "parameters": [ + { + "name": "year", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'year' which is required to fetch RepCalendarWeeks LOV" + }, + { + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "RepCalendarWeeksLOV 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": [ + "LOV" + ] + } + }, + "/listOfValues/year/{year}/statisticsYears": { + "get": { + "summary": "Fetch List Of Values for Statistics Years", + "description": "

OperationId:getStatisticsYearsLOV

", + "operationId": "getStatisticsYearsLOV", + "parameters": [ + { + "name": "year", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'year' which is required to fetch StatisticsYears LOV" }, { "name": "includeInactiveFlag", @@ -63143,8 +64634,8 @@ }, "/listOfValues/{name}": { "get": { - "summary": "Return list of values for the given name of the LOV", - "description": "Use this API to return the list of values for the given name of the LOV based on search criteria such as name, includeInactiveFlag, parameterName, parameterValue.

OperationId:getListOfValues

", + "summary": "Fetch List Of Values for the given name of the LOV", + "description": "

OperationId:getListOfValues

", "operationId": "getListOfValues", "parameters": [ { @@ -63260,6 +64751,7 @@ "CardTypes", "CardTypesIfc", "CashierShiftDropLocations", + "CashierStartingAmountCurrencyCodes", "CashieringTransactionTypes", "Cashiers", "CashiersConfig", @@ -63308,6 +64800,7 @@ "CompositeResvStatuses", "ConfigModes", "ConfigTitles", + "ConsumableItemsMultiHotel", "ContactMethod", "Container", "ContractBillingInstructions", @@ -64011,99 +65504,10 @@ ] } }, - "/services/listOfValues/cache": { - "delete": { - "summary": "Delete list of values service cache", - "description": "Use this API to delete the the list of values service cache.

OperationId:deleteLOVServiceCache

", - "operationId": "deleteLOVServiceCache", - "parameters": [ - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$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": [ - "LOV" - ] - } - }, "/services/listOfValues/status": { "get": { - "summary": "Ping list of values service version", - "description": "Use this API to return the the list of values service version.

OperationId:pingLOVService

", + "summary": "Retrieve List of Values Service Version", + "description": "

OperationId:pingLOVService

", "operationId": "pingLOVService", "parameters": [ { @@ -64607,6 +66011,12 @@ }, "active": { "type": "boolean" + }, + "imageURL": { + "type": "string", + "description": "The URL where the images are stored.", + "minLength": 0, + "maxLength": 2000 } } }, @@ -64737,25 +66147,27 @@ } } }, - "status": { + "operaVersion": { "type": "object", - "description": "Response Body.", + "description": "Response for Ping operation.", "properties": { - "warnings": { - "$ref": "#/definitions/warningsType" + "operaVersion": { + "description": "Current Opera Version Number", + "type": "string" }, "links": { "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "operaVersion": { + "listOfValuesCriteria": { "type": "object", - "description": "Response for Ping operation.", "properties": { - "operaVersion": { - "description": "Current Opera Version Number", - "type": "string" + "criteria": { + "$ref": "#/definitions/listOfValuesCriteriaType" }, "links": { "$ref": "#/definitions/links" diff --git a/rest-api-specs/property/medcfg.json b/rest-api-specs/property/medcfg.json index 6010cef..cd26c4e 100644 --- a/rest-api-specs/property/medcfg.json +++ b/rest-api-specs/property/medcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Content Service", - "description": "Opera Content Service offers capability to manage large content such as images and files.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "Opera Content Service offers capability to manage large content such as images and files.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/ops.json b/rest-api-specs/property/ops.json index b73dea9..d5bf1a0 100644 --- a/rest-api-specs/property/ops.json +++ b/rest-api-specs/property/ops.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Provisioning Service API", - "description": "APIs to cater to provisioning and deprovisioning of new properties and chains in OPERA.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater to provisioning and deprovisioning of new properties and chains in OPERA.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/outbound/crmoutbound.json b/rest-api-specs/property/outbound/crmoutbound.json index 188848d..381078d 100644 --- a/rest-api-specs/property/outbound/crmoutbound.json +++ b/rest-api-specs/property/outbound/crmoutbound.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Customer Relationship Management Outbound API", - "description": "APIs to cater for Customer Relationship Management external (outbound) functionality with OPERA. These APIs facilitate various operations related to getting data from an external system, and inserting it into OPERA.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Customer Relationship Management external (outbound) functionality with OPERA. These APIs facilitate various operations related to getting data from an external system, and inserting it into OPERA.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -1779,6 +1779,42 @@ "schema": { "$ref": "#/definitions/award" } + }, + "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": [ @@ -1860,6 +1896,42 @@ "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": [ @@ -1987,6 +2059,42 @@ }, "204": { "description": "MembershipDetails 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": [ @@ -2061,6 +2169,42 @@ }, "204": { "description": "ValidatedAddresses 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": [ @@ -2123,6 +2267,42 @@ }, "204": { "description": "ValidatedAddress 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": [ @@ -2208,6 +2388,42 @@ }, "204": { "description": "validateMembershipNumber 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": [ diff --git a/rest-api-specs/property/outbound/cshoutbound.json b/rest-api-specs/property/outbound/cshoutbound.json index 3a970d8..3ca7880 100644 --- a/rest-api-specs/property/outbound/cshoutbound.json +++ b/rest-api-specs/property/outbound/cshoutbound.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Cashiering Outbound API", - "description": "APIs to cater for Cashiering related external (outbound) functionality with OPERA. These APIs facilitate various operations related to getting data from an external system, and inserting it into OPERA.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Cashiering related external (outbound) functionality with OPERA. These APIs facilitate various operations related to getting data from an external system, and inserting it into OPERA.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -296,6 +296,42 @@ "schema": { "$ref": "#/definitions/postCompRedemptionsRS" } + }, + "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": [ @@ -374,6 +410,42 @@ "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": [ @@ -443,6 +515,42 @@ "schema": { "$ref": "#/definitions/sendBulkCompTransactionsStatus" } + }, + "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": [ @@ -512,6 +620,42 @@ "schema": { "$ref": "#/definitions/sendCompTransactionsStatus" } + }, + "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": [ @@ -581,6 +725,42 @@ "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": [ diff --git a/rest-api-specs/property/outbound/fofoutbound.json b/rest-api-specs/property/outbound/fofoutbound.json index 5c73216..2f25561 100644 --- a/rest-api-specs/property/outbound/fofoutbound.json +++ b/rest-api-specs/property/outbound/fofoutbound.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Front Desk Operations Outbound API", - "description": "APIs to cater for Front Desk related external (outbound) functionality with OPERA Cloud. These APIs facilitate various operations related to getting data from an external system, and inserting it into OPERA Cloud.

Compatible with OPERA Cloud release 23.3.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, 2024 Oracle and/or its affiliates.

", - "version": "23.3.0.0", + "description": "APIs to cater for Front Desk related external (outbound) functionality with OPERA Cloud. These APIs facilitate various operations related to getting data from an external system, and inserting it into OPERA Cloud.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -26,6 +26,7 @@ "summary": "Requests room key(s)", "description": "API that manages requests for Door Lock Room Keys. This operation is used by OPERA Cloud connected to external Door Lock Systems systems via Outbound Systems configuration: \n\nOPERA Cloud utilizes this operation \n\n- to request new or additional room keys - e.g. when guest checks in, or additional keys post check in.\n\n- to request to activate new keys after check on e.g. when a room key has been lost for a room.\n\n- to request a room key which is not related to a guest reservation but valid for a defined time - (for show rooms, repair) - One Shot Key.\n\n- to request to re-encode a key whereby other keys for this room remain active.\n\n- to request to read a key data from a room key and display it to the user in the PMS.\n\n- to request to modify existing key data - upon room move or change of departure date. (online key systems only!!)\n\n- to request to remove / delete a room key from a room on. Usually sent with check out of a reservation.\n\nUse this API to post a room key action to the active Door Lock System.\n\nNotes on keyType values:\n\nkeyType = New\n\nkeyType = Lost \n\nIt is expected that all previous active keys for the room will become invalid.\n\nIt is expected that partner system handles multiple keys being active in case numberOfKeys is >1.\n\nkeyType = Duplicate\n\nkeyType = ReEncode\n\nIt is expected that existing active keys for this room remain active.\n\nkeyType = OneShot\n\nIt is expected that the room key is only valid for a room for specific time (for maintenance or Show room).\n\nIt is never related to a reservation.\n\nkeyType = Read A request to the Key Card system to read Key Card information from requested Key Encoder/reader.\n\nThe Key Read functionality is of pure informational purpose. None of the received information is stored or processed in the PMS, and it is only for display to the user.\n\nkeyType = Remove\n\nIt is expected that with this request all active keys for a room or reservation will become inactive or invalid so they will not be able to open the room after defined validityEnd time.\n\nAdditional KeyType actions used by Online Door Lock Systems:\n\nOnline Key card Systems are systems which do not write guest data to the room key directly but do store guest data internally and send the information to the related door lock.\n\nkeyType = ModifyStay\n\nFor Online Door Lock Systems - Request to adjust Room key data when guest changes length of stay (validityEnd)\n\nkeyType = RoomMove\n\nFor Online Door Lock Systems - adjust Room key data when guest performs room move. \n\n

OperationId: postExternalRoomKeys

", "operationId": "postExternalRoomKeys", + "deprecated": true, "parameters": [ { "name": "hotelId", @@ -70,6 +71,140 @@ "schema": { "$ref": "#/definitions/roomKeyExternalDetails" } + }, + "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": [ + "FrontOfficeExternal" + ] + } + }, + "/hotels/{hotelId}/roomKeysOutbound": { + "post": { + "summary": "Requests room key(s)", + "description": "API that manages requests for Door Lock Room Keys. This operation is used by OPERA Cloud connected to external Door Lock Systems systems via Outbound Systems configuration: \n\nOPERA Cloud utilizes this operation \n\n- to request new or additional room keys - e.g. when guest checks in, or additional keys post check in.\n\n- to request to activate new keys after check on e.g. when a room key has been lost for a room.\n\n- to request a room key which is not related to a guest reservation but valid for a defined time - (for show rooms, repair) - One Shot Key.\n\n- to request to re-encode a key whereby other keys for this room remain active.\n\n- to request to read a key data from a room key and display it to the user in the PMS.\n\n- to request to modify existing key data - upon room move or change of departure date. (online key systems only!!)\n\n- to request to remove / delete a room key from a room on. Usually sent with check out of a reservation.\n\nUse this API to post a room key action to the active Door Lock System.\n\nNotes on keyType values:\n\nkeyType = New\n\nkeyType = Lost \n\nIt is expected that all previous active keys for the room will become invalid.\n\nIt is expected that partner system handles multiple keys being active in case numberOfKeys is >1.\n\nkeyType = Duplicate\n\nkeyType = ReEncode\n\nIt is expected that existing active keys for this room remain active.\n\nkeyType = OneShot\n\nIt is expected that the room key is only valid for a room for specific time (for maintenance or Show room).\n\nIt is never related to a reservation.\n\nkeyType = Read A request to the Key Card system to read Key Card information from requested Key Encoder/reader.\n\nThe Key Read functionality is of pure informational purpose. None of the received information is stored or processed in the PMS, and it is only for display to the user.\n\nkeyType = Remove\n\nIt is expected that with this request all active keys for a room or reservation will become inactive or invalid so they will not be able to open the room after defined validityEnd time.\n\nAdditional KeyType actions used by Online Door Lock Systems:\n\nOnline Key card Systems are systems which do not write guest data to the room key directly but do store guest data internally and send the information to the related door lock.\n\nkeyType = ModifyStay\n\nFor Online Door Lock Systems - Request to adjust Room key data when guest changes length of stay (validityEnd)\n\nkeyType = RoomMove\n\nFor Online Door Lock Systems - adjust Room key data when guest performs room move. \n\n

OperationId: postRoomKeysOutbound

", + "operationId": "postRoomKeysOutbound", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel" + }, + { + "name": "roomKey", + "in": "body", + "required": true, + "description": "Request for generation of room key.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/roomKeysOutbound" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + } + ], + "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" + } + }, + "description": "Response from the active Door Locking System Property Interface to the post request.

Note on Response messages:\n\nIt is necessary to specify both the PMS 'encoderTerminal' and the Key Service system's coder (encoderId) in cases where more than one PMS workstation may be addressing one key coder. ORACLE PMS will NOT send another Request command automatically should a negative response be received. The user sees the response and decides if another try should be made.

", + "schema": { + "$ref": "#/definitions/roomKeysOutboundDetails" + } + }, + "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": [ @@ -363,6 +498,89 @@ "RY" ] }, + "keyOptionsType": { + "type": "object", + "description": "This contains code and description information for key options.", + "properties": { + "keyOptionsCode": { + "description": "key options code.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "keyOptionDescription": { + "description": "key options description.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "keyOptionsResponseType": { + "type": "object", + "description": "This contains code and description information for key options.", + "properties": { + "keyOptionsCode": { + "description": "key options code.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "keyOptionDescription": { + "description": "key options description.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "isEnabled": { + "description": "Indicates that the keyOption is enabled for this key.", + "type": "boolean" + }, + "default": { + "description": "Indicates that this keyOption is a default access.", + "type": "boolean" + } + } + }, + "externalRoomKeyType": { + "type": "string", + "description": "Simple type for representing room key request type. 'HardKey' = request for physical key card with RFID; 'MobileKey' = request for mobile key (no physical key); 'PinCode' = request for PinCode; 'KeyPayload' = request Key image from DLS System", + "enum": [ + "HardKey", + "MobileKey", + "PinCode", + "KeyPayload" + ] + }, + "keyUserType": { + "type": "string", + "description": "Simple type for representing key user type. 'Guest' = request Opera Guest room key", + "enum": [ + "Guest" + ] + }, + "printDataType": { + "type": "object", + "description": "Lists the text, file or picture to print onto a Guest room key (only for roomKeyType is HardKey).", + "properties": { + "printText": { + "description": "key options code.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "printFile": { + "description": "Base64 format of file representing data to print.", + "type": "string", + "format": "byte" + }, + "printPicture": { + "description": "Base64 format of picture representing data to print.", + "type": "string", + "format": "byte" + } + } + }, "warningsType": { "type": "array", "description": "Used in conjunction with the Success element to define a business error.", @@ -531,6 +749,131 @@ "encoderId" ] }, + "roomKeysOutbound": { + "type": "object", + "description": "Request for generation of room key used for OutBound.", + "properties": { + "encoderId": { + "type": "string", + "description": "Unique Id as defined by Door Lock System.", + "minLength": 1, + "maxLength": 2000 + }, + "encoderTerminal": { + "type": "string", + "description": "The Unique PMS encoder name linked with the encoderId", + "minLength": 1, + "maxLength": 2000 + }, + "roomId": { + "description": "The PMS room number to generate a key for.", + "type": "string", + "maxLength": 2000 + }, + "oldRoomId": { + "description": "Old Room Number is used when a room move (keyType RoomMove) is performed.", + "type": "string", + "maxLength": 2000 + }, + "noOfKeys": { + "type": "integer", + "description": "Number of keys to be created.", + "minimum": 1, + "maximum": 1 + }, + "reservationIdList": { + "description": "Collection of unique reservation identifiers for the reservation we are trying to make a room key for.", + "$ref": "#/definitions/uniqueIDListType" + }, + "guestShareFlag": { + "type": "boolean", + "description": "Indicates if Guest is a sharer or not" + }, + "OldGuestShareFlag": { + "type": "boolean", + "description": "Indicates if old Guest room is a sharer or not when a room move (keyType RoomMove) is performed." + }, + "keyValidityStart": { + "type": "string", + "description": "The date/time the room key is valid from.", + "format": "date-time" + }, + "keyValidityEnd": { + "type": "string", + "description": "The date/time the room key is valid to.", + "format": "date-time" + }, + "keyType": { + "$ref": "#/definitions/roomKeyOutBoundType" + }, + "keyTrack": { + "description": "KeyTrack Data.", + "$ref": "#/definitions/keyTrackType" + }, + "additionalRooms": { + "description": "Collection of additional rooms to be included in key creation of reservation room.", + "type": "array", + "maxItems": 999, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "oldAdditionalRooms": { + "description": "Collection of old additional rooms in key creation of reservation room when a room move (keyType RoomMove) is performed.", + "type": "array", + "maxItems": 999, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "userId": { + "type": "string", + "description": "Unique identifier for the PMS user.", + "maxLength": 2000 + }, + "keyOptions": { + "description": "Lists the access areas defined in PMS valid for the room key.", + "type": "array", + "maxItems": 1000, + "items": { + "$ref": "#/definitions/keyOptionsType" + } + }, + "keyRequestTime": { + "type": "string", + "description": "The date/time the room key is requested.", + "format": "date-time" + }, + "roomKeyType": { + "$ref": "#/definitions/externalRoomKeyType" + }, + "keyUserType": { + "$ref": "#/definitions/keyUserType" + }, + "cardSerialNumber": { + "description": "Unique identifier of RFID card used for KeyPayload generation. Required when roomKeyType is KeyPayload.", + "type": "string", + "maxLength": 80 + }, + "printData": { + "description": "Lists the text, file or picture to print onto a Guest room key (only for roomKeyType is HardKey).", + "type": "object", + "$ref": "#/definitions/printDataType" + } + }, + "required": [ + "keyType", + "encoderTerminal", + "encoderId", + "roomKeyType", + "keyUserType", + "keyRequestTime" + ] + }, "roomKeyExternalDetails": { "type": "object", "description": "Response for the key request made to DLS from OPERA Cloud.", @@ -601,6 +944,120 @@ "responseCode", "encoderTerminal" ] + }, + "roomKeysOutboundDetails": { + "type": "object", + "description": "Response for the key request made to DLS from OPERA Cloud.", + "properties": { + "encoderId": { + "type": "string", + "description": "Unique Id as defined by Door Lock System.", + "maxLength": 2000 + }, + "encoderTerminal": { + "type": "string", + "description": "The Unique PMS encoder name linked with the encoderId", + "minLength": 1, + "maxLength": 2000 + }, + "reservationIdList": { + "description": "Collection of unique reservation identifiers for the reservation we are trying to make a room key for.", + "$ref": "#/definitions/uniqueIDListType" + }, + "roomId": { + "description": "The PMS room number to generate a key for.", + "type": "string", + "maxLength": 2000 + }, + "keyTrack": { + "description": "KeyTrack Data.", + "type": "array", + "items": { + "$ref": "#/definitions/keyTrackType" + } + }, + "keyValidityStart": { + "type": "string", + "description": "Date/Time Key is valid from - only send in response for keyType: 'Read' request", + "format": "date-time" + }, + "keyValidityEnd": { + "type": "string", + "description": "Date/Time Key is valid to - only send in response for keyType: 'Read' request", + "format": "date-time" + }, + "noOfKeys": { + "type": "integer", + "description": "Number of keys to be created.The value is always 1" + }, + "responseText": { + "type": "string", + "description": "A user-friendly text with information on why a request is not successful", + "maxLength": 2000 + }, + "responseCode": { + "$ref": "#/definitions/roomKeyResponseCodeType" + }, + "additionalRooms": { + "description": "Collection of additional rooms to be included in key creation of reservation room.", + "type": "array", + "maxItems": 999, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "keyOptions": { + "description": "Lists all PMS access areas.", + "type": "array", + "maxItems": 1000, + "items": { + "$ref": "#/definitions/keyOptionsResponseType" + } + }, + "userId": { + "type": "string", + "description": "Unique identifier for the PMS user.", + "maxLength": 2000 + }, + "digitalKeyData": { + "description": "Base64 format of Mobile Key data provided by DLS System which the external system requested - only send in response for roomKeyType: 'MobileKey'", + "type": "string", + "format": "byte" + }, + "keyImage": { + "description": "Image of the created key - only send in response for roomKeyType: 'KeyPayload'", + "type": "string", + "format": "byte" + }, + "cardSerialNumber": { + "description": "Unique identifier of RFID card used for KeyPayload generation - only send in response for roomKeyType: 'KeyPayload'.", + "type": "string", + "maxLength": 80 + }, + "keyCreationTime": { + "type": "string", + "description": "Date/Time the key has been generated by Door Locking system.", + "format": "date-time" + }, + "roomKeyType": { + "$ref": "#/definitions/externalRoomKeyType" + }, + "keyUserType": { + "$ref": "#/definitions/keyUserType" + } + }, + "required": [ + "roomId", + "responseCode", + "encoderTerminal", + "roomKeyType", + "keyUserType", + "keyValidityStart", + "keyValidityEnd", + "keyCreationTime" + ] } }, "tags": [ diff --git a/rest-api-specs/property/par.json b/rest-api-specs/property/par.json index c520b2f..a92ffc6 100644 --- a/rest-api-specs/property/par.json +++ b/rest-api-specs/property/par.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Price Availability Rate API", - "description": "APIs to cater for Price and Rate Availability functionality in OPERA Cloud.

Availability enables you to manage your room inventory by providing a detailed view of all available and sold rooms at a property. Some of the tasks you can perform include defining conditions for stay restrictions, setting room sell limits, and searching for and viewing room availability.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Price and Rate Availability functionality in OPERA Cloud.

Availability enables you to manage your room inventory by providing a detailed view of all available and sold rooms at a property. Some of the tasks you can perform include defining conditions for stay restrictions, setting room sell limits, and searching for and viewing room availability.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/parasync.json b/rest-api-specs/property/parasync.json index 3a4453d..f4450c9 100644 --- a/rest-api-specs/property/parasync.json +++ b/rest-api-specs/property/parasync.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Price Availability Rate Async API", - "description": "APIs to cater for Price and Rate Availability Asynchronous functionality in OPERA Cloud.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Price and Rate Availability Asynchronous functionality in OPERA Cloud.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/repcfg.json b/rest-api-specs/property/repcfg.json index ad07b4f..ec42002 100644 --- a/rest-api-specs/property/repcfg.json +++ b/rest-api-specs/property/repcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Report Master Data Management API", - "description": "APIs for adding, updating, and deleting stationery reports in OPERA Cloud.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs for adding, updating, and deleting stationery reports in OPERA Cloud.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -21,21 +21,21 @@ "application/json" ], "paths": { - "/reportTextConfiguration/copy": { - "put": { - "summary": "Operation to copy report text configuration.", - "description": "

OperationId:copyReportTextConfiguration

", - "operationId": "copyReportTextConfiguration", + "/genericReports": { + "post": { + "summary": "Create generic reports.", + "description": "Use this API to create generic reports.

OperationId:postGenericReports

", + "operationId": "postGenericReports", "parameters": [ { - "name": "reportTextConfigurationsCopy", + "name": "genericReports", "in": "body", "required": true, - "description": "Request object to copy the Report Text Configuration from Source Property to Destination Properties.", + "description": "This request provides End of Day reports to be created.", "schema": { "allOf": [ { - "$ref": "#/definitions/reportTextConfigurationsCopy" + "$ref": "#/definitions/genericReports" } ] } @@ -57,7 +57,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -70,7 +70,7 @@ "description": "Location of newly created resource" } }, - "description": "Response Body.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } @@ -121,358 +121,1775 @@ "tags": [ "Report" ] - } - } - }, - "parameters": { - "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-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": 80, - "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": { - "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" + }, + "delete": { + "summary": "Delete generic reports.", + "description": "Use this API to delete generic reports based on hotelId, Id, contextId.

OperationId:deleteGenericReports

", + "operationId": "deleteGenericReports", + "parameters": [ + { + "name": "hotelId", + "minLength": 0, + "maxLength": 2000, + "in": "query", + "required": false, + "type": "string", + "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." + }, + { + "name": "id", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "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.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "idContext", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "type", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).", + "items": { + "type": "string" + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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" } }, - "links": { - "$ref": "#/definitions/links" - } + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "Report" + ] }, - "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": { + "put": { + "summary": "Update generic reports.", + "description": "Use this API to update generic reports.

OperationId:changeGenericReports

", + "operationId": "changeGenericReports", + "parameters": [ + { + "name": "genericReports", + "in": "body", + "required": true, + "description": "This request provides generic reports to be updated.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/genericReports" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "This response provides the result of updating reports.", + "schema": { + "$ref": "#/definitions/genericReports" + } + }, + "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": [ + "Report" + ] + } + }, + "/reportParameters": { + "get": { + "summary": "Return report parameters.", + "description": "Use this API to return report parameters based on search criteria such as id, idContext, type.

OperationId:getReportParameters

", + "operationId": "getReportParameters", + "parameters": [ + { + "name": "id", + "minLength": 0, + "maxLength": 80, + "in": "query", + "required": false, + "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" + }, + { + "name": "idContext", + "minLength": 0, + "maxLength": 80, + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" + }, + { + "name": "type", + "minLength": 0, + "maxLength": 80, + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "The Fetch Report Parameters result object contains a collection of report parameters which allow/require user input prior to running the report.", + "schema": { + "$ref": "#/definitions/reportParameters" + } + }, + "204": { + "description": "ReportParameters 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": [ + "Report" + ] + } + }, + "/reportTextConfiguration/copy": { + "put": { + "summary": "Operation to copy report text configuration.", + "description": "

OperationId:copyReportTextConfiguration

", + "operationId": "copyReportTextConfiguration", + "parameters": [ + { + "name": "reportTextConfigurationsCopy", + "in": "body", + "required": true, + "description": "Request object to copy the Report Text Configuration from Source Property to Destination Properties.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/reportTextConfigurationsCopy" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": [ + "Report" + ] + } + }, + "/reports": { + "get": { + "summary": "Return reports.", + "description": "Use this API to return reports based on search criteria such as excludeGroup, includeInternalReports, includeRnAReports, includeUnpublished, includeWatermarkDetails, limit, multiPropertyOnly, protectedReportParam, scheduled, name, group, hotel, id, idContext, type.

OperationId:getReports

", + "operationId": "getReports", + "parameters": [ + { + "name": "excludeGroup", + "minLength": 0, + "maxLength": 2000, + "in": "query", + "required": false, + "description": "Indicates whether a report group should be excluded", + "type": "string" + }, + { + "name": "includeInternalReports", + "in": "query", + "required": false, + "description": "Indicates whether sample internal reports are to be included", + "type": "boolean" + }, + { + "name": "includeRnAReports", + "in": "query", + "required": false, + "description": "Indicates whether RnA reports are to be included", + "type": "boolean" + }, + { + "name": "includeUnpublished", + "in": "query", + "required": false, + "description": "Indicates whether protected reports should be included", + "type": "boolean" + }, + { + "name": "includeWatermarkDetails", + "in": "query", + "required": false, + "description": "Indicates whether the watermark details is to be populated. This is needed only for the configuration and not for the actual execution.", + "type": "boolean" + }, + { + "name": "limit", + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" + }, + { + "name": "multiPropertyOnly", + "in": "query", + "required": false, + "description": "Indicates whether the result set should only include multi-property reports.", + "type": "boolean" + }, + { + "name": "protectedReportParam", + "in": "query", + "required": false, + "description": "Indicates whether protected reports should be included", + "type": "boolean" + }, + { + "name": "scheduled", + "in": "query", + "required": false, + "description": "Indicates that only reports that can be scheduled are included", + "type": "boolean" + }, + { + "name": "name", + "minLength": 0, + "maxLength": 2000, + "in": "query", + "required": false, + "description": "Partial report name or description to search.", + "type": "string" + }, + { + "name": "group", + "minLength": 0, + "maxLength": 2000, + "in": "query", + "required": false, + "description": "Report group to limit search.", + "type": "string" + }, + { + "name": "hotel", + "minLength": 0, + "maxLength": 2000, + "in": "query", + "required": false, + "description": "Hotel code to search reports for.", + "type": "string" + }, + { + "name": "id", + "minLength": 0, + "maxLength": 80, + "in": "query", + "required": false, + "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" + }, + { + "name": "idContext", + "minLength": 0, + "maxLength": 80, + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" + }, + { + "name": "type", + "minLength": 0, + "maxLength": 80, + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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": "This type contains a collection of report modules which match the requested criteria. The object also may include a standard SUCCESS element or a WARNINGS or ERRORS collection.", + "schema": { + "$ref": "#/definitions/reports" + } + }, + "204": { + "description": "Reports 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": [ + "Report" + ] + } + } + }, + "parameters": { + "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-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": 80, + "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": { + "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": { + "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" + ] + }, + "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" + } + }, + "required": [ + "href", + "rel", + "method", + "operationId" + ] + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/instanceLink" + } + }, + "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 + } + } + }, + "status": { + "type": "object", + "description": "Response Body.", + "properties": { + "warnings": { + "$ref": "#/definitions/warningsType" + }, + "links": { + "$ref": "#/definitions/links" + } + } + }, + "copyReportsType": { + "type": "object", + "description": "Copy report configuration code from one property to the other.", + "properties": { + "codes": { + "description": "List of Code that is to be copied.", + "$ref": "#/definitions/codeListType" + }, + "targetHotelCodes": { + "description": "Property to which configuration code type to be copied to.", + "$ref": "#/definitions/codeListType" + }, + "sourceHotelCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "codeListType": { + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "reportTextConfigurationsCopy": { + "type": "object", + "description": "Request object to copy the Report Text Configurations from Source Property to Destination Properties.", + "properties": { + "copyReports": { + "description": "List of Report type to copy", + "$ref": "#/definitions/copyReportsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "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 + } + } + }, + "reportsType": { + "type": "object", + "description": "Contains a collection of reports matching the requested criteria.", + "properties": { + "reports": { + "description": "List of reports matching search criteria.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reportType" + } + }, + "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" + } + } + }, + "reportType": { + "type": "object", + "description": "Contains details about the report application module from the DB.", + "properties": { + "moduleId": { + "description": "Report module ID (table key).", + "$ref": "#/definitions/uniqueID_Type" + }, + "reportName": { + "description": "Report name.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "moduleType": { + "description": "Module type either RTF,GRP,SFT,URL,RNA or REP.", + "$ref": "#/definitions/reportModuleTypeType" + }, + "reportDescription": { + "description": "Report description.", + "$ref": "#/definitions/translationTextType1000" + }, + "reportGroupId": { + "description": "Report group module ID.", + "$ref": "#/definitions/uniqueID_Type" + }, + "reportGroup": { + "description": "Report group.", + "type": "string", + "minLength": 0, + "maxLength": 1000 + }, + "attachedReports": { + "description": "List of Reports attached with the Shift Report group.", + "$ref": "#/definitions/uniqueIDListType" + }, + "reportGroupDescription": { + "type": "string", + "minLength": 0, + "maxLength": 1000 + }, + "translatableReportGroupDescription": { + "description": "Translatable Name of the Report Group Description.", + "$ref": "#/definitions/translationTextType1000" + }, + "hotel": { + "description": "The hotel code that the report is associated with.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "formToRun": { + "description": "Form which is run to collect parameter information to generate the report.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "languageCode": { + "description": "Report language code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hasParameters": { + "description": "Flag which indicates whether the report requires parameters.", + "type": "boolean" + }, + "sample": { + "description": "Flag which indicates whether the report is a sample provided in the application.", + "type": "boolean" + }, + "customized": { + "description": "Flag which indicates whether the report is customized by the user.", + "type": "boolean" + }, + "customizedRtfAttachId": { + "description": "Customized RTF file's Attach ID in the database.", + "$ref": "#/definitions/uniqueID_Type" + }, + "canRunSeperate": { + "description": "Flag which indicates if the report can be run separately.", + "type": "boolean" + }, + "multiPropertyReport": { + "description": "Flag which indicates if the report can be run for multiple properties.", + "type": "boolean" + }, + "procedureRequired": { + "description": "Flag which indicates whether the report requires a procedure.", + "type": "boolean" + }, + "userDefinedReport": { + "description": "Flag which indicates whether the report is user defined.", + "type": "boolean" + }, + "protectedReport": { + "description": "Flag which indicates whether the report is protected.", + "type": "boolean" + }, + "systemReport": { + "description": "Flag to indicate whether this is a system report.", + "type": "boolean" + }, + "destination": { + "description": "Report default destination.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "defaultPrinterName": { + "description": "Default printer name.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "copies": { + "description": "Number of copies configured for report.", + "type": "integer" + }, + "shiftReport": { + "description": "Flag to indicate whether this is a shift report.", + "type": "boolean" + }, + "dataSourceType": { + "description": "Set to ODT for BI Publisher reports.", + "type": "string", + "minLength": 0, + "maxLength": 10 + }, + "dataSource": { + "description": "Data source for BI Publisher reports.", + "type": "string", + "minLength": 0, + "maxLength": 255 + }, + "usedInApp": { + "description": "A comma separated list of Opera V5 application indicators for which the report is enabled.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "opera9Certified": { + "description": "A flag indicating that the report has been certified for use with Opera 9.", + "type": "boolean" + }, + "watermarkDetails": { + "description": "The watermark details of the report being retrieved.", + "$ref": "#/definitions/watermarkType" + }, + "externalReportUrl": { + "description": "Information regarding Report Url from external source.", + "$ref": "#/definitions/externalUrlInfoType" + }, + "rowsPerPage": { + "description": "Rows for Key Packet report group.", + "type": "integer" + }, + "columnsPerPage": { + "description": "Columns for Key Packet report group.", + "type": "integer" + }, + "excelOutput": { + "description": "Flag to indicate whether the report can be exported to Excel.", + "type": "boolean" + } + } + }, + "reportModuleTypeType": { + "type": "string", + "description": "Procedure Report", + "enum": [ + "Rtf", + "Cus", + "Rep", + "Sft", + "Grp", + "Url", + "Lbl", + "Pcd", + "Rna" + ] + }, + "watermarkType": { + "type": "object", + "description": "Details of the watermark to be used at the time of report generation.", + "properties": { + "mode": { + "description": "Watermark for PDF files", + "$ref": "#/definitions/watermarkModeType" + }, + "text": { + "description": "Watermark Text.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "font": { + "description": "Watermark font name.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "fontSize": { + "description": "Watermark font name.", + "type": "number" + }, + "xPosition": { + "description": "X position of watermark on page starting in lower left corner.", + "type": "integer" + }, + "yPosition": { + "description": "Y position of watermark on page starting in lower left corner.", + "type": "integer" + }, + "angle": { + "description": "Watermark angle in degrees.", + "type": "integer" + }, + "red": { + "description": "Watermark color (red), value ranges from 0.0 to 1.0 ( Java API values ).", + "type": "number" + }, + "green": { + "description": "Watermark color (green), value ranges from 0.0 to 1.0 ( Java API values ).", + "type": "number" + }, + "blue": { + "description": "Watermark color (blue), value ranges from 0.0 to 1.0 ( Java API values ).", + "type": "number" + } + } + }, + "watermarkModeType": { + "type": "string", + "description": "Identifies the data type of the report parameter.", + "enum": [ + "Simple", + "Enhanced", + "NoWatermark", + "GroupSettings" + ] + }, + "translationTextType1000": { + "type": "object", + "description": "Contains Multiple translated texts and language codes.", + "properties": { + "defaultText": { + "description": "Default text with Character length from 0 to 1000.", + "type": "string", + "minLength": 0, + "maxLength": 1000 + }, + "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", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + } + }, + "description": "Language code for the translation." + } + }, + "uniqueIDListType": { + "type": "array", + "description": "Unique Id that references an object uniquely in the system.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "externalUrlInfoType": { + "type": "object", + "description": "Contains all the information of External Urls.", + "properties": { + "externalReportUrl": { + "description": "Report Url from external source.", "type": "string", - "description": "Human-readable description specific to this occurrence of the problem." + "minLength": 0, + "maxLength": 2000 }, - "instance": { - "type": "string", - "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." + "isUrlDynamic": { + "description": "Indicates if the Url is dynamic", + "type": "boolean" + } + } + }, + "reports": { + "type": "object", + "description": "This type contains a collection of report modules which match the requested criteria. The object also may include a standard SUCCESS element or a WARNINGS or ERRORS collection.", + "properties": { + "reports": { + "description": "The collection of reports that matches the requested criteria.", + "$ref": "#/definitions/reportsType" }, - "o:errorCode": { - "type": "string", - "description": "Application error code, which is different from HTTP error code." + "links": { + "$ref": "#/definitions/links" }, - "o:errorPath": { - "type": "string", - "description": "Path to the problem at the resource or property level." + "warnings": { + "$ref": "#/definitions/warningsType" } - }, - "required": [ - "type", - "title" - ] + } }, - "instanceLink": { + "reportParametersType": { + "type": "array", + "description": "List of parameters required to run report.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reportParameterType" + } + }, + "reportParameterType": { "type": "object", - "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", + "description": "Defines an individual report parameter.", "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" + "name": { + "description": "Individual report parameter details.", + "type": "string", + "minLength": 0, + "maxLength": 400 }, - "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" + "label": { + "description": "Display label for report parameter.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "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 + "dataType": { + "description": "Report parameter data type used to determine kind of UI control to display.", + "$ref": "#/definitions/paramDataType" }, - "method": { - "description": "HTTP method for requesting the target of the link.", + "value": { + "description": "Initial report parameter value.", "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE", - "PATCH", - "OPTIONS", - "HEAD" - ] + "minLength": 0, + "maxLength": 4000 }, - "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" + "calculatedDateValue": { + "description": "Date value from offset.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "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" + "dateFormatMask": { + "description": "Format mask for date report parameters.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "title": { - "description": "Exact copy of the \"summary\" field on the linked operation.", - "type": "string" + "orderBy": { + "description": "Report parameter display order.", + "type": "integer" + }, + "dateOffset": { + "description": "Number of days to offset from current business date for date report parameter.", + "type": "integer" + }, + "formatMask": { + "$ref": "#/definitions/paramFormatMaskType" + }, + "buildStringForDateOffset": { + "type": "string", + "minLength": 0, + "maxLength": 32000 + }, + "lovParam": { + "$ref": "#/definitions/lovParamDetailsType" } - }, - "required": [ - "href", - "rel", - "method", - "operationId" + } + }, + "paramDataType": { + "type": "string", + "description": "Identifies the data type of the report parameter.", + "enum": [ + "DateAsChar", + "Date", + "Number", + "CheckBox", + "DateTime", + "Char", + "Money", + "Integer" ] }, - "links": { - "type": "array", - "items": { - "$ref": "#/definitions/instanceLink" + "lovParamDetailsType": { + "type": "object", + "description": "Identifies a destination record for the report.", + "properties": { + "lovSql": { + "description": "Query statement for LOV based report parameters.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "lOVs": { + "description": "Report parameter LOV details.", + "$ref": "#/definitions/paramLOVsType" + }, + "lovValidate": { + "description": "Flag to indicate that input should be validated against LOV.", + "type": "boolean" + }, + "lovMultiSelect": { + "description": "This attribute is used to indicate if an LOV defined is multi-select. This is particularly useful for simple reports.", + "type": "boolean" + } } }, - "warningsType": { + "paramLOVsType": { "type": "array", - "description": "Used in conjunction with the Success element to define a business error.", + "description": "List of values for report parameter.", "maxItems": 4000, "items": { - "$ref": "#/definitions/warningType" + "$ref": "#/definitions/paramLOVType" } }, - "warningType": { + "paramLOVType": { "type": "object", - "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.", + "description": "Represents an individual LOV item for a report parameter.", "properties": { - "value": { - "type": "string", - "description": "Property Value" + "code": { + "description": "Report parameter LOV code.", + "type": "string" }, - "shortText": { - "description": "An abbreviated version of the error in textual format.", + "description": { + "description": "Report parameter LOV label.", + "type": "string" + }, + "string": { + "description": "Report parameter LOV string (third attribute returned for some queries).", + "type": "string" + } + } + }, + "paramFormatMaskType": { + "type": "string", + "description": "Specifies the format mask for the parameter.", + "enum": [ + "None", + "Upper", + "Lower" + ] + }, + "configGenericReportsType": { + "type": "object", + "description": "It contains collection of reports.", + "properties": { + "report": { + "description": "A generic report.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/configGenericReportType" + } + }, + "hotelId": { + "description": "Hotel code in which reports to be set up belong to.", "type": "string", - "maxLength": 2000 + "minLength": 0, + "maxLength": 20 }, - "code": { - "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", + "chainCode": { + "description": "Chain code in which reports to be set up belong to.", "type": "string", "minLength": 0, "maxLength": 20 + } + } + }, + "configGenericReportType": { + "type": "object", + "description": "A mandatory or non-mandatory procedure or report.", + "properties": { + "name": { + "description": "Display Name of procedure or report.", + "$ref": "#/definitions/translationTextType1000" }, - "docURL": { - "description": "If present, this URL refers to an online description of the error that occurred.", + "reportName": { + "description": "Name of the .REP or .RTF file. .REP or .RTF extension is not needed.", "type": "string", - "maxLength": 2000 + "minLength": 0, + "maxLength": 80 }, - "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.", + "userDefinedReport": { + "description": "Flag which indicates whether the report is user defined.", + "type": "boolean" + }, + "moduleType": { + "description": "Module type either RTF,GRP,SFT,URL,RNA or REP.", + "$ref": "#/definitions/reportModuleTypeType" + }, + "usedInApp": { + "description": "Report can be run in these applications - Global level, property level or in the Sales & Event Management.", + "type": "array", + "maxItems": 3, + "items": { + "$ref": "#/definitions/reportRunnableApps" + } + }, + "dataSourceType": { + "description": "Set to ODT for BI Publisher reports.", "type": "string", - "maxLength": 2000 + "minLength": 0, + "maxLength": 10 }, - "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].", + "dataSource": { + "description": "Data source for BI Publisher reports.", "type": "string", - "maxLength": 2000 + "minLength": 0, + "maxLength": 255 }, - "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.", + "mandatory": { + "description": "Flag indicating whether procedure or report is mandatory or not.", + "type": "boolean" + }, + "formToRun": { + "description": "Form which is run to collect parameter information to generate the report.", "type": "string", - "maxLength": 2000 + "minLength": 0, + "maxLength": 80 }, - "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\".", + "reportLanguage": { + "description": "The language in which the report is configured. This language code will be used when running a report for guests like registration cards, folio etc when GUEST LANGUAGE functionality is turned on.", "type": "string", "minLength": 0, "maxLength": 20 }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + "active": { + "description": "Flag indicating whether procedure or report is active to run.", + "type": "boolean" }, - "rph": { - "description": "Reference Place Holder used as an index for this warning.", + "protected": { + "description": "Flag indicating whether report is protected or not.", + "type": "boolean" + }, + "sequence": { + "description": "Display sequence of procedure or report.", + "type": "integer" + }, + "reportGroup": { + "description": "Report group to which the report is being added.", "type": "string", - "minLength": 1, - "maxLength": 8 + "minLength": 0, + "maxLength": 80 + }, + "multiPropertyReport": { + "description": "Flag which indicates if the report can be run for multiple properties.", + "type": "boolean" + }, + "excelOutput": { + "description": "Flag to indicate whether the report can be exported to Excel.", + "type": "boolean" + }, + "attachedReports": { + "description": "List of Reports attached with the Shift Report group.", + "$ref": "#/definitions/uniqueIDListType" + }, + "watermarkDetails": { + "description": "The watermark details of the report being added.", + "$ref": "#/definitions/watermarkType" + }, + "parameters": { + "description": "A report parameter.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/configReportParameterType" + } + }, + "rowsPerPage": { + "description": "Rows to be entered for Key Packet report group.", + "type": "integer" + }, + "columnsPerPage": { + "description": "Columns to be entered for Key Packet report group.", + "type": "integer" + }, + "moduleId": { + "description": "Module id of the report.", + "$ref": "#/definitions/uniqueID_Type" + }, + "externalReportUrl": { + "description": "Information regarding Report Url from external source.", + "$ref": "#/definitions/externalUrlInfoType" + }, + "printReport": { + "description": "Details of sending report to destination.", + "$ref": "#/definitions/printReportType" } } }, - "status": { + "reportRunnableApps": { + "type": "string", + "description": "Simple type for report module type.", + "enum": [ + "Global", + "Property", + "SalesAndCatering" + ] + }, + "configReportParameterType": { "type": "object", - "description": "Response Body.", + "description": "A report parameter.", "properties": { - "warnings": { - "$ref": "#/definitions/warningsType" + "name": { + "description": "Report parameter name.", + "type": "string", + "minLength": 0, + "maxLength": 400 }, - "links": { - "$ref": "#/definitions/links" + "label": { + "description": "Display label for report parameter.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "dataType": { + "description": "Report parameter data type.", + "$ref": "#/definitions/paramDataType" + }, + "value": { + "description": "Default report parameter value.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "dateOffset": { + "description": "Date Ofset could be in the format +x DAYS.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "lovSql": { + "description": "Query statement for LOV based report parameters.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "sequence": { + "description": "Display sequence of report parameter.", + "type": "integer" } } }, - "copyReportsType": { + "printReportType": { "type": "object", - "description": "Copy report configuration code from one property to the other.", + "description": "Details to print or send report to printer, email or fax.", "properties": { - "codes": { - "description": "List of Code that is to be copied.", - "$ref": "#/definitions/codeListType" + "destination": { + "description": "Destination to which the report is directed to by default.", + "$ref": "#/definitions/printDestinationType" }, - "targetHotelCodes": { - "description": "Property to which configuration code type to be copied to.", - "$ref": "#/definitions/codeListType" + "copies": { + "description": "Number of copies to be printed or sent.", + "type": "integer" }, - "sourceHotelCode": { - "type": "string", - "minLength": 0, - "maxLength": 20 + "sent": { + "description": "Indicates whether report has already been sent or not.", + "type": "boolean" } } }, - "codeListType": { - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "minLength": 0, - "maxLength": 20 + "printDestinationType": { + "type": "string", + "description": "Allowed values for Print Destination.", + "enum": [ + "Printer", + "Email", + "Fax" + ] + }, + "reportParameters": { + "type": "object", + "description": "The Fetch Report Parameters result object contains a collection of report parameters which allow/require user input prior to running the report.", + "properties": { + "reportParameters": { + "description": "This element holds the collection of report parameters for user input.", + "$ref": "#/definitions/reportParametersType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "reportTextConfigurationsCopy": { + "genericReports": { "type": "object", - "description": "Request object to copy the Report Text Configurations from Source Property to Destination Properties.", + "description": "This request provides End of Day reports to be created.", "properties": { - "copyReports": { - "description": "List of Report type to copy", - "$ref": "#/definitions/copyReportsType" + "reports": { + "description": "It contains collection of reports setup to be saved.", + "$ref": "#/definitions/configGenericReportsType" }, "links": { "$ref": "#/definitions/links" diff --git a/rest-api-specs/property/rmcfg.json b/rest-api-specs/property/rmcfg.json index 1d85292..0719e75 100644 --- a/rest-api-specs/property/rmcfg.json +++ b/rest-api-specs/property/rmcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Room Configuration API", - "description": "APIs to cater for room configuration, such as configuring room types, room Classes, creating new room features, or updating housekeeping room maintenance reasons.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for room configuration, such as configuring room types, room Classes, creating new room features, or updating housekeeping room maintenance reasons.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/rmr.json b/rest-api-specs/property/rmr.json index f33ab46..af9e607 100644 --- a/rest-api-specs/property/rmr.json +++ b/rest-api-specs/property/rmr.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Room Rotation Service API", - "description": "APIs to facilitate Room Rotation functionality in OPERA Cloud. Api provides capability to handle Room Rotation in OPERA Cloud. Room Rotation provides room ownership options for automatic inventory rotation and prioritization for owner rooms assignment and occupancy.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to facilitate Room Rotation functionality in OPERA Cloud. Api provides capability to handle Room Rotation in OPERA Cloud. Room Rotation provides room ownership options for automatic inventory rotation and prioritization for owner rooms assignment and occupancy.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/rmrcfg.json b/rest-api-specs/property/rmrcfg.json index 7c393a5..91b60f0 100644 --- a/rest-api-specs/property/rmrcfg.json +++ b/rest-api-specs/property/rmrcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Room Rotation Configuration Service API", - "description": "APIs to cater for Room Rotation Configuration functionality in OPERA Cloud. Api provides capability to handle Room Rotation in OPERA Cloud. Room Rotation provides room ownership options for automatic inventory rotation and prioritization for owner rooms assignment and occupancy.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Room Rotation Configuration functionality in OPERA Cloud. Api provides capability to handle Room Rotation in OPERA Cloud. Room Rotation provides room ownership options for automatic inventory rotation and prioritization for owner rooms assignment and occupancy.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/rsv.json b/rest-api-specs/property/rsv.json index 0ed7110..52c9999 100644 --- a/rest-api-specs/property/rsv.json +++ b/rest-api-specs/property/rsv.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Reservation API", - "description": "APIs to cater for Reservation functionality in OPERA Cloud.

OPERA Cloud Reservations provides a complete set of capabilities for creating and updating reservations. Reservations are a central feature of OPERA Cloud. As a key source of information, the reservation specifies a guest's arrival date, departure date, room type, rate, packages, and many other details. It is also a gateway to dozens of other functions that contribute to the guest's experience. All reservations in OPERA Cloud require a guest profile.

You can create profiles while booking a reservation. If a profile already exists, you can look it up (using getProfiles in the Customer Relationship Management module) and attach it to the reservation during the reservation booking process using the profileId.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Reservation functionality in OPERA Cloud.

OPERA Cloud Reservations provides a complete set of capabilities for creating and updating reservations. Reservations are a central feature of OPERA Cloud. As a key source of information, the reservation specifies a guest's arrival date, departure date, room type, rate, packages, and many other details. It is also a gateway to dozens of other functions that contribute to the guest's experience. All reservations in OPERA Cloud require a guest profile.

You can create profiles while booking a reservation. If a profile already exists, you can look it up (using getProfiles in the Customer Relationship Management module) and attach it to the reservation during the reservation booking process using the profileId.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -4961,6 +4961,15 @@ }, "required": false }, + { + "name": "reservationId", + "in": "query", + "type": "string", + "required": false, + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA." + }, { "$ref": "#/parameters/authKey" }, @@ -5489,7 +5498,8 @@ "PlayerSnapshot", "FiscalInfo", "CorrectionPostings", - "Vouchers" + "Vouchers", + "ScheduledRoomMove" ], "description": "Represents Reservation search type Player Snapshot." }, @@ -6767,10 +6777,50 @@ "name": "backToBackDateOn", "in": "query", "required": false, - "description": "Fetches all Back to Back reservations that are scheduled to stay over the selected Back to Back date and any additional reservations that are marked as Back to Back for fetched Back to Back reservations.", + "description": "Fetches linked Back to Back reservations with the specified Back to Back Date. Fetched reservations will be marked as Back to Back and they will either depart or arrive on the specified Back to Back day.", "type": "string", "format": "date" }, + { + "name": "scheduledRoomMoveDate", + "in": "query", + "required": false, + "description": "Scheduled Move Rooms Date Criteria. This will parameter be mandatory when search Type is ScheduledRoomMove.", + "type": "string", + "format": "date" + }, + { + "name": "scheduledRoomMoveStartTime", + "in": "query", + "required": false, + "description": "Start of Scheduled Move Room Time Range Criteria (in 24 hour time format). Applicable when Search Type is ScheduledRoomMove.", + "type": "string", + "minLength": 0, + "maxLength": 8, + "pattern": "([0-1]?[0-9]|2[0-3]):[0-5][0-9]" + }, + { + "name": "scheduledRoomMoveEndTime", + "in": "query", + "required": false, + "description": "End of Scheduled Move Room Time Range Criteria (in 24 hour time format). Applicable when Search Type is ScheduledRoomMove.", + "type": "string", + "minLength": 0, + "maxLength": 8, + "pattern": "([0-1]?[0-9]|2[0-3]):[0-5][0-9]" + }, + { + "name": "scheduledRoomMoveStatus", + "in": "query", + "required": false, + "description": "Scheduled Move Room Status Criteria.", + "type": "string", + "uniqueItems": true, + "enum": [ + "Completed", + "Pending" + ] + }, { "$ref": "#/parameters/authKey" }, @@ -8309,6 +8359,157 @@ ] } }, + "/hotels/{hotelId}/reservations/statistics": { + "get": { + "summary": "Get Reservation DistributionReservationsSummary", + "description": "Get DistributionReservationsSummary.

OperationId:getDistributionReservationsSummary

", + "operationId": "getDistributionReservationsSummary", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "This is the Hotel Code of the Reservations" + }, + { + "name": "enterpriseId", + "in": "query", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "This is the EnterpriseId of Hotel Code" + }, + { + "name": "channelCode", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, + "items": { + "type": "string", + "maxItems": 100 + }, + "description": "This is the ChannelCode of Hotel Code in the Reservations" + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "string", + "format": "date", + "description": "This is the Last Updated From Date for a Reservation" + }, + { + "name": "endDate", + "in": "query", + "required": false, + "type": "string", + "format": "date", + "description": "This is the Last Updated To Date for a Reservation" + }, + { + "name": "limit", + "in": "query", + "default": 20, + "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" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 checking allowed actions, existence of attached records.", + "schema": { + "$ref": "#/definitions/checkDistributionReservationsSummary" + } + }, + "204": { + "description": "DistributionReservationsSummary 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": [ + "Reservation" + ] + } + }, "/hotels/{hotelId}/reservations/summary": { "get": { "summary": "Get brief summary for Reservations", @@ -8566,8 +8767,8 @@ }, "/hotels/{hotelId}/reservations/validations": { "put": { - "summary": "Validate Reservation Change", - "description": "Use this API to validate either the guarantee type or stay details of a reservation you are about to create.

OperationId:putValidateReservationChanges

", + "summary": "Validate Reservation Before Creating or Applying Changes", + "description": "Use this API to validate details of a reservation that you are about to create or modify. Elements to be validated will depend on the instructions provided e.g. StayDates, Packages, Shares etc. Use of this api will not change any data on the reservation.

OperationId:putValidateReservationChanges

", "operationId": "putValidateReservationChanges", "parameters": [ { @@ -8862,6 +9063,96 @@ "description": "Room number", "type": "string" }, + { + "name": "cancellationNumberList", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "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.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "externalReferenceIds", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "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.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "externalSystemCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "default": [ + "External" + ], + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "confirmationNumberList", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "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.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "taRecordLocatorList", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Travel Agent Record Locators List.", + "items": { + "type": "string", + "maxItems": 30 + }, + "required": false + }, + { + "name": "reservationStatuses", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Reservation status list for reservations search.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "Cancelled", + "CheckedOut", + "CheckedIn", + "DueIn", + "DueOut", + "InHouse", + "NoShow", + "WaitList" + ] + }, + "required": false + }, + { + "name": "linkedName", + "in": "query", + "required": false, + "description": "Name of the group of Linked Reservations to be searched.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, { "name": "fetchInstructions", "in": "query", @@ -9077,7 +9368,8 @@ "AccompanyingGuestProfile", "AccompanyingGuestMembership", "AccompanyingGuestRelationship", - "Voucher" + "Voucher", + "ScheduledRoomMoves" ] }, "required": false @@ -15716,7 +16008,7 @@ { "name": "productCode", "in": "query", - "required": false, + "required": true, "type": "string" }, { @@ -23142,7 +23434,8 @@ "OpenBalance", "AutoFolioSettlement", "Routing", - "PlayerSnapshot" + "PlayerSnapshot", + "ScheduledRoomMoves" ], "description": "Represents Reservation search type Player Snapshot." }, @@ -24258,10 +24551,50 @@ "name": "backToBackDateOn", "in": "query", "required": false, - "description": "Fetches all Back to Back reservations that are scheduled to stay over the selected Back to Back date and any additional reservations that are marked as Back to Back for fetched Back to Back reservations.", + "description": "Fetches linked Back to Back reservations with the specified Back to Back Date. Fetched reservations will be marked as Back to Back and they will either depart or arrive on the specified Back to Back day.", "type": "string", "format": "date" }, + { + "name": "scheduledRoomMoveDate", + "in": "query", + "required": false, + "description": "Scheduled Move Rooms Date Criteria. This will parameter be mandatory when Search Type is ScheduledRoomMove.", + "type": "string", + "format": "date" + }, + { + "name": "scheduledRoomMoveStartTime", + "in": "query", + "required": false, + "description": "Start of Scheduled Move Room Time Range Criteria (in 24 hour time format). Applicable when Search Type is ScheduledRoomMove.", + "type": "string", + "minLength": 0, + "maxLength": 8, + "pattern": "([0-1]?[0-9]|2[0-3]):[0-5][0-9]" + }, + { + "name": "scheduledRoomMoveEndTime", + "in": "query", + "required": false, + "description": "End of Scheduled Move Room Time Range Criteria (in 24 hour time format). Applicable when Search Type is ScheduledRoomMove.", + "type": "string", + "minLength": 0, + "maxLength": 8, + "pattern": "([0-1]?[0-9]|2[0-3]):[0-5][0-9]" + }, + { + "name": "scheduledRoomMoveStatus", + "in": "query", + "required": false, + "description": "Scheduled Move Room Status Criteria.", + "type": "string", + "uniqueItems": true, + "enum": [ + "Completed", + "Pending" + ] + }, { "$ref": "#/parameters/authKey" }, @@ -27395,7 +27728,7 @@ "maxLength": 4000 }, "fiscalInfo": { - "description": "Fiscal related informatin for a reservation.", + "description": "Fiscal related information for a reservation.", "$ref": "#/definitions/fiscalInfoType" }, "parentReservationHotelId": { @@ -27403,6 +27736,10 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "scheduledRoomMoveInfo": { + "description": "Scheduled Room Move information for a reservation.", + "$ref": "#/definitions/scheduledRoomMoveInfoType" } } }, @@ -27490,6 +27827,10 @@ "description": "Provides the information of the assigned reservation room is an Owner, Referral or regular room.This value is returned when Room Rotation OPERA Control is active and room number is assigned to a reservation.", "$ref": "#/definitions/reservationRoomOwnershipType" }, + "scheduledRoomMoveRoomPending": { + "type": "boolean", + "description": "Pending Scheduled Move Room." + }, "ratePlanCode": { "description": "Rate plan code", "type": "string", @@ -27709,7 +28050,7 @@ }, "promotionType": { "type": "object", - "description": "Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.", + "description": "Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.

Note: For putReservation when promotion type element is sent with no value, existing promotion codes on the reservation will be removed.

", "properties": { "promotionCode": { "description": "Promotion code associated with the rate plan.", @@ -28998,6 +29339,20 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "profileId": { + "description": "Profile Id with attached Routing Instruction.", + "$ref": "#/definitions/profileId" + }, + "beginDate": { + "description": "Begin Date for attached Routing Instruction.", + "type": "string", + "format": "date" + }, + "endDate": { + "description": "End Date for attached Routing Instruction.", + "type": "string", + "format": "date" } } }, @@ -30408,6 +30763,18 @@ "payeeSharer": { "description": "This attribute indicates if the Shared reservation is marked as the Payee Sharer or not.", "type": "boolean" + }, + "scheduledRoomMoves": { + "description": "Scheduled Room Moves", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/scheduledRoomMoveType" + } + }, + "routeAllTransactionsToShare": { + "description": "Indicates if this joining reservation should route all transactions to the 'Share To' reservation when including Share Reservations Instructions.", + "type": "boolean" } } }, @@ -30796,6 +31163,24 @@ "allowAutoCheckIn": { "description": "It represents whether auto check-in is enabled or not for psuedo room types.", "type": "boolean" + }, + "bookingMedium": { + "description": "Classifies the medium(Channel field on reservation screen) through which the reservation is made.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "bookingMediumDescription": { + "description": "Description of the booking medium.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "purposeOfStay": { + "description": "Purpose of stay.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, @@ -37092,6 +37477,10 @@ "profileId": { "description": "Unique guest profile identifier for the linked reservation.", "$ref": "#/definitions/profileId" + }, + "backToBackSequence": { + "description": "This attribute represents Back To Back Sequence of Linked Reservations(e.g. '1 of 2' i.e, 1 indicates Sequence Position of total count 2). This is applicable when OPERA control Back to Back Handling for Linked Reservations is active.", + "$ref": "#/definitions/backToBackResSequenceType" } } }, @@ -38808,7 +39197,8 @@ "RoomAssignedByAI", "CustomNameValue", "CustomChargeExemptions", - "FiscalInfo" + "FiscalInfo", + "ScheduledRoomMoves" ] }, "reservationsInstructionsType": { @@ -39961,6 +40351,10 @@ "overrideRoomFeatures": { "description": "This flag indicates true/false. When this is true, it will allow to override the room feature preference validation while assigning rooms. The Reservation Room Features OPERA Control will determine which room feature preferences will be validated. When Reservation Room Features is on, the validation will be against the Room Feature preferences attached to the reservation. If the parameter is off, the validation will be against the room feature preferences attached to the profile. This is applicable when the Room Feature Validation OPERA Control is on.", "type": "boolean" + }, + "routeAllTransactionsToShare": { + "description": "Indicates if this joining reservation should route all transactions to the 'Share To' reservation when including Share Reservations Instructions.", + "type": "boolean" } } }, @@ -41248,6 +41642,10 @@ "roomOwnershipType": { "description": "Provides the information of the assigned reservation room is an Owner/Referral or Regular room.This value is returned when Room Rotation OPERA Control is active and room number is assigned to a reservation.", "$ref": "#/definitions/reservationRoomOwnershipType" + }, + "existingReservation": { + "description": "Details of the existing reservation to be combined as a sharer.", + "$ref": "#/definitions/combineShareFromExistingReservationType" } } }, @@ -41324,6 +41722,10 @@ "timeSpan": { "description": "Stay arrival and departure dates.", "$ref": "#/definitions/timeSpanType" + }, + "routeAllTransactionsToShareReservationId": { + "description": "Reservation ID of an existing reservation to whom all transactions of the joining reservation will be routed to.", + "$ref": "#/definitions/uniqueID_Type" } } }, @@ -41891,6 +42293,16 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "beginDate": { + "description": "This is the Begin date for the Default Routing Instruction selected.", + "type": "string", + "format": "date" + }, + "endDate": { + "description": "This is the End date for the Default Routing Instruction selected.", + "type": "string", + "format": "date" } } }, @@ -42567,7 +42979,8 @@ "ReservationGuarantee", "UpsellsAvailable", "InventoryItems", - "CompRouting" + "CompRouting", + "RoomAvailablity" ] }, "upsellRateInstructionType": { @@ -47814,6 +48227,10 @@ "linkedReservationInfo": { "description": "Linked reservation information that needs to be changed.", "$ref": "#/definitions/linkedReservationInfoType" + }, + "backToBackToReservationId": { + "description": "Unique identifier of the source linked reservation to be marked as Back to Back along with a target linked reservation when the target linked reservation is marked as Back to Back.", + "$ref": "#/definitions/uniqueID_Type" } } }, @@ -47830,6 +48247,250 @@ "type": "integer" } } + }, + "roomOccupancyType": { + "description": "Room Occupancy information.", + "type": "object", + "properties": { + "roomId": { + "type": "string", + "description": "Room Id.", + "minLength": 0, + "maxLength": 20 + }, + "roomType": { + "type": "string", + "description": "Room Type.", + "minLength": 0, + "maxLength": 20 + }, + "roomIsOccupied": { + "type": "boolean", + "description": "Indicates if the Room is currently occupied." + }, + "estimatedDepartureTime": { + "type": "string", + "description": "Estimated Time of Departure of reservation when room status is occupied.", + "format": "date-time" + }, + "guestFirstName": { + "type": "string", + "description": "Guest First/Given Name on reservation when room status is occupied.", + "minLength": 0, + "maxLength": 40 + }, + "guestLastName": { + "type": "string", + "description": "Guest Last Name /Surname on reservation when room status is occupied.", + "minLength": 0, + "maxLength": 40 + } + } + }, + "combineShareFromExistingReservationType": { + "type": "object", + "description": "Details of the existing reservation to be combined as a sharer.", + "properties": { + "routeAllTransactionsToShareReservationId": { + "description": "Reservation ID of an existing reservation to whom all transactions of the joining reservation will be routed to.", + "$ref": "#/definitions/uniqueID_Type" + }, + "dailyRates": { + "description": "Collection of room rate information on a daily basis.", + "$ref": "#/definitions/dailyRatesType" + } + } + }, + "scheduledRoomMoveInfoType": { + "description": "Scheduled Move information.", + "type": "object", + "properties": { + "moveStatus": { + "description": "Scheduled Room Move Status.", + "$ref": "#/definitions/scheduledRoomMoveStatusType" + }, + "moveComments": { + "type": "string", + "description": "Comments about scheduled move.", + "minLength": 0, + "maxLength": 200 + }, + "moveInRoomOccupancyInfo": { + "description": "Scheduled Move In Room Occupancy Information.", + "$ref": "#/definitions/roomOccupancyType" + }, + "estimatedMoveTime": { + "type": "string", + "description": "Estimated Move Time in 24Hour Format" + }, + "moveOutRoomId": { + "type": "string", + "description": "Scheduled Move Out Room Id.", + "minLength": 0, + "maxLength": 20 + }, + "moveOutRoomType": { + "type": "string", + "description": "Scheduled Move Out Room Type.", + "minLength": 0, + "maxLength": 20 + } + } + }, + "scheduledRoomMoveType": { + "description": "Scheduled Move information.", + "type": "object", + "properties": { + "scheduledRoomMoveInfo": { + "description": "Scheduled Room Move information for a reservation.", + "$ref": "#/definitions/scheduledRoomMoveInfoType" + }, + "roomAssignmentSegmentBegin": { + "type": "string", + "description": "Date Room Assignment Begins.", + "format": "date-time" + }, + "roomAssignmentSegmentEnd": { + "type": "string", + "description": "Date of the Scheduled Move Room.", + "format": "date-time" + }, + "roomAssignmentSegmentNo": { + "type": "integer", + "description": "Room Assignment Segment Number." + } + } + }, + "scheduledRoomMoveStatusType": { + "type": "string", + "description": "Flag indicating scheduled room move status.", + "enum": [ + "Completed", + "Pending" + ] + }, + "checkDistributionReservationsSummaryType": { + "type": "object", + "description": "Reservation Statistics and the status of its allowed actions, attached records.", + "properties": { + "hotelId": { + "description": "Property code of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "channelCode": { + "description": "Channel code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "enterpriseId": { + "description": "EnterpriseId of Property.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "arrivalDate": { + "description": "Arrival Date.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "departureDate": { + "description": "Departure Date.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "creationDate": { + "description": "Creation Date.", + "type": "string", + "format": "date-time" + }, + "lastUpdateDate": { + "description": "LastUpdate Date.", + "type": "string", + "format": "date-time" + }, + "cancellationDate": { + "description": "Cancellation Date.", + "type": "string", + "format": "date-time" + }, + "numberOfRooms": { + "description": "number of Rooms Booked.", + "type": "integer" + }, + "reservationStatus": { + "description": "Status of Reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "confirmationId": { + "description": "ConfirmationId of Reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "legNumber": { + "description": "ConfirmationLeg Number of Reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "reservationId": { + "description": "ReservationId of Reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "guestName": { + "description": "GuestName.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "creatorId": { + "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "type": "string", + "minLength": 0, + "maxLength": 200 + } + } + }, + "checkDistributionReservationsSummary": { + "type": "object", + "description": "Response for checking allowed actions, existence of attached records, or count of reservations.", + "properties": { + "checkReservations": { + "description": "Collection of reservations Count and the status of its allowed actions, attached records.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/checkDistributionReservationsSummaryType" + } + }, + "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" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/rsvasync.json b/rest-api-specs/property/rsvasync.json index 8155f15..80576e4 100644 --- a/rest-api-specs/property/rsvasync.json +++ b/rest-api-specs/property/rsvasync.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Reservation Asynchronous API", - "description": "APIs to cater for Reservation Asynchronous functionality in OPERA Cloud. This includes viewing reservation data along with its revenue.

This API follows an async pattern where

  • You make an initial request, which returns a Location header
  • You poll HEAD on the Location header returned to obtain the status of the process
  • Once the process completes HEAD will return in the Location header the URL that must be called to obtain the results of the process
  • You call the URL to obtain the results of the process


Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Reservation Asynchronous functionality in OPERA Cloud. This includes viewing reservation data along with its revenue.

This API follows an async pattern where

  • You make an initial request, which returns a Location header
  • You poll HEAD on the Location header returned to obtain the status of the process
  • Once the process completes HEAD will return in the Location header the URL that must be called to obtain the results of the process
  • You call the URL to obtain the results of the process


Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/rsvcfg.json b/rest-api-specs/property/rsvcfg.json index ec1fbf4..ed6386f 100644 --- a/rest-api-specs/property/rsvcfg.json +++ b/rest-api-specs/property/rsvcfg.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Reservation Master Data Management API", - "description": "APIs to cater for Reservation Configuration in OPERA Cloud. In this module you can retrieve, create, modify or delete configuration related to Reservations, Blocks and Leisure Management.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Reservation Configuration in OPERA Cloud. In this module you can retrieve, create, modify or delete configuration related to Reservations, Blocks and Leisure Management.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -27173,6 +27173,10 @@ "printGroup": { "description": "Print Group to map Market Code.", "$ref": "#/definitions/marketCodePrintGroupType" + }, + "central": { + "description": "Indicates if market code is originated from Central.", + "type": "boolean" } } }, @@ -27291,6 +27295,10 @@ "upgradable": { "description": "Defines if the Market Group is eligible for auto upgrade for Room Assignment Optimization", "type": "boolean" + }, + "central": { + "description": "Indicates if market code is originated from Central.", + "type": "boolean" } } }, @@ -28415,6 +28423,10 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "central": { + "description": "Indicates if market code is originated from Central.", + "type": "boolean" } } }, @@ -28524,6 +28536,10 @@ "sourceCodes": { "description": "Collection of Source Codes.", "$ref": "#/definitions/sourceCodesType" + }, + "central": { + "description": "Indicates if market code is originated from Central.", + "type": "boolean" } } }, @@ -29331,6 +29347,10 @@ "displayColor": { "description": "Display Color for the template market code type.", "$ref": "#/definitions/marketCodeColorsType" + }, + "central": { + "description": "Indicates if market code is originated from Central.", + "type": "boolean" } } }, @@ -29457,6 +29477,10 @@ "items": { "$ref": "#/definitions/templateMarketCodeType" } + }, + "central": { + "description": "Indicates if market code is originated from Central.", + "type": "boolean" } } }, @@ -30112,6 +30136,10 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "central": { + "description": "Indicates if market code is originated from Central.", + "type": "boolean" } } }, @@ -30225,6 +30253,10 @@ "items": { "$ref": "#/definitions/templateSourceCodeType" } + }, + "central": { + "description": "Indicates if market code is originated from Central.", + "type": "boolean" } } }, diff --git a/rest-api-specs/property/rtp.json b/rest-api-specs/property/rtp.json index 9d8d9eb..81d0f41 100644 --- a/rest-api-specs/property/rtp.json +++ b/rest-api-specs/property/rtp.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "OPERA Cloud Rate API", - "description": "APIs to cater for Rate Availability functionality in OPERA Cloud.

Rate Management provides all the tools you need to effectively define and manage the rate structures for a property in OPERA Cloud. Some of the things you can do include creating and managing rate codes, rate classes, rate categories, display sets, rate strategies, as well as managing promotion groups and codes.

Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs to cater for Rate Availability functionality in OPERA Cloud.

Rate Management provides all the tools you need to effectively define and manage the rate structures for a property in OPERA Cloud. Some of the things you can do include creating and managing rate codes, rate classes, rate categories, display sets, rate strategies, as well as managing promotion groups and codes.

Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -16758,7 +16758,7 @@ }, "postingRhythmType": { "type": "string", - "description": "Simple type for posting Rhythm types.", + "description": "Simple type for posting Rhythm types. Note: for redemption packages, EveryNight is the only valid value.", "enum": [ "EveryNight", "ArrivalNight", @@ -16928,6 +16928,12 @@ "bucket": { "description": "The bucket is applicable for child bucket functionality when package's price calculation rule is Child.", "$ref": "#/definitions/packageChildBuckets" + }, + "bucketLabel": { + "description": "Guest age label configured for the bucket when Guest Age Categories OPERA Control is active.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, @@ -17247,7 +17253,7 @@ "maxLength": 20 }, "displaySet": { - "description": "Display set for the rate plan.", + "description": "Display set for the rate plan. Passing a value of null in the request data will retain any existing value in the database, and an empty string will nullify the value.", "type": "string", "minLength": 0, "maxLength": 20 diff --git a/rest-api-specs/property/rtpasync.json b/rest-api-specs/property/rtpasync.json index d554c70..6d83796 100644 --- a/rest-api-specs/property/rtpasync.json +++ b/rest-api-specs/property/rtpasync.json @@ -2,8 +2,8 @@ "swagger": "2.0", "info": { "title": "Opera Cloud Rate Plan Asynchronous Service API", - "description": "APIs catering to the Rate Plan asynchronous related functionality in a hotel. This includes adding/updating daily rates' pricing schedules and best available rates by day or length of stay.

This API follows an async pattern where

  • You make an initial request, which returns a Location header
  • You poll HEAD on the Location header returned to obtain the status of the process
  • Once the process completes HEAD will return in the Location header the URL that must be called to obtain the results of the process
  • You call the URL to obtain the results of the process


Compatible with OPERA Cloud release 24.1.

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, 2024 Oracle and/or its affiliates.

", - "version": "24.1", + "description": "APIs catering to the Rate Plan asynchronous related functionality in a hotel. This includes adding/updating daily rates' pricing schedules and best available rates by day or length of stay.

This API follows an async pattern where

  • You make an initial request, which returns a Location header
  • You poll HEAD on the Location header returned to obtain the status of the process
  • Once the process completes HEAD will return in the Location header the URL that must be called to obtain the results of the process
  • You call the URL to obtain the results of the process


Compatible with OPERA Cloud release 24.2.

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, 2024 Oracle and/or its affiliates.

", + "version": "24.2", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com"