diff --git a/rest-api-specs/property/act.json b/rest-api-specs/property/act.json
index e3cbbdc..2e64fea 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.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", + "description": "APIs to cater for Sales Activity functionality in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -24,7 +24,7 @@ "/activities": { "get": { "summary": "Get activities", - "description": "Use this API to retrieve activities for multiple hotels. Results can be narrowed down by your search criteria in the request message.OperationId:getActivitiesByMultipleHotelIds
", + "description": "Use this API to retrieve activities for multiple hotels. Results can be narrowed down by your search criteria in the request message.OperationId:getActivitiesByMultipleHotelIds
The maximum allowable limit for this API is 200.
", "operationId": "getActivitiesByMultipleHotelIds", "parameters": [ { @@ -794,7 +794,7 @@ "/activities/emails": { "get": { "summary": "Get Emails", - "description": "Use this API to retrieve emails which have been received from an external system and stored in OPERA. They are stored against accounts, contacts and blocks in OPERA.OperationId:getEmails
", + "description": "Use this API to retrieve emails which have been received from an external system and stored in OPERA. They are stored against accounts, contacts and blocks in OPERA.OperationId:getEmails
The maximum allowable limit for this API is 200.
This API allows a time span of 90 days.
", "operationId": "getEmails", "parameters": [ { @@ -1398,7 +1398,7 @@ "/hotels/{hotelId}/activities": { "get": { "summary": "Get activities by hotel", - "description": "You can use this API to retrieve multiple Activities for a hotel, you can narrow the results using different search criteriaOperationId:getActivities
", + "description": "You can use this API to retrieve multiple Activities for a hotel, you can narrow the results using different search criteriaOperationId:getActivities
The maximum allowable limit for this API is 200.
", "operationId": "getActivities", "parameters": [ { @@ -3121,7 +3121,7 @@ "/hotels/{hotelId}/activityLog": { "get": { "summary": "Get Activity Log", - "description": "You can use this API to view the changes log for a specified Activity.OperationId:getActivityLog
", + "description": "You can use this API to view the changes log for a specified Activity.OperationId:getActivityLog
The maximum allowable limit for this API is 200.
This API allows a time span of 90 days.
", "operationId": "getActivityLog", "parameters": [ { diff --git a/rest-api-specs/property/actcfg.json b/rest-api-specs/property/actcfg.json index 81ff8be..a439455 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -24,7 +24,7 @@ "/activityResults": { "get": { "summary": "Get all Configured Activity Result Codes ", - "description": "Retrieve a list of all configured Activity Result codes and descriptions. Activity Results appear on the Activities screen in the Results field after the Activity is completed. And example could be Call Again - an activity is Completed but the result code as part of the completion is to Call Again.OperationId:getActivityResultsConfig
", + "description": "Retrieve a list of all configured Activity Result codes and descriptions. Activity Results appear on the Activities screen in the Results field after the Activity is completed. And example could be Call Again - an activity is Completed but the result code as part of the completion is to Call Again.OperationId:getActivityResultsConfig
The maximum allowable limit for this API is 25.
", "operationId": "getActivityResultsConfig", "parameters": [ { @@ -467,7 +467,7 @@ "/autoTraceCodes": { "get": { "summary": "Get Auto Trace codes", - "description": "Retrieve a list of all configured Auto Trace Codes for a property.OperationId:getAutoTraceCodes
", + "description": "Retrieve a list of all configured Auto Trace Codes for a property.OperationId:getAutoTraceCodes
The maximum allowable limit for this API is 25.
", "operationId": "getAutoTraceCodes", "parameters": [ { @@ -1330,7 +1330,7 @@ "/hotels/{hotelId}/activityTypes": { "get": { "summary": "Get all Activity Type Codes", - "description": "Retrieve all configured Activity types for a specified hotel.OperationId:getActivityTypes
", + "description": "Retrieve all configured Activity types for a specified hotel.OperationId:getActivityTypes
The maximum allowable limit for this API is 25.
", "operationId": "getActivityTypes", "parameters": [ { @@ -1801,7 +1801,7 @@ "/hotels/{hotelId}/autoTraceDefinitions": { "get": { "summary": "Get a list of Auto Trace definition Codes", - "description": "Get a list of all Auto trace definitions for a property.OperationId:getAutoTraceDefinitions
", + "description": "Get a list of all Auto trace definitions for a property.OperationId:getAutoTraceDefinitions
The maximum allowable limit for this API is 25.
", "operationId": "getAutoTraceDefinitions", "parameters": [ { @@ -2178,7 +2178,7 @@ "/hotels/{hotelId}/autoTraceOwnerAssignments": { "get": { "summary": "Get an Auto Trace owner mappings", - "description": "This API will provide a list of all configured Auto Trace Owner Mappings.OperationId:getAutoTraceOwnerAssignments
", + "description": "This API will provide a list of all configured Auto Trace Owner Mappings.OperationId:getAutoTraceOwnerAssignments
The maximum allowable limit for this API is 25.
", "operationId": "getAutoTraceOwnerAssignments", "parameters": [ { diff --git a/rest-api-specs/property/ars.json b/rest-api-specs/property/ars.json index c462792..8fc0b73 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.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", + "description": "APIs to cater for Accounts Receivables functionality in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -267,7 +267,7 @@ "/accounts": { "get": { "summary": "Get given profile's account receivable detail", - "description": "Use this API to search for AR Accounts for a given OPERA Profile id. API returns contain a list of AR Accounts and their AR information.OperationId:getAccounts
", + "description": "Use this API to search for AR Accounts for a given OPERA Profile id. API returns contain a list of AR Accounts and their AR information.OperationId:getAccounts
The maximum allowable limit for this API is 20.
", "operationId": "getAccounts", "parameters": [ { @@ -1926,7 +1926,7 @@ "/arTransactions": { "get": { "summary": "Get AR transactions.", - "description": "Use this API to get list of transaction data for a given account receivable account number and list of hotelsOperationId:getARTransactions
", + "description": "Use this API to get list of transaction data for a given account receivable account number and list of hotelsOperationId:getARTransactions
This API allows a time span of 30 days.
", "operationId": "getARTransactions", "parameters": [ { @@ -2240,7 +2240,7 @@ "/hotels/{hotelId}/accounts/invoicesOnHold": { "get": { "summary": "Get list of hold invoices for account receivable", - "description": "Use this API to get list of account receivable invoices which are put on hold.OperationId:getInvoicesOnHold
", + "description": "Use this API to get list of account receivable invoices which are put on hold.OperationId:getInvoicesOnHold
This API allows a time span of 30 days.
", "operationId": "getInvoicesOnHold", "parameters": [ { @@ -6896,7 +6896,7 @@ "/hotels/{hotelId}/transactions/{transactionId}/creditcard/payments": { "get": { "summary": "Get account receivable folios which are paid using credit cards", - "description": "Use this API to get lists of folios for guests who checked out using a credit card payment transaction code that has an account receivable associated with it. It also lists payments made prior to check out if the payment was made using a credit card transaction code that has a an account receivable associated with it.OperationId:getARCreditCardPayments
", + "description": "Use this API to get lists of folios for guests who checked out using a credit card payment transaction code that has an account receivable associated with it. It also lists payments made prior to check out if the payment was made using a credit card transaction code that has a an account receivable associated with it.OperationId:getARCreditCardPayments
The maximum allowable limit for this API is 50.
This API allows a time span of 30 days.
", "operationId": "getARCreditCardPayments", "parameters": [ { @@ -7283,7 +7283,7 @@ "/invoicePayments/accounts/{accountId}": { "get": { "summary": "Get payment detail for account's invoices", - "description": "Use this API to get payment data for account receivable invoices.OperationId:getInvoicesPayments
", + "description": "Use this API to get payment data for account receivable invoices.OperationId:getInvoicesPayments
The maximum allowable limit for this API is 50.
", "operationId": "getInvoicesPayments", "parameters": [ { @@ -7589,7 +7589,7 @@ "/invoicePostings": { "get": { "summary": "Get account receivable invoice postings", - "description": "Use this API to get account receivable postings.OperationId:getInvoicePostings
", + "description": "Use this API to get account receivable postings.OperationId:getInvoicePostings
This API allows a time span of 30 days.
", "operationId": "getInvoicePostings", "parameters": [ { diff --git a/rest-api-specs/property/blk.json b/rest-api-specs/property/blk.json index d0230b3..3d9f124 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.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", + "description": "APIs to cater for Business Block functionality in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -126,7 +126,7 @@ "/blockActivityLog": { "get": { "summary": "Get the Block activity log", - "description": "Use this API to facilitate retrieving the block activity log.OperationId:getBlockActivityLog
", + "description": "Use this API to facilitate retrieving the block activity log.OperationId:getBlockActivityLog
The maximum allowable limit for this API is 200.
", "operationId": "getBlockActivityLog", "parameters": [ { @@ -551,7 +551,7 @@ "/blocks": { "get": { "summary": "Get Blocks", - "description": "Use this API to retrieve a list of blocks for requested query parameters. A wide range of query parameters is available to support various persona requirements, so it is recommended to include, at least, the hotel block date range, stay date range, and/or number of days as query parameters. You can use more query parameters to narrow your results. This API is not designed to support sync between two systems or initial upload of data. If x-hubid is used as a header, it returns matching data from multiple hotels within the same chain.OperationId:getBlocks
", + "description": "Use this API to retrieve a list of blocks for requested query parameters. A wide range of query parameters is available to support various persona requirements, so it is recommended to include, at least, the hotel block date range, stay date range, and/or number of days as query parameters. You can use more query parameters to narrow your results. This API is not designed to support sync between two systems or initial upload of data. If x-hubid is used as a header, it returns matching data from multiple hotels within the same chain.OperationId:getBlocks
The maximum allowable limit for this API is 200.
", "operationId": "getBlocks", "parameters": [ { @@ -571,6 +571,7 @@ "name": "limit", "in": "query", "required": false, + "maximum": 200, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, @@ -1480,7 +1481,7 @@ "/blocks/statistics": { "get": { "summary": "Get Block statistics", - "description": "This API retrieves block statistics.OperationId:getBlockStats
", + "description": "This API retrieves block statistics.OperationId:getBlockStats
This API allows a time span of 90 days.
", "operationId": "getBlockStats", "parameters": [ { @@ -15289,7 +15290,7 @@ "/blocks/{blockId}/restrictions": { "get": { "summary": "Get Block restrictions ", - "description": "This API retrieves block restrictions.OperationId:getBlockRestrictions
", + "description": "This API retrieves block restrictions.OperationId:getBlockRestrictions
This API allows a time span of 90 days.
", "operationId": "getBlockRestrictions", "parameters": [ { @@ -15532,7 +15533,7 @@ }, "delete": { "summary": "Delete Block Restriction", - "description": "Use this API to delete block restrictions.OperationId:deleteBlockRestriction
", + "description": "Use this API to delete block restrictions.OperationId:deleteBlockRestriction
This API allows a time span of 90 days.
", "operationId": "deleteBlockRestriction", "parameters": [ { @@ -15587,6 +15588,18 @@ "OpenForDeparture" ] }, + { + "name": "roomTypes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Room Type for the restriction.", + "items": { + "type": "string", + "maxItems": 100 + }, + "required": false + }, { "$ref": "#/parameters/authKey" }, @@ -16040,7 +16053,7 @@ "/blocks/{blockId}/roomTypes": { "get": { "summary": "Get Bock Room Types", - "description": "Use this API to retrieve room types for a block based on search criteriaOperationId:getBlockRoomTypes
", + "description": "Use this API to retrieve room types for a block based on search criteriaOperationId:getBlockRoomTypes
This API allows a time span of 30 days.
", "operationId": "getBlockRoomTypes", "parameters": [ { @@ -16704,7 +16717,7 @@ "/blocks/{blockId}/statusActivityLog": { "get": { "summary": "Get Block Status Activity Log", - "description": "Use this API to retrieve block status change log based on the HotelCode and Block ID.OperationId:getBlockStatusChanges
", + "description": "Use this API to retrieve block status change log based on the HotelCode and Block ID.OperationId:getBlockStatusChanges
The maximum allowable limit for this API is 200.
This API allows a time span of 30 days.
", "operationId": "getBlockStatusChanges", "parameters": [ { @@ -17284,6 +17297,7 @@ "summary": "Remove Block Wash Schedules", "description": "Use this API to remove block wash schedules based on the HotelCode, Block ID and Wash Date.OperationId:deleteBlockWashSchedules
", "operationId": "deleteBlockWashSchedules", + "deprecated": true, "parameters": [ { "name": "blockId", @@ -19735,7 +19749,7 @@ "/hotels/{hotelId}/blocks/changesByDateTime": { "get": { "summary": "Get modified blocks from a specific time period in OPERA.", - "description": "A user can search for blocks that have been created, updated and/or deleted within maximum 3 day date range. If in the time period searched a block was created and deleted, the query won't return this information. If a block is created and updated, the create information is returned. If a block is updated only, it returns the update. If a block is updated and delete, it returns the delete.", + "description": "A user can search for blocks that have been created, updated and/or deleted within maximum 3 day date range. If in the time period searched a block was created and deleted, the query won't return this information. If a block is created and updated, the create information is returned. If a block is updated only, it returns the update. If a block is updated and delete, it returns the delete.The maximum allowable limit for this API is 1000.
This API allows a time span of 3 days.
", "operationId": "blockChangesByDateTime", "parameters": [ { @@ -19797,6 +19811,14 @@ "description": "Indicates if modified blocks are only for catering.", "type": "boolean" }, + { + "name": "includeEventChanges", + "in": "query", + "required": false, + "description": "Indicates if event changes for block are to be included.", + "type": "boolean", + "default": "false" + }, { "name": "limit", "in": "query", @@ -27987,6 +28009,311 @@ ] } }, + "/hotels/{hotelId}/blocks/{blockId}/regularToMasterBlock/{masterBlockCode}": { + "put": { + "summary": "Use this API to convert a regular block to a master block", + "description": "This API converts a regular block to a master block. The regular block is converted to a sub block with its room grid and events (if any on the original) and a master block is created with the same information as in the original block, except room grid and events.OperationId:putRegularToMasterBlock
", + "operationId": "putRegularToMasterBlock", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Hotel Id" + }, + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Block Id" + }, + { + "name": "masterBlockCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "The block code of the master block to be created" + }, + { + "$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": [ + "Block" + ] + } + }, + "/hotels/{hotelId}/blocks/{blockId}/roomRateGrid": { + "get": { + "summary": "Operation to get room rate grid for a Block and supports pagination.", + "description": "Use this API to retrieve grid details for a specific block. The response will include detailed information about the block grid and response can be paginated for blocks with longer date range..OperationId:getBlockRoomRateGrid
", + "operationId": "getBlockRoomRateGrid", + "parameters": [ + { + "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": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Hotel Id" + }, + { + "name": "fetchAllocatedRoomTypes", + "in": "query", + "required": false, + "description": "Indicates whether to fetch only those room types that have rooms allocated. If this flag is true then only those room types with rooms allocated for the block are fetched. Only applicable to fetch instruction RateGrid.", + "type": "boolean", + "default": false + }, + { + "name": "startDate", + "in": "query", + "required": false, + "description": "Start Date for the rate grid data. Only applicable to fetch instruction RateGrid.", + "type": "string", + "format": "date" + }, + { + "name": "numberOfDays", + "in": "query", + "required": false, + "description": "Number of days to fetch for the rate grid data. Only applicable to fetch instruction RateGrid.", + "type": "number" + }, + { + "name": "roomAllocationCriteria", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Simple type for block allocation used in room rate grid.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "Initial", + "Actual", + "Rates", + "Pickup", + "Contract", + "Available", + "Pickupperc", + "Changes", + "Released", + "Houseavailability", + "SellLimit", + "AvailableSellLimit", + "MasterAllocInitial", + "Allocated", + "SubAllocResv", + "CutoffDate", + "ForecastRooms", + "ForecastRates" + ] + }, + "required": false + }, + { + "name": "roomTypes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "The Room Types that need to be fetched for the rate room grid data. If these values are not provided, all room types for the block will be fetched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "limit", + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer", + "default": 20 + }, + { + "name": "offset", + "in": "query", + "default": 0, + "required": false, + "description": "Index or initial index of the set(page) being requested.", + "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": "Grid details of block.", + "schema": { + "$ref": "#/definitions/blockGridType" + } + }, + "204": { + "description": "Block grid details 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": [ + "Block" + ] + } + }, "/hotels/{hotelId}/blocks/{blockId}/shifts": { "put": { "summary": "Shifts the Block start date", @@ -29930,6 +30257,113 @@ ] } }, + "/hotels/{hotelId}/blocks/{blockId}/subBlockToRegular": { + "put": { + "summary": "Use this API to convert a sub block to a regular block", + "description": "This API converts a sub block to a regular block. If this is the only sub block for its master block, then the master block becomes a regular block as well.OperationId:putSubBlockToRegular
", + "operationId": "putSubBlockToRegular", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Hotel Id" + }, + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Block Id" + }, + { + "$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": [ + "Block" + ] + } + }, "/hotels/{hotelId}/blocks/{blockId}/subBlocks": { "post": { "summary": "Create a sub-Block", @@ -30050,6 +30484,120 @@ ] } }, + "/hotels/{hotelId}/blocks/{blockId}/washSchedules": { + "delete": { + "summary": "Remove Block Wash Schedule", + "description": "Use this API to remove block wash schedule based on the HotelCode, Block ID and Wash Date.OperationId:deleteBlockWashSchedule
", + "operationId": "deleteBlockWashSchedule", + "parameters": [ + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Block Id" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Hotel Id" + }, + { + "name": "washDate", + "in": "query", + "type": "string", + "format": "date", + "description": "Block Wash Date" + }, + { + "$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": [ + "Block" + ] + } + }, "/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}": { "get": { "summary": "Get a Block By ID", @@ -31181,7 +31729,7 @@ "/hotels/{hotelId}/tracesByDateRange": { "get": { "summary": "Get Traces By Date Range", - "description": "You can use this API to get traces for Reservations and Blocks.OperationId:getTracesByDateRange
", + "description": "You can use this API to get traces for Reservations and Blocks.OperationId:getTracesByDateRange
This API allows a time span of 90 days.
", "operationId": "getTracesByDateRange", "parameters": [ { @@ -32836,6 +33384,10 @@ "description": "Indicates whether rates of a block can be overridden. Applicable only for blocks with a Rate Code.", "type": "boolean" }, + "hasLinkedActivities": { + "description": "Indicates if block has any linked activity(s).", + "type": "boolean" + }, "manualCutOff": { "description": "Indicates whether Block was cutoff manually.", "type": "boolean" @@ -52468,6 +53020,10 @@ "masterBlock": { "description": "When true, Master block will be copied along with the sub blocks.", "type": "boolean" + }, + "copySubBlockAsRegularBlock": { + "description": "When true, this sub block will be copied as a new regular block.", + "type": "boolean" } } }, @@ -53071,6 +53627,10 @@ "minLength": 0, "maxLength": 20 }, + "updateLinkedActivities": { + "description": "Indicates whether to update the linked activities or not. If true and primary block profile and owners information is updated, then all associated linked activities will be updated with the new information.", + "type": "boolean" + }, "markAsRecentlyAccessed": { "description": "Mark this block as recently accessed.", "type": "boolean" @@ -55340,7 +55900,8 @@ "enum": [ "CREATE", "UPDATE", - "DELETE" + "DELETE", + "NONE" ] }, "blockChangesByDateTimeSummary": { @@ -55420,8 +55981,12 @@ }, "actionType": { "type": "string", - "description": "Action performed on the Business Block - CREATE, UPDATE, DELETE.", + "description": "Action performed on the Business Block - CREATE, UPDATE, DELETE, NONE. When block is created/updated/deleted, then CREATE/UPDATE/DELETE will be set to actionType. In case of no changes to the business block, but there are only catering event changes, then NONE will be set to actionType.", "$ref": "#/definitions/transactionActionEnumType" + }, + "eventsChanged": { + "description": "Indicates whether there are any catering events, linked to the business block, that have been changed, deleted, or created within the timeframe.", + "type": "boolean" } } }, @@ -55565,6 +56130,63 @@ "maxLength": 20 } } + }, + "gridRoomAllocations": { + "type": "object", + "properties": { + "roomAllocationType": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/roomAllocationTypeType" + } + }, + "masterInfo": { + "description": "Room Allocations Master Information contains all the room types in the property.", + "$ref": "#/definitions/roomAllocationMasterInfoType" + }, + "startDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "numberOfDays": { + "type": "number" + } + } + }, + "blockGridType": { + "type": "object", + "properties": { + "blockIdList": { + "description": "Collection of unique block identifiers.", + "$ref": "#/definitions/blockIdList" + }, + "roomAllocations": { + "description": "Grid details of block.", + "$ref": "#/definitions/gridRoomAllocations" + }, + "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" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/blkasync.json b/rest-api-specs/property/blkasync.json index bd20e11..8c594fc 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.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", + "description": "APIs to cater Block Reservation related asynchronous functionality in OPERA.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -24,7 +24,7 @@ "/externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary": { "post": { "summary": "This API facilitates fetching block allocation summary for a Hotel.", - "description": "This API will fetch Block allocation information for a hotel, and specified date range. The block allocated inventory, rates and room type statistics are returned as part of the response.OperationId:startBlockAllocationSummaryProcess
", + "description": "This API will fetch Block allocation information for a hotel, and specified date range. The block allocated inventory, rates and room type statistics are returned as part of the response. The maximum limit of date range (whether using start/endDate or startLastModifiedDate/endLastModifiedDate) is 94 days, but the recommendation is to use a date range proportionate to the size of the hotel. Every identical request (employing the same query parameters) for the getBlockAllocationSummary operation when requesting data with start/endDate or startLastModifiedDate/endLastModifiedDate, necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed. The API returns a header parameter location that can be used in the getBlockAllocationSummaryProcessStatus operation. Use event-driven APIs -(see https://docs.oracle.com/cd/F29336_01/doc.201/f27480/c_business_events.htm#OHIPU-BusinessEvents-F0AC1F1C) -to get real-time block updates.OperationId:startBlockAllocationSummaryProcess
", "operationId": "startBlockAllocationSummaryProcess", "x-interaction": [ "async-polling" @@ -1914,7 +1914,7 @@ } }, "bookingMedium": { - "description": "Booking Medium of the Block.", + "description": "Booking Medium/Origin Code of the Block.", "type": "string", "minLength": 0, "maxLength": 20 diff --git a/rest-api-specs/property/blkcfg.json b/rest-api-specs/property/blkcfg.json index faff00d..b7f8373 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 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", + "description": "APIs for Block configuration, such as creating, updating, fetching and removing codes related to blocks.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -2953,7 +2953,7 @@ "/hotels/{hotelId}/blockSalesAllowance": { "get": { "summary": "Get Block Sales Allowance", - "description": "You can use this API to get Block Sales Allowance.OperationId:getBlockSalesAllowance
", + "description": "You can use this API to get Block Sales Allowance.OperationId:getBlockSalesAllowance
This API allows a time span of 90 days.
", "operationId": "getBlockSalesAllowance", "parameters": [ { @@ -3081,10 +3081,146 @@ ] } }, + "/hotels/{hotelId}/blockSalesAllowance/activityLog": { + "get": { + "summary": "Get the Block Sales Allowance activity log", + "description": "Use this API to facilitate retrieving the Block Sales Allowance activity log.OperationId:getBlockSalesAllowanceActivityLog
", + "operationId": "getBlockSalesAllowanceActivityLog", + "parameters": [ + { + "name": "limit", + "in": "query", + "required": false, + "maximum": 200, + "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": "hotelId", + "in": "path", + "required": true, + "description": "Hotel code.", + "minLength": 1, + "maxLength": 20, + "type": "string" + }, + { + "name": "changeLogDate", + "in": "query", + "required": false, + "description": "Search date for the user activity log.", + "type": "string", + "format": "date" + }, + { + "name": "salesAllowanceDate", + "in": "query", + "required": false, + "description": "Sales Allowance date for the user activity log.", + "type": "string", + "format": "date" + }, + { + "name": "userId", + "in": "query", + "type": "integer", + "required": false, + "description": "User Id for the user activity log." + }, + { + "$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 block sales allowance activity log. This object contains collection of user activity log for the block sales allowance changes.", + "schema": { + "$ref": "#/definitions/blockSalesAllowanceActivityLog" + } + }, + "204": { + "description": "Block sales allowance activity log 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": [ + "BlockConfig" + ] + } + }, "/hotels/{hotelId}/blockSalesAllowanceRange": { "delete": { "summary": "Delete block sales allowance range", - "description": "You can use this API to delete block sales allowance range.OperationId:deleteBlockSalesAllowanceRange
", + "description": "You can use this API to delete block sales allowance range.OperationId:deleteBlockSalesAllowanceRange
This API allows a time span of 90 days.
", "operationId": "deleteBlockSalesAllowanceRange", "parameters": [ { @@ -3349,7 +3485,7 @@ "/hotels/{hotelId}/cutoffSchedules": { "get": { "summary": "Get block cutoff schedule codes.", - "description": "This API fetches a list of configured cutoff schedule codes for the property. It returns cutoff schedule code, description, start date, end date and default cutoff days. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.OperationId:getCutoffSchedules
", + "description": "This API fetches a list of configured cutoff schedule codes for the property. It returns cutoff schedule code, description, start date, end date and default cutoff days. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.OperationId:getCutoffSchedules
The maximum allowable limit for this API is 20.
", "operationId": "getCutoffSchedules", "parameters": [ { @@ -3588,7 +3724,7 @@ "/hotels/{hotelId}/cutoffSchedules/{cutoffCodeId}": { "get": { "summary": "Get cutoff Schedules Details for a cutoff schedule code.", - "description": "This API fetches a list of cutoff schedule details for a cutoff schedule code. It returns stay date, room type and cutoff days for cutoff schedule. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.OperationId:getCutoffSchedulesDetails
", + "description": "This API fetches a list of cutoff schedule details for a cutoff schedule code. It returns stay date, room type and cutoff days for cutoff schedule. Cutoff schedule codes can be applied to blocks, to default number of cutoff days per stay date and room type. A default number number of cutoff days can be set on cutoff scheduler header level, and will be applied when no specific number of days has been defined for a date / room type combination within the cutoff schedule dates.OperationId:getCutoffSchedulesDetails
The maximum allowable limit for this API is 365.
", "operationId": "getCutoffSchedulesDetails", "parameters": [ { @@ -3926,7 +4062,7 @@ "/hotels/{hotelId}/salesManagers": { "get": { "summary": "Get Sales Managers by Hotel.", - "description": "You can use this API to retrieve multiple Sales Managers for a hotel, you can narrow the results using different search criteria.OperationId:getSalesManagers
", + "description": "You can use this API to retrieve multiple Sales Managers for a hotel, you can narrow the results using different search criteria.OperationId:getSalesManagers
The maximum allowable limit for this API is 20.
", "operationId": "getSalesManagers", "parameters": [ { @@ -4063,7 +4199,7 @@ "/hotels/{hotelId}/salesManagers/{salesManagerId}/salesManagerGoals": { "get": { "summary": "Get Sales Manager Goals by Hotel", - "description": "You can use this API to retrieve individual Sales Manager Goals for a hotel, you can narrow the results using different search criteria.OperationId:getSalesManagerGoals
", + "description": "You can use this API to retrieve individual Sales Manager Goals for a hotel, you can narrow the results using different search criteria.OperationId:getSalesManagerGoals
The maximum allowable limit for this API is 20.
", "operationId": "getSalesManagerGoals", "parameters": [ { @@ -5230,7 +5366,7 @@ "/salesManagers": { "get": { "summary": "Get Sales Managers.", - "description": "You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria.OperationId:getSalesManagersMultipleHotelIds
", + "description": "You can use this API to retrieve multiple Sales Managers, you can narrow the results using different search criteria.OperationId:getSalesManagersMultipleHotelIds
The maximum allowable limit for this API is 20.
", "operationId": "getSalesManagersMultipleHotelIds", "parameters": [ { @@ -5476,7 +5612,7 @@ }, "get": { "summary": "Get Sales Manager Goals", - "description": "You can use this API to retrieve individual Sales Manager Goals, you can narrow the results using different search criteria.OperationId:getSalesManagerGoalsMultipleHotelIds
", + "description": "You can use this API to retrieve individual Sales Manager Goals, you can narrow the results using different search criteria.OperationId:getSalesManagerGoalsMultipleHotelIds
The maximum allowable limit for this API is 20.
", "operationId": "getSalesManagerGoalsMultipleHotelIds", "parameters": [ { @@ -5983,6 +6119,9 @@ "inactive": { "description": "Indicates whether the Block Cancellation Reason is inactive or not, returns TRUE when inactive", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -6317,6 +6456,9 @@ "inactive": { "description": "Indicates whether the Block Lost Reason is inactive or not, returns TRUE when inactive", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -6393,6 +6535,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -6473,6 +6618,9 @@ "inactive": { "description": "Indicates whether the Block Refused Reason is inactive or not, returns TRUE when inactive", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -6796,6 +6944,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -7406,6 +7557,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -7684,6 +7838,119 @@ "type": "boolean" } } + }, + "managedByOptions": { + "description": "Describes of the Configuration is Managed by Enterprise or Property.", + "type": "string", + "enum": [ + "EnterpriseManaged", + "PropertyManaged", + "EnterpriseEnforced", + "PropertyOverridden" + ] + }, + "blockSalesAllowanceActivityLogListType": { + "type": "object", + "properties": { + "activityLog": { + "type": "array", + "maxItems": 200, + "items": { + "$ref": "#/definitions/blockSalesAllowanceActivityLogType" + } + }, + "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" + } + } + }, + "blockSalesAllowanceActivityLogType": { + "type": "object", + "properties": { + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "logDate": { + "type": "string", + "format": "date-time", + "description": "Date on which change happened." + }, + "salesAllowanceDate": { + "type": "string", + "format": "date-time", + "description": "sales Allowance Date" + }, + "oldQuantity": { + "type": "number", + "description": "Value of sales allowance before the change." + }, + "newQuantity": { + "type": "number", + "description": "Value of sales allowance after the change." + }, + "refActionId": { + "type": "number" + }, + "logUserId": { + "type": "number", + "description": "ID of user who made the change." + }, + "logUserName": { + "type": "string", + "description": "Name of user who made the change." + }, + "actionType": { + "type": "string", + "minLength": 0, + "maxLength": 100, + "description": "Action type." + }, + "ipAddress": { + "description": "The IP Address of the machine that performed the activity", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "blockSalesAllowanceActivityLog": { + "type": "object", + "description": "Response object for fetching block sales allowance activity log.", + "properties": { + "blockSalesAllowance": { + "description": "Response object for Block Sales Allowance activity Log.", + "$ref": "#/definitions/blockSalesAllowanceActivityLogListType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/bof.json b/rest-api-specs/property/bof.json index 1ef3ecb..5558062 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.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", + "description": "APIs to cater for Back Office Operations functionality in OPERA Cloud.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.4", "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 729ed13..58be6f4 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.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", + "description": "APIs to cater for Channel Management functionality in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -13138,25 +13138,92 @@ ] } }, - "/hotels/totalPricing": { - "post": { - "summary": "Adds total pricing tax and fee types", - "description": "Use this API to add global distribution channels tax and fee configurations.OperationId:postTotalPricingElements
", - "operationId": "postTotalPricingElements", + "/clusters/{clusterId}/channels/negotiatedRates": { + "get": { + "summary": "Gets channel negotiate rate", + "description": "Use this API to update channel's negotiated rate code mapping including negotiated profile, negotiate rate access code, start date, end date, and sequence.OperationId:getChannelNegotiatedRates
", + "operationId": "getChannelNegotiatedRates", "deprecated": true, "parameters": [ { - "name": "totalPricingElements", - "in": "body", - "required": true, - "description": "Request object to create the total pricing elements of GDS channel.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/totalPricingElements" - } - ] - } + "name": "limit", + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" + }, + { + "$ref": "#/parameters/clusterIdPath" + }, + { + "name": "hotelIds", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "required": true + }, + { + "name": "channelCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "channelRateCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "ratePlanCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "accessCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "internalChannelsOnly", + "in": "query", + "required": false, + "description": "If true then it would fetch only the internal channels. If false then it expects channelCode as well to establish if its an inernal or external channel.", + "type": "boolean", + "default": false + }, + { + "name": "uniqueId", + "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": "uniqueIdType", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "required": false }, { "$ref": "#/parameters/authKey" @@ -13175,24 +13242,23 @@ } ], "responses": { - "201": { + "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", + "description": "Response object for fetching Negotiated channel rates.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/profileNegotiatedRateDetails" } }, + "204": { + "description": "ChannelNegotiatedRate not found." + }, "400": { "$ref": "#/responses/400" }, @@ -13239,26 +13305,37 @@ "tags": [ "Channel" ] - }, + } + }, + "/clusters/{clusterId}/channels/profileRatesAccess": { "put": { - "summary": "Updates total pricing tax and fee types", - "description": "Use this API to update global distribution channels tax and fee configurationsOperationId:putTotalPricingElements
", - "operationId": "putTotalPricingElements", + "summary": "Initiate profile rate access codes", + "description": "OperationId: putProfileNegRateAccessCodes
Operation to Initiate profile rate access codes
", + "operationId": "putProfileNegRateAccessCodes", "deprecated": true, "parameters": [ { - "name": "totalPricingElements", + "name": "items", "in": "body", "required": true, - "description": "Request object to change the total pricing elements of GDS channel.", + "description": "Request for configuring profile rate access codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/totalPricingElements" + "$ref": "#/definitions/profileRateAccessCodes" } ] } }, + { + "name": "clusterId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "description": "ClusterId in URI path." + }, { "$ref": "#/parameters/authKey" }, @@ -13289,7 +13366,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" } @@ -13340,37 +13417,36 @@ "tags": [ "Channel" ] - }, - "delete": { - "summary": "Deletes total pricing tax and fee types", - "description": "Use this API to delete global distribution channels tax and fee configurations.OperationId:deleteTotalPricingElements
", - "operationId": "deleteTotalPricingElements", + } + }, + "/clusters/{clusterId}/channels/profileRatesAccessDeletes": { + "post": { + "summary": "Delete Channel Rates Access for cluster level", + "operationId": "deleteProfileNegRateAccessCodes", + "description": "operationId:deleteProfileNegRateAccessCodes
Delete Channel Rates Access for cluster level
", "deprecated": true, "parameters": [ { - "name": "hotelId", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Hotel Code that associated with Transaction Code and Total Pricing Element", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "code", - "in": "query", - "required": false, - "description": "Code.", - "type": "string" + "name": "deleteNegotiatedRates", + "in": "body", + "required": true, + "description": "Request body", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/deleteNegotiatedRates" + } + ] + } }, { - "name": "description", - "in": "query", - "required": false, - "description": "description.", - "type": "string" + "name": "clusterId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "description": "ClusterId in URI path." }, { "$ref": "#/parameters/authKey" @@ -13389,7 +13465,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -13455,26 +13531,31 @@ ] } }, - "/hotels/totalPricing/copy": { + "/clusters/{clusterId}/channels/syncProfileRatesAccess": { "put": { - "summary": "Allows to copy total pricing tax and fees to another hotel id", - "description": "Use this API to copy global distribution system's fee and tax configurations from one hotel to another hotel within same chain/tenantOperationId:copyTotalPricingElements
", - "operationId": "copyTotalPricingElements", + "summary": "Sync profile rate access codes", + "description": "OperationId: syncProfileNegRateAccessCodes
Operation to Initiate profile rate access codes
", + "operationId": "syncProfileNegRateAccessCodes", "deprecated": true, "parameters": [ { - "name": "totalPricingElementsCopy", + "name": "items", "in": "body", "required": true, - "description": "Request object to copy the total pricing elements into the target properties.", + "description": "Request for configuring profile rate access codes.", "schema": { - "allOf": [ - { - "$ref": "#/definitions/totalPricingElementsCopy" - } - ] + "$ref": "#/definitions/syncProfileRatesAccessCodes" } }, + { + "name": "clusterId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "description": "ClusterId in URI path." + }, { "$ref": "#/parameters/authKey" }, @@ -13505,7 +13586,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" } @@ -13558,43 +13639,25 @@ ] } }, - "/hotels/{hotelId}/channel/sellLimits": { - "get": { - "summary": "Gets sell limit detail for a given channel hotel combination", - "description": "Use this API to retrieve channel sell limit detail to get or review daily sell limits for a given hotel-channel combination.OperationId:getChannelSellLimits
", - "operationId": "getChannelSellLimits", + "/hotels/totalPricing": { + "post": { + "summary": "Adds total pricing tax and fee types", + "description": "Use this API to add global distribution channels tax and fee configurations.OperationId:postTotalPricingElements
", + "operationId": "postTotalPricingElements", "deprecated": true, "parameters": [ { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel where channel sell limits is searched." - }, - { - "name": "fromDate", - "in": "query", + "name": "totalPricingElements", + "in": "body", "required": true, - "description": "Sell limits which exist at or beyond this date will be fetched.", - "type": "string", - "format": "date" - }, - { - "name": "bookingChannelCode", - "in": "query", - "required": false, - "description": "Channel for which the sell limits are to be fetched.", - "type": "string" - }, - { - "name": "channelRoomType", - "in": "query", - "required": false, - "description": "Channel room type for which the sell limits are to be fetched.", - "type": "string" + "description": "Request object to create the total pricing elements of GDS channel.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/totalPricingElements" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -13613,23 +13676,24 @@ } ], "responses": { - "200": { + "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": "Response object containing sell limit schedules set for the channel or channel room type.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/channelSellLimits" + "$ref": "#/definitions/status" } }, - "204": { - "description": "ChannelSellLimits not found." - }, "400": { "$ref": "#/responses/400" }, @@ -13674,35 +13738,24 @@ "application/json;charset=UTF-8" ], "tags": [ - "Inventory" + "Channel" ] - } - }, - "/hotels/{hotelId}/channelSellLimits": { + }, "put": { - "summary": "Updates channel sell limits by date", - "description": "Use this API to update channel property sell limit mapping by given dates.OperationId:changeChannelSellLimitsByDate
", - "operationId": "changeChannelSellLimitsByDate", + "summary": "Updates total pricing tax and fee types", + "description": "Use this API to update global distribution channels tax and fee configurationsOperationId:putTotalPricingElements
", + "operationId": "putTotalPricingElements", "deprecated": true, "parameters": [ { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel where channel sell limits are updated by date." - }, - { - "name": "channelSellLimitsByDate", + "name": "totalPricingElements", "in": "body", "required": true, - "description": "Request object to create or update sell limits for the channel or channel room type by day. Advanced logic is implemented to combine consecutive blocks of sell limits into a single schedule which have the same limits configured. Existing schedules can also be split as needed to account for overlapping schedules.", + "description": "Request object to change the total pricing elements of GDS channel.", "schema": { "allOf": [ { - "$ref": "#/definitions/channelSellLimitsByDate" + "$ref": "#/definitions/totalPricingElements" } ] } @@ -13786,34 +13839,39 @@ "application/json;charset=UTF-8" ], "tags": [ - "Inventory" + "Channel" ] - } - }, - "/hotels/{hotelId}/channelSellLimits/{Id}": { + }, "delete": { - "summary": "Deletes channel sell limits", - "description": "Use this API to delete channel property sell limit mapping.OperationId:deleteChannelSellLimits
", - "operationId": "deleteChannelSellLimits", + "summary": "Deletes total pricing tax and fee types", + "description": "Use this API to delete global distribution channels tax and fee configurations.OperationId:deleteTotalPricingElements
", + "operationId": "deleteTotalPricingElements", "deprecated": true, "parameters": [ { - "name": "Id", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the channel sell limit to be deleted." + "name": "hotelId", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Hotel Code that associated with Transaction Code and Total Pricing Element", + "items": { + "type": "string" + }, + "required": false }, { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel where channel sell limits is deleted." + "name": "code", + "in": "query", + "required": false, + "description": "Code.", + "type": "string" + }, + { + "name": "description", + "in": "query", + "required": false, + "description": "description.", + "type": "string" }, { "$ref": "#/parameters/authKey" @@ -13894,106 +13952,29 @@ "application/json;charset=UTF-8" ], "tags": [ - "Inventory" + "Channel" ] } }, - "/hotels/{hotelId}/channels/guarantees": { - "get": { - "summary": "Gets channel guarantee code mappings", - "description": "Use this API to get the list of the channel guarantee code mappings to the OPERA guarantee codes.OperationId:getChannelGuaranteeCodeMappings
", - "operationId": "getChannelGuaranteeCodeMappings", + "/hotels/totalPricing/copy": { + "put": { + "summary": "Allows to copy total pricing tax and fees to another hotel id", + "description": "Use this API to copy global distribution system's fee and tax configurations from one hotel to another hotel within same chain/tenantOperationId:copyTotalPricingElements
", + "operationId": "copyTotalPricingElements", "deprecated": true, "parameters": [ { - "name": "hotelId", - "in": "path", + "name": "totalPricingElementsCopy", + "in": "body", "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID that identifies a single hotel property." - }, - { - "name": "hotelIds", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Hotel code.", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "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": "bookingChannelCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "guaranteeCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "channelGuaranteeCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "includeInactive", - "in": "query", - "required": false, - "description": "Indicates whether search includes inactive mapping.", - "type": "boolean" - }, - { - "name": "fetchUnmapped", - "in": "query", - "required": false, - "description": "Indicates whether unmapped channel-hotel guarantee code should be fetched.", - "type": "boolean" - }, - { - "name": "fetchMapped", - "in": "query", - "required": false, - "description": "Indicates whether mapped channel-hotel guarantee code should be fetched.", - "type": "boolean" + "description": "Request object to copy the total pricing elements into the target properties.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/totalPricingElementsCopy" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -14019,16 +14000,17 @@ "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 object for fetching channel-hotel guarantee code mappings.", + "description": "Response Body.", "schema": { - "$ref": "#/definitions/channelGuaranteeCodeMappingDetails" + "$ref": "#/definitions/status" } }, - "204": { - "description": "ChannelGuaranteeCodeMappings not found." - }, "400": { "$ref": "#/responses/400" }, @@ -14077,11 +14059,11 @@ ] } }, - "/hotels/{hotelId}/channels/ratePlans": { - "put": { - "summary": "Publishes channel hotel rate plan codes", - "description": "This API changes the channel rate plans for given Hotel Id.OperationId:publishHotelChannelRatePlans
", - "operationId": "publishHotelChannelRatePlans", + "/hotels/{hotelId}/channel/sellLimits": { + "get": { + "summary": "Gets sell limit detail for a given channel hotel combination", + "description": "Use this API to retrieve channel sell limit detail to get or review daily sell limits for a given hotel-channel combination.OperationId:getChannelSellLimits
", + "operationId": "getChannelSellLimits", "deprecated": true, "parameters": [ { @@ -14091,20 +14073,29 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID that identifies a single hotel property." + "description": "Unique ID of the hotel where channel sell limits is searched." }, { - "name": "channelRatePlans", - "in": "body", + "name": "fromDate", + "in": "query", "required": true, - "description": "Request object for publishing rate codes to GDS.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/channelRatePlans" - } - ] - } + "description": "Sell limits which exist at or beyond this date will be fetched.", + "type": "string", + "format": "date" + }, + { + "name": "bookingChannelCode", + "in": "query", + "required": false, + "description": "Channel for which the sell limits are to be fetched.", + "type": "string" + }, + { + "name": "channelRoomType", + "in": "query", + "required": false, + "description": "Channel room type for which the sell limits are to be fetched.", + "type": "string" }, { "$ref": "#/parameters/authKey" @@ -14130,17 +14121,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": "Response Body.", + "description": "Response object containing sell limit schedules set for the channel or channel room type.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/channelSellLimits" } }, + "204": { + "description": "ChannelSellLimits not found." + }, "400": { "$ref": "#/responses/400" }, @@ -14185,15 +14175,15 @@ "application/json;charset=UTF-8" ], "tags": [ - "Channel" + "Inventory" ] } }, - "/hotels/{hotelId}/channels/rates": { - "post": { - "summary": "Distributes channel rate mappings to channel room types", - "description": "Use this API to link (distribute) channel a rate code to channel room types.OperationId:postChannelRates
", - "operationId": "postChannelRates", + "/hotels/{hotelId}/channelSellLimits": { + "put": { + "summary": "Updates channel sell limits by date", + "description": "Use this API to update channel property sell limit mapping by given dates.OperationId:changeChannelSellLimitsByDate
", + "operationId": "changeChannelSellLimitsByDate", "deprecated": true, "parameters": [ { @@ -14203,17 +14193,17 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID that identifies a single hotel property." + "description": "Unique ID of the hotel where channel sell limits are updated by date." }, { - "name": "channelRates", + "name": "channelSellLimitsByDate", "in": "body", "required": true, - "description": "Request object for distributing channel rates.", + "description": "Request object to create or update sell limits for the channel or channel room type by day. Advanced logic is implemented to combine consecutive blocks of sell limits into a single schedule which have the same limits configured. Existing schedules can also be split as needed to account for overlapping schedules.", "schema": { "allOf": [ { - "$ref": "#/definitions/channelRates" + "$ref": "#/definitions/channelSellLimitsByDate" } ] } @@ -14235,7 +14225,7 @@ } ], "responses": { - "201": { + "200": { "headers": { "Content-Language": { "type": "string", @@ -14248,7 +14238,7 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } @@ -14297,15 +14287,123 @@ "application/json;charset=UTF-8" ], "tags": [ - "Channel" + "Inventory" ] } }, - "/hotels/{hotelId}/channels/totalPricing": { + "/hotels/{hotelId}/channelSellLimits/{Id}": { + "delete": { + "summary": "Deletes channel sell limits", + "description": "Use this API to delete channel property sell limit mapping.OperationId:deleteChannelSellLimits
", + "operationId": "deleteChannelSellLimits", + "deprecated": true, + "parameters": [ + { + "name": "Id", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the channel sell limit to be deleted." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel where channel sell limits is deleted." + }, + { + "$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": [ + "Inventory" + ] + } + }, + "/hotels/{hotelId}/channels/guarantees": { "get": { - "summary": "Gets total pricing tax and fee types", - "description": "Use this API to get global distribution channels tax and fee configurations.OperationId:getTotalPricingElements
", - "operationId": "getTotalPricingElements", + "summary": "Gets channel guarantee code mappings", + "description": "Use this API to get the list of the channel guarantee code mappings to the OPERA guarantee codes.OperationId:getChannelGuaranteeCodeMappings
", + "operationId": "getChannelGuaranteeCodeMappings", "deprecated": true, "parameters": [ { @@ -14345,7 +14443,7 @@ "type": "integer" }, { - "name": "elementCodes", + "name": "bookingChannelCodes", "in": "query", "type": "array", "collectionFormat": "multi", @@ -14356,7 +14454,18 @@ "required": false }, { - "name": "transactionCodes", + "name": "guaranteeCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "channelGuaranteeCode", "in": "query", "type": "array", "collectionFormat": "multi", @@ -14366,6 +14475,27 @@ }, "required": false }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "description": "Indicates whether search includes inactive mapping.", + "type": "boolean" + }, + { + "name": "fetchUnmapped", + "in": "query", + "required": false, + "description": "Indicates whether unmapped channel-hotel guarantee code should be fetched.", + "type": "boolean" + }, + { + "name": "fetchMapped", + "in": "query", + "required": false, + "description": "Indicates whether mapped channel-hotel guarantee code should be fetched.", + "type": "boolean" + }, { "$ref": "#/parameters/authKey" }, @@ -14392,13 +14522,13 @@ "x-example": "en-GB" } }, - "description": "Response object to populate total pricing elements of the GDS channel.", + "description": "Response object for fetching channel-hotel guarantee code mappings.", "schema": { - "$ref": "#/definitions/totalPricingElements" + "$ref": "#/definitions/channelGuaranteeCodeMappingDetails" } }, "204": { - "description": "TotalPricingElements not found." + "description": "ChannelGuaranteeCodeMappings not found." }, "400": { "$ref": "#/responses/400" @@ -14448,31 +14578,13 @@ ] } }, - "/hotels/{hotelId}/channels/{channelCode}/cardType/{cardTypeCode}": { - "post": { - "summary": "Adds channel credit card mapping for a hotel", - "description": "Use this API to add channel mapping for OPERA credit cards to channel for a given hotel idOperationId:postChannelCardTypeMapping
", - "operationId": "postChannelCardTypeMapping", + "/hotels/{hotelId}/channels/ratePlans": { + "put": { + "summary": "Publishes channel hotel rate plan codes", + "description": "This API changes the channel rate plans for given Hotel Id.OperationId:publishHotelChannelRatePlans
", + "operationId": "publishHotelChannelRatePlans", "deprecated": true, "parameters": [ - { - "name": "cardTypeCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID that identifies a channel." - }, - { - "name": "channelCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID that identifies a channel." - }, { "name": "hotelId", "in": "path", @@ -14483,14 +14595,14 @@ "description": "Unique ID that identifies a single hotel property." }, { - "name": "channelCardTypeMappings", + "name": "channelRatePlans", "in": "body", "required": true, - "description": "Request object for creating a new channel-hotel card type mapping.", + "description": "Request object for publishing rate codes to GDS.", "schema": { "allOf": [ { - "$ref": "#/definitions/channelCardTypeMappings" + "$ref": "#/definitions/channelRatePlans" } ] } @@ -14512,7 +14624,7 @@ } ], "responses": { - "201": { + "200": { "headers": { "Content-Language": { "type": "string", @@ -14525,7 +14637,7 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } @@ -14576,31 +14688,15 @@ "tags": [ "Channel" ] - }, - "put": { - "summary": "Updates channel credit card mapping for a hotel", - "description": "Use this API to update channel mapping for OPERA credit cards to channel for a given hotel idOperationId:putChannelCardTypeMapping
", - "operationId": "putChannelCardTypeMapping", + } + }, + "/hotels/{hotelId}/channels/rates": { + "post": { + "summary": "Distributes channel rate mappings to channel room types", + "description": "Use this API to link (distribute) channel a rate code to channel room types.OperationId:postChannelRates
", + "operationId": "postChannelRates", "deprecated": true, "parameters": [ - { - "name": "cardTypeCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID that identifies a channel." - }, - { - "name": "channelCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID that identifies a channel." - }, { "name": "hotelId", "in": "path", @@ -14611,14 +14707,14 @@ "description": "Unique ID that identifies a single hotel property." }, { - "name": "channelCardTypeMappings", + "name": "channelRates", "in": "body", "required": true, - "description": "Request object for changing information of an existing channel-hotel card type mapping.", + "description": "Request object for distributing channel rates.", "schema": { "allOf": [ { - "$ref": "#/definitions/channelCardTypeMappings" + "$ref": "#/definitions/channelRates" } ] } @@ -14640,7 +14736,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -14653,7 +14749,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" } @@ -14704,46 +14800,72 @@ "tags": [ "Channel" ] - }, - "delete": { - "summary": "Deletes channel credit card mapping for a hotel", - "description": "Use this API to delete channel mapping for OPERA credit cards to channel for a given hotel id.OperationId:deleteChannelCardTypeMapping
", - "operationId": "deleteChannelCardTypeMapping", + } + }, + "/hotels/{hotelId}/channels/totalPricing": { + "get": { + "summary": "Gets total pricing tax and fee types", + "description": "Use this API to get global distribution channels tax and fee configurations.OperationId:getTotalPricingElements
", + "operationId": "getTotalPricingElements", "deprecated": true, "parameters": [ { - "name": "cardTypeCode", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID that identifies a channel." + "description": "Unique ID that identifies a single hotel property." }, { - "name": "channelCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID that identifies a channel." + "name": "hotelIds", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Hotel code.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID that identifies a single hotel property." + "name": "limit", + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "name": "channelCardType", + "name": "offset", "in": "query", + "default": 0, "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." + "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": "elementCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "transactionCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { "$ref": "#/parameters/authKey" @@ -14769,17 +14891,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": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response object to populate total pricing elements of the GDS channel.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/totalPricingElements" } }, + "204": { + "description": "TotalPricingElements not found." + }, "400": { "$ref": "#/responses/400" }, @@ -14828,21 +14949,21 @@ ] } }, - "/hotels/{hotelId}/channels/{channelCode}/guarantees/{guaranteeCode}": { + "/hotels/{hotelId}/channels/{channelCode}/cardType/{cardTypeCode}": { "post": { - "summary": "Adds channel guarantee code mapping for a hotel", - "description": "Use this API to add channel guarantee code mapping to OPERA guarantee code for a given hotelOperationId:postChannelGuaranteeCodeMapping
", - "operationId": "postChannelGuaranteeCodeMapping", + "summary": "Adds channel credit card mapping for a hotel", + "description": "Use this API to add channel mapping for OPERA credit cards to channel for a given hotel idOperationId:postChannelCardTypeMapping
", + "operationId": "postChannelCardTypeMapping", "deprecated": true, "parameters": [ { - "name": "guaranteeCode", + "name": "cardTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Guarantee Code." + "description": "Unique ID that identifies a channel." }, { "name": "channelCode", @@ -14863,14 +14984,14 @@ "description": "Unique ID that identifies a single hotel property." }, { - "name": "channelGuaranteeCodeMappings", + "name": "channelCardTypeMappings", "in": "body", "required": true, - "description": "Request object for creating a new channel-hotel guarantee code mapping.", + "description": "Request object for creating a new channel-hotel card type mapping.", "schema": { "allOf": [ { - "$ref": "#/definitions/channelGuaranteeCodeMappings" + "$ref": "#/definitions/channelCardTypeMappings" } ] } @@ -14958,19 +15079,19 @@ ] }, "put": { - "summary": "Updates channel guarantee code mapping for a hotel", - "description": "Use this API to update channel guarantee code mapping to OPERA guarantee code for a given hotelOperationId:putChannelGuaranteeCodeMapping
", - "operationId": "putChannelGuaranteeCodeMapping", + "summary": "Updates channel credit card mapping for a hotel", + "description": "Use this API to update channel mapping for OPERA credit cards to channel for a given hotel idOperationId:putChannelCardTypeMapping
", + "operationId": "putChannelCardTypeMapping", "deprecated": true, "parameters": [ { - "name": "guaranteeCode", + "name": "cardTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Guarantee Code." + "description": "Unique ID that identifies a channel." }, { "name": "channelCode", @@ -14991,14 +15112,14 @@ "description": "Unique ID that identifies a single hotel property." }, { - "name": "channelGuaranteeCodeMappings", + "name": "channelCardTypeMappings", "in": "body", "required": true, - "description": "Request object for changing information of an existing channel-hotel guarantee code mapping.", + "description": "Request object for changing information of an existing channel-hotel card type mapping.", "schema": { "allOf": [ { - "$ref": "#/definitions/channelGuaranteeCodeMappings" + "$ref": "#/definitions/channelCardTypeMappings" } ] } @@ -15086,19 +15207,19 @@ ] }, "delete": { - "summary": "Deletes channel guarantee code mapping for a hotel", - "description": "Use this API to delete channel guarantee code mapping to OPERA guarantee code for a given property.OperationId:deleteChannelGuaranteeCodeMapping
", - "operationId": "deleteChannelGuaranteeCodeMapping", + "summary": "Deletes channel credit card mapping for a hotel", + "description": "Use this API to delete channel mapping for OPERA credit cards to channel for a given hotel id.OperationId:deleteChannelCardTypeMapping
", + "operationId": "deleteChannelCardTypeMapping", "deprecated": true, "parameters": [ { - "name": "guaranteeCode", + "name": "cardTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Guarantee Code." + "description": "Unique ID that identifies a channel." }, { "name": "channelCode", @@ -15118,6 +15239,13 @@ "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, + { + "name": "channelCardType", + "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." + }, { "$ref": "#/parameters/authKey" }, @@ -15201,13 +15329,22 @@ ] } }, - "/hotels/{hotelId}/channels/{channelCode}/parameters": { - "get": { - "summary": "Retrieves channel parameters.", - "description": "Use this API to get list of channel parameters and their settings.OperationId:getChannelParameters
", - "operationId": "getChannelParameters", + "/hotels/{hotelId}/channels/{channelCode}/guarantees/{guaranteeCode}": { + "post": { + "summary": "Adds channel guarantee code mapping for a hotel", + "description": "Use this API to add channel guarantee code mapping to OPERA guarantee code for a given hotelOperationId:postChannelGuaranteeCodeMapping
", + "operationId": "postChannelGuaranteeCodeMapping", "deprecated": true, "parameters": [ + { + "name": "guaranteeCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Guarantee Code." + }, { "name": "channelCode", "in": "path", @@ -15227,11 +15364,17 @@ "description": "Unique ID that identifies a single hotel property." }, { - "name": "parameterNameWildCard", - "in": "query", - "required": false, - "description": "Parameter for wild card search on channel parameters.", - "type": "string" + "name": "channelGuaranteeCodeMappings", + "in": "body", + "required": true, + "description": "Request object for creating a new channel-hotel guarantee code mapping.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/channelGuaranteeCodeMappings" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -15250,23 +15393,24 @@ } ], "responses": { - "200": { + "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": "Response object for channel parameter(s) based on search criteria.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/channelParameterMapping" + "$ref": "#/definitions/status" } }, - "204": { - "description": "ChannelParameters not found." - }, "400": { "$ref": "#/responses/400" }, @@ -15313,15 +15457,22 @@ "tags": [ "Channel" ] - } - }, - "/hotels/{hotelId}/channels/{channelCode}/policies": { - "get": { - "summary": "Retrieves the channel policies", - "description": "Use this API to retrieve channel policies mapping.OperationId:getChannelPolicies
", - "operationId": "getChannelPolicies", + }, + "put": { + "summary": "Updates channel guarantee code mapping for a hotel", + "description": "Use this API to update channel guarantee code mapping to OPERA guarantee code for a given hotelOperationId:putChannelGuaranteeCodeMapping
", + "operationId": "putChannelGuaranteeCodeMapping", "deprecated": true, "parameters": [ + { + "name": "guaranteeCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Guarantee Code." + }, { "name": "channelCode", "in": "path", @@ -15341,118 +15492,52 @@ "description": "Unique ID that identifies a single hotel property." }, { - "name": "requestType", - "in": "query", - "required": false, - "type": "string" + "name": "channelGuaranteeCodeMappings", + "in": "body", + "required": true, + "description": "Request object for changing information of an existing channel-hotel guarantee code mapping.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/channelGuaranteeCodeMappings" + } + ] + } }, { - "name": "startDate", - "in": "query", - "required": false, - "type": "string", - "format": "date" + "$ref": "#/parameters/authKey" }, { - "name": "endDate", - "in": "query", - "required": false, - "type": "string", - "format": "date" + "$ref": "#/parameters/x-app-key" }, { - "name": "duration", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/x-hotelid" }, { - "name": "channelRatePlanCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "required": false + "$ref": "#/parameters/x-externalsystem" }, { - "name": "channelRoomTypeCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" + "$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" + } }, - "required": false - }, - { - "name": "ratePlanCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "roomTypeCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "corporateId", - "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": "corporateIdType", - "in": "query", - "required": false, - "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" - } - }, - "description": "Request object for fetching Policies, guarantee, and deposit Details.", - "schema": { - "$ref": "#/definitions/channelPolicies" - } - }, - "204": { - "description": "ChannelPolicies not found." + "description": "Response Body.", + "schema": { + "$ref": "#/definitions/status" + } }, "400": { "$ref": "#/responses/400" @@ -15500,23 +15585,21 @@ "tags": [ "Channel" ] - } - }, - "/hotels/{hotelId}/channels/{channelCode}/rooms/{channelRoomType}/rates": { - "post": { - "summary": "Distributes channel room rate mappings.", - "description": "Use this API to link (distribute) channel a room type to channel rate codes.OperationId:postChannelRoomTypeRate
", - "operationId": "postChannelRoomTypeRate", + }, + "delete": { + "summary": "Deletes channel guarantee code mapping for a hotel", + "description": "Use this API to delete channel guarantee code mapping to OPERA guarantee code for a given property.OperationId:deleteChannelGuaranteeCodeMapping
", + "operationId": "deleteChannelGuaranteeCodeMapping", "deprecated": true, "parameters": [ { - "name": "channelRoomType", + "name": "guaranteeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Channel Room Type." + "description": "Guarantee Code." }, { "name": "channelCode", @@ -15536,19 +15619,6 @@ "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, - { - "name": "channelRates", - "in": "body", - "required": true, - "description": "Request object for distributing channel rates.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/channelRates" - } - ] - } - }, { "$ref": "#/parameters/authKey" }, @@ -15566,7 +15636,7 @@ } ], "responses": { - "201": { + "200": { "headers": { "Content-Language": { "type": "string", @@ -15632,22 +15702,13 @@ ] } }, - "/hotels/{hotelId}/channels/{channelCode}/rooms/{roomTypeCode}": { + "/hotels/{hotelId}/channels/{channelCode}/parameters": { "get": { - "summary": "Gets channel room mapping by room type", - "description": "This API retrieves channel room mapping by room type.OperationId:getChannelRoomMappingById
", - "operationId": "getChannelRoomMappingById", + "summary": "Retrieves channel parameters.", + "description": "Use this API to get list of channel parameters and their settings.OperationId:getChannelParameters
", + "operationId": "getChannelParameters", "deprecated": true, "parameters": [ - { - "name": "roomTypeCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Room Type Code." - }, { "name": "channelCode", "in": "path", @@ -15667,18 +15728,10 @@ "description": "Unique ID that identifies a single hotel property." }, { - "name": "beginDate", - "in": "query", - "required": false, - "description": "Begin Date.", - "type": "string", - "format": "date" - }, - { - "name": "channelRoomType", + "name": "parameterNameWildCard", "in": "query", "required": false, - "description": "Channel Room Type.", + "description": "Parameter for wild card search on channel parameters.", "type": "string" }, { @@ -15707,13 +15760,13 @@ "x-example": "en-GB" } }, - "description": "Response object for Channel Room Mappings by ID.", + "description": "Response object for channel parameter(s) based on search criteria.", "schema": { - "$ref": "#/definitions/channelRoomMapping" + "$ref": "#/definitions/channelParameterMapping" } }, "204": { - "description": "ChannelRoomMappingById not found." + "description": "ChannelParameters not found." }, "400": { "$ref": "#/responses/400" @@ -15761,22 +15814,15 @@ "tags": [ "Channel" ] - }, - "put": { - "summary": "Updates channel property room mapping", - "description": "Use this API to update channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.OperationId:putChannelRoomMapping
", - "operationId": "putChannelRoomMapping", + } + }, + "/hotels/{hotelId}/channels/{channelCode}/policies": { + "get": { + "summary": "Retrieves the channel policies", + "description": "Use this API to retrieve channel policies mapping.OperationId:getChannelPolicies
", + "operationId": "getChannelPolicies", "deprecated": true, "parameters": [ - { - "name": "roomTypeCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Room Type Code." - }, { "name": "channelCode", "in": "path", @@ -15796,17 +15842,84 @@ "description": "Unique ID that identifies a single hotel property." }, { - "name": "channelRoomMapping", - "in": "body", - "required": true, - "description": "Request object for changing Channel Room Mapping.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/channelRoomMapping" - } - ] - } + "name": "requestType", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "string", + "format": "date" + }, + { + "name": "endDate", + "in": "query", + "required": false, + "type": "string", + "format": "date" + }, + { + "name": "duration", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "channelRatePlanCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "channelRoomTypeCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "ratePlanCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "roomTypeCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "corporateId", + "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": "corporateIdType", + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { "$ref": "#/parameters/authKey" @@ -15832,17 +15945,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": "Response Body.", + "description": "Request object for fetching Policies, guarantee, and deposit Details.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/channelPolicies" } }, + "204": { + "description": "ChannelPolicies not found." + }, "400": { "$ref": "#/responses/400" }, @@ -15889,21 +16001,23 @@ "tags": [ "Channel" ] - }, - "delete": { - "summary": "Deletes channel property room mapping", - "description": "Use this API to delete channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.OperationId:deleteChannelRoomMapping
", - "operationId": "deleteChannelRoomMapping", + } + }, + "/hotels/{hotelId}/channels/{channelCode}/rooms/{channelRoomType}/rates": { + "post": { + "summary": "Distributes channel room rate mappings.", + "description": "Use this API to link (distribute) channel a room type to channel rate codes.OperationId:postChannelRoomTypeRate
", + "operationId": "postChannelRoomTypeRate", "deprecated": true, "parameters": [ { - "name": "roomTypeCode", + "name": "channelRoomType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Room Type Code." + "description": "Channel Room Type." }, { "name": "channelCode", @@ -15924,27 +16038,17 @@ "description": "Unique ID that identifies a single hotel property." }, { - "name": "beginDate", - "in": "query", - "required": false, - "description": "Begin Date.", - "type": "string", - "format": "date" - }, - { - "name": "channelRoomType", - "in": "query", - "required": false, - "description": "Channel Room Type.", - "type": "string" - }, - { - "name": "endDate", - "in": "query", - "required": false, - "description": "End date of the hotel-channel room type mapping.", - "type": "string", - "format": "date" + "name": "channelRates", + "in": "body", + "required": true, + "description": "Request object for distributing channel rates.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/channelRates" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -15963,7 +16067,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -16029,11 +16133,11 @@ ] } }, - "/hotels/{hotelId}/channels/{channelCode}/rooms/{roomTypeCode}/inventorySnapshot": { + "/hotels/{hotelId}/channels/{channelCode}/rooms/{roomTypeCode}": { "get": { - "summary": "Gets hotel room's restrictions and channel availability", - "description": "Operation to fetch the room availability and restrictions for a given property and room type in relation to channels.OperationId:getChannelInventorySnapshotByRoomType
", - "operationId": "getChannelInventorySnapshotByRoomType", + "summary": "Gets channel room mapping by room type", + "description": "This API retrieves channel room mapping by room type.OperationId:getChannelRoomMappingById
", + "operationId": "getChannelRoomMappingById", "deprecated": true, "parameters": [ { @@ -16052,7 +16156,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Channel Code." + "description": "Unique ID that identifies a channel." }, { "name": "hotelId", @@ -16064,86 +16168,20 @@ "description": "Unique ID that identifies a single hotel property." }, { - "name": "fromDate", - "in": "query", - "required": true, - "type": "string", - "format": "date" - }, - { - "name": "friday", - "in": "query", - "default": "false", - "required": false, - "type": "boolean" - }, - { - "name": "monday", - "in": "query", - "default": "false", - "required": false, - "type": "boolean" - }, - { - "name": "saturday", - "in": "query", - "default": "false", - "required": false, - "type": "boolean" - }, - { - "name": "sunday", - "in": "query", - "default": "false", - "required": false, - "type": "boolean" - }, - { - "name": "thursday", - "in": "query", - "default": "false", - "required": false, - "type": "boolean" - }, - { - "name": "tuesday", - "in": "query", - "default": "false", - "required": false, - "type": "boolean" - }, - { - "name": "wednesday", - "in": "query", - "default": "false", - "required": false, - "type": "boolean" - }, - { - "name": "endDate", + "name": "beginDate", "in": "query", "required": false, + "description": "Begin Date.", "type": "string", "format": "date" }, { - "name": "duration", + "name": "channelRoomType", "in": "query", "required": false, + "description": "Channel Room Type.", "type": "string" }, - { - "name": "snapshotLevel", - "in": "query", - "required": false, - "type": "string", - "description": "Indicates to evaluate statistics for house, channel, and room type level. Must include the specific booking channel in the search criteria.", - "uniqueItems": true, - "enum": [ - "BookingChannel", - "ChannelRoomType" - ] - }, { "$ref": "#/parameters/authKey" }, @@ -16170,13 +16208,13 @@ "x-example": "en-GB" } }, - "description": "Response object containing the room availability and restrictions for a hotel in relation to booking channels.", + "description": "Response object for Channel Room Mappings by ID.", "schema": { - "$ref": "#/definitions/channelInventorySnapshot" + "$ref": "#/definitions/channelRoomMapping" } }, "204": { - "description": "ChannelInventorySnapshotByRoomType not found." + "description": "ChannelRoomMappingById not found." }, "400": { "$ref": "#/responses/400" @@ -16222,25 +16260,32 @@ "application/json;charset=UTF-8" ], "tags": [ - "Availability" + "Channel" ] - } - }, - "/hotels/{hotelId}/channels/{channelId}/channelSellLimitsByDateRange": { + }, "put": { - "summary": "Updates channel sell limits by daterange", - "description": "Use this API to update channel property sell limit mapping by given date range.OperationId:changeChannelSellLimitsByDateRange
", - "operationId": "changeChannelSellLimitsByDateRange", + "summary": "Updates channel property room mapping", + "description": "Use this API to update channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.OperationId:putChannelRoomMapping
", + "operationId": "putChannelRoomMapping", "deprecated": true, "parameters": [ { - "name": "channelId", + "name": "roomTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of the channel for which sell limits are updated by date range." + "description": "Room Type Code." + }, + { + "name": "channelCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID that identifies a channel." }, { "name": "hotelId", @@ -16249,17 +16294,17 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of the hotel where channel sell limits are updated by date range." + "description": "Unique ID that identifies a single hotel property." }, { - "name": "channelSellLimitsByDateRange", + "name": "channelRoomMapping", "in": "body", "required": true, - "description": "Request object to create or update sell limit schedules for the channel or channel room type within a date range. Existing schedules can be split as needed to account for overlapping schedules.", + "description": "Request object for changing Channel Room Mapping.", "schema": { "allOf": [ { - "$ref": "#/definitions/channelSellLimitsByDateRange" + "$ref": "#/definitions/channelRoomMapping" } ] } @@ -16343,128 +16388,76 @@ "application/json;charset=UTF-8" ], "tags": [ - "Inventory" + "Channel" ] - } - }, - "/hotels/{hotelId}/generalAvailabilitySimulator": { - "get": { - "summary": "Gets the General Availability", - "description": "Use this API to fetch the General Availability Simulator.OperationId:getGeneralAvailabilitySimulator
", - "operationId": "getGeneralAvailabilitySimulator", + }, + "delete": { + "summary": "Deletes channel property room mapping", + "description": "Use this API to delete channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.OperationId:deleteChannelRoomMapping
", + "operationId": "deleteChannelRoomMapping", "deprecated": true, "parameters": [ { - "name": "hotelId", + "name": "roomTypeCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID that identifies a single hotel property." + "description": "Room Type Code." }, { - "name": "limit", - "in": "query", - "required": false, - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "name": "channelCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID that identifies a channel." }, { - "name": "bookingChannelCode", - "in": "query", - "required": false, - "type": "string" + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID that identifies a single hotel property." }, { - "name": "arrival", + "name": "beginDate", "in": "query", "required": false, + "description": "Begin Date.", "type": "string", "format": "date" }, { - "name": "adults", - "in": "query", - "required": false, - "type": "integer" - }, - { - "name": "nights", + "name": "channelRoomType", "in": "query", "required": false, - "type": "integer" + "description": "Channel Room Type.", + "type": "string" }, { - "name": "children", + "name": "endDate", "in": "query", "required": false, - "type": "integer" + "description": "End date of the hotel-channel room type mapping.", + "type": "string", + "format": "date" }, { - "name": "noOfRooms", - "in": "query", - "required": false, - "type": "integer" + "$ref": "#/parameters/authKey" }, { - "name": "channelRatePlanCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "$ref": "#/parameters/x-app-key" }, { - "name": "rateAccessCode", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/x-hotelid" }, { - "name": "corpIdIATA", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "inventoryBlockCode", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "promotionCode", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "currencyCode", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "language", - "in": "query", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$ref": "#/parameters/x-hotelid" - }, - { - "$ref": "#/parameters/x-externalsystem" + "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" @@ -16478,16 +16471,17 @@ "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 object to simulate general availability.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/generalAvailabilitySimulator" + "$ref": "#/definitions/status" } }, - "204": { - "description": "GeneralAvailabilitySimulator not found." - }, "400": { "$ref": "#/responses/400" }, @@ -16532,17 +16526,35 @@ "application/json;charset=UTF-8" ], "tags": [ - "Availability" + "Channel" ] } }, - "/hotels/{hotelId}/inventorySnapshot": { + "/hotels/{hotelId}/channels/{channelCode}/rooms/{roomTypeCode}/inventorySnapshot": { "get": { - "summary": "Gets hotel's rooms and restrictions channel availability", - "description": "Operation to fetch the room availability and restrictions for a given property in relation to channels.OperationId:getChannelInventorySnapshot
", - "operationId": "getChannelInventorySnapshot", + "summary": "Gets hotel room's restrictions and channel availability", + "description": "Operation to fetch the room availability and restrictions for a given property and room type in relation to channels.OperationId:getChannelInventorySnapshotByRoomType
", + "operationId": "getChannelInventorySnapshotByRoomType", "deprecated": true, "parameters": [ + { + "name": "roomTypeCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Room Type Code." + }, + { + "name": "channelCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Channel Code." + }, { "name": "hotelId", "in": "path", @@ -16621,28 +16633,6 @@ "required": false, "type": "string" }, - { - "name": "bookingChannelCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "channelRoomTypes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, { "name": "snapshotLevel", "in": "query", @@ -16687,7 +16677,7 @@ } }, "204": { - "description": "ChannelInventorySnapshot not found." + "description": "ChannelInventorySnapshotByRoomType not found." }, "400": { "$ref": "#/responses/400" @@ -16737,144 +16727,43 @@ ] } }, - "/hotels/{hotelId}/rateParity": { - "get": { - "summary": "Gets channel's rate configuration", - "description": "Operation to Fetch the Rate Parity. The rate parity search criteria can include room types, rate plans, promotion code, rate access code or chain codes.OperationId:getRateParity
", - "operationId": "getRateParity", + "/hotels/{hotelId}/channels/{channelId}/channelSellLimitsByDateRange": { + "put": { + "summary": "Updates channel sell limits by daterange", + "description": "Use this API to update channel property sell limit mapping by given date range.OperationId:changeChannelSellLimitsByDateRange
", + "operationId": "changeChannelSellLimitsByDateRange", "deprecated": true, "parameters": [ { - "name": "hotelId", + "name": "channelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID that identifies a single hotel property." - }, - { - "name": "comparisonType", - "in": "query", - "required": false, - "description": "An enumerated type defining the Parity Comparison type. Values: FIRST_RATES, CHANNEL_RATES. CHANNEL_RATES requires HotelCode and BookingChannelCode as part of request.", - "type": "string" - }, - { - "name": "language", - "in": "query", - "required": false, - "description": "Language identification.", - "type": "string" - }, - { - "name": "limit", - "in": "query", - "required": false, - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" - }, - { - "name": "numberOfDays", - "in": "query", - "required": false, - "type": "integer" - }, - { - "name": "channelCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "roomType", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "ratePlanCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "channelRoomType", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "channelRatePlanCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "chainCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "rateAccessCode", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "inventoryBlockCode", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "promotionCode", - "in": "query", - "required": false, - "type": "string" + "description": "Unique ID of the channel for which sell limits are updated by date range." }, { - "name": "qualifyingProfileCategory", - "in": "query", - "required": false, - "type": "string" + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel where channel sell limits are updated by date range." }, { - "name": "qualifyingProfileId", - "in": "query", - "required": false, - "type": "string" + "name": "channelSellLimitsByDateRange", + "in": "body", + "required": true, + "description": "Request object to create or update sell limit schedules for the channel or channel room type within a date range. Existing schedules can be split as needed to account for overlapping schedules.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/channelSellLimitsByDateRange" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -16900,16 +16789,17 @@ "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 object to fetch Rate Parity.", + "description": "Response Body.", "schema": { - "$ref": "#/definitions/rateParity" + "$ref": "#/definitions/status" } }, - "204": { - "description": "RateParity not found." - }, "400": { "$ref": "#/responses/400" }, @@ -16954,34 +16844,116 @@ "application/json;charset=UTF-8" ], "tags": [ - "Availability" + "Inventory" ] } }, - "/hotels/{hotelId}/rates/{ratePlanCode}/globalDescription": { + "/hotels/{hotelId}/generalAvailabilitySimulator": { "get": { - "summary": "Gets global rate descriptions", - "description": "Use this API to get global rate description for given hotel id and rate code.OperationId:getChannelRateCodeGlobalDesc
", - "operationId": "getChannelRateCodeGlobalDesc", + "summary": "Gets the General Availability", + "description": "Use this API to fetch the General Availability Simulator.OperationId:getGeneralAvailabilitySimulator
", + "operationId": "getGeneralAvailabilitySimulator", "deprecated": true, "parameters": [ { - "name": "ratePlanCode", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Rate Plan Code." + "description": "Unique ID that identifies a single hotel property." }, { - "name": "hotelId", - "in": "path", - "required": true, + "name": "limit", + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" + }, + { + "name": "bookingChannelCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "arrival", + "in": "query", + "required": false, "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID that identifies a single hotel property." + "format": "date" + }, + { + "name": "adults", + "in": "query", + "required": false, + "type": "integer" + }, + { + "name": "nights", + "in": "query", + "required": false, + "type": "integer" + }, + { + "name": "children", + "in": "query", + "required": false, + "type": "integer" + }, + { + "name": "noOfRooms", + "in": "query", + "required": false, + "type": "integer" + }, + { + "name": "channelRatePlanCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "rateAccessCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "corpIdIATA", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "inventoryBlockCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "promotionCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "currencyCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "required": false, + "type": "string" }, { "$ref": "#/parameters/authKey" @@ -17009,13 +16981,13 @@ "x-example": "en-GB" } }, - "description": "Response object for information regarding global descriptions of hotel rate codes.", + "description": "Response object to simulate general availability.", "schema": { - "$ref": "#/definitions/channelEnhancedGlobalDescription" + "$ref": "#/definitions/generalAvailabilitySimulator" } }, "204": { - "description": "ChannelRateCodeGlobalDesc not found." + "description": "GeneralAvailabilitySimulator not found." }, "400": { "$ref": "#/responses/400" @@ -17061,15 +17033,15 @@ "application/json;charset=UTF-8" ], "tags": [ - "Channel" + "Availability" ] } }, - "/hotels/{hotelId}/rooms/mapping": { + "/hotels/{hotelId}/inventorySnapshot": { "get": { - "summary": "Gets channel property room mapping", - "description": "Use this API to get channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.OperationId:getChannelRoomMapping
", - "operationId": "getChannelRoomMapping", + "summary": "Gets hotel's rooms and restrictions channel availability", + "description": "Operation to fetch the room availability and restrictions for a given property in relation to channels.OperationId:getChannelInventorySnapshot
", + "operationId": "getChannelInventorySnapshot", "deprecated": true, "parameters": [ { @@ -17082,45 +17054,76 @@ "description": "Unique ID that identifies a single hotel property." }, { - "name": "hotelIds", + "name": "fromDate", "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Hotel code.", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "required": true, + "type": "string", + "format": "date" }, { - "name": "limit", + "name": "friday", "in": "query", + "default": "false", "required": false, - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "type": "boolean" }, { - "name": "offset", + "name": "monday", "in": "query", - "default": 0, + "default": "false", "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" + "type": "boolean" }, { - "name": "bookingChannelCodes", + "name": "saturday", "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "default": "false", + "required": false, + "type": "boolean" }, { - "name": "roomTypes", + "name": "sunday", + "in": "query", + "default": "false", + "required": false, + "type": "boolean" + }, + { + "name": "thursday", + "in": "query", + "default": "false", + "required": false, + "type": "boolean" + }, + { + "name": "tuesday", + "in": "query", + "default": "false", + "required": false, + "type": "boolean" + }, + { + "name": "wednesday", + "in": "query", + "default": "false", + "required": false, + "type": "boolean" + }, + { + "name": "endDate", + "in": "query", + "required": false, + "type": "string", + "format": "date" + }, + { + "name": "duration", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "bookingChannelCodes", "in": "query", "type": "array", "collectionFormat": "multi", @@ -17142,25 +17145,16 @@ "required": false }, { - "name": "includeInactiveMappings", - "in": "query", - "required": false, - "description": "Flag whether to include inactive mappings or not.", - "type": "boolean" - }, - { - "name": "includeUnmappedRoomTypes", - "in": "query", - "required": false, - "description": "Flag whether to include unmapped room types or not.", - "type": "boolean" - }, - { - "name": "onlyUnmappedRoomTypes", + "name": "snapshotLevel", "in": "query", "required": false, - "description": "Flag whether to include mapped room types only.", - "type": "boolean" + "type": "string", + "description": "Indicates to evaluate statistics for house, channel, and room type level. Must include the specific booking channel in the search criteria.", + "uniqueItems": true, + "enum": [ + "BookingChannel", + "ChannelRoomType" + ] }, { "$ref": "#/parameters/authKey" @@ -17188,13 +17182,13 @@ "x-example": "en-GB" } }, - "description": "Operation to fetch hotel-channel room type mappings.", + "description": "Response object containing the room availability and restrictions for a hotel in relation to booking channels.", "schema": { - "$ref": "#/definitions/channelRoomMappingsSummary" + "$ref": "#/definitions/channelInventorySnapshot" } }, "204": { - "description": "ChannelRoomMapping not found." + "description": "ChannelInventorySnapshot not found." }, "400": { "$ref": "#/responses/400" @@ -17240,28 +17234,249 @@ "application/json;charset=UTF-8" ], "tags": [ - "Channel" + "Availability" ] } }, - "/hotels/{hotelId}/rooms/{roomType}/globalDescription": { + "/hotels/{hotelId}/rateParity": { "get": { - "summary": "Gets global room descriptions", - "description": "Use this API to get global room description for given hotel id and room type code.OperationId:getChannelRoomTypeGlobalDesc
", - "operationId": "getChannelRoomTypeGlobalDesc", + "summary": "Gets channel's rate configuration", + "description": "Operation to Fetch the Rate Parity. The rate parity search criteria can include room types, rate plans, promotion code, rate access code or chain codes.OperationId:getRateParity
", + "operationId": "getRateParity", "deprecated": true, "parameters": [ { - "name": "roomType", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Room type." + "description": "Unique ID that identifies a single hotel property." }, { - "name": "hotelId", + "name": "comparisonType", + "in": "query", + "required": false, + "description": "An enumerated type defining the Parity Comparison type. Values: FIRST_RATES, CHANNEL_RATES. CHANNEL_RATES requires HotelCode and BookingChannelCode as part of request.", + "type": "string" + }, + { + "name": "language", + "in": "query", + "required": false, + "description": "Language identification.", + "type": "string" + }, + { + "name": "limit", + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" + }, + { + "name": "numberOfDays", + "in": "query", + "required": false, + "type": "integer" + }, + { + "name": "channelCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "roomType", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "ratePlanCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "channelRoomType", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "channelRatePlanCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "chainCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "rateAccessCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "inventoryBlockCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "promotionCode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "qualifyingProfileCategory", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "qualifyingProfileId", + "in": "query", + "required": false, + "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": "Response object to fetch Rate Parity.", + "schema": { + "$ref": "#/definitions/rateParity" + } + }, + "204": { + "description": "RateParity 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": [ + "Availability" + ] + } + }, + "/hotels/{hotelId}/rates/{ratePlanCode}/globalDescription": { + "get": { + "summary": "Gets global rate descriptions", + "description": "Use this API to get global rate description for given hotel id and rate code.OperationId:getChannelRateCodeGlobalDesc
", + "operationId": "getChannelRateCodeGlobalDesc", + "deprecated": true, + "parameters": [ + { + "name": "ratePlanCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Rate Plan Code." + }, + { + "name": "hotelId", "in": "path", "required": true, "type": "string", @@ -17295,13 +17510,13 @@ "x-example": "en-GB" } }, - "description": "Response object for information regarding global descriptions of hotel room types.", + "description": "Response object for information regarding global descriptions of hotel rate codes.", "schema": { "$ref": "#/definitions/channelEnhancedGlobalDescription" } }, "204": { - "description": "ChannelRoomTypeGlobalDesc not found." + "description": "ChannelRateCodeGlobalDesc not found." }, "400": { "$ref": "#/responses/400" @@ -17350,37 +17565,323 @@ "Channel" ] } - } - }, - "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", + "/hotels/{hotelId}/rooms/mapping": { + "get": { + "summary": "Gets channel property room mapping", + "description": "Use this API to get channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.OperationId:getChannelRoomMapping
", + "operationId": "getChannelRoomMapping", + "deprecated": true, + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID that identifies a single hotel property." + }, + { + "name": "hotelIds", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Hotel code.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "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": "bookingChannelCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "roomTypes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "channelRoomTypes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "includeInactiveMappings", + "in": "query", + "required": false, + "description": "Flag whether to include inactive mappings or not.", + "type": "boolean" + }, + { + "name": "includeUnmappedRoomTypes", + "in": "query", + "required": false, + "description": "Flag whether to include unmapped room types or not.", + "type": "boolean" + }, + { + "name": "onlyUnmappedRoomTypes", + "in": "query", + "required": false, + "description": "Flag whether to include mapped room types only.", + "type": "boolean" + }, + { + "$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": "Operation to fetch hotel-channel room type mappings.", + "schema": { + "$ref": "#/definitions/channelRoomMappingsSummary" + } + }, + "204": { + "description": "ChannelRoomMapping 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": [ + "Channel" + ] + } + }, + "/hotels/{hotelId}/rooms/{roomType}/globalDescription": { + "get": { + "summary": "Gets global room descriptions", + "description": "Use this API to get global room description for given hotel id and room type code.OperationId:getChannelRoomTypeGlobalDesc
", + "operationId": "getChannelRoomTypeGlobalDesc", + "deprecated": true, + "parameters": [ + { + "name": "roomType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Room type." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID that identifies a single hotel property." + }, + { + "$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 information regarding global descriptions of hotel room types.", + "schema": { + "$ref": "#/definitions/channelEnhancedGlobalDescription" + } + }, + "204": { + "description": "ChannelRoomTypeGlobalDesc 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": [ + "Channel" + ] + } + } + }, + "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": { @@ -17394,6 +17895,14 @@ "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" + }, + "clusterIdPath": { + "name": "clusterId", + "description": "ClusterId in URI path", + "type": "string", + "in": "path", + "required": true, + "maxLength": 50 } }, "responses": { @@ -22212,47 +22721,221 @@ } } }, - "channelRestrictions": { + "channelRestrictions": { + "type": "object", + "description": "Request object for publishing rate restrictions to channels.", + "properties": { + "publishRestriction": { + "description": "Restriction information to be published.", + "$ref": "#/definitions/publishRatePlanType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "channelRoomMappings": { + "type": "object", + "description": "Request object for Channel Room Mapping creation.", + "properties": { + "channelRoomMappings": { + "description": "Channel Room Type mapping details to be defined.", + "$ref": "#/definitions/channelRoomMappingsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "channelRoomMappingsType": { + "type": "array", + "description": "Hotel-channel room type mapping information.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/channelRoomMappingType" + } + }, + "channelRoomMappingType": { + "type": "object", + "description": "Basic details of hotel-channel room type mapping.", + "properties": { + "endDate": { + "description": "End date of the hotel-channel room type mapping.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "description": { + "description": "Hotel-channel room type mapping description.", + "$ref": "#/definitions/channelRoomMappingDescriptionType" + }, + "alternateChannelRoomType": { + "description": "Alternate channel room type name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "channelRoomTypeOrder": { + "description": "Channel room type order of the hotel-channel room type mapping.", + "type": "number" + }, + "sellSequence": { + "description": "Sell sequence for hotel-channel room type mapping.", + "type": "number" + }, + "active": { + "description": "Flag that indicates whether hotel-channel room type mapping is active or not.", + "type": "boolean" + }, + "bedTypeCode": { + "description": "Channel bed type code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "baseAllocation": { + "description": "Channel base allocation.", + "type": "integer" + }, + "rateCodes": { + "description": "Rate codes where hotel-channel room type mappings belong to.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "channelRateCodes": { + "description": "Channel rate codes where hotel-channel room mappings belong to.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "newChannelRoomType": { + "description": "Channel Room Type. This element is used for sending modified Channel room type value for operation ChangeChannelRoomMapping.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "newBeginDate": { + "description": "Begin date of the channel room type mapping. This element is used for sending modified Begin date value for operation ChangeChannelRoomMapping.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "bookingChannelInfo": { + "description": "Additional details about the booking channel.", + "$ref": "#/definitions/bookingChannelInfoType" + }, + "globalDescription": { + "description": "Global descriptions for the hotel room type.", + "$ref": "#/definitions/channelMappingEnhancedDescriptionType" + }, + "channelRoomMappingDetails": { + "description": "Channel Room Type. This element is used for sending modified Channel room type value for operation ChangeChannelRoomMapping.", + "$ref": "#/definitions/channelRoomMappingDetailsType" + }, + "bookingChannelCode": { + "description": "Booking Channel Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelId": { + "description": "Hotel Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomType": { + "description": "Room Type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "channelRoomType": { + "description": "Channel Room Type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "beginDate": { + "description": "Begin Date.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "channelRoomMappingDescriptionType": { "type": "object", - "description": "Request object for publishing rate restrictions to channels.", + "description": "This type holds descriptions of hotel-channel room type mapping. Description may be from Hotel Room Type description, Global description or custom user defined description. Global description only supports enhanced description.", "properties": { - "publishRestriction": { - "description": "Restriction information to be published.", - "$ref": "#/definitions/publishRatePlanType" + "roomTypeDescription": { + "description": "Description of hotel-channel room type mapping from Hotel Room Type configuration.", + "$ref": "#/definitions/channelRoomMappingDescriptionDetailsType" }, - "links": { - "$ref": "#/definitions/links" + "globalDescription": { + "description": "Description of hotel-channel room type mapping from Global description.", + "$ref": "#/definitions/channelMappingEnhancedDescriptionType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "customDescription": { + "description": "Custom or user-defined description of hotel-channel room type mapping.", + "$ref": "#/definitions/channelRoomMappingDescriptionDetailsType" } } }, - "channelRoomMappings": { + "channelRoomMappingDescriptionDetailsType": { "type": "object", - "description": "Request object for Channel Room Mapping creation.", + "description": "This type holds descriptions of hotel-channel room type mapping. Descriptions may be enhanced descriptions, HTML supported description or a simple string description.", "properties": { - "channelRoomMappings": { - "description": "Channel Room Type mapping details to be defined.", - "$ref": "#/definitions/channelRoomMappingsType" + "enhancedDescription": { + "description": "Enhanced descriptions which allow defining line 1 to 3 descriptions.", + "$ref": "#/definitions/channelMappingEnhancedDescriptionType" }, - "links": { - "$ref": "#/definitions/links" + "hTMLSupportedDescription": { + "description": "HTML supported description with addition of channel room type short description.", + "$ref": "#/definitions/channelRoomMappingHTMLSupportedDescriptionType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "description": { + "description": "Description.", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "channelRoomMappingsType": { - "type": "array", - "description": "Hotel-channel room type mapping information.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/channelRoomMappingType" + "channelRoomMappingHTMLSupportedDescriptionType": { + "type": "object", + "description": "This type holds HTML description of hotel-channel room type with additional channel room type short description.", + "properties": { + "description": { + "description": "Description.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "shortDescription": { + "description": "Channel room type or rate code short description.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } } }, - "channelRoomMappingType": { + "channelRoomMappingDetailsType": { "type": "object", "description": "Basic details of hotel-channel room type mapping.", "properties": { @@ -22333,190 +23016,387 @@ "globalDescription": { "description": "Global descriptions for the hotel room type.", "$ref": "#/definitions/channelMappingEnhancedDescriptionType" + } + } + }, + "channelGlobalDescription": { + "type": "object", + "description": "Request object for changing channel rate codes global description.", + "properties": { + "channelRoomDescription": { + "description": "Channel Rate code mapping global description details.", + "$ref": "#/definitions/channelGlobalDescriptionType" }, - "channelRoomMappingDetails": { - "description": "Channel Room Type. This element is used for sending modified Channel room type value for operation ChangeChannelRoomMapping.", - "$ref": "#/definitions/channelRoomMappingDetailsType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "channelGlobalDescriptionType": { + "type": "object", + "description": "This type holds enhanced room/rate description.", + "properties": { + "shortDescription": { + "$ref": "#/definitions/translationTextType2000" + }, + "description": { + "$ref": "#/definitions/translationTextType2000" + }, + "enhancedDesc1": { + "$ref": "#/definitions/translationTextType50" + }, + "enhancedDesc2": { + "$ref": "#/definitions/translationTextType50" + }, + "enhancedDesc3": { + "$ref": "#/definitions/translationTextType50" + }, + "source": { + "type": "string" + }, + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, "bookingChannelCode": { - "description": "Booking Channel Code.", "type": "string", "minLength": 0, "maxLength": 20 }, + "roomType": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "rateCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "channel": { + "type": "object", + "description": "Response object for fetching details of channel.", + "properties": { + "channel": { + "description": "Details of a channel.", + "$ref": "#/definitions/channelType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "channelErrors": { + "type": "object", + "description": "Request object for creating channel errors.", + "properties": { + "errors": { + "description": "channel errors to be created.", + "type": "object", + "properties": { + "error": { + "description": "Channel error details.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/systemErrorType" + } + }, + "bookingChannelCode": { + "description": "Channel code.", + "$ref": "#/definitions/codeType" + } + } + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "codeType": { + "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.", + "minLength": 0, + "maxLength": 20 + }, + "channelHotelCodeMapping": { + "type": "object", + "description": "Response giving OPERA hotel code mapped to channel hotel code for a booking channel and vice versa.", + "properties": { + "channelCode": { + "description": "Channel code for which the hotel code mapping information is needed.", + "type": "string", + "maxLength": 2000 + }, + "hotelInfo": { + "description": "OPERA or Channel hotel code information.", + "$ref": "#/definitions/hotelCodeMappingInfoType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "hotelCodeMappingInfoType": { + "type": "object", + "description": "Generic information of the OPERA hotel code, channel hotelcode for the requested booking channel code.", + "properties": { "hotelId": { - "description": "Hotel Code.", + "description": "OPERA hotel code for the requested channel hotel code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "channelHotelCode": { + "description": "Channel hotel code for the requested OPERA hotel code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "changeChannelParameters": { + "type": "object", + "description": "Request object for modifying channel parameter(s).", + "properties": { + "criteria": { + "description": "Collection of channel parameter(s) to be modified.", + "$ref": "#/definitions/changeChannelParametersType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "changeChannelParametersType": { + "type": "object", + "properties": { + "systemCode": { + "description": "External system code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "channelParameters": { + "description": "Collection of channel parameters whose value needs to be modified.", + "$ref": "#/definitions/channelParametersSimpleType" + } + } + }, + "channelParametersSimpleType": { + "type": "array", + "description": "Collection of channel parameters simple information.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/channelParameterSimpleType" + } + }, + "channelParameterSimpleType": { + "type": "object", + "description": "Basic channel parameter info used in changing channel parameter values.", + "properties": { + "parameterName": { "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 80 }, - "roomType": { - "description": "Room Type.", + "parameterValue": { "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "channelRoomType": { - "description": "Channel Room Type.", + "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 }, - "beginDate": { - "description": "Begin Date.", - "type": "string", - "format": "date", - "maxLength": 8 + "parameterValueType": { + "$ref": "#/definitions/channelParameterValueType" } } }, - "channelRoomMappingDescriptionType": { + "channelParameterValueType": { + "type": "string", + "description": "The value types of parameter, possible types are Boolean, String, Date, and Number.", + "enum": [ + "Boolean", + "String", + "Date", + "Time", + "Number", + "SingleSelectLOV", + "MultiSelectLOV" + ] + }, + "channelRateCategories": { "type": "object", - "description": "This type holds descriptions of hotel-channel room type mapping. Description may be from Hotel Room Type description, Global description or custom user defined description. Global description only supports enhanced description.", + "description": "Request object for creating channel rate categories.", "properties": { - "roomTypeDescription": { - "description": "Description of hotel-channel room type mapping from Hotel Room Type configuration.", - "$ref": "#/definitions/channelRoomMappingDescriptionDetailsType" + "rateCategories": { + "description": "channel rate categories to be created.", + "type": "object", + "properties": { + "rateCategory": { + "description": "Channel rate category details.", + "type": "array", + "items": { + "$ref": "#/definitions/systemRateCategoryType" + } + }, + "bookingChannelCode": { + "description": "Channel code.", + "$ref": "#/definitions/codeType" + } + } }, - "globalDescription": { - "description": "Description of hotel-channel room type mapping from Global description.", - "$ref": "#/definitions/channelMappingEnhancedDescriptionType" + "links": { + "$ref": "#/definitions/links" }, - "customDescription": { - "description": "Custom or user-defined description of hotel-channel room type mapping.", - "$ref": "#/definitions/channelRoomMappingDescriptionDetailsType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "channelRoomMappingDescriptionDetailsType": { + "channelRateLevels": { "type": "object", - "description": "This type holds descriptions of hotel-channel room type mapping. Descriptions may be enhanced descriptions, HTML supported description or a simple string description.", + "description": "Request object for creating channel rate levels.", "properties": { - "enhancedDescription": { - "description": "Enhanced descriptions which allow defining line 1 to 3 descriptions.", - "$ref": "#/definitions/channelMappingEnhancedDescriptionType" + "rateLevels": { + "description": "channel rate levels to be created.", + "type": "object", + "properties": { + "rateLevel": { + "description": "Channel rate level details.", + "type": "array", + "items": { + "$ref": "#/definitions/systemRateLevelType" + } + }, + "bookingChannelCode": { + "description": "Channel code.", + "$ref": "#/definitions/codeType" + } + } }, - "hTMLSupportedDescription": { - "description": "HTML supported description with addition of channel room type short description.", - "$ref": "#/definitions/channelRoomMappingHTMLSupportedDescriptionType" + "links": { + "$ref": "#/definitions/links" }, - "description": { - "description": "Description.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "channelRoomMappingHTMLSupportedDescriptionType": { + "channelRatePlans": { "type": "object", - "description": "This type holds HTML description of hotel-channel room type with additional channel room type short description.", + "description": "Request object for publishing rate codes to GDS.", "properties": { - "description": { - "description": "Description.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "publishRatePlan": { + "description": "Rate code information to be published.", + "$ref": "#/definitions/publishRatePlanType" }, - "shortDescription": { - "description": "Channel room type or rate code short description.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "channelRoomMappingDetailsType": { + "channelRateRoomSequenceDetails": { "type": "object", - "description": "Basic details of hotel-channel room type mapping.", + "description": "Response object for channel rate rooms sequence based on a criteria.", "properties": { - "endDate": { - "description": "End date of the hotel-channel room type mapping.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "description": { - "description": "Hotel-channel room type mapping description.", - "$ref": "#/definitions/channelRoomMappingDescriptionType" - }, - "alternateChannelRoomType": { - "description": "Alternate channel room type name.", - "type": "string", - "minLength": 0, - "maxLength": 40 - }, - "channelRoomTypeOrder": { - "description": "Channel room type order of the hotel-channel room type mapping.", - "type": "number" - }, - "sellSequence": { - "description": "Sell sequence for hotel-channel room type mapping.", - "type": "number" - }, - "active": { - "description": "Flag that indicates whether hotel-channel room type mapping is active or not.", - "type": "boolean" - }, - "bedTypeCode": { - "description": "Channel bed type code.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "baseAllocation": { - "description": "Channel base allocation.", - "type": "integer" + "channelRateRoomList": { + "description": "Booking channel rate room List.", + "$ref": "#/definitions/channelRateRoomListType" }, - "rateCodes": { - "description": "Rate codes where hotel-channel room type mappings belong to.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "minLength": 0, - "maxLength": 20 - } + "links": { + "$ref": "#/definitions/links" }, - "channelRateCodes": { - "description": "Channel rate codes where hotel-channel room mappings belong to.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "minLength": 0, - "maxLength": 20 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "channelRoomTypes": { + "type": "object", + "description": "Request object for creating channel room types.", + "properties": { + "roomTypes": { + "description": "channel room types to be created.", + "type": "object", + "properties": { + "roomType": { + "description": "Channel room type details.", + "type": "array", + "items": { + "$ref": "#/definitions/systemRoomTypeType" + } + }, + "bookingChannelCode": { + "description": "Channel code.", + "$ref": "#/definitions/codeType" + } } }, - "newChannelRoomType": { - "description": "Channel Room Type. This element is used for sending modified Channel room type value for operation ChangeChannelRoomMapping.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "links": { + "$ref": "#/definitions/links" }, - "newBeginDate": { - "description": "Begin date of the channel room type mapping. This element is used for sending modified Begin date value for operation ChangeChannelRoomMapping.", - "type": "string", - "format": "date", - "maxLength": 8 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "channelCarriers": { + "type": "object", + "description": "Request object for creating channel carriers.", + "properties": { + "carriers": { + "description": "Channel carriers to be created.", + "type": "object", + "properties": { + "carrier": { + "description": "Channel carrier details.", + "type": "array", + "items": { + "$ref": "#/definitions/systemCarrierType" + } + }, + "bookingChannelCode": { + "description": "Channel code.", + "$ref": "#/definitions/codeType" + } + } }, - "bookingChannelInfo": { - "description": "Additional details about the booking channel.", - "$ref": "#/definitions/bookingChannelInfoType" + "links": { + "$ref": "#/definitions/links" }, - "globalDescription": { - "description": "Global descriptions for the hotel room type.", - "$ref": "#/definitions/channelMappingEnhancedDescriptionType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "channelGlobalDescription": { + "channelOrgMapping": { "type": "object", - "description": "Request object for changing channel rate codes global description.", + "description": "Request object for Create Channel to ORG and CRO Mapping.", "properties": { - "channelRoomDescription": { - "description": "Channel Rate code mapping global description details.", - "$ref": "#/definitions/channelGlobalDescriptionType" + "channelOrgMappingDetails": { + "$ref": "#/definitions/channelOrgMappingType" }, "links": { "$ref": "#/definitions/links" @@ -22526,57 +23406,36 @@ } } }, - "channelGlobalDescriptionType": { + "channelOrgMappingType": { "type": "object", - "description": "This type holds enhanced room/rate description.", + "description": "Respresents information of the Channel Code, OrgCode and Default Login Resort used for mapping.", "properties": { - "shortDescription": { - "$ref": "#/definitions/translationTextType2000" - }, - "description": { - "$ref": "#/definitions/translationTextType2000" - }, - "enhancedDesc1": { - "$ref": "#/definitions/translationTextType50" - }, - "enhancedDesc2": { - "$ref": "#/definitions/translationTextType50" - }, - "enhancedDesc3": { - "$ref": "#/definitions/translationTextType50" - }, - "source": { - "type": "string" - }, - "hotelId": { - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "bookingChannelCode": { + "channelCode": { + "description": "Channel code for which OrgCode mapping needs to be done.", "type": "string", "minLength": 0, "maxLength": 20 }, - "roomType": { + "orgCode": { + "description": "OrgCode for which Channel code mapping needs to be done.", "type": "string", "minLength": 0, "maxLength": 20 }, - "rateCode": { + "defaultLoginResort": { + "description": "Default Login Resort value used while mapping Channel Code and OrgCode.", "type": "string", "minLength": 0, "maxLength": 20 } } }, - "channel": { + "channelOrgMappingsDetails": { "type": "object", - "description": "Response object for fetching details of channel.", + "description": "Response object for Fetch Channel to ORG and CRO Mapping.", "properties": { - "channel": { - "description": "Details of a channel.", - "$ref": "#/definitions/channelType" + "channelOrgMappingsDetails": { + "$ref": "#/definitions/channelOrgMappingsType" }, "links": { "$ref": "#/definitions/links" @@ -22586,85 +23445,119 @@ } } }, - "channelErrors": { + "channelOrgMappingsType": { + "type": "array", + "description": "Respresents information of the Channel Code, OrgCode and Default Login Resort used for mapping.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/channelOrgMappingType" + } + }, + "totalPricingElements": { "type": "object", - "description": "Request object for creating channel errors.", + "description": "Response object to populate total pricing elements of the GDS channel.", "properties": { - "errors": { - "description": "channel errors to be created.", - "type": "object", - "properties": { - "error": { - "description": "Channel error details.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/systemErrorType" - } - }, - "bookingChannelCode": { - "description": "Channel code.", - "$ref": "#/definitions/codeType" - } - } + "totalPricingElements": { + "$ref": "#/definitions/totalPricingElementsType" + }, + "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" } } }, - "codeType": { - "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.", - "minLength": 0, - "maxLength": 20 + "totalPricingElementsType": { + "type": "array", + "description": "List of Total Pricing Element Type", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/totalPricingElementType" + } }, - "channelHotelCodeMapping": { + "totalPricingElementType": { "type": "object", - "description": "Response giving OPERA hotel code mapped to channel hotel code for a booking channel and vice versa.", + "description": "Total Pricing Element ID type used to identify the record", "properties": { - "channelCode": { - "description": "Channel code for which the hotel code mapping information is needed.", + "hotelId": { + "description": "Hotel Code that associated with Transaction Code and Total Pricing Element", "type": "string", - "maxLength": 2000 + "minLength": 0, + "maxLength": 20 }, - "hotelInfo": { - "description": "OPERA or Channel hotel code information.", - "$ref": "#/definitions/hotelCodeMappingInfoType" + "transaction": { + "description": "Transaction Code with Total Pricing Element of the GDS channel", + "$ref": "#/definitions/codeDescriptionType" }, - "links": { - "$ref": "#/definitions/links" + "elementCode": { + "description": "The mapped Total Pricing Element code of the GDS channel", + "$ref": "#/definitions/codeDescriptionType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "chargeType": { + "description": "The mapped Total Pricing Element Charge Type of the GDS channel", + "$ref": "#/definitions/chargeTypeType" + }, + "editPricingElementId": { + "description": "Combination of primary attributes of Total Pricing Element to update the primary attribute field", + "$ref": "#/definitions/totalPricingElementIDType" } } }, - "hotelCodeMappingInfoType": { + "chargeTypeType": { + "type": "string", + "description": "Total Pricing Element either Tax or Service Fee", + "enum": [ + "Tax", + "ServiceFee" + ] + }, + "totalPricingElementIDType": { "type": "object", - "description": "Generic information of the OPERA hotel code, channel hotelcode for the requested booking channel code.", + "description": "Total Pricing Element ID type used to identify the record", "properties": { "hotelId": { - "description": "OPERA hotel code for the requested channel hotel code.", + "description": "Hotel Code that associated with Transaction Code and Total Pricing Element", "type": "string", "minLength": 0, "maxLength": 20 }, - "channelHotelCode": { - "description": "Channel hotel code for the requested OPERA hotel code.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "transaction": { + "description": "Transaction Code with Total Pricing Element of the GDS channel", + "$ref": "#/definitions/codeDescriptionType" } } }, - "changeChannelParameters": { + "totalPricingElementsCopy": { "type": "object", - "description": "Request object for modifying channel parameter(s).", + "description": "Request object to copy the total pricing elements into the target properties.", "properties": { - "criteria": { - "description": "Collection of channel parameter(s) to be modified.", - "$ref": "#/definitions/changeChannelParametersType" + "copyInstructions": { + "$ref": "#/definitions/copyTotalPricingElementsType" }, "links": { "$ref": "#/definitions/links" @@ -22674,174 +23567,214 @@ } } }, - "changeChannelParametersType": { + "copyTotalPricingElementsType": { "type": "object", + "description": "Total Pricing Elements to copy from single source property to multi target properties", "properties": { - "systemCode": { - "description": "External system code.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "totalPricingElements": { + "description": "Total Pricing Element Type record details to copy", + "$ref": "#/definitions/totalPricingElementsType" }, - "channelParameters": { - "description": "Collection of channel parameters whose value needs to be modified.", - "$ref": "#/definitions/channelParametersSimpleType" + "targetHotels": { + "description": "Target properties to copy Total Pricing Element records", + "$ref": "#/definitions/codeListType" } } }, - "channelParametersSimpleType": { + "channelSellLimits": { + "type": "object", + "description": "Response object containing sell limit schedules set for the channel or channel room type.", + "properties": { + "sellLimits": { + "description": "List of sell limit schedules configured for the requested channel or channel room type.", + "$ref": "#/definitions/channelSellLimitSchedulesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "channelSellLimitSchedulesType": { "type": "array", - "description": "Collection of channel parameters simple information.", + "description": "Details about a sell limit schedule for a channel or channel room type.", "maxItems": 4000, "items": { - "$ref": "#/definitions/channelParameterSimpleType" + "$ref": "#/definitions/channelSellLimitScheduleType" } }, - "channelParameterSimpleType": { + "channelSellLimitScheduleType": { "type": "object", - "description": "Basic channel parameter info used in changing channel parameter values.", + "description": "Details about a sell limit schedule for a channel or channel room type.", "properties": { - "parameterName": { + "sellLimitId": { + "description": "Unique identifier for the channel sell limit.", + "$ref": "#/definitions/uniqueID_Type" + }, + "hotelId": { + "description": "Hotel for which the sell limit schedule is applicable.", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 20 }, - "parameterValue": { + "bookingChannelCode": { + "description": "Channel for which the sell limit schedule is applicable.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "hotelId": { + "channelRoomType": { + "description": "Channel room type for which the sell limit schedule is applicable.", "type": "string", "minLength": 0, "maxLength": 20 }, - "parameterValueType": { - "$ref": "#/definitions/channelParameterValueType" + "dateRange": { + "description": "Sell limit schedule begin and end dates as well as which days of the week the limit applies to.", + "$ref": "#/definitions/timeSpanDaysOfWeekType" + }, + "numberOfRooms": { + "description": "Number of rooms which can be sold under the hotel, channel, and channel room type combination for the specified date range.", + "type": "integer" } } }, - "channelParameterValueType": { - "type": "string", - "description": "The value types of parameter, possible types are Boolean, String, Date, and Number.", - "enum": [ - "Boolean", - "String", - "Date", - "Time", - "Number", - "SingleSelectLOV", - "MultiSelectLOV" - ] - }, - "channelRateCategories": { + "timeSpanDaysOfWeekType": { "type": "object", - "description": "Request object for creating channel rate categories.", + "description": "Container for Time span with days of week.", "properties": { - "rateCategories": { - "description": "channel rate categories to be created.", - "type": "object", - "properties": { - "rateCategory": { - "description": "Channel rate category details.", - "type": "array", - "items": { - "$ref": "#/definitions/systemRateCategoryType" - } - }, - "bookingChannelCode": { - "description": "Channel code.", - "$ref": "#/definitions/codeType" - } - } + "timeSpan": { + "$ref": "#/definitions/timeSpanType" }, - "links": { - "$ref": "#/definitions/links" + "sunday": { + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "monday": { + "type": "boolean" + }, + "tuesday": { + "type": "boolean" + }, + "wednesday": { + "type": "boolean" + }, + "thursday": { + "type": "boolean" + }, + "friday": { + "type": "boolean" + }, + "saturday": { + "type": "boolean" } } }, - "channelRateLevels": { + "channelSellLimitsByDate": { "type": "object", - "description": "Request object for creating channel rate levels.", + "description": "Request object to create or update sell limits for the channel or channel room type by day. Advanced logic is implemented to combine consecutive blocks of sell limits into a single schedule which have the same limits configured. Existing schedules can also be split as needed to account for overlapping schedules.", "properties": { - "rateLevels": { - "description": "channel rate levels to be created.", - "type": "object", - "properties": { - "rateLevel": { - "description": "Channel rate level details.", - "type": "array", - "items": { - "$ref": "#/definitions/systemRateLevelType" - } - }, - "bookingChannelCode": { - "description": "Channel code.", - "$ref": "#/definitions/codeType" - } - } + "sellLimits": { + "description": "Collection of sell limits to be created or updated for the channel or channel room type and a particular day.", + "$ref": "#/definitions/channelSellLimitsByDateType" }, - "links": { - "$ref": "#/definitions/links" + "adjustOverlappingSchedules": { + "description": "Flag to indicate whether any overlapping schedules should be automatically adjusted (split, truncated, etc.) as needed.", + "type": "boolean" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "channelRatePlans": { + "channelSellLimitsByDateType": { "type": "object", - "description": "Request object for publishing rate codes to GDS.", + "description": "Collection of sell limits for a channel or channel room type structured by day.", "properties": { - "publishRatePlan": { - "description": "Rate code information to be published.", - "$ref": "#/definitions/publishRatePlanType" + "channelSellLimits": { + "description": "Details about the sell limit for this particular resort, channel, and date.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/channelSellLimitType" + } }, - "links": { - "$ref": "#/definitions/links" + "channelRoomTypeSellLimits": { + "description": "Details about the sell limit for this particular resort, channel, channel room type, and date.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "object", + "properties": { + "numberOfRooms": { + "description": "Number of rooms that can be sold for this particular sell limit date.", + "type": "integer" + }, + "bookingChannelCode": { + "description": "Channel for which this sell limit is applicable.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "date": { + "description": "Date on which this sell limit is applicable.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "channelRoomType": { + "description": "Channel room type for which this sell limit is applicable.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + } }, - "warnings": { - "$ref": "#/definitions/warningsType" + "hotelId": { + "description": "Hotel under which the channel sell limits are applicable.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "channelRateRoomSequenceDetails": { + "channelSellLimitType": { "type": "object", - "description": "Response object for channel rate rooms sequence based on a criteria.", "properties": { - "channelRateRoomList": { - "description": "Booking channel rate room List.", - "$ref": "#/definitions/channelRateRoomListType" + "numberOfRooms": { + "description": "Number of rooms that can be sold for this particular sell limit date.", + "type": "integer" }, - "links": { - "$ref": "#/definitions/links" + "bookingChannelCode": { + "description": "Channel for which this sell limit is applicable.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "date": { + "description": "Date on which this sell limit is applicable.", + "type": "string", + "format": "date", + "maxLength": 8 } } }, - "channelRoomTypes": { + "channelGuaranteeCodeMappingDetails": { "type": "object", - "description": "Request object for creating channel room types.", + "description": "Response object for fetching channel-hotel guarantee code mappings.", "properties": { - "roomTypes": { - "description": "channel room types to be created.", + "channelGuaranteeCodeMappings": { + "description": "Paging information and collection of channel-hotel guarantee code mappings.", "type": "object", "properties": { - "roomType": { - "description": "Channel room type details.", + "channelGuaranteeCodeMapping": { + "description": "Channel-hotel guarantee code mapping and its details.", "type": "array", "items": { - "$ref": "#/definitions/systemRoomTypeType" + "$ref": "#/definitions/channelGuaranteeCodeMappingType" } - }, - "bookingChannelCode": { - "description": "Channel code.", - "$ref": "#/definitions/codeType" } } }, @@ -22853,41 +23786,61 @@ } } }, - "channelCarriers": { + "channelGuaranteeCodeMappingType": { "type": "object", - "description": "Request object for creating channel carriers.", + "description": "Channel-hotel guarantee code mapping information.", "properties": { - "carriers": { - "description": "Channel carriers to be created.", - "type": "object", - "properties": { - "carrier": { - "description": "Channel carrier details.", - "type": "array", - "items": { - "$ref": "#/definitions/systemCarrierType" - } - }, - "bookingChannelCode": { - "description": "Channel code.", - "$ref": "#/definitions/codeType" - } - } + "newChannelGuaranteeCode": { + "description": "New channel guarantee code for the existing guarantee code mapping.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "links": { - "$ref": "#/definitions/links" + "paymentType": { + "description": "Payment type of guarantee code mapping.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "inactiveDate": { + "description": "Inactive date of guarantee code mapping.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "hotelId": { + "description": "Hotel code of guarantee code mapping.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "bookingChannelCode": { + "description": "Booking channel code of guarantee code mapping.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "guaranteeCode": { + "description": "Guarantee code of guarantee code mapping.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "channelGuaranteeCode": { + "description": "Channel guarantee code of guarantee code mapping.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "channelOrgMapping": { + "channelRates": { "type": "object", - "description": "Request object for Create Channel to ORG and CRO Mapping.", + "description": "Request object for distributing channel rates.", "properties": { - "channelOrgMappingDetails": { - "$ref": "#/definitions/channelOrgMappingType" + "distributeChannelRates": { + "description": "Information about rate code to be distributed to channels.", + "$ref": "#/definitions/distributeChannelRatesType" }, "links": { "$ref": "#/definitions/links" @@ -22897,158 +23850,221 @@ } } }, - "channelOrgMappingType": { + "distributeChannelRatesType": { "type": "object", - "description": "Respresents information of the Channel Code, OrgCode and Default Login Resort used for mapping.", + "description": "Information about rate codes to be distributed to channels.", "properties": { - "channelCode": { - "description": "Channel code for which OrgCode mapping needs to be done.", + "distributeChannelRate": { + "description": "Information about rate codes to be distributed to a channel.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/distributeChannelRateType" + } + }, + "hotelId": { + "description": "Hotel Code.", "type": "string", "minLength": 0, "maxLength": 20 + } + } + }, + "distributeChannelRateType": { + "type": "object", + "description": "Information about rate codes to be distributed to a channel.", + "properties": { + "distributeChannelRateMappings": { + "description": "Information about rate codes to be distributed to a channel.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/distributeChannelRateMappingType" + } }, - "orgCode": { - "description": "OrgCode for which Channel code mapping needs to be done.", + "negotiatedProfiles": { + "description": "Negotiated channel rate details to be modified.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/channelNegProfileType" + } + }, + "bookingChannelCode": { + "description": "Channel.", "type": "string", "minLength": 0, "maxLength": 20 }, - "defaultLoginResort": { - "description": "Default Login Resort value used while mapping Channel Code and OrgCode.", + "channelRatePlanCode": { + "description": "Channel Rate Code.", "type": "string", "minLength": 0, "maxLength": 20 } } }, - "channelOrgMappingsDetails": { + "distributeChannelRateMappingType": { "type": "object", - "description": "Response object for Fetch Channel to ORG and CRO Mapping.", + "description": "Basic details of a hotel-channel rate code mapping.", "properties": { - "channelOrgMappingsDetails": { - "$ref": "#/definitions/channelOrgMappingsType" + "description": { + "description": "Description of channel rate plan code.", + "$ref": "#/definitions/channelRateMappingDescriptionType" }, - "links": { - "$ref": "#/definitions/links" + "channelRatePlanWebName": { + "description": "Name of channel rate plan code to display on web.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "channelOrgMappingsType": { - "type": "array", - "description": "Respresents information of the Channel Code, OrgCode and Default Login Resort used for mapping.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/channelOrgMappingType" - } - }, - "totalPricingElements": { - "type": "object", - "description": "Response object to populate total pricing elements of the GDS channel.", - "properties": { - "totalPricingElements": { - "$ref": "#/definitions/totalPricingElementsType" + "channelRatePlanCategory": { + "description": "Channel rate category of hotel-channel rate code mapping.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", - "type": "integer" + "rateLevel": { + "description": "Rate Level.", + "type": "string", + "minLength": 0, + "maxLength": 3 }, - "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" + "rateTierAttr": { + "description": "Rate Tier.", + "type": "object", + "properties": { + "rateTier": { + "type": "integer" + } + } }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "blockRateIndicator": { + "description": "Block Rate Indicator.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "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.", + "promotionCode": { + "description": "Promotion Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "channelRatePlanOrder": { + "description": "Order of the channel rate type mapping.", + "type": "number" + }, + "allowRateUpdate": { + "description": "Indicates if Rate updates to Channel are allowed.", "type": "boolean" }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "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" }, - "count": { - "description": "Total number of rows returned", - "type": "integer" + "regionalAvailAttr": { + "description": "Indicates if rate participates in Regional Availability.", + "type": "object", + "properties": { + "inclInRegionalAvail": { + "type": "boolean" + }, + "allowRegionalAvail": { + "type": "boolean" + } + } }, - "links": { - "$ref": "#/definitions/links" + "beginDate": { + "description": "Begin date of the channel rate code mapping.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "totalPricingElementsType": { - "type": "array", - "description": "List of Total Pricing Element Type", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/totalPricingElementType" - } - }, - "totalPricingElementType": { - "type": "object", - "description": "Total Pricing Element ID type used to identify the record", - "properties": { - "hotelId": { - "description": "Hotel Code that associated with Transaction Code and Total Pricing Element", + "endDate": { + "description": "End date of the channel rate code mapping.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "carrierInfo": { + "description": "Carrier attached to the Channel Rate Plan.", + "$ref": "#/definitions/carrierInfoType" + }, + "newChannelRatePlanCode": { + "description": "New Channel Rate Plan Code of the mapping. Used only to change the Channel Rate Plan Code.", "type": "string", "minLength": 0, "maxLength": 20 }, - "transaction": { - "description": "Transaction Code with Total Pricing Element of the GDS channel", - "$ref": "#/definitions/codeDescriptionType" + "roomTypes": { + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } }, - "elementCode": { - "description": "The mapped Total Pricing Element code of the GDS channel", - "$ref": "#/definitions/codeDescriptionType" + "ratePlanInfo": { + "description": "Rate plan information including description and sell dates.", + "$ref": "#/definitions/ratePlanPrimaryDetailsType" }, - "chargeType": { - "description": "The mapped Total Pricing Element Charge Type of the GDS channel", - "$ref": "#/definitions/chargeTypeType" + "ratePlanCode": { + "description": "Rate Plan Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "editPricingElementId": { - "description": "Combination of primary attributes of Total Pricing Element to update the primary attribute field", - "$ref": "#/definitions/totalPricingElementIDType" + "hasNegotiatedRates": { + "description": "True if this channel rate plan code has negotiated rates, otherwise false", + "type": "boolean" + }, + "hasChannelNegotiatedRates": { + "description": "True if the mapping has channel negotiated rates, otherwise false.", + "type": "boolean" } } }, - "chargeTypeType": { - "type": "string", - "description": "Total Pricing Element either Tax or Service Fee", - "enum": [ - "Tax", - "ServiceFee" - ] + "channelCardTypeMappings": { + "type": "object", + "description": "Request object for creating a new channel-hotel card type mapping.", + "properties": { + "channelCardTypeMapping": { + "description": "Channel-hotel card type mapping information to be created.", + "$ref": "#/definitions/channelCardTypeMappingType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } }, - "totalPricingElementIDType": { + "channelGuaranteeCodeMappings": { "type": "object", - "description": "Total Pricing Element ID type used to identify the record", + "description": "Request object for creating a new channel-hotel guarantee code mapping.", "properties": { - "hotelId": { - "description": "Hotel Code that associated with Transaction Code and Total Pricing Element", - "type": "string", - "minLength": 0, - "maxLength": 20 + "channelGuaranteeCodeMapping": { + "description": "Channel-hotel guarantee code mapping information to be created.", + "$ref": "#/definitions/channelGuaranteeCodeMappingType" }, - "transaction": { - "description": "Transaction Code with Total Pricing Element of the GDS channel", - "$ref": "#/definitions/codeDescriptionType" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "totalPricingElementsCopy": { + "channelParameterMapping": { "type": "object", - "description": "Request object to copy the total pricing elements into the target properties.", + "description": "Response object for channel parameter(s) based on search criteria.", "properties": { - "copyInstructions": { - "$ref": "#/definitions/copyTotalPricingElementsType" + "channelParameterMapping": { + "description": "Collection of channel parameter(s) result based on the search criteria.", + "$ref": "#/definitions/channelParameterMappingType" }, "links": { "$ref": "#/definitions/links" @@ -23058,216 +24074,209 @@ } } }, - "copyTotalPricingElementsType": { + "channelParameterMappingType": { "type": "object", - "description": "Total Pricing Elements to copy from single source property to multi target properties", + "description": "Includes information about the parametersTypes and system Information for the Channel/Hotel.", "properties": { - "totalPricingElements": { - "description": "Total Pricing Element Type record details to copy", - "$ref": "#/definitions/totalPricingElementsType" + "systemInfo": { + "description": "Identify details of External System", + "$ref": "#/definitions/systemInfoType" }, - "targetHotels": { - "description": "Target properties to copy Total Pricing Element records", - "$ref": "#/definitions/codeListType" + "groups": { + "description": "Collection of channel parameters organized into groups.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/channelParameterGroupType" + } } } }, - "channelSellLimits": { + "channelParameterGroupType": { "type": "object", - "description": "Response object containing sell limit schedules set for the channel or channel room type.", "properties": { - "sellLimits": { - "description": "List of sell limit schedules configured for the requested channel or channel room type.", - "$ref": "#/definitions/channelSellLimitSchedulesType" + "channelParameters": { + "$ref": "#/definitions/channelParametersType" }, - "links": { - "$ref": "#/definitions/links" + "groupName": { + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "groupDisplayName": { + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, - "channelSellLimitSchedulesType": { + "channelParametersType": { "type": "array", - "description": "Details about a sell limit schedule for a channel or channel room type.", + "description": "parameters details.", "maxItems": 4000, "items": { - "$ref": "#/definitions/channelSellLimitScheduleType" + "$ref": "#/definitions/channelParameterType" } }, - "channelSellLimitScheduleType": { + "channelParameterType": { "type": "object", - "description": "Details about a sell limit schedule for a channel or channel room type.", "properties": { - "sellLimitId": { - "description": "Unique identifier for the channel sell limit.", - "$ref": "#/definitions/uniqueID_Type" - }, - "hotelId": { - "description": "Hotel for which the sell limit schedule is applicable.", + "parameterName": { + "description": "Name of the parameter in the channel.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 80 }, - "bookingChannelCode": { - "description": "Channel for which the sell limit schedule is applicable.", + "parameterDisplay": { + "description": "The display name for the parameter in the channel.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 80 }, - "channelRoomType": { - "description": "Channel room type for which the sell limit schedule is applicable.", + "shortDescription": { + "description": "Short description for the parameter.", "type": "string", "minLength": 0, - "maxLength": 20 - }, - "dateRange": { - "description": "Sell limit schedule begin and end dates as well as which days of the week the limit applies to.", - "$ref": "#/definitions/timeSpanDaysOfWeekType" - }, - "numberOfRooms": { - "description": "Number of rooms which can be sold under the hotel, channel, and channel room type combination for the specified date range.", - "type": "integer" - } - } - }, - "timeSpanDaysOfWeekType": { - "type": "object", - "description": "Container for Time span with days of week.", - "properties": { - "timeSpan": { - "$ref": "#/definitions/timeSpanType" - }, - "sunday": { - "type": "boolean" + "maxLength": 2000 }, - "monday": { - "type": "boolean" + "parameterDescription": { + "description": "The Description for the parameter.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "tuesday": { - "type": "boolean" + "parameterValue": { + "description": "The Value of the parameter.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "wednesday": { - "type": "boolean" + "hotelId": { + "description": "Hotel code identifying the parameters related to the Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "thursday": { - "type": "boolean" + "parameterType": { + "description": "The type of the parameter, the possible types are P (Parameter), Setting (S).", + "type": "string", + "enum": [ + "P", + "S" + ] }, - "friday": { - "type": "boolean" + "scope": { + "description": "Whether this is a global or property level parameter.", + "type": "string", + "enum": [ + "H", + "P" + ] }, - "saturday": { - "type": "boolean" - } - } - }, - "channelSellLimitsByDate": { - "type": "object", - "description": "Request object to create or update sell limits for the channel or channel room type by day. Advanced logic is implemented to combine consecutive blocks of sell limits into a single schedule which have the same limits configured. Existing schedules can also be split as needed to account for overlapping schedules.", - "properties": { - "sellLimits": { - "description": "Collection of sell limits to be created or updated for the channel or channel room type and a particular day.", - "$ref": "#/definitions/channelSellLimitsByDateType" + "valueType": { + "$ref": "#/definitions/channelParameterValueType" }, - "adjustOverlappingSchedules": { - "description": "Flag to indicate whether any overlapping schedules should be automatically adjusted (split, truncated, etc.) as needed.", - "type": "boolean" + "sequence": { + "description": "Sequence number for displaying the parameter in the channel.", + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "channelSellLimitsByDateType": { - "type": "object", - "description": "Collection of sell limits for a channel or channel room type structured by day.", - "properties": { - "channelSellLimits": { - "description": "Details about the sell limit for this particular resort, channel, and date.", + "parameters": { "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/channelSellLimitType" + "$ref": "#/definitions/baseChannelParameterType" } }, - "channelRoomTypeSellLimits": { - "description": "Details about the sell limit for this particular resort, channel, channel room type, and date.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "object", - "properties": { - "numberOfRooms": { - "description": "Number of rooms that can be sold for this particular sell limit date.", - "type": "integer" - }, - "bookingChannelCode": { - "description": "Channel for which this sell limit is applicable.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "date": { - "description": "Date on which this sell limit is applicable.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "channelRoomType": { - "description": "Channel room type for which this sell limit is applicable.", - "type": "string", - "minLength": 0, - "maxLength": 20 - } - } - } + "levelType": { + "$ref": "#/definitions/channelParameterLevelType" }, - "hotelId": { - "description": "Hotel under which the channel sell limits are applicable.", + "levelCode": { "type": "string", "minLength": 0, "maxLength": 20 } - } + }, + "description": "Parameters details for the Channel." }, - "channelSellLimitType": { + "baseChannelParameterType": { "type": "object", + "description": "Parameters details for the Channel.", "properties": { - "numberOfRooms": { - "description": "Number of rooms that can be sold for this particular sell limit date.", - "type": "integer" + "parameterName": { + "description": "Name of the parameter in the channel.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "parameterDisplay": { + "description": "The display name for the parameter in the channel.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "shortDescription": { + "description": "Short description for the parameter.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "parameterDescription": { + "description": "The Description for the parameter.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "parameterValue": { + "description": "The Value of the parameter.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "bookingChannelCode": { - "description": "Channel for which this sell limit is applicable.", + "hotelId": { + "description": "Hotel code identifying the parameters related to the Hotel.", "type": "string", "minLength": 0, "maxLength": 20 }, - "date": { - "description": "Date on which this sell limit is applicable.", + "parameterType": { + "description": "The type of the parameter, the possible types are P (Parameter), Setting (S).", "type": "string", - "format": "date", - "maxLength": 8 + "enum": [ + "P", + "S" + ] + }, + "scope": { + "description": "Whether this is a global or property level parameter.", + "type": "string", + "enum": [ + "H", + "P" + ] + }, + "valueType": { + "$ref": "#/definitions/channelParameterValueType" + }, + "sequence": { + "description": "Sequence number for displaying the parameter in the channel.", + "type": "integer" } } }, - "channelGuaranteeCodeMappingDetails": { + "channelParameterLevelType": { + "type": "string", + "enum": [ + "Global", + "Hotel" + ] + }, + "channelPolicies": { "type": "object", - "description": "Response object for fetching channel-hotel guarantee code mappings.", + "description": "Request object for fetching Policies, guarantee, and deposit Details.", "properties": { - "channelGuaranteeCodeMappings": { - "description": "Paging information and collection of channel-hotel guarantee code mappings.", - "type": "object", - "properties": { - "channelGuaranteeCodeMapping": { - "description": "Channel-hotel guarantee code mapping and its details.", - "type": "array", - "items": { - "$ref": "#/definitions/channelGuaranteeCodeMappingType" - } - } - } + "channelPoliciesInfo": { + "description": "Reservation Rules and Policies related Information", + "$ref": "#/definitions/channelPoliciesInfoType" }, "links": { "$ref": "#/definitions/links" @@ -23277,253 +24286,381 @@ } } }, - "channelGuaranteeCodeMappingType": { + "channelPoliciesInfoType": { + "type": "array", + "description": "To list down all the policies associated with the relevant input request.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/channelPolicyType" + } + }, + "channelPolicyType": { "type": "object", - "description": "Channel-hotel guarantee code mapping information.", + "description": "Policy details including guaranteeInfo, cancellation information etc.", "properties": { - "newChannelGuaranteeCode": { - "description": "New channel guarantee code for the existing guarantee code mapping.", + "guarantees": { + "description": "Guarantee details to be fetched", + "$ref": "#/definitions/guaranteesInfoType" + }, + "cancelPenalty": { + "description": "Cancellation details.", + "$ref": "#/definitions/cancelPenaltyType" + }, + "depositPolicy": { + "description": "DepositPolicy details.", + "$ref": "#/definitions/depositPolicyType" + }, + "channelMarketingInfo": { + "description": "Channel Marketing Text like cancel,deposit,tax,commission policy etc.", + "$ref": "#/definitions/channelMarketingInfoType" + }, + "ratePlanCode": { "type": "string", "minLength": 0, "maxLength": 20 }, - "paymentType": { - "description": "Payment type of guarantee code mapping.", + "channelRatePlanCode": { "type": "string", "minLength": 0, "maxLength": 20 }, - "inactiveDate": { - "description": "Inactive date of guarantee code mapping.", - "type": "string", - "format": "date", - "maxLength": 8 + "hold": { + "type": "boolean" }, - "hotelId": { - "description": "Hotel code of guarantee code mapping.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "deposit": { + "type": "boolean" }, - "bookingChannelCode": { - "description": "Booking channel code of guarantee code mapping.", + "commissionCode": { + "type": "string" + } + } + }, + "guaranteesInfoType": { + "type": "array", + "description": "Guarantee details.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/guaranteeType" + } + }, + "guaranteeType": { + "type": "object", + "description": "Specifies Guarantee Code attributes.", + "properties": { + "description": { + "description": "Description of the Guarantee Code.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 + }, + "requirements": { + "description": "Specifies various requirements for the guarantee code.", + "$ref": "#/definitions/guaranteeRequirementsType" + }, + "shortDescription": { + "description": "Brief description of the Guarantee Code.", + "$ref": "#/definitions/translationTextType80" + }, + "paymentTypes": { + "description": "Specifies various payment types for the guarantee code.", + "$ref": "#/definitions/paymentTypesType" }, "guaranteeCode": { - "description": "Guarantee code of guarantee code mapping.", + "description": "Code assigned to the Guarantee.", "type": "string", "minLength": 0, "maxLength": 20 }, - "channelGuaranteeCode": { - "description": "Channel guarantee code of guarantee code mapping.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "onHold": { + "description": "If true indicates this Guarantee Code is used only to hold the inventory during reservation process.", + "type": "boolean" + }, + "reserveInventory": { + "description": "If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" + }, + "lateArrival": { + "description": "Represents the late arrival time.", + "type": "string" } } }, - "channelRates": { + "guaranteeRequirementsType": { "type": "object", - "description": "Request object for distributing channel rates.", + "description": "Specifies various requirement for the guarantee code.", "properties": { - "distributeChannelRates": { - "description": "Information about rate code to be distributed to channels.", - "$ref": "#/definitions/distributeChannelRatesType" + "requirementCode": { + "description": "Requirement Code.", + "type": "string" }, - "links": { - "$ref": "#/definitions/links" + "cancellation": { + "description": "When true indicates cancellation on the reservation is required for this guarantee code.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "phoneNumber": { + "description": "When true indicates phone number on the reservation is required for this guarantee code.", + "type": "boolean" + }, + "address": { + "description": "When true indicates address on the reservation is required for this guarantee code.", + "type": "boolean" + }, + "creditCard": { + "description": "When true indicates Credit Card on the reservation is required for this guarantee code.", + "type": "boolean" + }, + "arrivalTime": { + "description": "When true indicates arrival Time on the reservation is required for this guarantee code.", + "type": "boolean" + }, + "deposit": { + "description": "When true indicates deposit is required for this guarantee code.", + "type": "boolean" } } }, - "distributeChannelRatesType": { + "paymentTypesType": { + "type": "array", + "description": "Payment card code like AX,VI etc.", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "cancelPenaltyType": { "type": "object", - "description": "Information about rate codes to be distributed to channels.", + "description": "The CancelPenalty class defines the cancellation policy of the hotel facility.", "properties": { - "distributeChannelRate": { - "description": "Information about rate codes to be distributed to a channel.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/distributeChannelRateType" - } + "deadline": { + "description": "Cancellation deadline, absolute or relative.", + "$ref": "#/definitions/policyDeadlineType" }, - "hotelId": { - "description": "Hotel Code.", + "amountPercent": { + "description": "Cancellation fee expressed as a fixed amount, or percentage of/or room nights.", + "$ref": "#/definitions/policyAmountPercentType" + }, + "penaltyDescription": { + "description": "Text description of the Penalty in a given language.", "type": "string", "minLength": 0, - "maxLength": 20 - } - } - }, - "distributeChannelRateType": { - "type": "object", - "description": "Information about rate codes to be distributed to a channel.", - "properties": { - "distributeChannelRateMappings": { - "description": "Information about rate codes to be distributed to a channel.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/distributeChannelRateMappingType" - } + "maxLength": 2000 }, - "negotiatedProfiles": { - "description": "Negotiated channel rate details to be modified.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/channelNegProfileType" - } + "offsetUnit": { + "$ref": "#/definitions/offsetUnitType" }, - "bookingChannelCode": { - "description": "Channel.", + "formattedRule": { + "description": "Formatted Text Rule of the Cancellation Penalty.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "channelRatePlanCode": { - "description": "Channel Rate Code.", + "policyCode": { + "description": "Policy Code.", "type": "string", "minLength": 0, "maxLength": 20 + }, + "manual": { + "description": "Flag to indicate if the cancellation policy is manual.", + "type": "boolean" + }, + "nonRefundable": { + "description": "Indicates if the amount is refundable if booking is canceled.", + "type": "boolean" } } }, - "distributeChannelRateMappingType": { + "policyDeadlineType": { "type": "object", - "description": "Basic details of a hotel-channel rate code mapping.", + "description": "Cancellation deadline, absolute or relative.", "properties": { - "description": { - "description": "Description of channel rate plan code.", - "$ref": "#/definitions/channelRateMappingDescriptionType" - }, - "channelRatePlanWebName": { - "description": "Name of channel rate plan code to display on web.", + "absoluteDeadline": { + "description": "Defines the absolute deadline. Either this or the offset attributes may be used.", "type": "string", - "minLength": 0, - "maxLength": 80 + "format": "date-time" }, - "channelRatePlanCategory": { - "description": "Channel rate category of hotel-channel rate code mapping.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "offsetFromArrival": { + "description": "The number of days before arrival that allows cancellation without penalties.", + "type": "integer" }, - "rateLevel": { - "description": "Rate Level.", + "offsetDropTime": { + "description": "Time on offset day the cancellation penalties applies.", "type": "string", - "minLength": 0, - "maxLength": 3 + "format": "date-time" }, - "rateTierAttr": { - "description": "Rate Tier.", - "type": "object", - "properties": { - "rateTier": { - "type": "integer" - } - } + "offsetFromBookingDate": { + "description": "The number of days after booking deposit must be paid.", + "type": "integer" + } + } + }, + "policyAmountPercentType": { + "type": "object", + "description": "Defines the percentage basis for calculating the fee amount or the amount.", + "properties": { + "basisType": { + "description": "Provides the basis for how the amount of the guarantee is calculated.", + "$ref": "#/definitions/policyBasisTypeType" }, - "blockRateIndicator": { - "description": "Block Rate Indicator.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "nights": { + "description": "The number of nights of the hotel stay that are used to calculate the fee amount.", + "type": "integer" }, - "promotionCode": { - "description": "Promotion Code.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "percent": { + "description": "The percentage used to calculate the amount.", + "type": "number", + "minimum": 0, + "maximum": 100 }, - "channelRatePlanOrder": { - "description": "Order of the channel rate type mapping.", + "amount": { + "description": "A monetary amount.", "type": "number" }, - "allowRateUpdate": { - "description": "Indicates if Rate updates to Channel are allowed.", - "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" + "currencyCode": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 + } + } + }, + "policyBasisTypeType": { + "type": "string", + "description": "Full Amount.", + "enum": [ + "FlatAmount", + "Percentage", + "Nights", + "NightPercentage", + "FullAmount" + ] + }, + "offsetUnitType": { + "type": "string", + "description": "Indicates deadline offset unit type.", + "enum": [ + "Year", + "Month", + "Day", + "Hour" + ] + }, + "depositPolicyType": { + "type": "object", + "description": "Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.", + "properties": { + "amountPercent": { + "description": "Payment expressed as a fixed amount, or a percentage of/or room nights.", + "$ref": "#/definitions/policyAmountPercentType" }, - "regionalAvailAttr": { - "description": "Indicates if rate participates in Regional Availability.", - "type": "object", - "properties": { - "inclInRegionalAvail": { - "type": "boolean" - }, - "allowRegionalAvail": { - "type": "boolean" - } - } + "deadline": { + "description": "Payment deadline, absolute or relative.", + "$ref": "#/definitions/policyDeadlineType" }, - "beginDate": { - "description": "Begin date of the channel rate code mapping.", + "description": { + "description": "Text description of the Payment in a given language.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 2000 }, - "endDate": { - "description": "End date of the channel rate code mapping.", + "depositReceiptNo": { + "description": "Receipt number associated with the deposit policy", + "type": "integer" + }, + "transactionDate": { + "description": "Transaction Date associated with the deposit policy", "type": "string", "format": "date", "maxLength": 8 }, - "carrierInfo": { - "description": "Carrier attached to the Channel Rate Plan.", - "$ref": "#/definitions/carrierInfoType" + "depositReqReversed": { + "description": "Flag to indicate if deposit policy is reversed", + "type": "boolean" }, - "newChannelRatePlanCode": { - "description": "New Channel Rate Plan Code of the mapping. Used only to change the Channel Rate Plan Code.", + "formattedRule": { + "description": "Formatted Text Rule of the deposit policy.", "type": "string", "minLength": 0, - "maxLength": 20 - }, - "roomTypes": { - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "minLength": 0, - "maxLength": 20 - } + "maxLength": 2000 }, - "ratePlanInfo": { - "description": "Rate plan information including description and sell dates.", - "$ref": "#/definitions/ratePlanPrimaryDetailsType" + "typeOfCharges": { + "description": "Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both", + "$ref": "#/definitions/depositCancelRevenueType" }, - "ratePlanCode": { - "description": "Rate Plan Code.", + "policyCode": { + "description": "Deposit Policy Code", "type": "string", "minLength": 0, "maxLength": 20 }, - "hasNegotiatedRates": { - "description": "True if this channel rate plan code has negotiated rates, otherwise false", - "type": "boolean" - }, - "hasChannelNegotiatedRates": { - "description": "True if the mapping has channel negotiated rates, otherwise false.", + "manual": { + "description": "Flag to indicate if the cancellation policy is manual.", "type": "boolean" } } }, - "channelCardTypeMappings": { + "depositCancelRevenueType": { + "type": "string", + "description": "The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.", + "enum": [ + "Rooms", + "Catering", + "All" + ] + }, + "channelMarketingInfoType": { + "type": "array", + "description": "Marketing Text like cancel policy, deposit policy etc.", + "maxItems": 4000, + "items": { + "type": "object", + "properties": { + "description": { + "description": "Marketing Text like cancel policy, deposit policy etc.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "policyType": { + "description": "Indicates the policy type like cancel,deposit etc.", + "$ref": "#/definitions/marketingPolicyType" + }, + "ratePlanCode": { + "description": "Indicates the rate code for which the policy is associated with.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + } + }, + "marketingPolicyType": { + "type": "string", + "description": "Indicates the channel policy type like deposit,cancel etc.", + "enum": [ + "Deposit", + "Commission", + "Cancel", + "Guarantee", + "General", + "Penalty", + "Tax", + "Promotion" + ] + }, + "channelRoomMapping": { "type": "object", - "description": "Request object for creating a new channel-hotel card type mapping.", - "properties": { - "channelCardTypeMapping": { - "description": "Channel-hotel card type mapping information to be created.", - "$ref": "#/definitions/channelCardTypeMappingType" + "description": "Request object for changing Channel Room Mapping.", + "properties": { + "channelRoomMapping": { + "description": "Channel Room Type mapping details to be changed.", + "$ref": "#/definitions/channelRoomMappingType" }, "links": { "$ref": "#/definitions/links" @@ -23533,13 +24670,13 @@ } } }, - "channelGuaranteeCodeMappings": { + "channelInventorySnapshot": { "type": "object", - "description": "Request object for creating a new channel-hotel guarantee code mapping.", + "description": "Response object containing the room availability and restrictions for a hotel in relation to booking channels.", "properties": { - "channelGuaranteeCodeMapping": { - "description": "Channel-hotel guarantee code mapping information to be created.", - "$ref": "#/definitions/channelGuaranteeCodeMappingType" + "channelInventorySnapshot": { + "description": "Channel inventory snapshot containing room availability and restrictions for a hotel in relation to booking channels.", + "$ref": "#/definitions/channelInventorySnapshotType" }, "links": { "$ref": "#/definitions/links" @@ -23549,609 +24686,475 @@ } } }, - "channelParameterMapping": { + "channelInventorySnapshotType": { "type": "object", - "description": "Response object for channel parameter(s) based on search criteria.", + "description": "The evaluated channel inventory snapshot statistics based on the search criteria given.", "properties": { - "channelParameterMapping": { - "description": "Collection of channel parameter(s) result based on the search criteria.", - "$ref": "#/definitions/channelParameterMappingType" - }, - "links": { - "$ref": "#/definitions/links" + "inventories": { + "description": "The main statistics for the channel inventory snapshot.", + "$ref": "#/definitions/channelInventorySnapshotInventoriesType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "masterInfo": { + "description": "Additional information about the records returned in the snapshot.", + "$ref": "#/definitions/channelInventorySnapshotMasterInfoType" } } }, - "channelParameterMappingType": { + "channelInventorySnapshotInventoriesType": { "type": "object", - "description": "Includes information about the parametersTypes and system Information for the Channel/Hotel.", + "description": "Collection of inventory statistics and restrictions for a hotel in relation to booking channels.", "properties": { - "systemInfo": { - "description": "Identify details of External System", - "$ref": "#/definitions/systemInfoType" - }, - "groups": { - "description": "Collection of channel parameters organized into groups.", + "inventory": { + "description": "Details of inventory statistics and restrictions.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/channelParameterGroupType" + "$ref": "#/definitions/channelInventoryType" } - } - } - }, - "channelParameterGroupType": { - "type": "object", - "properties": { - "channelParameters": { - "$ref": "#/definitions/channelParametersType" - }, - "groupName": { - "type": "string", - "minLength": 0, - "maxLength": 80 }, - "groupDisplayName": { + "hotelId": { + "description": "Hotel that the inventory belongs to.", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 20 } } }, - "channelParametersType": { - "type": "array", - "description": "parameters details.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/channelParameterType" - } - }, - "channelParameterType": { + "channelInventoryType": { "type": "object", + "description": "Inventory statistics and restrictions. This can have no code (House level), BookingChannelCode, or ChannelRoomType to represent the different levels.", "properties": { - "parameterName": { - "description": "Name of the parameter in the channel.", - "type": "string", - "minLength": 0, - "maxLength": 80 - }, - "parameterDisplay": { - "description": "The display name for the parameter in the channel.", - "type": "string", - "minLength": 0, - "maxLength": 80 - }, - "shortDescription": { - "description": "Short description for the parameter.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "parameterDescription": { - "description": "The Description for the parameter.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "parameterValue": { - "description": "The Value of the parameter.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "hotelId": { - "description": "Hotel code identifying the parameters related to the Hotel.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "parameterType": { - "description": "The type of the parameter, the possible types are P (Parameter), Setting (S).", - "type": "string", - "enum": [ - "P", - "S" - ] - }, - "scope": { - "description": "Whether this is a global or property level parameter.", - "type": "string", - "enum": [ - "H", - "P" - ] - }, - "valueType": { - "$ref": "#/definitions/channelParameterValueType" - }, - "sequence": { - "description": "Sequence number for displaying the parameter in the channel.", - "type": "integer" - }, - "parameters": { + "snapshot": { + "description": "Inventory statistics and restriction details.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/baseChannelParameterType" + "$ref": "#/definitions/channelSnapshotType" } }, - "levelType": { - "$ref": "#/definitions/channelParameterLevelType" + "bookingChannelCode": { + "description": "Booking channel code that the snapshot belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "levelCode": { + "channelRoomType": { + "description": "Booking channel room type that the snapshot belongs to.", "type": "string", "minLength": 0, "maxLength": 20 } - }, - "description": "Parameters details for the Channel." + } }, - "baseChannelParameterType": { + "channelSnapshotType": { "type": "object", - "description": "Parameters details for the Channel.", + "description": "Inventory statistic and restriction information for a given date.", "properties": { - "parameterName": { - "description": "Name of the parameter in the channel.", - "type": "string", - "minLength": 0, - "maxLength": 80 - }, - "parameterDisplay": { - "description": "The display name for the parameter in the channel.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "restrictionsInfo": { + "description": "Restrictions information for the day.", + "$ref": "#/definitions/restrictionsInfoType" }, - "shortDescription": { - "description": "Short description for the parameter.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "inventoryRooms": { + "description": "Number of rooms in inventory.", + "type": "number" }, - "parameterDescription": { - "description": "The Description for the parameter.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "sellLimit": { + "description": "Number of overbooking rooms allowed.", + "type": "number" }, - "parameterValue": { - "description": "The Value of the parameter.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "tentativeRoomsSold": { + "description": "Number of tentative rooms sold - does not include definite reservations.", + "type": "number" }, - "hotelId": { - "description": "Hotel code identifying the parameters related to the Hotel.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "roomsSold": { + "description": "Number of rooms sold.", + "type": "number" }, - "parameterType": { - "description": "The type of the parameter, the possible types are P (Parameter), Setting (S).", - "type": "string", - "enum": [ - "P", - "S" - ] + "availableRooms": { + "description": "Number of available rooms.", + "type": "number" }, - "scope": { - "description": "Whether this is a global or property level parameter.", + "date": { + "description": "Date of the statistics and restrictions.", "type": "string", - "enum": [ - "H", - "P" - ] - }, - "valueType": { - "$ref": "#/definitions/channelParameterValueType" - }, - "sequence": { - "description": "Sequence number for displaying the parameter in the channel.", - "type": "integer" - } - } - }, - "channelParameterLevelType": { - "type": "string", - "enum": [ - "Global", - "Hotel" - ] - }, - "channelPolicies": { - "type": "object", - "description": "Request object for fetching Policies, guarantee, and deposit Details.", - "properties": { - "channelPoliciesInfo": { - "description": "Reservation Rules and Policies related Information", - "$ref": "#/definitions/channelPoliciesInfoType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" + "format": "date", + "maxLength": 8 } } }, - "channelPoliciesInfoType": { + "restrictionsInfoType": { "type": "array", - "description": "To list down all the policies associated with the relevant input request.", + "description": "Provides the basic Restriction type details, specifically used in snapshot operations for efficiency.", "maxItems": 4000, "items": { - "$ref": "#/definitions/channelPolicyType" + "$ref": "#/definitions/restrictionInfoType" } }, - "channelPolicyType": { + "restrictionInfoType": { "type": "object", - "description": "Policy details including guaranteeInfo, cancellation information etc.", "properties": { - "guarantees": { - "description": "Guarantee details to be fetched", - "$ref": "#/definitions/guaranteesInfoType" + "restrictionStatus": { + "description": "Indicates the type of the restriction.", + "$ref": "#/definitions/restrictionInfoStatusType" + } + } + }, + "restrictionInfoStatusType": { + "type": "object", + "description": "The RestrictionStatusType is used to indicate the type of restriction applied. An enumerated restriction type is defined in the attribute group.", + "properties": { + "code": { + "description": "Identifies the type of restriction. I.E. Closed, ClosedForArrival, etc.", + "$ref": "#/definitions/restrictionStatusesType" }, - "cancelPenalty": { - "description": "Cancellation details.", - "$ref": "#/definitions/cancelPenaltyType" + "unit": { + "description": "Defines restriction in conjunction with Restriction Code. Value must be specified for Restriction Codes MinimumStayThrough, MaximumStayThrough, MinimumLengthOfStay, MaximumLengthOfStay, MinimumAdvanceBooking, MaximumAdvanceBooking.", + "type": "integer" }, - "depositPolicy": { - "description": "DepositPolicy details.", - "$ref": "#/definitions/depositPolicyType" + "lOS1": { + "description": "Indicates Length of Stay 1 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", + "type": "boolean" }, - "channelMarketingInfo": { - "description": "Channel Marketing Text like cancel,deposit,tax,commission policy etc.", - "$ref": "#/definitions/channelMarketingInfoType" + "lOS2": { + "description": "Indicates Length of Stay 2 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", + "type": "boolean" }, - "ratePlanCode": { + "lOS3": { + "description": "Indicates Length of Stay 3 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", + "type": "boolean" + }, + "lOS4": { + "description": "Indicates Length of Stay 4 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", + "type": "boolean" + }, + "lOS5": { + "description": "Indicates Length of Stay 5 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", + "type": "boolean" + }, + "lOS6": { + "description": "Indicates Length of Stay 6 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", + "type": "boolean" + }, + "lOS7": { + "description": "Indicates Length of Stay 7 or more is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", + "type": "boolean" + }, + "roomClass": { + "description": "Room Class of actual restriction.", "type": "string", "minLength": 0, "maxLength": 20 }, - "channelRatePlanCode": { + "rateCategory": { + "description": "Rate Category of actual restriction.", "type": "string", "minLength": 0, "maxLength": 20 }, - "hold": { - "type": "boolean" + "rateCode": { + "description": "Rate Code of actual restriction.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "deposit": { - "type": "boolean" + "roomType": { + "description": "Room Type of actual restriction.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "commissionCode": { - "type": "string" + "bookingChannelCode": { + "description": "Booking channel code of actual restriction.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "guaranteesInfoType": { - "type": "array", - "description": "Guarantee details.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/guaranteeType" - } + "restrictionStatusesType": { + "type": "string", + "enum": [ + "Closed", + "ClosedForArrival", + "ClosedForDeparture", + "MinimumStayThrough", + "MaximumStayThrough", + "MinimumLengthOfStay", + "MaximumLengthOfStay", + "LOSNotAvailable", + "MinimumAdvanceBooking", + "MaximumAdvanceBooking", + "Open", + "OpenForArrival", + "OpenForDeparture" + ] }, - "guaranteeType": { + "channelInventorySnapshotMasterInfoType": { "type": "object", - "description": "Specifies Guarantee Code attributes.", + "description": "Details about the booking channels and room types contained in the channel inventory snapshot.", "properties": { - "description": { - "description": "Description of the Guarantee Code.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "requirements": { - "description": "Specifies various requirements for the guarantee code.", - "$ref": "#/definitions/guaranteeRequirementsType" - }, - "shortDescription": { - "description": "Brief description of the Guarantee Code.", - "$ref": "#/definitions/translationTextType80" - }, - "paymentTypes": { - "description": "Specifies various payment types for the guarantee code.", - "$ref": "#/definitions/paymentTypesType" + "bookingChannel": { + "description": "Collection of booking channels returned in the channel inventory snapshot and the details about those channels.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "object", + "properties": { + "channelRoomTypes": { + "description": "Details about a specific channel room type.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "object", + "properties": { + "channelRoomTypeCode": { + "description": "The channel room type's identifying code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomTypeCode": { + "description": "The internal room type label which is mapped to the channel room type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "If the ENHANCED_ROOM_RATE_DESCRIPTION function is off, this element will contain the simple channel room type description.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "roomDescriptionLine1": { + "description": "If the ENHANCED_ROOM_RATE_DESCRIPTION function is on, this element will contain the first line of the enhanced channel room type description.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "roomDescriptionLine2": { + "description": "If the ENHANCED_ROOM_RATE_DESCRIPTION function is on, this element will contain the second line of the enhanced channel room type description.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "roomDescriptionLine3": { + "description": "If the ENHANCED_ROOM_RATE_DESCRIPTION function is on, this element will contain the third line of the enhanced channel room type description.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "sellSequence": { + "description": "The order in which the channel room type is to be displayed.", + "type": "integer" + } + } + } + }, + "code": { + "description": "The booking channel's identifying code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "The name or description of the booking channel.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "bookingChannelType": { + "description": "The type of channel. I.E. GDS, ADS, ODS, WEB.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "channelInventoryActive": { + "description": "Flag to indicate if the channel and hotel combination have the Channel Inventory parameter active. This parameter allows sell limits to be set for the channel or channel room type.", + "type": "boolean" + } + } + } }, - "guaranteeCode": { - "description": "Code assigned to the Guarantee.", + "hotelId": { + "description": "The internal hotel code that the given booking channel info is mapped under.", "type": "string", "minLength": 0, "maxLength": 20 - }, - "onHold": { - "description": "If true indicates this Guarantee Code is used only to hold the inventory during reservation process.", - "type": "boolean" - }, - "reserveInventory": { - "description": "If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.", - "type": "boolean" - }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" - }, - "lateArrival": { - "description": "Represents the late arrival time.", - "type": "string" } } }, - "guaranteeRequirementsType": { - "type": "object", - "description": "Specifies various requirement for the guarantee code.", - "properties": { - "requirementCode": { - "description": "Requirement Code.", - "type": "string" - }, - "cancellation": { - "description": "When true indicates cancellation on the reservation is required for this guarantee code.", - "type": "boolean" - }, - "phoneNumber": { - "description": "When true indicates phone number on the reservation is required for this guarantee code.", - "type": "boolean" - }, - "address": { - "description": "When true indicates address on the reservation is required for this guarantee code.", - "type": "boolean" - }, - "creditCard": { - "description": "When true indicates Credit Card on the reservation is required for this guarantee code.", - "type": "boolean" + "channelSellLimitsByDateRange": { + "type": "object", + "description": "Request object to create or update sell limit schedules for the channel or channel room type within a date range. Existing schedules can be split as needed to account for overlapping schedules.", + "properties": { + "sellLimits": { + "description": "List of sell limit schedules to be created or updated for the channel or channel room type.", + "$ref": "#/definitions/channelSellLimitSchedulesType" }, - "arrivalTime": { - "description": "When true indicates arrival Time on the reservation is required for this guarantee code.", + "adjustOverlappingSchedules": { + "description": "Flag to indicate whether any overlapping schedules should be automatically adjusted (split, truncated, etc.) as needed.", "type": "boolean" }, - "deposit": { - "description": "When true indicates deposit is required for this guarantee code.", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "paymentTypesType": { - "type": "array", - "description": "Payment card code like AX,VI etc.", - "maxItems": 4000, - "items": { - "type": "string", - "minLength": 0, - "maxLength": 20 + "generalAvailabilitySimulator": { + "type": "object", + "description": "Response object to simulate general availability.", + "properties": { + "generalAvailability": { + "description": "Room Type and room rate combination.", + "$ref": "#/definitions/generalAvailSimulatorType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } }, - "cancelPenaltyType": { + "generalAvailSimulatorType": { "type": "object", - "description": "The CancelPenalty class defines the cancellation policy of the hotel facility.", + "description": "Room Type and Room Rate combination.", "properties": { - "deadline": { - "description": "Cancellation deadline, absolute or relative.", - "$ref": "#/definitions/policyDeadlineType" - }, - "amountPercent": { - "description": "Cancellation fee expressed as a fixed amount, or percentage of/or room nights.", - "$ref": "#/definitions/policyAmountPercentType" + "availableRatePlans": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/availableRatePlanType" + } }, - "penaltyDescription": { - "description": "Text description of the Penalty in a given language.", + "hotelId": { "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "offsetUnit": { - "$ref": "#/definitions/offsetUnitType" + "bookingChannelCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "formattedRule": { - "description": "Formatted Text Rule of the Cancellation Penalty.", + "marketingInfo": { "type": "string", "minLength": 0, "maxLength": 2000 }, - "policyCode": { - "description": "Policy Code.", + "supportsHTMLEditor": { "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 10 }, - "manual": { - "description": "Flag to indicate if the cancellation policy is manual.", - "type": "boolean" + "sellOrder": { + "description": "Sell by room, rate or rate room.", + "$ref": "#/definitions/sellOrderType" }, - "nonRefundable": { - "description": "Indicates if the amount is refundable if booking is canceled.", + "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" - } - } - }, - "policyDeadlineType": { - "type": "object", - "description": "Cancellation deadline, absolute or relative.", - "properties": { - "absoluteDeadline": { - "description": "Defines the absolute deadline. Either this or the offset attributes may be used.", - "type": "string", - "format": "date-time" }, - "offsetFromArrival": { - "description": "The number of days before arrival that allows cancellation without penalties.", + "totalResults": { + "description": "Total number of rows queried", "type": "integer" }, - "offsetDropTime": { - "description": "Time on offset day the cancellation penalties applies.", - "type": "string", - "format": "date-time" - }, - "offsetFromBookingDate": { - "description": "The number of days after booking deposit must be paid.", + "count": { + "description": "Total number of rows returned", "type": "integer" } } }, - "policyAmountPercentType": { + "availableRatePlanType": { "type": "object", - "description": "Defines the percentage basis for calculating the fee amount or the amount.", + "description": "Room Type and Room Rate combination.", "properties": { - "basisType": { - "description": "Provides the basis for how the amount of the guarantee is calculated.", - "$ref": "#/definitions/policyBasisTypeType" + "marketingInfo": { + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "nights": { - "description": "The number of nights of the hotel stay that are used to calculate the fee amount.", - "type": "integer" + "availableRooms": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/availableRoomType" + } }, - "percent": { - "description": "The percentage used to calculate the amount.", - "type": "number", - "minimum": 0, - "maximum": 100 + "ratePlanCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "amount": { - "description": "A monetary amount.", - "type": "number" + "ratePlanDesc": { + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "currencyCode": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "currency": { "type": "string", - "minLength": 3, - "maxLength": 3 + "minLength": 0, + "maxLength": 20 + }, + "taxInfo": { + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "policyBasisTypeType": { - "type": "string", - "description": "Full Amount.", - "enum": [ - "FlatAmount", - "Percentage", - "Nights", - "NightPercentage", - "FullAmount" - ] - }, - "offsetUnitType": { - "type": "string", - "description": "Indicates deadline offset unit type.", - "enum": [ - "Year", - "Month", - "Day", - "Hour" - ] - }, - "depositPolicyType": { + "availableRoomType": { "type": "object", - "description": "Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.", + "description": "Room Type and Room Rate combination.", "properties": { - "amountPercent": { - "description": "Payment expressed as a fixed amount, or a percentage of/or room nights.", - "$ref": "#/definitions/policyAmountPercentType" - }, - "deadline": { - "description": "Payment deadline, absolute or relative.", - "$ref": "#/definitions/policyDeadlineType" - }, "description": { - "description": "Text description of the Payment in a given language.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "depositReceiptNo": { - "description": "Receipt number associated with the deposit policy", - "type": "integer" - }, - "transactionDate": { - "description": "Transaction Date associated with the deposit policy", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "depositReqReversed": { - "description": "Flag to indicate if deposit policy is reversed", - "type": "boolean" - }, - "formattedRule": { - "description": "Formatted Text Rule of the deposit policy.", "type": "string", "minLength": 0, "maxLength": 2000 }, - "typeOfCharges": { - "description": "Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both", - "$ref": "#/definitions/depositCancelRevenueType" - }, - "policyCode": { - "description": "Deposit Policy Code", + "channelRoomType": { "type": "string", "minLength": 0, "maxLength": 20 }, - "manual": { - "description": "Flag to indicate if the cancellation policy is manual.", - "type": "boolean" - } - } - }, - "depositCancelRevenueType": { - "type": "string", - "description": "The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.", - "enum": [ - "Rooms", - "Catering", - "All" - ] - }, - "channelMarketingInfoType": { - "type": "array", - "description": "Marketing Text like cancel policy, deposit policy etc.", - "maxItems": 4000, - "items": { - "type": "object", - "properties": { - "description": { - "description": "Marketing Text like cancel policy, deposit policy etc.", - "type": "string", - "minLength": 0, - "maxLength": 4000 - }, - "policyType": { - "description": "Indicates the policy type like cancel,deposit etc.", - "$ref": "#/definitions/marketingPolicyType" - }, - "ratePlanCode": { - "description": "Indicates the rate code for which the policy is associated with.", - "type": "string", - "minLength": 0, - "maxLength": 20 - } + "roomType": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "rateChangedYN": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "amount": { + "description": "A monetary amount.", + "type": "number" + }, + "currencyCode": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 } } }, - "marketingPolicyType": { + "sellOrderType": { "type": "string", - "description": "Indicates the channel policy type like deposit,cancel etc.", + "description": "Channel Sell By which may be RATEROOM, RATE or ROOM.", "enum": [ - "Deposit", - "Commission", - "Cancel", - "Guarantee", - "General", - "Penalty", - "Tax", - "Promotion" + "RateRoom", + "Rate", + "Room" ] }, - "channelRoomMapping": { + "rateParity": { "type": "object", - "description": "Request object for changing Channel Room Mapping.", + "description": "Response object to fetch Rate Parity.", "properties": { - "channelRoomMapping": { - "description": "Channel Room Type mapping details to be changed.", - "$ref": "#/definitions/channelRoomMappingType" + "rateParity": { + "description": "Rate parity.", + "$ref": "#/definitions/rateParityType" }, "links": { "$ref": "#/definitions/links" @@ -24161,343 +25164,340 @@ } } }, - "channelInventorySnapshot": { + "rateParityType": { "type": "object", - "description": "Response object containing the room availability and restrictions for a hotel in relation to booking channels.", + "description": "Information on Room Rate Parity among Channels/Property", "properties": { - "channelInventorySnapshot": { - "description": "Channel inventory snapshot containing room availability and restrictions for a hotel in relation to booking channels.", - "$ref": "#/definitions/channelInventorySnapshotType" + "parityGroups": { + "description": "Channels and Property combination.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/parityGroupType" + } }, - "links": { - "$ref": "#/definitions/links" + "hotelsInfo": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelChannelInfoType" + } }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "channelInventorySnapshotType": { - "type": "object", - "description": "The evaluated channel inventory snapshot statistics based on the search criteria given.", - "properties": { - "inventories": { - "description": "The main statistics for the channel inventory snapshot.", - "$ref": "#/definitions/channelInventorySnapshotInventoriesType" + "bookingChannelsInfo": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/bookingChannelInfoType" + } }, - "masterInfo": { - "description": "Additional information about the records returned in the snapshot.", - "$ref": "#/definitions/channelInventorySnapshotMasterInfoType" + "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" } } }, - "channelInventorySnapshotInventoriesType": { + "parityGroupType": { "type": "object", - "description": "Collection of inventory statistics and restrictions for a hotel in relation to booking channels.", + "description": "Channels and Property Group wise Rates for Room Type and Rate Plan combination.", "properties": { - "inventory": { - "description": "Details of inventory statistics and restrictions.", + "parityRoomRates": { + "description": "Room Type and Rate Plan combination.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/channelInventoryType" + "$ref": "#/definitions/parityRoomRateType" } }, "hotelId": { - "description": "Hotel that the inventory belongs to.", + "description": "The code that identifies a Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "bookingChannelCode": { + "description": "The code that identifies a Booking Channel.", "type": "string", "minLength": 0, "maxLength": 20 + }, + "bookingChannelURL": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "bookingChannelIconURL": { + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "channelInventoryType": { + "parityRoomRateType": { "type": "object", - "description": "Inventory statistics and restrictions. This can have no code (House level), BookingChannelCode, or ChannelRoomType to represent the different levels.", + "description": "Rate for Room Type and Rate Plan combination.", "properties": { - "snapshot": { - "description": "Inventory statistics and restriction details.", + "parityRates": { + "description": "Rate on specific arrival date.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/channelSnapshotType" + "$ref": "#/definitions/parityRateType" } }, - "bookingChannelCode": { - "description": "Booking channel code that the snapshot belongs to.", + "roomType": { + "description": "The code that identifies a Room Type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "ratePlanCode": { + "description": "The code that identifies a Rate Plan Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "channelRoomType": { - "description": "Booking channel room type that the snapshot belongs to.", + "description": "The code that identifies a Booking Channel Room Type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "channelRatePlanCode": { + "description": "The code that identifies a Booking Channel Rate Plan Code.", "type": "string", "minLength": 0, "maxLength": 20 } } }, - "channelSnapshotType": { + "parityRateType": { "type": "object", - "description": "Inventory statistic and restriction information for a given date.", + "description": "Minimum and Maximum Rate on specific arrival date.", "properties": { - "restrictionsInfo": { - "description": "Restrictions information for the day.", - "$ref": "#/definitions/restrictionsInfoType" + "additionalDetailList": { + "$ref": "#/definitions/additionalDetailListType" }, - "inventoryRooms": { - "description": "Number of rooms in inventory.", - "type": "number" + "roomTypeDescription": { + "$ref": "#/definitions/enhancedDescriptionType" }, - "sellLimit": { - "description": "Number of overbooking rooms allowed.", - "type": "number" + "rateDescription": { + "$ref": "#/definitions/enhancedDescriptionType" }, - "tentativeRoomsSold": { - "description": "Number of tentative rooms sold - does not include definite reservations.", - "type": "number" + "ratePlanDescription": { + "type": "string" }, - "roomsSold": { - "description": "Number of rooms sold.", - "type": "number" + "channelRatePlanCategory": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "rateFrequency": { + "type": "string" }, "availableRooms": { - "description": "Number of available rooms.", - "type": "number" + "type": "integer" }, - "date": { - "description": "Date of the statistics and restrictions.", + "additionalAmounts": { + "$ref": "#/definitions/additionalAmountListType" + }, + "rateAmounts": { + "type": "object", + "properties": { + "totalAmount": { + "$ref": "#/definitions/currencyAmountType" + }, + "taxAmount": { + "$ref": "#/definitions/currencyAmountType" + }, + "cancellationAmount": { + "$ref": "#/definitions/currencyAmountType" + }, + "commissionAmount": { + "$ref": "#/definitions/currencyAmountType" + }, + "depositAmount": { + "$ref": "#/definitions/currencyAmountType" + } + } + }, + "totalPricingAmounts": { + "type": "object", + "properties": { + "totalSurcharge": { + "$ref": "#/definitions/currencyAmountType" + }, + "totalTax": { + "$ref": "#/definitions/currencyAmountType" + }, + "totalRateIncl": { + "$ref": "#/definitions/currencyAmountType" + } + } + }, + "arrivalDate": { + "description": "Arrival Date.", "type": "string", "format": "date", "maxLength": 8 + }, + "weekendDay": { + "type": "boolean" + }, + "closed": { + "type": "boolean" + }, + "amount": { + "description": "A monetary amount.", + "type": "number" + }, + "currencyCode": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "statusCode": { + "description": "Status Code related to functionality.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "statusDescription": { + "description": "Description of Status Code.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "rateChangesOverDays": { + "type": "boolean" } } }, - "restrictionsInfoType": { + "additionalDetailListType": { "type": "array", - "description": "Provides the basic Restriction type details, specifically used in snapshot operations for efficiency.", "maxItems": 4000, "items": { - "$ref": "#/definitions/restrictionInfoType" + "$ref": "#/definitions/additionalDetailType" } }, - "restrictionInfoType": { + "additionalDetailType": { "type": "object", "properties": { - "restrictionStatus": { - "description": "Indicates the type of the restriction.", - "$ref": "#/definitions/restrictionInfoStatusType" + "description": { + "type": "string" + }, + "detailType": { + "type": "string", + "enum": [ + "CancelPolicy", + "CommissionPolicy", + "GuaranteePolicy", + "DepositPolicy", + "PenaltyPolicy", + "MarketingInformation", + "Promotion", + "TaxInformation", + "Other" + ] + }, + "otherDetailType": { + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, - "restrictionInfoStatusType": { + "enhancedDescriptionType": { "type": "object", - "description": "The RestrictionStatusType is used to indicate the type of restriction applied. An enumerated restriction type is defined in the attribute group.", + "description": "This type holds enhanced room/rate description.", "properties": { - "code": { - "description": "Identifies the type of restriction. I.E. Closed, ClosedForArrival, etc.", - "$ref": "#/definitions/restrictionStatusesType" - }, - "unit": { - "description": "Defines restriction in conjunction with Restriction Code. Value must be specified for Restriction Codes MinimumStayThrough, MaximumStayThrough, MinimumLengthOfStay, MaximumLengthOfStay, MinimumAdvanceBooking, MaximumAdvanceBooking.", - "type": "integer" - }, - "lOS1": { - "description": "Indicates Length of Stay 1 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", - "type": "boolean" - }, - "lOS2": { - "description": "Indicates Length of Stay 2 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", - "type": "boolean" - }, - "lOS3": { - "description": "Indicates Length of Stay 3 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", - "type": "boolean" - }, - "lOS4": { - "description": "Indicates Length of Stay 4 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", - "type": "boolean" - }, - "lOS5": { - "description": "Indicates Length of Stay 5 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", - "type": "boolean" - }, - "lOS6": { - "description": "Indicates Length of Stay 6 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", - "type": "boolean" - }, - "lOS7": { - "description": "Indicates Length of Stay 7 or more is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", - "type": "boolean" + "shortDescription": { + "$ref": "#/definitions/translationTextType2000" }, - "roomClass": { - "description": "Room Class of actual restriction.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "description": { + "$ref": "#/definitions/translationTextType2000" }, - "rateCategory": { - "description": "Rate Category of actual restriction.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "enhancedDesc1": { + "$ref": "#/definitions/translationTextType50" }, - "rateCode": { - "description": "Rate Code of actual restriction.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "enhancedDesc2": { + "$ref": "#/definitions/translationTextType50" }, - "roomType": { - "description": "Room Type of actual restriction.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "enhancedDesc3": { + "$ref": "#/definitions/translationTextType50" }, - "bookingChannelCode": { - "description": "Booking channel code of actual restriction.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "source": { + "type": "string" } } }, - "restrictionStatusesType": { - "type": "string", - "enum": [ - "Closed", - "ClosedForArrival", - "ClosedForDeparture", - "MinimumStayThrough", - "MaximumStayThrough", - "MinimumLengthOfStay", - "MaximumLengthOfStay", - "LOSNotAvailable", - "MinimumAdvanceBooking", - "MaximumAdvanceBooking", - "Open", - "OpenForArrival", - "OpenForDeparture" - ] + "additionalAmountListType": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/additionalAmountType" + } }, - "channelInventorySnapshotMasterInfoType": { + "additionalAmountType": { "type": "object", - "description": "Details about the booking channels and room types contained in the channel inventory snapshot.", "properties": { - "bookingChannel": { - "description": "Collection of booking channels returned in the channel inventory snapshot and the details about those channels.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "object", - "properties": { - "channelRoomTypes": { - "description": "Details about a specific channel room type.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "object", - "properties": { - "channelRoomTypeCode": { - "description": "The channel room type's identifying code.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "roomTypeCode": { - "description": "The internal room type label which is mapped to the channel room type.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "description": { - "description": "If the ENHANCED_ROOM_RATE_DESCRIPTION function is off, this element will contain the simple channel room type description.", - "type": "string", - "minLength": 0, - "maxLength": 200 - }, - "roomDescriptionLine1": { - "description": "If the ENHANCED_ROOM_RATE_DESCRIPTION function is on, this element will contain the first line of the enhanced channel room type description.", - "type": "string", - "minLength": 0, - "maxLength": 200 - }, - "roomDescriptionLine2": { - "description": "If the ENHANCED_ROOM_RATE_DESCRIPTION function is on, this element will contain the second line of the enhanced channel room type description.", - "type": "string", - "minLength": 0, - "maxLength": 200 - }, - "roomDescriptionLine3": { - "description": "If the ENHANCED_ROOM_RATE_DESCRIPTION function is on, this element will contain the third line of the enhanced channel room type description.", - "type": "string", - "minLength": 0, - "maxLength": 200 - }, - "sellSequence": { - "description": "The order in which the channel room type is to be displayed.", - "type": "integer" - } - } - } - }, - "code": { - "description": "The booking channel's identifying code.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "description": { - "description": "The name or description of the booking channel.", - "type": "string", - "minLength": 0, - "maxLength": 40 - }, - "bookingChannelType": { - "description": "The type of channel. I.E. GDS, ADS, ODS, WEB.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "channelInventoryActive": { - "description": "Flag to indicate if the channel and hotel combination have the Channel Inventory parameter active. This parameter allows sell limits to be set for the channel or channel room type.", - "type": "boolean" - } - } - } + "amountType": { + "type": "string", + "enum": [ + "AdditionalAdult", + "AdditionalChild", + "AdditionalRollawayBed", + "AdditionalCrib", + "AdditionalRollawayCrib" + ] }, - "hotelId": { - "description": "The internal hotel code that the given booking channel info is mapped under.", + "amount": { + "description": "A monetary amount.", + "type": "number" + }, + "currencyCode": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", "type": "string", - "minLength": 0, - "maxLength": 20 + "minLength": 3, + "maxLength": 3 } } }, - "channelSellLimitsByDateRange": { + "channelEnhancedGlobalDescription": { "type": "object", - "description": "Request object to create or update sell limit schedules for the channel or channel room type within a date range. Existing schedules can be split as needed to account for overlapping schedules.", + "description": "Response object for information regarding global descriptions of hotel room types.", "properties": { - "sellLimits": { - "description": "List of sell limit schedules to be created or updated for the channel or channel room type.", - "$ref": "#/definitions/channelSellLimitSchedulesType" + "globalDescription": { + "description": "Contains the global descriptions of hotel room types.", + "$ref": "#/definitions/enhancedDescriptionType" }, - "adjustOverlappingSchedules": { - "description": "Flag to indicate whether any overlapping schedules should be automatically adjusted (split, truncated, etc.) as needed.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "generalAvailabilitySimulator": { + "channelRoomMappingsSummary": { "type": "object", - "description": "Response object to simulate general availability.", + "description": "Operation to fetch hotel-channel room type mappings.", "properties": { - "generalAvailability": { - "description": "Room Type and room rate combination.", - "$ref": "#/definitions/generalAvailSimulatorType" + "channelRoomMappingsSummary": { + "description": "Refer to Generic common types document.", + "$ref": "#/definitions/channelRoomMappingsSummaryType" + }, + "masterInfo": { + "description": "Additional details about the booking channels and source descriptions for a hotel room type referenced within the fetched results.", + "$ref": "#/definitions/channelRoomMappingMasterInfoType" }, "links": { "$ref": "#/definitions/links" @@ -24507,40 +25507,29 @@ } } }, - "generalAvailSimulatorType": { + "channelRoomMappingsSummaryType": { "type": "object", - "description": "Room Type and Room Rate combination.", + "description": "Collection of hotel-channel room type mappings.", "properties": { - "availableRatePlans": { + "channelRoomMappingSummary": { + "description": "Information about hotel-channel room type mapping.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/availableRatePlanType" + "$ref": "#/definitions/channelRoomMappingSummaryType" } }, - "hotelId": { - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "bookingChannelCode": { - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "marketingInfo": { - "type": "string", - "minLength": 0, - "maxLength": 2000 + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" }, - "supportsHTMLEditor": { - "type": "string", - "minLength": 0, - "maxLength": 10 + "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" }, - "sellOrder": { - "description": "Sell by room, rate or rate room.", - "$ref": "#/definitions/sellOrderType" + "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.", @@ -24556,643 +25545,564 @@ } } }, - "availableRatePlanType": { + "channelRoomMappingSummaryType": { "type": "object", - "description": "Room Type and Room Rate combination.", + "description": "Basic details of hotel-channel room type mapping.", "properties": { - "marketingInfo": { + "endDate": { + "description": "End date of the hotel-channel room type mapping.", "type": "string", - "minLength": 0, - "maxLength": 2000 + "format": "date", + "maxLength": 8 }, - "availableRooms": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/availableRoomType" - } + "description": { + "description": "Hotel-channel room type mapping description.", + "$ref": "#/definitions/channelRoomMappingDescriptionType" }, - "ratePlanCode": { + "alternateChannelRoomType": { + "description": "Alternate channel room type name.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 40 }, - "ratePlanDesc": { - "type": "string", - "minLength": 0, - "maxLength": 2000 + "channelRoomTypeOrder": { + "description": "Channel room type order of the hotel-channel room type mapping.", + "type": "number" }, - "currency": { + "sellSequence": { + "description": "Sell sequence for hotel-channel room type mapping.", + "type": "number" + }, + "active": { + "description": "Flag that indicates whether hotel-channel room type mapping is active or not.", + "type": "boolean" + }, + "bedTypeCode": { + "description": "Channel bed type code.", "type": "string", "minLength": 0, "maxLength": 20 }, - "taxInfo": { - "type": "string", - "minLength": 0, - "maxLength": 2000 - } - } - }, - "availableRoomType": { - "type": "object", - "description": "Room Type and Room Rate combination.", - "properties": { - "description": { + "baseAllocation": { + "description": "Channel base allocation.", + "type": "integer" + }, + "rateCodes": { + "description": "Rate codes where hotel-channel room type mappings belong to.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "channelRateCodes": { + "description": "Channel rate codes where hotel-channel room mappings belong to.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "noOfRateRoomsMapped": { + "description": "Number of active rate room mappings for the channel room type.", + "type": "integer" + }, + "maximumOccupancy": { + "description": "The maximum occupancy for this room category.", + "type": "integer" + }, + "defaultOccupancy": { + "description": "Default occupancy for the room type.", + "type": "integer" + }, + "physicalRoomsCount": { + "description": "The physical number of rooms in this room category at this property.", + "type": "integer" + }, + "bookingChannelCode": { + "description": "Booking Channel Code.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "channelRoomType": { + "hotelId": { + "description": "Hotel Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomType": { + "description": "Room Type.", "type": "string", "minLength": 0, "maxLength": 20 }, - "rateChangedYN": { + "channelRoomType": { + "description": "Channel Room Type.", "type": "string", "minLength": 0, "maxLength": 20 }, - "amount": { - "description": "A monetary amount.", - "type": "number" - }, - "currencyCode": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "beginDate": { + "description": "Begin Date.", "type": "string", - "minLength": 3, - "maxLength": 3 + "format": "date", + "maxLength": 8 } } }, - "sellOrderType": { - "type": "string", - "description": "Channel Sell By which may be RATEROOM, RATE or ROOM.", - "enum": [ - "RateRoom", - "Rate", - "Room" - ] - }, - "rateParity": { + "channelRoomMappingMasterInfoType": { "type": "object", - "description": "Response object to fetch Rate Parity.", + "description": "Additional details about the booking channels and source descriptions for a hotel room type referenced within the fetched results.", "properties": { - "rateParity": { - "description": "Rate parity.", - "$ref": "#/definitions/rateParityType" - }, - "links": { - "$ref": "#/definitions/links" + "bookingChannelsInfo": { + "description": "Additional details about booking channels.", + "$ref": "#/definitions/bookingChannelsInfoType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "sourceDescriptions": { + "description": "hotel-channel room type mapping source descriptions.", + "$ref": "#/definitions/channelRoomMappingsSourceDescriptionsType" } } }, - "rateParityType": { - "type": "object", - "description": "Information on Room Rate Parity among Channels/Property", - "properties": { - "parityGroups": { - "description": "Channels and Property combination.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/parityGroupType" - } - }, - "hotelsInfo": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelChannelInfoType" - } - }, - "bookingChannelsInfo": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/bookingChannelInfoType" - } - }, - "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" - } + "channelRoomMappingsSourceDescriptionsType": { + "type": "array", + "description": "This type holds hotel-channel room type mapping source descriptions.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/channelRoomMappingSourceDescriptionsType" } }, - "parityGroupType": { - "type": "object", - "description": "Channels and Property Group wise Rates for Room Type and Rate Plan combination.", - "properties": { - "parityRoomRates": { - "description": "Room Type and Rate Plan combination.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/parityRoomRateType" - } - }, - "hotelId": { - "description": "The code that identifies a Hotel.", + "channelRoomMappingSourceDescriptionsType": { + "type": "object", + "description": "Hotel-channel room type mapping source descriptions.", + "properties": { + "description": { + "description": "Hotel room type description.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "bookingChannelCode": { - "description": "The code that identifies a Booking Channel.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "globalDescription": { + "description": "Hotel room type global description.", + "$ref": "#/definitions/channelMappingEnhancedDescriptionType" }, - "bookingChannelURL": { + "hotelId": { + "description": "Hotel code the descriptions belong to.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "bookingChannelIconURL": { + "roomType": { + "description": "Room type the descriptions belong to.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 } } }, - "parityRoomRateType": { + "profileNegotiatedRateDetails": { "type": "object", - "description": "Rate for Room Type and Rate Plan combination.", + "description": "Response object for fetching Negotiated channel rates.", "properties": { - "parityRates": { - "description": "Rate on specific arrival date.", + "items": { "type": "array", - "maxItems": 4000, "items": { - "$ref": "#/definitions/parityRateType" + "$ref": "#/definitions/getChannelRatesAccessItems" } }, - "roomType": { - "description": "The code that identifies a Room Type.", + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "getChannelRatesAccessItems": { + "type": "object", + "description": "Response object for fetching Negotiated channel rates.", + "properties": { + "hotelId": { + "description": "Hotel Id.", "type": "string", "minLength": 0, "maxLength": 20 }, - "ratePlanCode": { - "description": "The code that identifies a Rate Plan Code.", + "channelCode": { + "description": "Channel Room Type.", "type": "string", "minLength": 0, "maxLength": 20 }, - "channelRoomType": { - "description": "The code that identifies a Booking Channel Room Type.", + "ratePlanCode": { + "description": "Channel Room Type.", "type": "string", "minLength": 0, "maxLength": 20 }, "channelRatePlanCode": { - "description": "The code that identifies a Booking Channel Rate Plan Code.", + "description": "Channel Room Type.", "type": "string", "minLength": 0, "maxLength": 20 - } - } - }, - "parityRateType": { - "type": "object", - "description": "Minimum and Maximum Rate on specific arrival date.", - "properties": { - "additionalDetailList": { - "$ref": "#/definitions/additionalDetailListType" - }, - "roomTypeDescription": { - "$ref": "#/definitions/enhancedDescriptionType" - }, - "rateDescription": { - "$ref": "#/definitions/enhancedDescriptionType" }, - "ratePlanDescription": { - "type": "string" + "channelRatePlanOrder": { + "description": "Channel Room Type.", + "type": "integer", + "default": true }, - "channelRatePlanCategory": { + "rateAccessCode": { "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "rateFrequency": { - "type": "string" - }, - "availableRooms": { - "type": "integer" - }, - "additionalAmounts": { - "$ref": "#/definitions/additionalAmountListType" - }, - "rateAmounts": { - "type": "object", - "properties": { - "totalAmount": { - "$ref": "#/definitions/currencyAmountType" - }, - "taxAmount": { - "$ref": "#/definitions/currencyAmountType" - }, - "cancellationAmount": { - "$ref": "#/definitions/currencyAmountType" - }, - "commissionAmount": { - "$ref": "#/definitions/currencyAmountType" - }, - "depositAmount": { - "$ref": "#/definitions/currencyAmountType" - } - } - }, - "totalPricingAmounts": { - "type": "object", - "properties": { - "totalSurcharge": { - "$ref": "#/definitions/currencyAmountType" - }, - "totalTax": { - "$ref": "#/definitions/currencyAmountType" - }, - "totalRateIncl": { - "$ref": "#/definitions/currencyAmountType" - } - } + "description": "Negotiated Rate Access Code." }, - "arrivalDate": { - "description": "Arrival Date.", + "startDate": { "type": "string", - "format": "date", - "maxLength": 8 + "description": "Start Date of the Channel Rate Access Code.", + "format": "date" }, - "weekendDay": { - "type": "boolean" + "endDate": { + "type": "string", + "description": "End Date of the Channel Rate Access Code.", + "format": "date" }, - "closed": { + "active": { "type": "boolean" }, - "amount": { - "description": "A monetary amount.", - "type": "number" - }, - "currencyCode": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "profileId": { "type": "string", - "minLength": 3, - "maxLength": 3 + "minLength": 1, + "maxLength": 20, + "pattern": "[A-Z0-9]+", + "description": "Profile Id for which Channel Rate access code is applicable for." }, - "statusCode": { - "description": "Status Code related to functionality.", + "accountId": { "type": "string", - "minLength": 0, - "maxLength": 80 + "minLength": 1, + "maxLength": 20, + "pattern": "[A-Z0-9]+", + "description": "Account Id for which Channel Rate access code is applicable for." }, - "statusDescription": { - "description": "Description of Status Code.", + "accountName": { "type": "string", - "minLength": 0, - "maxLength": 2000 + "description": "Account name for which Channel Rate access Code is applicable for.", + "minLength": 1, + "maxLength": 80 }, - "rateChangesOverDays": { - "type": "boolean" + "profileAccountType": { + "$ref": "#/definitions/accountTypeEnum" } } }, - "additionalDetailListType": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/additionalDetailType" + "profileRateAccessCodes": { + "type": "object", + "description": "Request Object for Profile Rate Access Async Job", + "properties": { + "items": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/profileRateAccessCode" + } + } } }, - "additionalDetailType": { + "profileRateAccessCode": { "type": "object", + "required": [ + "hotelId", + "channelCode", + "channelRatePlans" + ], "properties": { - "description": { - "type": "string" - }, - "detailType": { + "hotelId": { "type": "string", - "enum": [ - "CancelPolicy", - "CommissionPolicy", - "GuaranteePolicy", - "DepositPolicy", - "PenaltyPolicy", - "MarketingInformation", - "Promotion", - "TaxInformation", - "Other" - ] + "description": "Unique ID that identifies a single hotel property.", + "minLength": 1, + "maxLength": 20 }, - "otherDetailType": { + "channelCode": { "type": "string", - "minLength": 0, - "maxLength": 80 + "description": "Unique ID that identifies a single Channel.", + "minLength": 1, + "maxLength": 20 + }, + "channelRatePlans": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/profileChannelRatePlan" + } } } }, - "enhancedDescriptionType": { + "profileChannelRatePlan": { "type": "object", - "description": "This type holds enhanced room/rate description.", + "required": [ + "ratePlanCode", + "channelRatePlanCode", + "channelRateAccessCodes" + ], "properties": { - "shortDescription": { - "$ref": "#/definitions/translationTextType2000" - }, - "description": { - "$ref": "#/definitions/translationTextType2000" - }, - "enhancedDesc1": { - "$ref": "#/definitions/translationTextType50" + "ratePlanCode": { + "type": "string", + "description": "Rate Plan Code (length of string must be less than or equal to 20)", + "minLength": 1, + "maxLength": 20 }, - "enhancedDesc2": { - "$ref": "#/definitions/translationTextType50" + "channelRatePlanCode": { + "type": "string", + "description": "Chennel Rate Plan Code (length of string must be less than or equal to 20)", + "minLength": 1, + "maxLength": 20 }, - "enhancedDesc3": { - "$ref": "#/definitions/translationTextType50" + "startDate": { + "type": "string", + "description": "ISO 8601 date Format 'YYYY-MM-DD'", + "format": "date" }, - "source": { - "type": "string" - } - } - }, - "additionalAmountListType": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/additionalAmountType" - } - }, - "additionalAmountType": { - "type": "object", - "properties": { - "amountType": { + "endDate": { "type": "string", - "enum": [ - "AdditionalAdult", - "AdditionalChild", - "AdditionalRollawayBed", - "AdditionalCrib", - "AdditionalRollawayCrib" - ] + "description": "ISO 8601 date Format 'YYYY-MM-DD'", + "format": "date" }, - "amount": { - "description": "A monetary amount.", - "type": "number" + "active": { + "type": "boolean", + "default": true + }, + "channelRatePlanOrder": { + "type": "integer", + "default": true, + "description": "Channel Rate Plan Order" }, - "currencyCode": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", - "type": "string", - "minLength": 3, - "maxLength": 3 + "channelRateAccessCodes": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/profileChannelRateAccessCode" + } } } }, - "channelEnhancedGlobalDescription": { + "profileChannelRateAccessCode": { "type": "object", - "description": "Response object for information regarding global descriptions of hotel room types.", + "required": [ + "rateAccessCode", + "active", + "accountId", + "accountName", + "accountType" + ], "properties": { - "globalDescription": { - "description": "Contains the global descriptions of hotel room types.", - "$ref": "#/definitions/enhancedDescriptionType" + "rateAccessCode": { + "type": "string", + "description": "Negotiated Rate Access Code." }, - "links": { - "$ref": "#/definitions/links" + "startDate": { + "type": "string", + "description": "Start Date of the Channel Rate Access Code.", + "format": "date" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "channelRoomMappingsSummary": { - "type": "object", - "description": "Operation to fetch hotel-channel room type mappings.", - "properties": { - "channelRoomMappingsSummary": { - "description": "Refer to Generic common types document.", - "$ref": "#/definitions/channelRoomMappingsSummaryType" + "endDate": { + "type": "string", + "description": "End Date of the Channel Rate Access Code.", + "format": "date" }, - "masterInfo": { - "description": "Additional details about the booking channels and source descriptions for a hotel room type referenced within the fetched results.", - "$ref": "#/definitions/channelRoomMappingMasterInfoType" + "active": { + "type": "boolean" }, - "links": { - "$ref": "#/definitions/links" + "accountId": { + "type": "string", + "minLength": 1, + "maxLength": 20, + "pattern": "[A-Z0-9]+", + "description": "Account Id for which Channel Rate access code is applicable for." }, - "warnings": { - "$ref": "#/definitions/warningsType" + "accountName": { + "type": "string", + "description": "Account name for which Channel Rate access Code is applicable for.", + "minLength": 1, + "maxLength": 80 + }, + "profileAccountType": { + "$ref": "#/definitions/accountTypeEnum" + }, + "profileId": { + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Profile Id for which Channel Rate access code is applicable for." + }, + "oldRateAccessCode": { + "type": "string", + "description": "Negotiated Rate Access Code." + }, + "oldStartDate": { + "type": "string", + "description": "Start Date of the Channel Rate Access Code.", + "format": "date" + }, + "oldEndDate": { + "type": "string", + "description": "End Date of the Channel Rate Access Code.", + "format": "date" } } }, - "channelRoomMappingsSummaryType": { + "syncProfileRatesAccessCodes": { "type": "object", - "description": "Collection of hotel-channel room type mappings.", "properties": { - "channelRoomMappingSummary": { - "description": "Information about hotel-channel room type mapping.", + "targetHotels": { "type": "array", - "maxItems": 4000, + "maxItems": 50, + "minItems": 1, "items": { - "$ref": "#/definitions/channelRoomMappingSummaryType" + "type": "string" } }, - "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" + "oldChannelRatesAccess": { + "$ref": "#/definitions/channelRatesAccessMain" }, - "count": { - "description": "Total number of rows returned", - "type": "integer" + "newChannelRatesAccess": { + "$ref": "#/definitions/channelRatesAccessMain" } } }, - "channelRoomMappingSummaryType": { + "channelRatesAccessMain": { "type": "object", - "description": "Basic details of hotel-channel room type mapping.", "properties": { - "endDate": { - "description": "End date of the hotel-channel room type mapping.", + "hotelId": { "type": "string", - "format": "date", - "maxLength": 8 + "description": "Unique ID that identifies a single hotel property.", + "minLength": 1, + "maxLength": 20 }, - "description": { - "description": "Hotel-channel room type mapping description.", - "$ref": "#/definitions/channelRoomMappingDescriptionType" + "channelCode": { + "type": "string" }, - "alternateChannelRoomType": { - "description": "Alternate channel room type name.", + "channelRatePlanCode": { + "type": "string" + }, + "startDate": { "type": "string", - "minLength": 0, - "maxLength": 40 + "format": "date", + "description": "ISO 8601 date Format 'YYYY-MM-DD'" }, - "channelRoomTypeOrder": { - "description": "Channel room type order of the hotel-channel room type mapping.", - "type": "number" + "endDate": { + "type": "string", + "format": "date", + "description": "ISO 8601 date Format 'YYYY-MM-DD'" }, - "sellSequence": { - "description": "Sell sequence for hotel-channel room type mapping.", - "type": "number" + "rateAccessCode": { + "type": "string" }, "active": { - "description": "Flag that indicates whether hotel-channel room type mapping is active or not.", "type": "boolean" }, - "bedTypeCode": { - "description": "Channel bed type code.", + "accountId": { + "description": "Id of the profile account", "type": "string", - "minLength": 0, - "maxLength": 20 + "minLength": 1, + "maxLength": 20, + "pattern": "[A-Z0-9]+" }, - "baseAllocation": { - "description": "Channel base allocation.", - "type": "integer" + "accountName": { + "description": "Name of the profile account", + "type": "string", + "minLength": 1 }, - "rateCodes": { - "description": "Rate codes where hotel-channel room type mappings belong to.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "minLength": 0, - "maxLength": 20 - } + "profileAccountType": { + "$ref": "#/definitions/accountTypeEnum" }, - "channelRateCodes": { - "description": "Channel rate codes where hotel-channel room mappings belong to.", + "profileId": { + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Profile Id for which Channel Rate access code is applicable for." + } + } + }, + "accountTypeEnum": { + "description": "Type of the profile account", + "type": "string", + "enum": [ + "Source", + "TravelAgent", + "Company" + ] + }, + "deleteNegotiatedRates": { + "type": "object", + "properties": { + "items": { "type": "array", - "maxItems": 4000, + "minItems": 1, + "maxItems": 100, "items": { - "type": "string", - "minLength": 0, - "maxLength": 20 + "$ref": "#/definitions/hotelIdChannelRatesAccess" } - }, - "noOfRateRoomsMapped": { - "description": "Number of active rate room mappings for the channel room type.", - "type": "integer" - }, - "maximumOccupancy": { - "description": "The maximum occupancy for this room category.", - "type": "integer" - }, - "defaultOccupancy": { - "description": "Default occupancy for the room type.", - "type": "integer" - }, - "physicalRoomsCount": { - "description": "The physical number of rooms in this room category at this property.", - "type": "integer" - }, - "bookingChannelCode": { - "description": "Booking Channel Code.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, + } + } + }, + "hotelIdChannelRatesAccess": { + "description": "HotelId with mappingIds", + "type": "object", + "properties": { "hotelId": { "description": "Hotel Code.", "type": "string", "minLength": 0, "maxLength": 20 }, - "roomType": { - "description": "Room Type.", + "profileId": { + "description": "Profile ID.", "type": "string", "minLength": 0, "maxLength": 20 }, - "channelRoomType": { - "description": "Channel Room Type.", + "accountId": { + "description": "Account ID.", "type": "string", "minLength": 0, "maxLength": 20 }, - "beginDate": { - "description": "Begin Date.", + "channelcode": { + "description": "channel Code.", "type": "string", - "format": "date", - "maxLength": 8 - } - } - }, - "channelRoomMappingMasterInfoType": { - "type": "object", - "description": "Additional details about the booking channels and source descriptions for a hotel room type referenced within the fetched results.", - "properties": { - "bookingChannelsInfo": { - "description": "Additional details about booking channels.", - "$ref": "#/definitions/bookingChannelsInfoType" + "minLength": 0, + "maxLength": 20 }, - "sourceDescriptions": { - "description": "hotel-channel room type mapping source descriptions.", - "$ref": "#/definitions/channelRoomMappingsSourceDescriptionsType" - } - } - }, - "channelRoomMappingsSourceDescriptionsType": { - "type": "array", - "description": "This type holds hotel-channel room type mapping source descriptions.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/channelRoomMappingSourceDescriptionsType" - } - }, - "channelRoomMappingSourceDescriptionsType": { - "type": "object", - "description": "Hotel-channel room type mapping source descriptions.", - "properties": { - "description": { - "description": "Hotel room type description.", + "channelRateCode": { + "description": "channel Rate Code.", "type": "string", "minLength": 0, - "maxLength": 2000 - }, - "globalDescription": { - "description": "Hotel room type global description.", - "$ref": "#/definitions/channelMappingEnhancedDescriptionType" + "maxLength": 20 }, - "hotelId": { - "description": "Hotel code the descriptions belong to.", + "ratePlanCode": { + "description": " Rate Plan Code.", "type": "string", "minLength": 0, "maxLength": 20 }, - "roomType": { - "description": "Room type the descriptions belong to.", + "accessCode": { + "description": "Access Code.", "type": "string", "minLength": 0, "maxLength": 20 + }, + "startDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "endDate": { + "type": "string", + "format": "date", + "maxLength": 8 } } } diff --git a/rest-api-specs/property/cms.json b/rest-api-specs/property/cms.json index f291eea..2f581a4 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.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", + "description": "This API deals with the different aspect of the CustomerManagement.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -24,7 +24,7 @@ "/activities/tasks": { "get": { "summary": "Get Calendar Tasks", - "description": "You can fetch a list of Calendar Tasks for with this API, for one or more properties.OperationId:getCalendarTasks
", + "description": "You can fetch a list of Calendar Tasks for with this API, for one or more properties.OperationId:getCalendarTasks
This API allows a time span of 90 days.
", "operationId": "getCalendarTasks", "parameters": [ { diff --git a/rest-api-specs/property/crm.json b/rest-api-specs/property/crm.json index 1b373b9..1d77842 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -154,7 +154,7 @@ "/airline/transactions": { "get": { "summary": "Get airline transactions status", - "description": "Request for fetching membership transactions processed by the airline.OperationId:getAirlineTransactionsStatus
", + "description": "Request for fetching membership transactions processed by the airline.OperationId:getAirlineTransactionsStatus
The maximum allowable limit for this API is 200.
", "operationId": "getAirlineTransactionsStatus", "deprecated": true, "parameters": [ @@ -280,7 +280,7 @@ "/availableAwardsBasedOnType": { "get": { "summary": "Get Available Awards", - "description": "Get available awards based on type of award selected like Rates, products or services, room type upgrades, and other gifts.OperationId:getAvailableAwardsBasedOnType
", + "description": "Get available awards based on type of award selected like Rates, products or services, room type upgrades, and other gifts.OperationId:getAvailableAwardsBasedOnType
This API allows a time span of 90 days.
", "operationId": "getAvailableAwardsBasedOnType", "parameters": [ { @@ -1325,7 +1325,7 @@ "/duplicateExternalSubscriptions": { "get": { "summary": "Get profiles with duplicate external subscriptions ", - "description": "Fetch profile subscriptions where the same OPERA Cloud profile is linked to multiple external profiles, within the same external system.OperationId:getDuplicateExternalSubscriptions
", + "description": "Fetch profile subscriptions where the same OPERA Cloud profile is linked to multiple external profiles, within the same external system.OperationId:getDuplicateExternalSubscriptions
The maximum allowable limit for this API is 200.
", "operationId": "getDuplicateExternalSubscriptions", "parameters": [ { @@ -1456,7 +1456,7 @@ "/duplicateOPERASubscriptions": { "get": { "summary": "Get profiles with duplicate OPERA Cloud subscriptions", - "description": "Fetch subscriptions where an external profile within a particular external system is linked to multiple OPERA Cloud profiles.OperationId:getDuplicateOPERASubscriptions
", + "description": "Fetch subscriptions where an external profile within a particular external system is linked to multiple OPERA Cloud profiles.OperationId:getDuplicateOPERASubscriptions
The maximum allowable limit for this API is 200.
", "operationId": "getDuplicateOPERASubscriptions", "parameters": [ { @@ -2690,7 +2690,6 @@ "cityName": "Redwood Shores", "postalCode": "94065", "cityExtension": "a", - "county": "a", "state": "CA", "country": { "name": "United States of America", @@ -3030,6 +3029,302 @@ "tags": [ "Profile" ] + }, + "put": { + "summary": "Update by external ID", + "description": "Use this API to update guests details on profile. You will need to know the External Profile ID and external system code to use this API.OperationId:putProfileByExtId
", + "operationId": "putProfileByExtId", + "parameters": [ + { + "name": "profileExternalId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "External System's ID used to get the profile." + }, + { + "name": "extSystemCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." + }, + { + "name": "profile", + "in": "body", + "required": true, + "description": "Request object for change/modification of profile details. This object contains modified profile details with unique identifiers for each profile. The standard optional Opera Context element is also included.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/profile" + }, + { + "example": { + "profileIdList": [ + { + "type": "Profile", + "idContext": "OPERA", + "id": "3149001" + } + ], + "profileDetails": { + "customer": { + "personName": [ + { + "givenName": "William", + "middleName": "D", + "surname": "Smith", + "nameSuffix": "10", + "nameTitle": "Mr.....", + "envelopeGreeting": "Hello Mr. Smith", + "salutation": "Mr. Smith", + "nameType": "PRIMARY", + "language": "E" + } + ], + "citizenCountry": { + "value": "United States of America", + "code": "USA" + }, + "identifications": { + "identificationInfo": [ + { + "identification": { + "idType": "PASSPORT", + "idNumber": "C03005988", + "idNumberMasked": "C030059XX", + "issuedCountry": "USA", + "issuedDate": "2009-11-30", + "issuedPlace": "New York", + "expirationDate": "2019-11-29", + "registeredProperty": "HOTEL1", + "primaryInd": true + } + } + ] + }, + "language": "E", + "nationality": "US", + "nationalityDescription": "USA", + "vipStatus": "006", + "vipDescription": "VVIP: VV important person", + "privateProfile": false + }, + "company": { + "companyName": "Oracle America Inc", + "companyName2": "Oracle Group Companies", + "businessTitle": "Developer", + "currencyCode": "USD", + "currencySymbol": "$", + "decimalPlaces": -100000000, + "language": "E", + "nationality": "USA", + "nationalityDescription": "United States", + "commissionCode": "", + "creditRating": "", + "corporateIdType": "", + "vipStatus": "006", + "vipDescription": "Important", + "blacklist": false + }, + "addresses": { + "addressInfo": [ + { + "address": { + "addressLine": [ + "500 Oracle Parkway" + ], + "cityName": "Redwood Shores", + "postalCode": "94065", + "cityExtension": "a", + "state": "CA", + "country": { + "value": "USA", + "code": "US" + }, + "language": "E", + "type": "Office", + "typeDescription": "This is office address.", + "primaryInd": false, + "barCode": "", + "createDateTime": "2019-09-18T21:09:36.498Z", + "creatorId": "12883", + "lastModifyDateTime": "2019-09-18T21:09:36.498Z", + "lastModifierId": "12883" + } + } + ] + }, + "territory": "North America", + "telephones": { + "telephoneInfo": [ + { + "telephone": { + "phoneTechType": "PHONE", + "phoneUseTypeDescription": "office", + "phoneNumber": "+1 415 555 0100", + "extension": "x25", + "primaryInd": false, + "orderSequence": -100000000, + "createDateTime": "2019-09-18T21:09:36.499Z", + "creatorId": "12883", + "lastModifyDateTime": "2019-09-18T21:09:36.499Z", + "lastModifierId": "12883" + } + } + ] + }, + "emails": { + "emailInfo": [ + { + "email": { + "emailAddress": "eg@example.com", + "type": "EMAIL", + "typeDescription": "Email Address", + "emailFormat": "EMAIL", + "primaryInd": false, + "orderSequence": -100000000, + "createDateTime": "2019-09-17T18:18:32.415Z", + "creatorId": "12883", + "lastModifyDateTime": "2019-09-17T18:18:32.416Z", + "lastModifierId": "12883" + } + } + ] + }, + "comments": { + "commentInfo": [ + { + "comment": { + "text": { + "value": "Please add comments here.", + "language": "E" + }, + "commentTitle": "Discount", + "type": "GEN", + "typeDescription": "Comments for discount.", + "internal": false, + "confidential": false, + "overrideInternal": false + } + } + ] + }, + "profileAccessType": { + "croCode": "HOTEL1", + "sharedLevel": "CRO" + }, + "profileRestrictions": { + "restricted": false + }, + "statusCode": "ACTIVE", + "registeredProperty": "HOTEL1", + "createDateTime": "2019-09-17 08:10:28.0", + "creatorId": "12883", + "lastModifyDateTime": "2019-09-17 08:23:05.0", + "lastModifierId": "12883", + "markForHistory": false + }, + "links": [ + { + "href": "http://hotelCompany.example.com/operarest/opera/crm/v2/guests", + "rel": "guestProfile", + "templated": false, + "method": "POST", + "operationId": "postGuestProfile" + } + ] + } + } + ] + } + }, + { + "$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 object for change/modification of profile details. This object contains the profile details with unique identifiers for each profile. Also Success,Warnings and Errors related to this operation.", + "schema": { + "$ref": "#/definitions/profile" + } + }, + "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" + ] } }, "/guests": { @@ -3344,7 +3639,6 @@ "cityName": "Redwood Shores", "postalCode": "94065", "cityExtension": "a", - "county": "a", "state": "CA", "country": { "name": "United States of America", @@ -3912,231 +4206,38 @@ ] } }, - "/membershipClaims": { - "get": { - "summary": "Get membership claims", - "description": "Retrieve available membership claims without specifying the membership ID.OperationId:getAllMembershipClaims
", - "operationId": "getAllMembershipClaims", + "/hotels/{hotelId}/profiles/{profileId}/flexFieldCode/{flexFieldCode}": { + "delete": { + "summary": "Operation to delete a flex field.", + "description": "Operation to delete a flex field Value.OperationId:deleteFlexFieldValue
", + "operationId": "deleteProfileFlexFieldValue", "parameters": [ { - "name": "membershipId", - "in": "query", - "required": false, + "name": "flexFieldCode", + "in": "path", + "required": true, "type": "string", "minLength": 1, - "maxLength": 2000, - "description": "Id to get the claims." - }, - { - "name": "profileId", - "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": "profileIdContext", - "in": "query", - "required": false, - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "type": "string" - }, - { - "name": "profileIdType", - "in": "query", - "required": false, - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string" - }, - { - "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.", - "type": "string" - }, - { - "name": "membershipType", - "in": "query", - "required": false, - "description": "Membership Type code.", - "type": "string" - }, - { - "name": "claimType", - "in": "query", - "required": false, - "description": "Type of user-definable claim to be searched.", - "type": "string" - }, - { - "name": "source", - "in": "query", - "required": false, - "type": "string", - "description": "Source of the membership claim.", - "uniqueItems": true, - "enum": [ - "Ocis", - "Opms", - "Web" - ] - }, - { - "name": "owner", - "in": "query", - "required": false, - "description": "Unique application user ID of the person responsible for handling the claim.", - "type": "string" - }, - { - "name": "claimNumber", - "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": "claimNoContext", - "in": "query", - "required": false, - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "type": "string" - }, - { - "name": "claimNoType", - "in": "query", - "required": false, - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string" + "maxLength": 20, + "description": "Flex field code" }, { "name": "hotelId", - "in": "query", - "required": false, - "description": "Property where the stay took place.", - "type": "string" - }, - { - "name": "confirmationNo", - "in": "query", - "required": false, - "description": "Reservation confirmation or booking reference number.", - "type": "string" - }, - { - "name": "submitter", - "in": "query", - "required": false, - "description": "Application user ID of the user who entered the claim.", - "type": "string" - }, - { - "name": "claimStatus", - "in": "query", - "required": false, - "description": "Status of the claim.(Open, Waiting for Manager, etc.)", - "type": "string" - }, - { - "name": "closeDateEnd", - "in": "query", - "required": false, - "description": "The ending value of the date range.", - "type": "string", - "format": "date" - }, - { - "name": "closeDateStart", - "in": "query", - "required": false, - "description": "The starting value of the date range.", - "type": "string", - "format": "date" - }, - { - "name": "claimDateEnd", - "in": "query", - "required": false, - "description": "The ending value of the date range.", - "type": "string", - "format": "date" - }, - { - "name": "claimDateStart", - "in": "query", - "required": false, - "description": "The starting value of the date range.", - "type": "string", - "format": "date" - }, - { - "name": "replyByEnd", - "in": "query", - "required": false, - "description": "The ending value of the date range.", - "type": "string", - "format": "date" - }, - { - "name": "replyByStart", - "in": "query", - "required": false, - "description": "The starting value of the date range.", - "type": "string", - "format": "date" - }, - { - "name": "arrivalEnd", - "in": "query", - "required": false, - "description": "The ending value of the date range.", - "type": "string", - "format": "date" - }, - { - "name": "arrivalStart", - "in": "query", - "required": false, - "description": "The starting value of the date range.", - "type": "string", - "format": "date" - }, - { - "name": "departureEnd", - "in": "query", - "required": false, - "description": "The ending value of the date range.", - "type": "string", - "format": "date" - }, - { - "name": "departureStart", - "in": "query", - "required": false, - "description": "The starting value of the date range.", + "in": "path", + "required": true, "type": "string", - "format": "date" + "minLength": 1, + "maxLength": 20, + "description": "Unique ID of the hotel in OPERA" }, { - "name": "approvalStatus", - "in": "query", - "required": false, + "name": "profileId", + "in": "path", + "required": true, "type": "string", - "description": "Claim approve or reject status.", - "uniqueItems": true, - "enum": [ - "Approved", - "Rejected", - "Pending" - ] + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." }, { "$ref": "#/parameters/authKey" @@ -4162,16 +4263,17 @@ "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 object for fetching membership claims.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/membershipClaims" + "$ref": "#/definitions/status" } }, - "204": { - "description": "MembershipClaims not found." - }, "400": { "$ref": "#/responses/400" }, @@ -4216,26 +4318,71 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileMembership" + "Profile" ] - }, - "post": { - "summary": "Create membership Claim", - "description": "This will create membership claim details based on the claim number and instructions provided in the request.OperationId:postMembershipClaim
", - "operationId": "postMembershipClaim", + } + }, + "/hotels/{hotelId}/profiles/{profileId}/flexFieldValues": { + "get": { + "summary": "Operation to fetch flex field values.", + "description": "API to fetch flex field values.OperationId:getFlexFieldValue
", + "operationId": "getProfileFlexFieldValue", "parameters": [ { - "name": "membershipClaim", - "in": "body", + "name": "hotelId", + "in": "path", "required": true, - "description": "Request object for creating membership claim.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/membershipClaim" - } - ] - } + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Unique ID of the hotel in OPERA" + }, + { + "name": "profileId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." + }, + { + "name": "flexFieldId", + "in": "query", + "type": "number", + "description": "Flex field ID", + "required": false + }, + { + "name": "flexFieldCode", + "in": "query", + "type": "string", + "description": "Flex field code", + "required": false + }, + { + "name": "flexFieldValue", + "in": "query", + "type": "string", + "description": "Flex field Value", + "required": false + }, + { + "name": "limit", + "in": "query", + "required": false, + "default": 50, + "maximum": 100, + "description": "Indicates maximum number of records a Web Service should return. Default is 50", + "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" }, { "$ref": "#/parameters/authKey" @@ -4254,24 +4401,23 @@ } ], "responses": { - "201": { + "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", + "description": "Response object for fetching flex field Values.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/flexFieldsResponse" } }, + "204": { + "description": "Flex field details not found." + }, "400": { "$ref": "#/responses/400" }, @@ -4316,61 +4462,44 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileMembership" + "Profile" ] - } - }, - "/membershipClaims/{claimId}": { - "get": { - "summary": "Get membership claim ", - "description": "Get membership claim details based on the claim number and instructions provided in the request.OperationId:getMembershipClaim
", - "operationId": "getMembershipClaim", + }, + "post": { + "summary": "Operation to create a flex field with value for a module.", + "description": "Operation to create a flex field Value.OperationId:postFlexFieldValue
", + "operationId": "postProfileFlexFieldValue", "parameters": [ { - "name": "claimId", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, - "maxLength": 2000, - "description": "" - }, - { - "name": "id", - "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", - "in": "query", - "required": false, - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "type": "string" + "maxLength": 20, + "description": "Unique ID of the hotel in OPERA" }, { - "name": "type", - "in": "query", - "required": false, - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string" + "name": "profileId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." }, { - "name": "fetchInstructions", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Simple type for membership claim instructions that can be used in requests for partial operations.", - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "ClaimDetail", - "ClaimActivityLog" + "name": "flexFieldValueInfo", + "in": "body", + "required": true, + "description": "Request object to create a new flex field", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/flexFieldValues" + } ] - }, - "required": false + } }, { "$ref": "#/parameters/authKey" @@ -4389,23 +4518,24 @@ } ], "responses": { - "200": { + "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": "Response object for fetching membership claim.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/membershipClaim" + "$ref": "#/definitions/status" } }, - "204": { - "description": "MembershipClaim not found." - }, "400": { "$ref": "#/responses/400" }, @@ -4450,32 +4580,41 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileMembership" + "Profile" ] }, "put": { - "summary": "Change membership Claim", - "description": "Change membership claim details based on the claim number and instructions provided in the request.OperationId:changeMembershipClaim
", - "operationId": "changeMembershipClaim", + "summary": "Operation to update flex field value.", + "description": "Operation to update flex field value.OperationId:putFlexFieldValue
", + "operationId": "putProfileFlexFieldValue", "parameters": [ { - "name": "claimId", + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Unique ID of the hotel in OPERA" + }, + { + "name": "profileId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "" + "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." }, { - "name": "membershipClaim", + "name": "flexFieldValueInfo", "in": "body", "required": true, - "description": "Request object for changing membership claim information.", + "description": "Request object for updating the configuration of flex fields.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipClaim" + "$ref": "#/definitions/flexFieldValues" } ] } @@ -4559,25 +4698,25 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileMembership" + "Profile" ] } }, - "/membershipPoints/calculations": { + "/issueOtherAwards": { "post": { - "summary": "Calculate Membership Points", - "description": "Start Membership Points Calculation processOperationId:calculateMembershipPoints
", - "operationId": "calculateMembershipPoints", + "summary": "Issue an OTHER type award ", + "description": "This API will allow you to issue OTHER type award based on membership id or membership type and membership card numberOperationId:issueOtherAwards
", + "operationId": "issueOtherAwards", "parameters": [ { - "name": "membershipPointsToCalculate", + "name": "otherAwardsIssueCriteria", "in": "body", "required": true, - "description": "Request to run membership points calculation job.", + "description": "Request object to issue an OTHER type award to a member's profile.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipPointsToCalculate" + "$ref": "#/definitions/otherAwardsIssueCriteria" } ] } @@ -4612,9 +4751,9 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response object for issue awards.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/issuedAward" } }, "400": { @@ -4665,104 +4804,248 @@ ] } }, - "/membershipPointsExceptions": { + "/membershipClaims": { "get": { - "summary": "Get membership points exception details", - "description": "Use this API to get membership points exceptions.OperationId:getMembershipPointsExceptions
OperationId:getAllMembershipClaims
This API allows a time span of 90 days.
", + "operationId": "getAllMembershipClaims", "parameters": [ { - "name": "hotelId", + "name": "membershipId", "in": "query", + "required": false, + "type": "string", "minLength": 1, - "maxLength": 20, + "maxLength": 2000, + "description": "Id to get the claims." + }, + { + "name": "profileId", + "in": "query", "required": false, - "description": "Membership transaction belongs to which Hotel.", + "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": "profileId", + "name": "profileIdContext", "in": "query", "required": false, - "description": "Profile Id of the guest.", - "type": "number" + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "name": "arrivalFrom", + "name": "profileIdType", "in": "query", "required": false, - "description": "Arrival From Date to fetch the reservations flagged for Membership Points Exception", - "type": "string", - "format": "date" + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "name": "departureTo", + "name": "name", "in": "query", "required": false, - "description": "Departure To Date to fetch the reservation flagged for Membership Points Exception", - "type": "string", - "format": "date" + "description": "Family name, last name or Company Name.", + "type": "string" + }, + { + "name": "givenName", + "in": "query", + "required": false, + "description": "Given name, first name or names.", + "type": "string" }, { "name": "membershipType", "in": "query", "required": false, - "description": "The type of the membership.", - "type": "string", - "minLength": 1, - "maxLength": 20 + "description": "Membership Type code.", + "type": "string" }, { - "name": "membershipLevel", + "name": "claimType", "in": "query", "required": false, - "description": "The current level of the membership.", - "type": "string", - "minLength": 1, - "maxLength": 20 + "description": "Type of user-definable claim to be searched.", + "type": "string" }, { - "name": "membershipCardNo", + "name": "source", "in": "query", "required": false, - "description": "The card number associated with this membership.", "type": "string", - "minLength": 1, - "maxLength": 50 + "description": "Source of the membership claim.", + "uniqueItems": true, + "enum": [ + "Ocis", + "Opms", + "Web" + ] }, { - "name": "limit", + "name": "owner", "in": "query", "required": false, - "default": 20, - "maximum": 100, - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "description": "Unique application user ID of the person responsible for handling the claim.", + "type": "string" }, { - "name": "offset", + "name": "claimNumber", "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" + "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": "exceptionStatus", + "name": "claimNoContext", "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" - ] - } + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" + }, + { + "name": "claimNoType", + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" + }, + { + "name": "hotelId", + "in": "query", + "required": false, + "description": "Property where the stay took place.", + "type": "string" + }, + { + "name": "confirmationNo", + "in": "query", + "required": false, + "description": "Reservation confirmation or booking reference number.", + "type": "string" + }, + { + "name": "submitter", + "in": "query", + "required": false, + "description": "Application user ID of the user who entered the claim.", + "type": "string" + }, + { + "name": "claimStatus", + "in": "query", + "required": false, + "description": "Status of the claim.(Open, Waiting for Manager, etc.)", + "type": "string" + }, + { + "name": "closeDateEnd", + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" + }, + { + "name": "closeDateStart", + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" + }, + { + "name": "claimDateEnd", + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" + }, + { + "name": "claimDateStart", + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" + }, + { + "name": "replyByEnd", + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" + }, + { + "name": "replyByStart", + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" + }, + { + "name": "arrivalEnd", + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" + }, + { + "name": "arrivalStart", + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" + }, + { + "name": "departureEnd", + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" + }, + { + "name": "departureStart", + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" + }, + { + "name": "approvalStatus", + "in": "query", + "required": false, + "type": "string", + "description": "Claim approve or reject status.", + "uniqueItems": true, + "enum": [ + "Approved", + "Rejected", + "Pending" + ] + }, + { + "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" }, { "$ref": "#/parameters/authKey" @@ -4790,13 +5073,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching membership points exceptions.", + "description": "Response object for fetching membership claims.", "schema": { - "$ref": "#/definitions/memberPointsExceptions" + "$ref": "#/definitions/membershipClaims" } }, "204": { - "description": "MembershipPointsExceptions not found." + "description": "MembershipClaims not found." }, "400": { "$ref": "#/responses/400" @@ -4845,20 +5128,20 @@ "ProfileMembership" ] }, - "put": { - "summary": "Update membership points exceptions", - "description": "Use this API to update membership points exceptions.OperationId:putMembershipPointsExceptions
", - "operationId": "putMembershipPointsExceptions", + "post": { + "summary": "Create membership Claim", + "description": "This will create membership claim details based on the claim number and instructions provided in the request.OperationId:postMembershipClaim
", + "operationId": "postMembershipClaim", "parameters": [ { - "name": "membershipPointsExceptions", + "name": "membershipClaim", "in": "body", "required": true, - "description": "Request object for updating membership points exceptions.", + "description": "Request object for creating membership claim.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipPointsExceptions" + "$ref": "#/definitions/membershipClaim" } ] } @@ -4880,7 +5163,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -4893,7 +5176,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" } @@ -4946,25 +5229,20 @@ ] } }, - "/membershipTierProjections": { + "/membershipClaims/{claimId}": { "get": { - "summary": "Get Membership Tier Projection", - "description": "Retrieve a list of membership Tier Projection such as upgrades and downgrades.OperationId:getMembershipTierProjections
", - "operationId": "getMembershipTierProjections", + "summary": "Get membership claim ", + "description": "Get membership claim details based on the claim number and instructions provided in the request.OperationId:getMembershipClaim
", + "operationId": "getMembershipClaim", "parameters": [ { - "name": "membershipId", - "in": "query", - "required": false, - "description": "Membership Card Number.", - "type": "string" - }, - { - "name": "membershipType", - "in": "query", - "required": false, - "description": "Type of the Membership.", - "type": "string" + "name": "claimId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { "name": "id", @@ -4988,25 +5266,20 @@ "type": "string" }, { - "name": "projectionDate", - "in": "query", - "required": false, - "description": "Date for which Tier projections is fetched.", - "type": "string", - "format": "date" - }, - { - "name": "projectionType", + "name": "fetchInstructions", "in": "query", - "required": false, - "type": "string", - "description": "Upgrade And Downgrade", + "type": "array", + "collectionFormat": "multi", + "description": "Simple type for membership claim instructions that can be used in requests for partial operations.", "uniqueItems": true, - "enum": [ - "Upgrade", - "Downgrade", - "UpgradeAndDowngrade" - ] + "items": { + "type": "string", + "enum": [ + "ClaimDetail", + "ClaimActivityLog" + ] + }, + "required": false }, { "$ref": "#/parameters/authKey" @@ -5034,13 +5307,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching Membership Tier Process Text.", + "description": "Response object for fetching membership claim.", "schema": { - "$ref": "#/definitions/membershipTierProjections" + "$ref": "#/definitions/membershipClaim" } }, "204": { - "description": "MembershipTierProjections not found." + "description": "MembershipClaim not found." }, "400": { "$ref": "#/responses/400" @@ -5086,18 +5359,16 @@ "application/json;charset=UTF-8" ], "tags": [ - "Profile" + "ProfileMembership" ] - } - }, - "/membershipTransactions/{membershipTransactionId}": { - "get": { - "summary": "Get a membership transaction", - "description": "Retrieve membership transactions.OperationId:getMembershipTransaction
", - "operationId": "getMembershipTransaction", + }, + "put": { + "summary": "Change membership Claim", + "description": "Change membership claim details based on the claim number and instructions provided in the request.OperationId:changeMembershipClaim
", + "operationId": "changeMembershipClaim", "parameters": [ { - "name": "membershipTransactionId", + "name": "claimId", "in": "path", "required": true, "type": "string", @@ -5106,25 +5377,17 @@ "description": "" }, { - "name": "id", - "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", - "in": "query", - "required": false, - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "type": "string" - }, - { - "name": "type", - "in": "query", - "required": false, - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string" + "name": "membershipClaim", + "in": "body", + "required": true, + "description": "Request object for changing membership claim information.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipClaim" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -5150,16 +5413,17 @@ "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 object for fetching a membership transaction.", + "description": "Response Body.", "schema": { - "$ref": "#/definitions/membershipTransaction" + "$ref": "#/definitions/status" } }, - "204": { - "description": "MembershipTransaction not found." - }, "400": { "$ref": "#/responses/400" }, @@ -5208,35 +5472,24 @@ ] } }, - "/membershipTransactions/{membershipTransactionId}/awardPoints": { - "get": { - "summary": "Fetch the Award Points Accrued for the current points transaction.", - "description": "Retrieves the validated rule used to generate award points, the type of points, number of points, cost per point, rule code for the award points, billing group the points belong.OperationId:getMembershipTransactionAwardPoints
", - "operationId": "getMembershipTransactionAwardPoints", + "/membershipPoints/calculations": { + "post": { + "summary": "Calculate Membership Points", + "description": "Start Membership Points Calculation processOperationId:calculateMembershipPoints
", + "operationId": "calculateMembershipPoints", "parameters": [ { - "name": "membershipTransactionId", - "in": "path", + "name": "membershipPointsToCalculate", + "in": "body", "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" - }, - { - "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" + "description": "Request to run membership points calculation job.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipPointsToCalculate" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -5255,23 +5508,24 @@ } ], "responses": { - "200": { + "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": "Response object for fetching membership transaction points information.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/calculatedPoints" + "$ref": "#/definitions/status" } }, - "204": { - "description": "MembershipTransactionAwardPoints not found." - }, "400": { "$ref": "#/responses/400" }, @@ -5320,36 +5574,105 @@ ] } }, - "/membershipTransactions/{membershipTransactionId}/pointRejectionReasons": { + "/membershipPointsExceptions": { "get": { - "summary": "Fetch the reason points were not awarded for a given points transaction.", - "description": "Retrieves the rule used to generate points and the reason the points were not awarded (validation failure, for e.g.'Membership level requirements not met').OperationId:getMembershipTransactionPointsRejectionReasons
", - "operationId": "getMembershipTransactionPointsRejectionReasons", + "summary": "Get membership points exception details", + "description": "Use this API to get membership points exceptions.OperationId:getMembershipPointsExceptions
OperationId:getMembershipTransactionRates
", - "operationId": "getMembershipTransactionRates", + }, + "put": { + "summary": "Update membership points exceptions", + "description": "Use this API to update membership points exceptions.OperationId:putMembershipPointsExceptions
", + "operationId": "putMembershipPointsExceptions", "parameters": [ { - "name": "membershipTransactionId", - "in": "path", + "name": "membershipPointsExceptions", + "in": "body", "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" - }, - { - "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" + "description": "Request object for updating membership points exceptions.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipPointsExceptions" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -5486,16 +5796,17 @@ "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 object for fetching Membership Transaction Rates information.", + "description": "Response Body.", "schema": { - "$ref": "#/definitions/rates" + "$ref": "#/definitions/status" } }, - "204": { - "description": "MembershipTransactionRates not found." - }, "400": { "$ref": "#/responses/400" }, @@ -5544,35 +5855,52 @@ ] } }, - "/membershipTransactions/{membershipTransactionId}/revenue": { + "/membershipReservationActivity": { "get": { - "summary": "Fetch the revenue details for the stay associated with current point transaction.", - "description": "Retrieves the date the revenue was recognized, the revenue type (PMS revenue buckets are seen as revenue types in ORS), PMS revenue and centralOperationId:getMembershipTransactionRevenue
", - "operationId": "getMembershipTransactionRevenue", + "summary": "Get Membership Reservation Activity", + "description": "This API is useful to retrieve membership reservation activity for the day(ExpectedArrival, ExpectedDepartures, InHouse, Projected Room Revenue)OperationId:getMembershipReservationActivity
", + "operationId": "getMembershipReservationActivity", "parameters": [ { - "name": "membershipTransactionId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" - }, - { - "name": "limit", + "name": "hotelIds", "in": "query", - "required": false, - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "type": "array", + "collectionFormat": "multi", + "description": "Unique ID of the hotels to fetch the membership reservation activity.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": true }, { - "name": "offset", + "name": "propertyDate", "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" + "description": "Business Date of the property selected.", + "type": "string", + "format": "date" + }, + { + "name": "roomClasses", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Room Classes required to fetch the membership reservation activity.", + "items": { + "type": "string", + "maxItems": 100 + }, + "required": false + }, + { + "name": "membershipType", + "in": "query", + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Membership Type required to fetch the membership reservation activity.", + "required": false }, { "$ref": "#/parameters/authKey" @@ -5600,13 +5928,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching Membership Transaction Revenue.", + "description": "Response element for membership Reservation Details.", "schema": { - "$ref": "#/definitions/revenues" + "$ref": "#/definitions/membershipReservationDetails" } }, "204": { - "description": "MembershipTransactionRevenue not found." + "description": "Statistics not found." }, "400": { "$ref": "#/responses/400" @@ -5656,35 +5984,67 @@ ] } }, - "/membershipTransactions/{membershipTransactionId}/tierPoints": { + "/membershipTierProjections": { "get": { - "summary": "Fetch the Tier Points Accrued for the current points transaction", - "description": "Retrieves the validated rule used to generate tier points, the type of points, number of points, cost per point, rule code for the award points, billing group the points belong.OperationId:getMembershipTransactionTierPoints
", - "operationId": "getMembershipTransactionTierPoints", + "summary": "Get Membership Tier Projection", + "description": "Retrieve a list of membership Tier Projection such as upgrades and downgrades.OperationId:getMembershipTierProjections
The maximum allowable limit for this API is 200.
", + "operationId": "getMembershipTierProjections", "parameters": [ { - "name": "membershipTransactionId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" + "name": "membershipId", + "in": "query", + "required": false, + "description": "Membership Card Number.", + "type": "string" }, { - "name": "limit", + "name": "membershipType", "in": "query", "required": false, - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "description": "Type of the Membership.", + "type": "string" }, { - "name": "offset", + "name": "id", "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" + "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", + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" + }, + { + "name": "type", + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" + }, + { + "name": "projectionDate", + "in": "query", + "required": false, + "description": "Date for which Tier projections is fetched.", + "type": "string", + "format": "date" + }, + { + "name": "projectionType", + "in": "query", + "required": false, + "type": "string", + "description": "Upgrade And Downgrade", + "uniqueItems": true, + "enum": [ + "Upgrade", + "Downgrade", + "UpgradeAndDowngrade" + ] }, { "$ref": "#/parameters/authKey" @@ -5712,13 +6072,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching membership transaction points information.", + "description": "Response object for fetching Membership Tier Process Text.", "schema": { - "$ref": "#/definitions/calculatedPoints" + "$ref": "#/definitions/membershipTierProjections" } }, "204": { - "description": "MembershipTransactionTierPoints not found." + "description": "MembershipTierProjections not found." }, "400": { "$ref": "#/responses/400" @@ -5764,18 +6124,18 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileMembership" + "Profile" ] } }, - "/memberships/{membershipId}/award": { + "/membershipTransactions/{membershipTransactionId}": { "get": { - "summary": "Export Membership Award", - "description": "Export members information for Fulfillment house processingOperationId:exportMembershipAward
", - "operationId": "exportMembershipAward", + "summary": "Get a membership transaction", + "description": "Retrieve membership transactions.OperationId:getMembershipTransaction
", + "operationId": "getMembershipTransaction", "parameters": [ { - "name": "membershipId", + "name": "membershipTransactionId", "in": "path", "required": true, "type": "string", @@ -5784,496 +6144,1174 @@ "description": "" }, { - "name": "rateInfoHotelId", + "name": "id", "in": "query", "required": false, - "description": "HotelCode where the award will be consumed.", + "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": "totalAvailablePoints", + "name": "idContext", "in": "query", "required": false, - "description": "Total award points available for redemption.", - "type": "number" + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "name": "pointsRequired", + "name": "type", "in": "query", "required": false, - "description": "The number of points that must be redeemed for this award.", - "type": "number" + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "name": "cancelPenaltyPoints", - "in": "query", - "required": false, - "description": "The award points that will be forfeited if the cancel penalty charge is applied.", - "type": "number" + "$ref": "#/parameters/authKey" }, { - "name": "cancelPenaltyDays", - "in": "query", - "required": false, - "description": "Number of days before arrival when a reservation may be cancelled without an award points penalty.", - "type": "number" + "$ref": "#/parameters/x-app-key" }, { - "name": "cancelPenaltyCharge", - "in": "query", - "required": false, - "description": "The cancel penalty charge.", - "type": "number" + "$ref": "#/parameters/x-hotelid" }, { - "name": "cancelPenaltyType", - "in": "query", - "required": false, - "description": "The penalty charge is either a percentage or a flat number of points.", - "type": "string" + "$ref": "#/parameters/x-externalsystem" }, { - "name": "rawIssueKey", - "in": "query", - "required": false, - "description": "Issue key in format of Raw data.", - "type": "string" + "$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 a membership transaction.", + "schema": { + "$ref": "#/definitions/membershipTransaction" + } }, - { - "name": "awardNumber", - "in": "query", - "required": false, - "description": "An identifying number of the award, assigned by the system when the award was issued.", - "type": "number" + "204": { + "description": "MembershipTransaction not found." }, - { - "name": "rateCode", - "in": "query", - "required": false, - "description": "Rate code associated with the award.", - "type": "string" + "400": { + "$ref": "#/responses/400" }, - { - "name": "rateDescription", - "in": "query", - "required": false, - "description": "Rate code description associated with the award.", - "type": "string" + "401": { + "$ref": "#/responses/401" }, - { - "name": "roomLabel", - "in": "query", - "required": false, - "description": "Code for the room type in which the award was issued.", - "type": "string" + "403": { + "$ref": "#/responses/403" }, - { - "name": "roomDescription", - "in": "query", - "required": false, - "description": "Description of the Room.", - "type": "string" + "404": { + "$ref": "#/responses/404" }, - { - "name": "roomCategory", - "in": "query", - "required": false, - "description": "Indicates which room category it belongs.", - "type": "string" + "405": { + "$ref": "#/responses/405" }, - { - "name": "stayDate", - "in": "query", - "required": false, - "description": "The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award.", - "type": "string", - "format": "date" + "406": { + "$ref": "#/responses/406" }, - { - "name": "awardType", - "in": "query", - "required": false, - "description": "Unique code that identifies this award.", - "type": "string" + "413": { + "$ref": "#/responses/413" }, - { - "name": "productInfoHotelId", - "in": "query", - "required": false, - "description": "HotelCode where the award will be consumed.", - "type": "string" + "414": { + "$ref": "#/responses/414" }, - { - "name": "productInfoTotalAvailablePoints", - "in": "query", - "required": false, - "description": "Total award points available for redemption.", - "type": "number" + "415": { + "$ref": "#/responses/415" }, - { - "name": "productInfoPointsRequired", - "in": "query", - "required": false, - "description": "The number of points that must be redeemed for this award.", - "type": "number" + "500": { + "$ref": "#/responses/500" }, - { - "name": "productInfoCancelPenaltyPoints", - "in": "query", - "required": false, - "description": "The award points that will be forfeited if the cancel penalty charge is applied.", - "type": "number" + "502": { + "$ref": "#/responses/502" }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ProfileMembership" + ] + } + }, + "/membershipTransactions/{membershipTransactionId}/awardPoints": { + "get": { + "summary": "Fetch the Award Points Accrued for the current points transaction.", + "description": "Retrieves the validated rule used to generate award points, the type of points, number of points, cost per point, rule code for the award points, billing group the points belong.OperationId:getMembershipTransactionAwardPoints
The maximum allowable limit for this API is 200.
", + "operationId": "getMembershipTransactionAwardPoints", + "parameters": [ { - "name": "productInfoCancelPenaltyDays", - "in": "query", - "required": false, - "description": "Number of days before arrival when a reservation may be cancelled without an award points penalty.", - "type": "number" + "name": "membershipTransactionId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "name": "productInfoCancelPenaltyCharge", + "name": "limit", "in": "query", "required": false, - "description": "The cancel penalty charge.", - "type": "number" + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "name": "productInfoCancelPenaltyType", + "name": "offset", "in": "query", + "default": 0, "required": false, - "description": "The penalty charge is either a percentage or a flat number of points.", - "type": "string" + "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": "productInfoRawIssueKey", - "in": "query", - "required": false, - "description": "Issue key in format of Raw data.", - "type": "string" + "$ref": "#/parameters/authKey" }, { - "name": "productInfoAwardNumber", - "in": "query", - "required": false, - "description": "An identifying number of the award, assigned by the system when the award was issued.", - "type": "number" + "$ref": "#/parameters/x-app-key" }, { - "name": "packageCode", - "in": "query", - "required": false, - "description": "Package/Product code for the award .", - "type": "string" + "$ref": "#/parameters/x-hotelid" }, { - "name": "packageDescription", - "in": "query", - "required": false, - "description": "Description of the product.", - "type": "string" + "$ref": "#/parameters/x-externalsystem" }, { - "name": "awardValidFrom", - "in": "query", - "required": false, - "description": "The valid time period from when the award can be issued.", - "type": "string", - "format": "date" + "$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 transaction points information.", + "schema": { + "$ref": "#/definitions/calculatedPoints" + } }, - { - "name": "awardValidTo", - "in": "query", - "required": false, - "description": "The valid time to an issued award.", - "type": "string", - "format": "date" + "204": { + "description": "MembershipTransactionAwardPoints not found." }, - { - "name": "upgradeInfoAwardType", - "in": "query", - "required": false, - "description": "Unique code that identifies this award.", - "type": "string" + "400": { + "$ref": "#/responses/400" }, - { - "name": "upgradeInfoHotelId", - "in": "query", - "required": false, - "description": "HotelCode where the award will be consumed.", - "type": "string" + "401": { + "$ref": "#/responses/401" }, - { - "name": "upgradeInfoTotalAvailablePoints", - "in": "query", - "required": false, - "description": "Total award points available for redemption.", - "type": "number" + "403": { + "$ref": "#/responses/403" }, - { - "name": "upgradeInfoPointsRequired", - "in": "query", - "required": false, - "description": "The number of points that must be redeemed for this award.", - "type": "number" + "404": { + "$ref": "#/responses/404" }, - { - "name": "upgradeInfoCancelPenaltyPoints", - "in": "query", - "required": false, - "description": "The award points that will be forfeited if the cancel penalty charge is applied.", - "type": "number" + "405": { + "$ref": "#/responses/405" }, - { - "name": "upgradeInfoCancelPenaltyDays", - "in": "query", - "required": false, - "description": "Number of days before arrival when a reservation may be cancelled without an award points penalty.", - "type": "number" + "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" + ] + } + }, + "/membershipTransactions/{membershipTransactionId}/pointRejectionReasons": { + "get": { + "summary": "Fetch the reason points were not awarded for a given points transaction.", + "description": "Retrieves the rule used to generate points and the reason the points were not awarded (validation failure, for e.g.'Membership level requirements not met').OperationId:getMembershipTransactionPointsRejectionReasons
The maximum allowable limit for this API is 200.
", + "operationId": "getMembershipTransactionPointsRejectionReasons", + "parameters": [ { - "name": "upgradeInfoCancelPenaltyCharge", - "in": "query", - "required": false, - "description": "The cancel penalty charge.", - "type": "number" + "name": "membershipTransactionId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "name": "upgradeInfoCancelPenaltyType", + "name": "limit", "in": "query", "required": false, - "description": "The penalty charge is either a percentage or a flat number of points.", - "type": "string" + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "name": "upgradeInfoRawIssueKey", + "name": "offset", "in": "query", + "default": 0, "required": false, - "description": "Issue key in format of Raw data.", - "type": "string" + "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": "upgradeInfoAwardNumber", - "in": "query", - "required": false, - "description": "An identifying number of the award, assigned by the system when the award was issued.", - "type": "number" + "$ref": "#/parameters/authKey" }, { - "name": "fromRoomCategory", - "in": "query", - "required": false, - "description": "Indicates room type code for the room prior to the upgrade.", - "type": "string" + "$ref": "#/parameters/x-app-key" }, { - "name": "toRoomCategory", - "in": "query", - "required": false, - "description": "Indicates room type code of the upgrade room.", - "type": "string" + "$ref": "#/parameters/x-hotelid" }, { - "name": "fromRoomDescription", - "in": "query", - "required": false, - "description": "Indicates room type Description for the room prior to the upgrade.", - "type": "string" + "$ref": "#/parameters/x-externalsystem" }, { - "name": "toRoomDescription", - "in": "query", - "required": false, - "description": "Indicates room type Description of the upgrade room.", - "type": "string" + "$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 member transactions points rejection reasons information.", + "schema": { + "$ref": "#/definitions/pointsRejectionReasons" + } + }, + "204": { + "description": "MembershipTransactionPointsRejectionReasons 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" + ] + } + }, + "/membershipTransactions/{membershipTransactionId}/rates": { + "get": { + "summary": "Fetch the rate details associated to current points transaction.", + "description": "Retrieves the dates of the stay, the rate code, the PMS rate amount, the central rate amount, the central currency and the market code associated with the stay.OperationId:getMembershipTransactionRates
The maximum allowable limit for this API is 200.
", + "operationId": "getMembershipTransactionRates", + "parameters": [ + { + "name": "membershipTransactionId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "name": "fromRoom", + "name": "limit", "in": "query", "required": false, - "description": "Indicates room type code for the room prior to the upgrade.", - "type": "string" + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "name": "toRoom", + "name": "offset", "in": "query", + "default": 0, "required": false, - "description": "Indicates room type code of the upgrade room.", - "type": "string" + "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": "upgradeInfoStayDate", - "in": "query", - "required": false, - "description": "The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award.", + "$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 Transaction Rates information.", + "schema": { + "$ref": "#/definitions/rates" + } + }, + "204": { + "description": "MembershipTransactionRates 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" + ] + } + }, + "/membershipTransactions/{membershipTransactionId}/revenue": { + "get": { + "summary": "Fetch the revenue details for the stay associated with current point transaction.", + "description": "Retrieves the date the revenue was recognized, the revenue type (PMS revenue buckets are seen as revenue types in ORS), PMS revenue and centralOperationId:getMembershipTransactionRevenue
The maximum allowable limit for this API is 200.
", + "operationId": "getMembershipTransactionRevenue", + "parameters": [ + { + "name": "membershipTransactionId", + "in": "path", + "required": true, "type": "string", - "format": "date" + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "name": "otherInfoAwardType", + "name": "limit", "in": "query", "required": false, - "description": "Unique code that identifies this award.", - "type": "string" + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "name": "sellBeginDate", + "name": "offset", "in": "query", + "default": 0, "required": false, - "description": "Beginning date of the award.", + "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 object for fetching Membership Transaction Revenue.", + "schema": { + "$ref": "#/definitions/revenues" + } + }, + "204": { + "description": "MembershipTransactionRevenue 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" + ] + } + }, + "/membershipTransactions/{membershipTransactionId}/tierPoints": { + "get": { + "summary": "Fetch the Tier Points Accrued for the current points transaction", + "description": "Retrieves the validated rule used to generate tier points, the type of points, number of points, cost per point, rule code for the award points, billing group the points belong.OperationId:getMembershipTransactionTierPoints
The maximum allowable limit for this API is 200.
", + "operationId": "getMembershipTransactionTierPoints", + "parameters": [ + { + "name": "membershipTransactionId", + "in": "path", + "required": true, "type": "string", - "format": "date" + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "name": "sellEndDate", + "name": "limit", "in": "query", "required": false, - "description": "End date that the award will be available.", - "type": "string", - "format": "date" + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "name": "shortDescription", + "name": "offset", "in": "query", + "default": 0, "required": false, - "description": "Descriptive name of the award.", - "type": "string" + "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": "awardValue", + "$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 transaction points information.", + "schema": { + "$ref": "#/definitions/calculatedPoints" + } + }, + "204": { + "description": "MembershipTransactionTierPoints 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" + ] + } + }, + "/memberships/{membershipId}/award": { + "get": { + "summary": "Export Membership Award", + "description": "Export members information for Fulfillment house processingOperationId:exportMembershipAward
This API allows a time span of 90 days.
", + "operationId": "exportMembershipAward", + "parameters": [ + { + "name": "membershipId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" + }, + { + "name": "rateInfoHotelId", "in": "query", "required": false, - "description": "The actual value of the award, in the amount of currency.", - "type": "number" + "description": "HotelCode where the award will be consumed.", + "type": "string" }, { - "name": "otherInfoTotalAvailablePoints", + "name": "totalAvailablePoints", "in": "query", "required": false, "description": "Total award points available for redemption.", "type": "number" }, { - "name": "otherInfoPointsRequired", + "name": "pointsRequired", "in": "query", "required": false, "description": "The number of points that must be redeemed for this award.", "type": "number" }, { - "name": "longDescription", + "name": "cancelPenaltyPoints", "in": "query", "required": false, - "description": "Detail description of the award.", - "type": "string" + "description": "The award points that will be forfeited if the cancel penalty charge is applied.", + "type": "number" }, { - "name": "otherInfoAwardNumber", + "name": "cancelPenaltyDays", "in": "query", "required": false, - "description": "An identifying number of the award, assigned by the system when the award was issued.", + "description": "Number of days before arrival when a reservation may be cancelled without an award points penalty.", "type": "number" }, { - "name": "issueAwardsHotelId", + "name": "cancelPenaltyCharge", "in": "query", "required": false, - "description": "HotelCode where the award will be consumed.", - "type": "string" + "description": "The cancel penalty charge.", + "type": "number" }, { - "name": "externalReservationNumber", + "name": "cancelPenaltyType", "in": "query", "required": false, - "description": "PMS Reservation number.", + "description": "The penalty charge is either a percentage or a flat number of points.", "type": "string" }, { - "name": "confirmationBookingNumber", + "name": "rawIssueKey", "in": "query", "required": false, - "description": "ORS Booking number.", + "description": "Issue key in format of Raw data.", "type": "string" }, { - "name": "awardSource", + "name": "awardNumber", "in": "query", "required": false, - "description": "The source for the reservation associated with the award.", - "type": "string" + "description": "An identifying number of the award, assigned by the system when the award was issued.", + "type": "number" }, { - "name": "arrivalDate", + "name": "rateCode", "in": "query", "required": false, - "description": "Arrival date of the reservation associated with the award.", - "type": "string", - "format": "date" + "description": "Rate code associated with the award.", + "type": "string" }, { - "name": "departureDate", + "name": "rateDescription", "in": "query", "required": false, - "description": "Departure date of the reservation associated with the award.", - "type": "string", - "format": "date" + "description": "Rate code description associated with the award.", + "type": "string" }, { - "name": "exportInfoAwardNumber", + "name": "roomLabel", "in": "query", "required": false, - "description": "Award Number to identify member's information.", - "type": "number" + "description": "Code for the room type in which the award was issued.", + "type": "string" }, { - "name": "nameType", + "name": "roomDescription", "in": "query", "required": false, - "type": "string", - "description": "Person's name in an external system.", - "uniqueItems": true, - "enum": [ - "Primary", - "Alternate", - "Incognito", - "External", - "Phonetic" - ] + "description": "Description of the Room.", + "type": "string" }, { - "name": "name", + "name": "roomCategory", "in": "query", "required": false, - "description": "Family name, last name or Company Name.", + "description": "Indicates which room category it belongs.", "type": "string" }, { - "name": "fullName", + "name": "stayDate", "in": "query", "required": false, - "description": "Full display Name.", - "type": "string" + "description": "The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award.", + "type": "string", + "format": "date" }, { - "name": "namePrefix", + "name": "awardType", "in": "query", "required": false, - "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", + "description": "Unique code that identifies this award.", "type": "string" }, { - "name": "givenName", + "name": "productInfoHotelId", "in": "query", "required": false, - "description": "Given name, first name or names.", + "description": "HotelCode where the award will be consumed.", "type": "string" }, { - "name": "middleName", + "name": "productInfoTotalAvailablePoints", "in": "query", "required": false, - "description": "The middle name of the person name.", - "type": "string" + "description": "Total award points available for redemption.", + "type": "number" + }, + { + "name": "productInfoPointsRequired", + "in": "query", + "required": false, + "description": "The number of points that must be redeemed for this award.", + "type": "number" + }, + { + "name": "productInfoCancelPenaltyPoints", + "in": "query", + "required": false, + "description": "The award points that will be forfeited if the cancel penalty charge is applied.", + "type": "number" + }, + { + "name": "productInfoCancelPenaltyDays", + "in": "query", + "required": false, + "description": "Number of days before arrival when a reservation may be cancelled without an award points penalty.", + "type": "number" + }, + { + "name": "productInfoCancelPenaltyCharge", + "in": "query", + "required": false, + "description": "The cancel penalty charge.", + "type": "number" + }, + { + "name": "productInfoCancelPenaltyType", + "in": "query", + "required": false, + "description": "The penalty charge is either a percentage or a flat number of points.", + "type": "string" + }, + { + "name": "productInfoRawIssueKey", + "in": "query", + "required": false, + "description": "Issue key in format of Raw data.", + "type": "string" + }, + { + "name": "productInfoAwardNumber", + "in": "query", + "required": false, + "description": "An identifying number of the award, assigned by the system when the award was issued.", + "type": "number" + }, + { + "name": "packageCode", + "in": "query", + "required": false, + "description": "Package/Product code for the award .", + "type": "string" + }, + { + "name": "packageDescription", + "in": "query", + "required": false, + "description": "Description of the product.", + "type": "string" + }, + { + "name": "awardValidFrom", + "in": "query", + "required": false, + "description": "The valid time period from when the award can be issued.", + "type": "string", + "format": "date" + }, + { + "name": "awardValidTo", + "in": "query", + "required": false, + "description": "The valid time to an issued award.", + "type": "string", + "format": "date" + }, + { + "name": "upgradeInfoAwardType", + "in": "query", + "required": false, + "description": "Unique code that identifies this award.", + "type": "string" + }, + { + "name": "upgradeInfoHotelId", + "in": "query", + "required": false, + "description": "HotelCode where the award will be consumed.", + "type": "string" + }, + { + "name": "upgradeInfoTotalAvailablePoints", + "in": "query", + "required": false, + "description": "Total award points available for redemption.", + "type": "number" + }, + { + "name": "upgradeInfoPointsRequired", + "in": "query", + "required": false, + "description": "The number of points that must be redeemed for this award.", + "type": "number" + }, + { + "name": "upgradeInfoCancelPenaltyPoints", + "in": "query", + "required": false, + "description": "The award points that will be forfeited if the cancel penalty charge is applied.", + "type": "number" + }, + { + "name": "upgradeInfoCancelPenaltyDays", + "in": "query", + "required": false, + "description": "Number of days before arrival when a reservation may be cancelled without an award points penalty.", + "type": "number" + }, + { + "name": "upgradeInfoCancelPenaltyCharge", + "in": "query", + "required": false, + "description": "The cancel penalty charge.", + "type": "number" + }, + { + "name": "upgradeInfoCancelPenaltyType", + "in": "query", + "required": false, + "description": "The penalty charge is either a percentage or a flat number of points.", + "type": "string" + }, + { + "name": "upgradeInfoRawIssueKey", + "in": "query", + "required": false, + "description": "Issue key in format of Raw data.", + "type": "string" + }, + { + "name": "upgradeInfoAwardNumber", + "in": "query", + "required": false, + "description": "An identifying number of the award, assigned by the system when the award was issued.", + "type": "number" + }, + { + "name": "fromRoomCategory", + "in": "query", + "required": false, + "description": "Indicates room type code for the room prior to the upgrade.", + "type": "string" + }, + { + "name": "toRoomCategory", + "in": "query", + "required": false, + "description": "Indicates room type code of the upgrade room.", + "type": "string" + }, + { + "name": "fromRoomDescription", + "in": "query", + "required": false, + "description": "Indicates room type Description for the room prior to the upgrade.", + "type": "string" + }, + { + "name": "toRoomDescription", + "in": "query", + "required": false, + "description": "Indicates room type Description of the upgrade room.", + "type": "string" + }, + { + "name": "fromRoom", + "in": "query", + "required": false, + "description": "Indicates room type code for the room prior to the upgrade.", + "type": "string" + }, + { + "name": "toRoom", + "in": "query", + "required": false, + "description": "Indicates room type code of the upgrade room.", + "type": "string" + }, + { + "name": "upgradeInfoStayDate", + "in": "query", + "required": false, + "description": "The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award.", + "type": "string", + "format": "date" + }, + { + "name": "otherInfoAwardType", + "in": "query", + "required": false, + "description": "Unique code that identifies this award.", + "type": "string" + }, + { + "name": "sellBeginDate", + "in": "query", + "required": false, + "description": "Beginning date of the award.", + "type": "string", + "format": "date" + }, + { + "name": "sellEndDate", + "in": "query", + "required": false, + "description": "End date that the award will be available.", + "type": "string", + "format": "date" + }, + { + "name": "shortDescription", + "in": "query", + "required": false, + "description": "Descriptive name of the award.", + "type": "string" + }, + { + "name": "awardValue", + "in": "query", + "required": false, + "description": "The actual value of the award, in the amount of currency.", + "type": "number" + }, + { + "name": "otherInfoTotalAvailablePoints", + "in": "query", + "required": false, + "description": "Total award points available for redemption.", + "type": "number" + }, + { + "name": "otherInfoPointsRequired", + "in": "query", + "required": false, + "description": "The number of points that must be redeemed for this award.", + "type": "number" + }, + { + "name": "longDescription", + "in": "query", + "required": false, + "description": "Detail description of the award.", + "type": "string" + }, + { + "name": "otherInfoAwardNumber", + "in": "query", + "required": false, + "description": "An identifying number of the award, assigned by the system when the award was issued.", + "type": "number" + }, + { + "name": "issueAwardsHotelId", + "in": "query", + "required": false, + "description": "HotelCode where the award will be consumed.", + "type": "string" + }, + { + "name": "externalReservationNumber", + "in": "query", + "required": false, + "description": "PMS Reservation number.", + "type": "string" + }, + { + "name": "confirmationBookingNumber", + "in": "query", + "required": false, + "description": "ORS Booking number.", + "type": "string" + }, + { + "name": "awardSource", + "in": "query", + "required": false, + "description": "The source for the reservation associated with the award.", + "type": "string" + }, + { + "name": "arrivalDate", + "in": "query", + "required": false, + "description": "Arrival date of the reservation associated with the award.", + "type": "string", + "format": "date" + }, + { + "name": "departureDate", + "in": "query", + "required": false, + "description": "Departure date of the reservation associated with the award.", + "type": "string", + "format": "date" + }, + { + "name": "exportInfoAwardNumber", + "in": "query", + "required": false, + "description": "Award Number to identify member's information.", + "type": "number" + }, + { + "name": "nameType", + "in": "query", + "required": false, + "type": "string", + "description": "Person's name in an external system.", + "uniqueItems": true, + "enum": [ + "Primary", + "Alternate", + "Incognito", + "External", + "Phonetic" + ] + }, + { + "name": "name", + "in": "query", + "required": false, + "description": "Family name, last name or Company Name.", + "type": "string" + }, + { + "name": "fullName", + "in": "query", + "required": false, + "description": "Full display Name.", + "type": "string" + }, + { + "name": "namePrefix", + "in": "query", + "required": false, + "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", + "type": "string" + }, + { + "name": "givenName", + "in": "query", + "required": false, + "description": "Given name, first name or names.", + "type": "string" + }, + { + "name": "middleName", + "in": "query", + "required": false, + "description": "The middle name of the person name.", + "type": "string" }, { "name": "nameSuffix", @@ -6434,7 +7472,7 @@ "name": "county", "in": "query", "required": false, - "description": "County or District Name (e.g., Fairfax). This is read only.", + "description": "County or District Name (e.g., Fairfax). Currently this attribute is not used.", "type": "string" }, { @@ -6747,7 +7785,7 @@ "/memberships/{membershipId}/awards": { "get": { "summary": "Get Membership Award list", - "description": "Retrieve a list of member issued awards.OperationId:getMembershipIssueAwardsList
", + "description": "Retrieve a list of member issued awards.OperationId:getMembershipIssueAwardsList
The maximum allowable limit for this API is 200.
", "operationId": "getMembershipIssueAwardsList", "parameters": [ { @@ -6907,7 +7945,7 @@ "/memberships/{membershipId}/claims": { "get": { "summary": "Get membership claims", - "description": "Retrieve available membership claims by specifying the membership ID.OperationId:getMembershipClaims
", + "description": "Retrieve available membership claims by specifying the membership ID.OperationId:getMembershipClaims
This API allows a time span of 90 days.
", "operationId": "getMembershipClaims", "parameters": [ { @@ -7898,6 +8936,15 @@ "maxLength": 20, "description": "An alphanumeric code for the promotion." }, + { + "name": "membershipPromotionId", + "in": "query", + "required": false, + "type": "string", + "minLength": 0, + "maxLength": 20, + "description": "The ID of a promotion owned by a membership." + }, { "$ref": "#/parameters/authKey" }, @@ -8298,6 +9345,418 @@ ] } }, + "/membershipsCard/{membershipCardNo}/membershipType/{membershipCardType}/pointsToExpire": { + "get": { + "summary": "Get membership points to expire ", + "description": "Use this API to retrieve your Points To Expire by by specifying membership card number and membership card type. This operation can return more than one membership points to expire if duplicate card numbers are allowed in the configuration.OperationId:getMemberPointsToExpireByCardNo
", + "operationId": "getMemberPointsToExpireByCardNo", + "parameters": [ + { + "name": "membershipCardNo", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "description": "The card number associated to the membership" + }, + { + "name": "membershipCardType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "The type of card the membership belongs to" + }, + { + "$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 member points to expire information.", + "schema": { + "$ref": "#/definitions/memberPointsToExpireCollection" + } + }, + "204": { + "description": "MemberPointsToExpire 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" + ] + } + }, + "/membershipsCard/{membershipCardNo}/membershipType/{membershipCardType}/transactions": { + "get": { + "summary": "Get membership transactions ", + "description": "Get membership transactions summary information by specifying membership card number and membership card type, this operation can return more than one membership transactions if duplicate card numbers allowed in the configuration.OperationId:getMembershipTransactionsSummaryByCardNo
", + "operationId": "getMembershipTransactionsSummaryByCardNo", + "parameters": [ + { + "name": "membershipCardNo", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "description": "" + }, + { + "name": "membershipCardType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "" + }, + { + "$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 member point totals information.", + "schema": { + "$ref": "#/definitions/membershipTransactionsSummaryCollection" + } + }, + "204": { + "description": "MembershipTransactionsSummary 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" + ] + } + }, + "/processStagedProfile": { + "put": { + "summary": "Process a staged profile", + "description": "Use this API to process one profile that has been staged.OperationId:processStagedProfile
", + "operationId": "processStagedProfile", + "parameters": [ + { + "name": "stagedProfileCriteria", + "in": "body", + "required": true, + "description": "Request object for processing the staged profile.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/stagedProfileCriteria" + } + ] + } + }, + { + "$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 object for the staged profile.", + "schema": { + "$ref": "#/definitions/processedStagedProfile" + } + }, + "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" + ] + } + }, + "/processSuspendedStays": { + "put": { + "summary": "Process Suspended Stays", + "description": "This API processes Suspended Stay. If no Suspended Stay Record IDs are sent in the body all suspended stays will be processed.OperationId:putProcessSuspendedStays
", + "operationId": "putProcessSuspendedStays", + "parameters": [ + { + "name": "suspendedStayRecordId", + "in": "body", + "required": true, + "description": "Request object for change/modification of Suspended Stay, including Revenue, Rate and Membership details. If no Suspended Stay Record IDs are sent in the body all suspended stays will be processed.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/suspendedStayDetails" + } + ] + } + }, + { + "$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 process Suspended Stays.", + "schema": { + "$ref": "#/definitions/suspendedStayErrorsType" + } + }, + "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": [ + "SuspendedStay" + ] + } + }, "/profileForEnrollment": { "get": { "summary": "Get Profiles for Enrollment", @@ -8429,7 +9888,7 @@ "name": "county", "in": "query", "required": false, - "description": "County or District Name (e.g., Fairfax). This is read only.", + "description": "County or District Name (e.g., Fairfax). Currently this attribute is not used.", "type": "string" }, { @@ -9031,10 +10490,188 @@ ] } }, + "/profileMatch": { + "get": { + "summary": "Fetch the profile Id if a unique guest profile Exists", + "description": "Use this operation to fetch guest profile (profile Id). This operation can be integrated with createReservation API, to prevent creation of duplicate profiles.OperationId:getProfileMatch
", + "operationId": "getProfileMatch", + "parameters": [ + { + "name": "lastName", + "in": "query", + "minLength": 1, + "maxLength": 40, + "required": true, + "description": "Last Name for the profile that needs to be matched.", + "type": "string" + }, + { + "name": "firstName", + "in": "query", + "minLength": 1, + "maxLength": 40, + "required": false, + "description": "First Name for the profile that needs to be matched.", + "type": "string" + }, + { + "name": "membershipType", + "in": "query", + "minLength": 1, + "maxLength": 20, + "required": false, + "description": "Membership Type for the profile that needs to be matched.", + "type": "string" + }, + { + "name": "membershipCardNumber", + "in": "query", + "minLength": 1, + "maxLength": 50, + "required": false, + "description": "Membership Card Number for the profile that needs to be matched.", + "type": "string" + }, + { + "name": "identificationType", + "in": "query", + "required": false, + "minLength": 1, + "maxLength": 40, + "description": "Identification Type for the profile that needs to be matched.", + "type": "string" + }, + { + "name": "identificationNumber", + "in": "query", + "required": false, + "minLength": 1, + "maxLength": 80, + "description": "Identification Number for the profile that needs to be matched.", + "type": "string" + }, + { + "name": "email", + "in": "query", + "required": false, + "description": "Email for the profile that needs to be matched.", + "minLength": 1, + "maxLength": 2000, + "type": "string" + }, + { + "name": "subscriptionType", + "in": "query", + "required": false, + "minLength": 1, + "maxLength": 20, + "description": "Subscription Type for the profile that needs to be matched.", + "type": "string" + }, + { + "name": "subscriptionId", + "in": "query", + "required": false, + "minLength": 1, + "maxLength": 80, + "description": "Subscription Id for the profile that needs to be matched.", + "type": "string" + }, + { + "name": "clientId", + "in": "query", + "required": false, + "type": "string", + "description": "Client Id for the profile that needs to be matched.", + "minLength": 1, + "maxLength": 80 + }, + { + "$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 profile match.", + "schema": { + "$ref": "#/definitions/profileMatch" + } + }, + "204": { + "description": "No unique match found for the search criteria." + }, + "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" + ] + } + }, "/profileMembershipStatistics": { "get": { "summary": "Get Membership statistics ", - "description": "Retrieve the summary statistics and/or the details of each of the membership transactions and its points. You can filter by membership Type, or Membership Number.OperationId:getProfileMembershipStatistics
", + "description": "Retrieve the summary statistics and/or the details of each of the membership transactions and its points. You can filter by membership Type, or Membership Number.OperationId:getProfileMembershipStatistics
This API allows a time span of 90 days.
", "operationId": "getProfileMembershipStatistics", "parameters": [ { @@ -9213,7 +10850,7 @@ "/profileStatistics": { "get": { "summary": "Get Profile Statistics", - "description": "This API provides summary/detail/revenue statistics informationOperationId:getProfileStatistics
", + "description": "This API provides summary/detail/revenue statistics informationOperationId:getProfileStatistics
This API allows a time span of 90 days.
", "operationId": "getProfileStatistics", "parameters": [ { @@ -9340,6 +10977,23 @@ "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, + { + "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" + }, { "$ref": "#/parameters/authKey" }, @@ -9422,6 +11076,153 @@ ] } }, + "/profileTransactions/{profileId}": { + "get": { + "summary": "Get Profile Transactions ", + "description": "Retrieve the Transactions associated to a profile related to Stay Records or Membership Adjustments.OperationId:getProfileTransactions
This API allows a time span of 90 days.
", + "operationId": "getProfileTransactions", + "parameters": [ + { + "name": "profileId", + "in": "path", + "type": "string", + "description": "Profile Id for which we want to fetch transactions", + "required": true + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "string", + "format": "date" + }, + { + "name": "endDate", + "in": "query", + "required": false, + "type": "string", + "format": "date" + }, + { + "name": "transactionDate", + "in": "query", + "required": false, + "type": "string", + "format": "date" + }, + { + "name": "hotelId", + "in": "query", + "required": false, + "description": "Stay Record or Membership transaction belongs to which Hotel.", + "type": "string" + }, + { + "name": "confirmationNumber", + "in": "query", + "required": false, + "description": "Confirmation Number of the stay Record or Membership Transaction.", + "type": "string" + }, + { + "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" + }, + { + "$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 of the WS operation FetchProfileTransactions.", + "schema": { + "$ref": "#/definitions/profileTransactions" + } + }, + "204": { + "description": "ProfileTransactions 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" + ] + } + }, "/profiles": { "get": { "summary": "Search for profile(s)", @@ -9923,20 +11724,6 @@ }, "required": false }, - { - "name": "predefinedFilterId", - "in": "query", - "required": false, - "description": "Unique ID of the Filter used to filter profiles.", - "type": "number" - }, - { - "name": "predefinedFilterCode", - "in": "query", - "required": false, - "description": "Filter code.", - "type": "string" - }, { "name": "prioritieCodes", "in": "query", @@ -10123,7 +11910,6 @@ "cityName": "Redwood Shores", "postalCode": "94065", "cityExtension": "a", - "county": "a", "state": "CA", "country": { "value": "USA", @@ -10432,7 +12218,7 @@ "/profiles/activityLog": { "get": { "summary": "Fetch profile activity log", - "description": "Use this API to fetch the activity log for a specific profile. This will allow you to see the changes that have occurred on this profile.OperationId:getProfileActivityLog
", + "description": "Use this API to fetch the activity log for a specific profile. This will allow you to see the changes that have occurred on this profile.OperationId:getProfileActivityLog
The maximum allowable limit for this API is 200.
", "operationId": "getProfileActivityLog", "parameters": [ { @@ -10935,7 +12721,6 @@ "cityName": "Redwood Shores", "postalCode": "94065", "cityExtension": "a", - "county": "a", "state": "CA", "country": { "name": "United States of America", @@ -11379,7 +13164,6 @@ "cityName": "Redwood Shores", "postalCode": "94065", "cityExtension": "a", - "county": "a", "state": "CA", "country": { "value": "USA", @@ -11791,11 +13575,11 @@ ] } }, - "/profiles/{profileId}/action/delete": { - "delete": { - "summary": "Delete the profile permanently.", - "description": "OperationId:deleteProfilePermanently
", - "operationId": "deleteProfilePermanently", + "/profiles/{profileId}/attachments": { + "get": { + "summary": "Get profile attachments", + "description": "This API will provide the attachments on a profile in OPERA Cloud.OperationId:getProfileAttachments
", + "operationId": "getProfileAttachments", "parameters": [ { "name": "profileId", @@ -11806,6 +13590,38 @@ "maxLength": 2000, "description": "" }, + { + "name": "idContext", + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" + }, + { + "name": "type", + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" + }, + { + "name": "attachedFileName", + "in": "query", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "File name used to filter final list of attachments. For example, Document.txt." + }, + { + "name": "description", + "in": "query", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 100, + "description": "Description used to filter final list of attachments. For example, Offical guest ID. (This parameter does not require wildcard characters like * or % )." + }, { "$ref": "#/parameters/authKey" }, @@ -11830,17 +13646,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": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response object with the details of the attachments of a profile.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/profileAttachments" } }, + "204": { + "description": "ProfileAttachments not found." + }, "400": { "$ref": "#/responses/400" }, @@ -11889,12 +13704,21 @@ ] } }, - "/profiles/{profileId}/attachments": { - "get": { - "summary": "Get profile attachments", - "description": "This API will provide the attachments on a profile in OPERA Cloud.OperationId:getProfileAttachments
", - "operationId": "getProfileAttachments", + "/profiles/{profileId}/attachments/{attachmentId}": { + "delete": { + "summary": "Delete profile attachment", + "description": "This API will delete an attachment on a profile in OPERA Cloud.OperationId:deleteProfileAttachment
", + "operationId": "deleteProfileAttachment", "parameters": [ + { + "name": "attachmentId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" + }, { "name": "profileId", "in": "path", @@ -11904,326 +13728,188 @@ "maxLength": 2000, "description": "" }, + { + "name": "idExtension", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Additional identifying value assigned by the creating system.", + "items": { + "type": "integer" + }, + "required": false + }, { "name": "idContext", "in": "query", - "required": false, + "type": "array", + "collectionFormat": "multi", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "type": "string" + "items": { + "type": "string" + }, + "required": false }, { "name": "type", "in": "query", - "required": false, + "type": "array", + "collectionFormat": "multi", + "default": [ + "Profile" + ], "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string" + "items": { + "type": "string" + }, + "required": false }, { - "name": "attachedFileName", + "name": "uniqueIdIdExtension", "in": "query", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "File name used to filter final list of attachments. For example, Document.txt." + "type": "array", + "collectionFormat": "multi", + "description": "Additional identifying value assigned by the creating system.", + "items": { + "type": "integer" + }, + "required": false }, { - "name": "description", + "name": "uniqueIdIdContext", "in": "query", - "required": false, + "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "uniqueIdType", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "default": [ + "Attachment" + ], + "description": "A reference to the type of object defined by the UniqueID element.", + "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" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "Profile" + ] + } + }, + "/profiles/{profileId}/awards/redeem": { + "put": { + "summary": "Redeem an award", + "description": "Redeem an award that exists on a profile.OperationId:redeemAward
", + "operationId": "redeemAward", + "parameters": [ + { + "name": "profileId", + "in": "path", + "required": true, "type": "string", "minLength": 1, - "maxLength": 100, - "description": "Description used to filter final list of attachments. For example, Offical guest ID. (This parameter does not require wildcard characters like * or % )." - }, - { - "$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 with the details of the attachments of a profile.", - "schema": { - "$ref": "#/definitions/profileAttachments" - } - }, - "204": { - "description": "ProfileAttachments 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" - ] - } - }, - "/profiles/{profileId}/attachments/{attachmentId}": { - "delete": { - "summary": "Delete profile attachment", - "description": "This API will delete an attachment on a profile in OPERA Cloud.OperationId:deleteProfileAttachment
", - "operationId": "deleteProfileAttachment", - "parameters": [ - { - "name": "attachmentId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" - }, - { - "name": "profileId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" - }, - { - "name": "idExtension", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Additional identifying value assigned by the creating system.", - "items": { - "type": "integer" - }, - "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", - "default": [ - "Profile" - ], - "description": "A reference to the type of object defined by the UniqueID element.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "uniqueIdIdExtension", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Additional identifying value assigned by the creating system.", - "items": { - "type": "integer" - }, - "required": false - }, - { - "name": "uniqueIdIdContext", - "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": "uniqueIdType", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "default": [ - "Attachment" - ], - "description": "A reference to the type of object defined by the UniqueID element.", - "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" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Profile" - ] - } - }, - "/profiles/{profileId}/awards/redeem": { - "put": { - "summary": "Redeem an award", - "description": "Redeem an award that exists on a profile.OperationId:redeemAward
", - "operationId": "redeemAward", - "parameters": [ - { - "name": "profileId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" - }, - { - "name": "award", - "in": "body", - "required": true, - "description": "Request object to redeem award.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/award" - } - ] - } + "maxLength": 2000, + "description": "" + }, + { + "name": "award", + "in": "body", + "required": true, + "description": "Request object to redeem award.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/award" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -13296,48 +14982,67 @@ ] } }, - "/profiles/{profileId}/hotels/{hotelId}/forecasts": { + "/profiles/{profileId}/flexFieldValues": { "get": { - "summary": "Fetch Account Forecasts by hotel", - "description": "You can use this API to retrieve account forecasts for a hotelOperationId:getAccountForecasts
", - "operationId": "getAccountForecasts", + "summary": "Operation to fetch flex field values.", + "description": "API to fetch flex field values.OperationId:getAllFlexFieldValues
", + "operationId": "getAllProfileFlexFieldValues", "parameters": [ { - "name": "hotelId", + "name": "profileId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Hotel Code" + "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." }, { - "name": "profileId", - "in": "path", - "required": true, + "name": "hotelIds", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Hotel code", + "items": { + "type": "string", + "maxItems": 50 + }, + "required": true + }, + { + "name": "flexFieldId", + "in": "query", + "type": "number", + "description": "Flex field ID", + "required": false + }, + { + "name": "flexFieldCode", + "in": "query", "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique OPERA internal account profile ID" + "description": "Flex field code", + "required": false }, { - "name": "fromPeriodCode", + "name": "flexFieldValue", "in": "query", - "required": false, - "description": "Specifies the From Fiscal or Calendar Period Code", - "type": "string" + "type": "string", + "description": "Flex field Value", + "required": false }, { "name": "limit", "in": "query", "required": false, - "description": "Indicates maximum number of records a Web Service should return.", + "default": 50, + "maximum": 100, + "description": "Indicates maximum number of records a Web Service should return. Default is 50", "type": "integer" }, { "name": "offset", "in": "query", - "default": 0, + "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" @@ -13368,13 +15073,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching forecasts of an account profile.", + "description": "Response object for fetching flex field Values.", "schema": { - "$ref": "#/definitions/accountForecasts" + "$ref": "#/definitions/flexFieldsResponse" } }, "204": { - "description": "AccountForecasts not found." + "description": "Flex field details not found." }, "400": { "$ref": "#/responses/400" @@ -13422,11 +15127,13 @@ "tags": [ "Profile" ] - }, - "post": { - "summary": "Create account forecast in a hotel", - "description": "Use postAccountForecast to create a new account forecast for a hotel.OperationId:postAccountForecast
", - "operationId": "postAccountForecast", + } + }, + "/profiles/{profileId}/hotels/{hotelId}/forecasts": { + "get": { + "summary": "Fetch Account Forecasts by hotel", + "description": "You can use this API to retrieve account forecasts for a hotelOperationId:getAccountForecasts
The maximum allowable limit for this API is 200.
", + "operationId": "getAccountForecasts", "parameters": [ { "name": "hotelId", @@ -13435,7 +15142,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of the hotel" + "description": "Hotel Code" }, { "name": "profileId", @@ -13447,17 +15154,26 @@ "description": "Unique OPERA internal account profile ID" }, { - "name": "forecastsInformation", - "in": "body", - "required": true, - "description": "Request object for creating forecast(s) of an account profile.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/forecastsInformation" - } - ] - } + "name": "fromPeriodCode", + "in": "query", + "required": false, + "description": "Specifies the From Fiscal or Calendar Period Code", + "type": "string" + }, + { + "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" }, { "$ref": "#/parameters/authKey" @@ -13476,24 +15192,23 @@ } ], "responses": { - "201": { + "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", + "description": "Response object for fetching forecasts of an account profile.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/accountForecasts" } }, + "204": { + "description": "AccountForecasts not found." + }, "400": { "$ref": "#/responses/400" }, @@ -13541,10 +15256,10 @@ "Profile" ] }, - "delete": { - "summary": "Delete multiple account forecasts", - "description": "Use this API to delete multiple account forecasts.OperationId:deleteMultipleAccountForecasts
", - "operationId": "deleteMultipleAccountForecasts", + "post": { + "summary": "Create account forecast in a hotel", + "description": "Use postAccountForecast to create a new account forecast for a hotel.OperationId:postAccountForecast
", + "operationId": "postAccountForecast", "parameters": [ { "name": "hotelId", @@ -13552,7 +15267,8 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 2000 + "maxLength": 2000, + "description": "Unique ID of the hotel" }, { "name": "profileId", @@ -13564,15 +15280,17 @@ "description": "Unique OPERA internal account profile ID" }, { - "name": "periodCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", - "items": { - "type": "string" - }, - "required": false + "name": "forecastsInformation", + "in": "body", + "required": true, + "description": "Request object for creating forecast(s) of an account profile.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/forecastsInformation" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -13591,7 +15309,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -13655,31 +15373,19 @@ "tags": [ "Profile" ] - } - }, - "/profiles/{profileId}/hotels/{hotelId}/forecasts/periodCodes/{periodCode}": { - "put": { - "summary": "Update account forecast in a hotel by period code", - "description": "Use this to update an existing account Forecast for a hotel. You must know the period code for this API.OperationId:putAccountForecast
", - "operationId": "putAccountForecast", + }, + "delete": { + "summary": "Delete multiple account forecasts", + "description": "Use this API to delete multiple account forecasts.OperationId:deleteMultipleAccountForecasts
", + "operationId": "deleteMultipleAccountForecasts", "parameters": [ - { - "name": "periodCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Period Code" - }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel." + "maxLength": 2000 }, { "name": "profileId", @@ -13688,20 +15394,18 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique Account Profile ID." + "description": "Unique OPERA internal account profile ID" }, { - "name": "forecastsInformation", - "in": "body", - "required": true, - "description": "Request object for changing forecast(s) of an account profile.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/forecastsInformation" - } - ] - } + "name": "periodCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", + "items": { + "type": "string" + }, + "required": false }, { "$ref": "#/parameters/authKey" @@ -13733,9 +15437,9 @@ "description": "Location of newly created resource" } }, - "description": "Response Body.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/changeAccountForecastsRS" + "$ref": "#/definitions/status" } }, "400": { @@ -13784,11 +15488,13 @@ "tags": [ "Profile" ] - }, - "delete": { - "summary": "Delete account forecast in a hotel by period code", - "description": "Use this to delete an existing account Forecast for a hotel. You must know the period code for this API.OperationId:deleteAccountForecast
", - "operationId": "deleteAccountForecast", + } + }, + "/profiles/{profileId}/hotels/{hotelId}/forecasts/periodCodes/{periodCode}": { + "put": { + "summary": "Update account forecast in a hotel by period code", + "description": "Use this to update an existing account Forecast for a hotel. You must know the period code for this API.OperationId:putAccountForecast
", + "operationId": "putAccountForecast", "parameters": [ { "name": "periodCode", @@ -13797,7 +15503,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Period Code." + "description": "Period Code" }, { "name": "hotelId", @@ -13818,15 +15524,17 @@ "description": "Unique Account Profile ID." }, { - "name": "periodCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", - "items": { - "type": "string" - }, - "required": false + "name": "forecastsInformation", + "in": "body", + "required": true, + "description": "Request object for changing forecast(s) of an account profile.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/forecastsInformation" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -13858,9 +15566,9 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response Body.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/changeAccountForecastsRS" } }, "400": { @@ -13909,31 +15617,20 @@ "tags": [ "Profile" ] - } - }, - "/profiles/{profileId}/hotels/{hotelId}/preferenceType/{preferenceType}/preferences/{preferenceCode}": { + }, "delete": { - "summary": "Delete a preference from a profile", - "description": "This will allow you to delete a preference code from a profile. For example the guest no longer has a preference for High Floor Room, so you would go ahead and delete this preference from their profile.OperationId:deletePreference
", - "operationId": "deletePreference", + "summary": "Delete account forecast in a hotel by period code", + "description": "Use this to delete an existing account Forecast for a hotel. You must know the period code for this API.OperationId:deleteAccountForecast
", + "operationId": "deleteAccountForecast", "parameters": [ { - "name": "preferenceCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" - }, - { - "name": "preferenceType", + "name": "periodCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "" + "description": "Period Code." }, { "name": "hotelId", @@ -13942,7 +15639,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "" + "description": "Unique ID of the hotel." }, { "name": "profileId", @@ -13951,14 +15648,257 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "" + "description": "Unique Account Profile ID." }, { - "name": "registeredProperty", + "name": "periodCodes", "in": "query", - "required": false, - "type": "string", - "description": "Profiles Registered Property" + "type": "array", + "collectionFormat": "multi", + "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", + "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" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "Profile" + ] + } + }, + "/profiles/{profileId}/hotels/{hotelId}/preferenceType/{preferenceType}/preferences/{preferenceCode}": { + "delete": { + "summary": "Delete a preference from a profile", + "description": "This will allow you to delete a preference code from a profile. For example the guest no longer has a preference for High Floor Room, so you would go ahead and delete this preference from their profile.OperationId:deletePreference
", + "operationId": "deletePreference", + "parameters": [ + { + "name": "preferenceCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" + }, + { + "name": "preferenceType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" + }, + { + "name": "profileId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" + }, + { + "name": "registeredProperty", + "in": "query", + "required": false, + "type": "string", + "description": "Profiles Registered Property" + }, + { + "$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": [ + "Profile" + ] + } + }, + "/profiles/{profileId}/hotels/{hotelId}/stagedProfile": { + "delete": { + "summary": "Delete a staged profile", + "description": "This API can be used to delete a staged profile.OperationId:deleteStagedProfile
", + "operationId": "deleteStagedProfile", + "parameters": [ + { + "name": "profileId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Profile id of staged profile." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Hotel id of staged profile." }, { "$ref": "#/parameters/authKey" @@ -14475,7 +16415,7 @@ "/profiles/{profileId}/membershipTransactionExceptions": { "get": { "summary": "Get membership transaction exception details", - "description": "Use this API to get membership transaction exceptions on a profile.OperationId:getMembershipTransactionExceptions
", + "description": "Use this API to get membership transaction exceptions on a profile.OperationId:getMembershipTransactionExceptions
This API allows a time span of 90 days.
", "operationId": "getMembershipTransactionExceptions", "deprecated": true, "parameters": [ @@ -15003,11 +16943,11 @@ ] } }, - "/profiles/{profileId}/memberships/info": { + "/profiles/{profileId}/memberships/history": { "get": { - "summary": "Get membership information on a profile", - "description": "Use this API to retrieve membership details on a profile.OperationId:getMembershipDetails
", - "operationId": "getMembershipDetails", + "summary": "Get membership card history information on a profile", + "description": "Use this API to retrieve membership card history on a profile.OperationId:getMembershipCardHistory
", + "operationId": "getMembershipCardHistory", "parameters": [ { "name": "profileId", @@ -15016,95 +16956,209 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "" + "description": "Profile Id of the guest." }, { - "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": "idType", - "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": "membershipType", - "in": "query", - "required": false, - "description": "The type of the membership.", - "type": "string" - }, - { - "name": "membershipId", - "in": "query", - "required": false, - "description": "The card number associated with this membership.", - "type": "string" - }, - { - "name": "hotelId", - "in": "query", - "required": false, - "description": "Property from which the membership stay information was received.", - "type": "string" - }, - { - "name": "startDate", - "in": "query", - "required": false, - "type": "string", - "format": "date" - }, - { - "name": "endDate", - "in": "query", - "required": false, - "type": "string", - "format": "date" - }, - { - "name": "duration", + "name": "limit", "in": "query", "required": false, - "type": "string" + "default": 20, + "maximum": 100, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "name": "mode", + "name": "offset", "in": "query", + "default": 1, "required": false, - "type": "string", - "description": "Whether member info search will pertain to transaction dates/ stay dates/ points credit dates.", - "uniqueItems": true, - "enum": [ - "TransactionDate", - "StayBeginDate", - "StayEndDate", - "PointsCreditDate" - ] + "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 object for list of membership card number changes.", + "schema": { + "$ref": "#/definitions/memberCardHistoryList" + } + }, + "204": { + "description": "memberCardHistory 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" + ] + } + }, + "/profiles/{profileId}/memberships/info": { + "get": { + "summary": "Get membership information on a profile", + "description": "Use this API to retrieve membership details on a profile.OperationId:getMembershipDetails
This API allows a time span of 90 days.
", + "operationId": "getMembershipDetails", + "parameters": [ + { + "name": "profileId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" + }, + { + "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": "idType", + "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": "membershipType", + "in": "query", + "required": false, + "description": "The type of the membership.", + "type": "string" + }, + { + "name": "membershipId", + "in": "query", + "required": false, + "description": "The card number associated with this membership.", + "type": "string" + }, + { + "name": "hotelId", + "in": "query", + "required": false, + "description": "Property from which the membership stay information was received.", + "type": "string" + }, + { + "name": "startDate", + "in": "query", + "required": false, + "type": "string", + "format": "date" + }, + { + "name": "endDate", + "in": "query", + "required": false, + "type": "string", + "format": "date" + }, + { + "name": "duration", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "mode", + "in": "query", + "required": false, + "type": "string", + "description": "Whether member info search will pertain to transaction dates/ stay dates/ points credit dates.", + "uniqueItems": true, + "enum": [ + "TransactionDate", + "StayBeginDate", + "StayEndDate", + "PointsCreditDate" + ] }, { "$ref": "#/parameters/authKey" @@ -16311,7 +18365,7 @@ "/profiles/{profileId}/stayHistory": { "get": { "summary": "FetchStayHistory method provides stay history and future reservations of a profile based on the unique internal ID specified.", - "description": "OperationId:getStayHistory
", + "description": "OperationId:getStayHistory
The maximum allowable limit for this API is 200.
", "operationId": "getStayHistory", "parameters": [ { @@ -17319,7 +19373,7 @@ "/profilesByIds": { "get": { "summary": "Search for profile(s)", - "description": "Use this API when you want to search for a profile. The response will include a list of profiles that exist in OPERA, based on your search criteria. For example, you want to see if a profile for Mr David Smith exists - you can search by various criteria, such as first, last name, email. The response will include a list of any profiles that exist for Mr Davis Smith. If a profile matches the criteria, and you want to get more details of that profile, proceed to use getProfile with the profileID in the request.OperationId:getProfilesByIds
", + "description": "Use this API when you want to search for a profile. The response will include a list of profiles that exist in OPERA, based on your search criteria. For example, you want to see if a profile for Mr David Smith exists - you can search by various criteria, such as first, last name, email. The response will include a list of any profiles that exist for Mr Davis Smith. If a profile matches the criteria, and you want to get more details of that profile, proceed to use getProfile with the profileID in the request.OperationId:getProfilesByIds
The maximum allowable limit for this API is 200.
", "operationId": "getProfilesByIds", "parameters": [ { @@ -17643,7 +19697,7 @@ "/profilesMatchList/profileType/{profileType}": { "get": { "summary": "Get profiles match list.", - "description": "This API provides list of matching profiles based on the profile match configuration. These profiles are matched based on address, Postal codes, Last Name etc.OperationId:getProfilesMatchList
", + "description": "This API provides list of matching profiles based on the profile match configuration. These profiles are matched based on address, Postal codes, Last Name etc.OperationId:getProfilesMatchList
The maximum allowable limit for this API is 200.
", "operationId": "getProfilesMatchList", "parameters": [ { @@ -18007,75 +20061,12 @@ ] } }, - "/stagedProfile/{id}": { + "/services/profile/status": { "get": { - "summary": "Get a staged profile", - "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. This API will get a specific profile that has been staged.OperationId:getStagedProfile
", - "operationId": "getStagedProfile", + "summary": "Operation to check the status of profile service", + "description": "OperationId:pingProfileService
", + "operationId": "pingProfileService", "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" - }, - { - "name": "hotelId", - "in": "query", - "required": false, - "description": "The hotel code that the stage profile belongs to.", - "type": "string" - }, - { - "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": "fetchInstructions", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "If selected, only invalid details of the staged profile will be retrieved.", - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "Profile", - "Address", - "Communication", - "NegotiatedRate", - "Membership", - "Preference", - "Keyword", - "Routing", - "UserDefinedField", - "Identifier", - "InvalidDetail" - ] - }, - "required": false - }, { "$ref": "#/parameters/authKey" }, @@ -18102,13 +20093,13 @@ "x-example": "en-GB" } }, - "description": "Response object for the staged profile.", + "description": "Response for Ping operation.", "schema": { - "$ref": "#/definitions/stagedProfileDetails" + "$ref": "#/definitions/operaVersion" } }, "204": { - "description": "StagedProfile not found." + "description": "pingProfileService not found." }, "400": { "$ref": "#/responses/400" @@ -18156,34 +20147,14 @@ "tags": [ "Profile" ] - }, - "put": { - "summary": "Change a staged profile", - "description": "This API can be used to update the staged Profile.OperationId:changeStagedProfile
", - "operationId": "changeStagedProfile", + } + }, + "/services/profileExternal/status": { + "get": { + "summary": "Operation to check status of ProfileExternal service", + "description": "OperationId:pingProfileExternalService
", + "operationId": "pingProfileExternalService", "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" - }, - { - "name": "stagedProfile", - "in": "body", - "required": true, - "description": "Request object for changing the staged profile.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/stagedProfile" - } - ] - } - }, { "$ref": "#/parameters/authKey" }, @@ -18208,17 +20179,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": "Response Body.", + "description": "Response for Ping operation.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/operaVersion" } }, + "204": { + "description": "pingProfileExternalService not found." + }, "400": { "$ref": "#/responses/400" }, @@ -18263,66 +20233,104 @@ "application/json;charset=UTF-8" ], "tags": [ - "Profile" + "ProfileExternal" ] } }, - "/suspendedAddresses": { + "/services/profileMembership/status": { "get": { - "summary": "Fetch Suspended Profile Addresses", - "description": "Fetch Suspended Profile AddressesOperationId:getSuspendedAddresses
", - "operationId": "getSuspendedAddresses", + "summary": "Operation to check status of ProfileMembership service", + "description": "OperationId:pingMembershipService
", + "operationId": "pingMembershipService", "parameters": [ { - "name": "name", - "in": "query", - "required": false, - "description": "Last Name of the Profile against which the Suspended Addresses are fetched.", - "type": "string" + "$ref": "#/parameters/authKey" }, { - "name": "hotelId", - "in": "query", - "required": false, - "description": "Hotel Code, It is used to filter hotel specific children to this specific hotel code.", - "type": "string" + "$ref": "#/parameters/x-app-key" }, { - "name": "firstName", - "in": "query", - "required": false, - "description": "First Name of the Profile against which the Suspended Addresses are fetched.", - "type": "string" + "$ref": "#/parameters/x-hotelid" }, { - "name": "profileType", - "in": "query", - "required": false, - "description": "ProfileT ype of the Profile against which the Suspended Addresses are fetched..", - "type": "string" + "$ref": "#/parameters/x-externalsystem" }, { - "name": "matchCode", - "in": "query", - "required": false, - "description": "Match Code of the Address Validation Performed from the batch processing", - "type": "string" + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + } + }, + "description": "Response for Ping operation.", + "schema": { + "$ref": "#/definitions/operaVersion" + } }, - { - "name": "countryCode", - "in": "query", - "required": false, - "description": "Code for a country or a nationality.", - "type": "string" + "204": { + "description": "pingMembershipService not found." }, - { - "name": "validateDate", - "in": "query", - "required": false, - "description": "Validate Date.", - "type": "string", - "format": "date" + "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" + ] + } + }, + "/services/profileStats/status": { + "get": { + "summary": "Operation to check the status of ProfileStats service", + "description": "OperationId:pingProfileStatsService
", + "operationId": "pingProfileStatsService", + "parameters": [ { "$ref": "#/parameters/authKey" }, @@ -18349,13 +20357,13 @@ "x-example": "en-GB" } }, - "description": "Response list of suspended addresses based on supplied criteria", + "description": "Response for Ping operation.", "schema": { - "$ref": "#/definitions/suspendedAddresses" + "$ref": "#/definitions/operaVersion" } }, "204": { - "description": "SuspendedAddresses not found." + "description": "pingProfileStatsService not found." }, "400": { "$ref": "#/responses/400" @@ -18401,24 +20409,76 @@ "application/json;charset=UTF-8" ], "tags": [ - "Profile" + "ProfileStatistics" ] } }, - "/suspendedProfileErrorSummary": { + "/stagedProfile/{id}": { "get": { - "summary": "Get suspended profile error summary details", - "description": "Retrieve the suspended profile error summary detailsOperationId:getSuspendedProfileErrorSummary
", - "operationId": "getSuspendedProfileErrorSummary", + "summary": "Get a staged profile", + "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. This API will get a specific profile that has been staged.OperationId:getStagedProfile
", + "operationId": "getStagedProfile", "parameters": [ { - "name": "hotelIds", + "name": "id", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" + }, + { + "name": "hotelId", + "in": "query", + "required": false, + "description": "The hotel code that the stage profile belongs to.", + "type": "string" + }, + { + "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": "fetchInstructions", "in": "query", "type": "array", "collectionFormat": "multi", + "description": "If selected, only invalid details of the staged profile will be retrieved.", + "uniqueItems": true, "items": { "type": "string", - "maxItems": 4000 + "enum": [ + "Profile", + "Address", + "Communication", + "NegotiatedRate", + "Membership", + "Preference", + "Keyword", + "Routing", + "UserDefinedField", + "Identifier", + "InvalidDetail" + ] }, "required": false }, @@ -18448,13 +20508,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetch suspended profile Errors summary. This object contains collection of profile erros and count of how many profiles encountered this error.", + "description": "Response object for the staged profile.", "schema": { - "$ref": "#/definitions/suspendedProfileErrorSummaryInfo" + "$ref": "#/definitions/stagedProfileDetails" } }, "204": { - "description": "SuspendedProfileErrorSummary not found." + "description": "StagedProfile not found." }, "400": { "$ref": "#/responses/400" @@ -18502,23 +20562,30 @@ "tags": [ "Profile" ] - } - }, - "/synchronizeProfileSubscriptions": { + }, "put": { - "summary": "Synchronize profile subscriptions", - "description": "Synchronize profile subscriptionsOperationId:synchronizeProfileSubscriptions
", - "operationId": "synchronizeProfileSubscriptions", + "summary": "Change a staged profile", + "description": "This API can be used to update the staged Profile.OperationId:changeStagedProfile
", + "operationId": "changeStagedProfile", "parameters": [ { - "name": "profileSubscriptionsToSynchronize", + "name": "id", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" + }, + { + "name": "stagedProfile", "in": "body", "required": true, - "description": "Request object for re-subscribing profile subscriptions.", + "description": "Request object for changing the staged profile.", "schema": { "allOf": [ { - "$ref": "#/definitions/profileSubscriptionsToSynchronize" + "$ref": "#/definitions/stagedProfile" } ] } @@ -18606,24 +20673,190 @@ ] } }, - "/validateForgetProfiles": { - "put": { - "summary": "Validate forget profiles", - "description": "Validate forget profiles.OperationId:validateForgetProfiles
", - "operationId": "validateForgetProfiles", + "/stagedProfiles": { + "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
The maximum allowable limit for this API is 200.
", + "operationId": "getStagedProfiles", "parameters": [ { - "name": "forgetProfilesCriteria", - "in": "body", - "required": true, - "description": "Operation to validate profiles for forgetting.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/forgetProfilesCriteria" - } + "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": "stagedReasons", + "in": "query", + "type": "array", + "description": "This can be used to fetch staged profiles based on the reason why it got staged Ex : NameChange", + "collectionFormat": "multi", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "InvalidEnrollmentCode", + "EmptyEnrollmentCode", + "NameChange", + "InvalidExpirationDate", + "EmptyExpirationDate", + "EmptyMembershipLevel", + "InvalidMembershipLevel", + "DuplicateMembership" ] - } + }, + "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.", + "type": "string" + }, + { + "name": "region", + "in": "query", + "required": false, + "description": "The profile region for which the staged profiles shall be fetched.", + "type": "string" + }, + { + "name": "countryCode", + "in": "query", + "required": false, + "description": "Code for a country or a nationality.", + "type": "string" + }, + { + "name": "profileType", + "in": "query", + "required": false, + "description": "Profile type to be included in the search.", + "type": "string" + }, + { + "name": "importDate", + "in": "query", + "required": false, + "description": "The date on which the staged profiles have been received. This parameter is deprecated. ", + "type": "string", + "format": "date" + }, + { + "name": "stageStatus", + "in": "query", + "required": false, + "description": "The status of the staged profiles.", + "type": "string" + }, + { + "name": "applyTo", + "in": "query", + "required": false, + "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 + }, + { + "name": "insertDateFrom", + "in": "query", + "required": false, + "description": "Accepts a date value and retrieves all the suspended profiles inserted on or after the provided date.", + "type": "string", + "format": "date" + }, + { + "name": "insertDateTo", + "in": "query", + "required": false, + "description": "Accepts a date value and retrieves all the suspended profiles inserted up to and including the specified date.", + "type": "string", + "format": "date" + }, + { + "name": "membershipNumber", + "in": "query", + "required": false, + "description": " Accepts a membership number and retrieves the suspended profile(s) associated with the provided code.", + "maxLength": 40, + "type": "string" }, { "$ref": "#/parameters/authKey" @@ -18643,6 +20876,100 @@ ], "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" + ] + } + }, + "/stayMembership": { + "post": { + "summary": "This API facilitates attaching or replacing a membership to a given stayRecord.", + "description": "A user can add a new membership or substitute an existing membership for a stay record by providing the relevant membership information in the request.OperationId:addReplaceStayMembership
", + "operationId": "addReplaceStayMembership", + "parameters": [ + { + "name": "stayMembershipDetails", + "in": "body", + "required": true, + "description": "Request object for Membership details to attach or replace.", + "schema": { + "$ref": "#/definitions/stayMembershipDetails" + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -18652,12 +20979,12 @@ }, "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Location of newly created resource." } }, - "description": "Response object for validating profiles for forgetting.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/validatedForgetProfiles" + "$ref": "#/definitions/status" } }, "400": { @@ -18707,44 +21034,1126 @@ "Profile" ] } - } - }, - "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" + }, + "/stayRecord": { + "post": { + "summary": "This API facilitates uploading stage records to LCS.", + "description": "A user can upload stay record to OPERA by specifying stay record column details in the request.OperationId:postStayRecord
", + "operationId": "postStayRecord", + "parameters": [ + { + "name": "stayRecordDetails", + "in": "body", + "required": true, + "description": "Request object for uploading stage records to LCS.", + "schema": { + "$ref": "#/definitions/stayRecordDetails" + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$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 stay record." + } + }, + "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": [ + "Profile" + ] + } + }, + "/stayRecord/{stayRecordId}": { + "get": { + "summary": "Get Stay Record Detail.", + "description": "This API is used to retrieve details of a given stay record (including UDFs, Daily Rates and Revenue).OperationId:getStayRecordDetail
", + "operationId": "getStayRecordDetail", + "parameters": [ + { + "name": "stayRecordId", + "in": "path", + "required": true, + "type": "string", + "description": "A unique identifying value of the stay record, assigned by the creating system.", + "minLength": 1, + "maxLength": 40 + }, + { + "name": "fetchInstructions", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Fetch instructions that can be used to fetch required stay record details.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "UDF", + "Revenue", + "Rates" + ] + } + }, + { + "$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 stay record detail.", + "schema": { + "$ref": "#/definitions/stayRecordDetail" + } + }, + "204": { + "description": "Stay Record detail 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 AddressesOperationId:getSuspendedAddresses
The maximum allowable limit for this API is 200.
", + "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" + }, + { + "$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 list of suspended addresses based on supplied criteria", + "schema": { + "$ref": "#/definitions/suspendedAddresses" + } + }, + "204": { + "description": "SuspendedAddresses 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" + ] + } + }, + "/suspendedProfileErrorSummary": { + "get": { + "summary": "Get suspended profile error summary details", + "description": "Retrieve the suspended profile error summary detailsOperationId:getSuspendedProfileErrorSummary
", + "operationId": "getSuspendedProfileErrorSummary", + "parameters": [ + { + "name": "hotelIds", + "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 fetch suspended profile Errors summary. This object contains collection of profile erros and count of how many profiles encountered this error.", + "schema": { + "$ref": "#/definitions/suspendedProfileErrorSummaryInfo" + } + }, + "204": { + "description": "SuspendedProfileErrorSummary 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" + ] + } + }, + "/suspendedStayRecordId/{suspendedStayRecordId}": { + "get": { + "summary": "Get a Suspended Stay by the Suspended Stay Record ID.", + "description": "This API provides Suspended Stay information including Revenue, Rate, Membership and Error details.OperationId:getSuspendedStay
", + "operationId": "getSuspendedStay", + "parameters": [ + { + "name": "suspendedStayRecordId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Suspended Stay Record ID." + }, + { + "$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 Suspended Stay, including Revenue, Rate, Membership and Error details.", + "schema": { + "$ref": "#/definitions/suspendedStayType" + } + }, + "204": { + "description": "SuspendedStay 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": [ + "SuspendedStay" + ] + }, + "put": { + "summary": "Update a Suspended Stay by the Suspended Stay Record ID.", + "description": "Use this to update a Suspended Stay information including Revenue, Rate and Membership details.OperationId:putSuspendedStay
", + "operationId": "putSuspendedStay", + "parameters": [ + { + "name": "suspendedStayRecordId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Suspended Stay Record ID." + }, + { + "name": "suspendedStay", + "in": "body", + "required": true, + "description": "Request object for change/modification of Suspended Stay, including Revenue, Rate and Membership details.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/suspendedStayType" + } + ] + } + }, + { + "$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 object for change/modification of Suspended Stay, including Revenue, Rate and Membership details.", + "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": [ + "SuspendedStay" + ] + }, + "delete": { + "summary": "Delete a suspended stay by the Suspended Stay Record ID.", + "description": "Use this to remove a Suspended Stay from OPERA including all its details like Revenue, Rate, Membership, Errors.OperationId:deleteSuspendedStay
", + "operationId": "deleteSuspendedStay", + "parameters": [ + { + "name": "suspendedStayRecordId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Suspended Stay Record ID." + }, + { + "$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": [ + "SuspendedStay" + ] + } + }, + "/suspendedStays": { + "get": { + "summary": "Get Suspended Stays", + "description": "This API provides Suspended Stay information. Suspended stays are records that need to be manually processed, as they have been suspended during an upload to OPERA Cloud.OperationId:getSuspendedStays
", + "operationId": "getSuspendedStays", + "parameters": [ + { + "name": "hotelId", + "in": "query", + "required": false, + "description": "Hotel code.", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "reservationStatus", + "in": "query", + "required": false, + "type": "string", + "description": "Status of reservation.", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "importDate", + "in": "query", + "required": false, + "description": "Date of creation or import of stay.", + "type": "string", + "format": "date" + }, + { + "name": "limit", + "in": "query", + "default": 20, + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer", + "maximum": 200 + }, + { + "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 object for fetching Suspended Stays.", + "schema": { + "$ref": "#/definitions/suspendedStaySummariesType" + } + }, + "204": { + "description": "SuspendedStays 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": [ + "SuspendedStay" + ] + } + }, + "/synchronizeProfileSubscriptions": { + "put": { + "summary": "Synchronize profile subscriptions", + "description": "Synchronize profile subscriptionsOperationId:synchronizeProfileSubscriptions
", + "operationId": "synchronizeProfileSubscriptions", + "parameters": [ + { + "name": "profileSubscriptionsToSynchronize", + "in": "body", + "required": true, + "description": "Request object for re-subscribing profile subscriptions.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/profileSubscriptionsToSynchronize" + } + ] + } + }, + { + "$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": [ + "Profile" + ] + } + }, + "/validateForgetProfiles": { + "put": { + "summary": "Validate forget profiles", + "description": "Validate forget profiles.OperationId:validateForgetProfiles
", + "operationId": "validateForgetProfiles", + "parameters": [ + { + "name": "forgetProfilesCriteria", + "in": "body", + "required": true, + "description": "Operation to validate profiles for forgetting.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/forgetProfilesCriteria" + } + ] + } + }, + { + "$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 object for validating profiles for forgetting.", + "schema": { + "$ref": "#/definitions/validatedForgetProfiles" + } + }, + "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" + ] + } + } + }, + "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", @@ -18854,7 +22263,7 @@ "maxLength": 20 }, "county": { - "description": "County or District Name (e.g., Fairfax). This is read only.", + "description": "County or District Name (e.g., Fairfax). Currently this attribute is not used.", "type": "string", "minLength": 0, "maxLength": 20 @@ -21144,7 +24553,7 @@ "maxLength": 20 }, "enrollmentSource": { - "description": "Source from where the enrollment is done.", + "description": "Source from where the enrollment is done. This is set at the OPERA control level and cannot be overriden.", "type": "string", "minLength": 0, "maxLength": 20 @@ -21937,7 +25346,7 @@ "description": "This provides name information for a person.", "properties": { "namePrefix": { - "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", + "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.). Currently this attribute is not used.", "type": "string", "minLength": 0, "maxLength": 40 @@ -21961,7 +25370,7 @@ "maxLength": 40 }, "nameSuffix": { - "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)", + "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.). Currently this attribute is not used.", "type": "string", "minLength": 0, "maxLength": 40 @@ -22143,7 +25552,7 @@ "description": "Legal Company.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 80 }, "department": { "description": "Department of the Profile.", @@ -22155,7 +25564,7 @@ "description": "Business Title or Position of the profile.", "type": "string", "minLength": 0, - "maxLength": 40 + "maxLength": 80 } } }, @@ -27169,575 +30578,1338 @@ "$ref": "#/definitions/stayReservationInfoType" } }, - "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" + "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" + } + } + }, + "roomOwnershipType": { + "type": "object", + "description": "Define the search criteria for retrieving room ownership records", + "properties": { + "roomOwnershipId": { + "description": "Unique Id for Room Owner record.", + "type": "integer" + }, + "contractNumber": { + "description": "Contract number for room owner.", + "type": "string" + }, + "roomId": { + "description": "Room Id of room owner.", + "type": "string" + }, + "roomCategory": { + "description": "Room Category of the room ownership record.", + "type": "string" + }, + "roomType": { + "description": "Room Type of the room ownership record.", + "type": "string" + }, + "startDate": { + "description": "Start Date of the room ownership record.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "endDate": { + "description": "End Date of the room ownership record.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "profileId": { + "description": "Profile ID of the room ownership record.", + "$ref": "#/definitions/uniqueID_Type" + }, + "status": { + "description": "Status of the room ownership record.", + "type": "string" + } + } + }, + "hotelStaysType": { + "type": "array", + "description": "Detailed information of the hotel stay.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelStayType" + } + }, + "hotelStayType": { + "type": "object", + "description": "Type provides the hotel stay information.", + "properties": { + "hotelName": { + "description": "Hotel Name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "pointsMiles": { + "description": "Points or Miles.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "pointsMilesEarned": { + "description": "Guest stay points or miles earned", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "arrivalDate": { + "description": "Guest arrival date.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "roomPreferencesType": { + "type": "object", + "description": "Indicates the guest's room preferences.", + "properties": { + "bedType": { + "description": "Indicates the bed type preference.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "smoking": { + "description": "Indicates the smoking preference.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "precedence": { + "description": "Indicates which room preference takes priority, bed type or smoking type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "floor": { + "description": "Indicates the floor type preference.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "newspapers": { + "description": "Indicates the newspaper preference.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "snack": { + "description": "Indicates the snack preference.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "beverage": { + "description": "Indicates the beverage preference.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "pillow": { + "description": "Indicates the pillow type preference.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomAmenities": { + "description": "Indicates the room amenities requested.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "interests": { + "description": "Indicates guest preferred interests.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "accessible": { + "description": "Indicates if the member requires accessible rooms.", + "type": "boolean" + } + } + }, + "earningPreferencesType": { + "type": "object", + "description": "Indicates guest's rewards earning preferences.", + "properties": { + "earningPreference": { + "description": "Indicates the earning preference, Points or Miles.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "airline": { + "description": "Indicates preferred airline code and name.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "frequentFlyerNumber": { + "description": "Indicates frequent flyer's number of the guest.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "mailingPreferencesType": { + "type": "object", + "description": "Indicates guest's mailing preferences.", + "properties": { + "eFolio": { + "description": "Defines if an E-Folio is required.", + "type": "boolean" + }, + "mailings": { + "description": "Defines mailings only.", + "type": "boolean" + } + } + }, + "rewardsInfoType": { + "type": "object", + "description": "Indicates membership base information like CurrentBalance,association and Owned card.", + "properties": { + "mVCIOwner": { + "description": "Indicates if the member is an MVCI owner.", + "type": "string", + "minLength": 0, + "maxLength": 3 + }, + "ownsVisaCard": { + "description": "Indicates if guest owns a visa card.", + "type": "boolean" + }, + "meetingPlanner": { + "description": "Indicates if meeting planner is requested.", + "type": "boolean" + }, + "association": { + "description": "Indicates guest association.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "currentBalance": { + "description": "Current membership points.", + "type": "number" + }, + "membershipId": { + "description": "Indicates membership id of the guest.", + "type": "number" + }, + "membershipNo": { + "description": "Indicates membership number of the guest", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "membershipLevel": { + "description": "Indicates membership level of the guest", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "membershipDate": { + "description": "Indicates membership date of the guest", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "reservationId": { + "type": "object", + "description": "An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).", + "properties": { + "url": { + "description": "URL that identifies the location associated with the record identified by the UniqueID.", + "type": "string" + }, + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "instance": { + "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "id": { + "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "idExtension": { + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" + } + } + }, + "enrollmentPaymentDetailsType": { + "type": "object", + "description": "Payment details to enrolll profile to the membership program.", + "properties": { + "paymentMethod": { + "description": "Indicate which method of payment will be used for enrollment to membership program.", + "$ref": "#/definitions/codeDescriptionType" + }, + "amount": { + "description": "Amount/Fee to enroll to membership Program.", + "type": "number" + }, + "amountCode": { + "description": "Code of Amount/Fee to enroll to membership Program.", + "$ref": "#/definitions/codeDescriptionType" + }, + "paymentDate": { + "description": "The date of Payment for enrollment to membership program.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "comments": { + "description": "Payment Comments.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + } + } + }, + "enrollmentTypeType": { + "type": "string", + "description": "The type of external system that the guest is enrolling in, such as Loyalty, Gaming or Activities.", + "enum": [ + "Gaming", + "Loyalty", + "Activities" + ] + }, + "profileSummaryInfoType": { + "type": "object", + "description": "Summary information about a profile and the associated Unique IDs.", + "properties": { + "profileIdList": { + "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code.", + "$ref": "#/definitions/profileIdList" + }, + "profile": { + "description": "Provides summary information regarding profile.", + "$ref": "#/definitions/profileSummaryType" + } + } + }, + "profileSummaryType": { + "type": "object", + "description": "Type provides the basic information about the profile.", + "properties": { + "formerName": { + "description": "This provides name information for a person.", + "type": "object", + "properties": { + "name": { + "description": "Family name, last name or Company Name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "fullName": { + "description": "Full display Name.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "namePrefix": { + "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "givenName": { + "description": "Given name, first name or names.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "middleName": { + "description": "The middle name of the person name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "nameSuffix": { + "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "nameTitle": { + "description": "Degree or honors (e.g., Ph.D., M.D.)", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "nameType": { + "description": "Type of name of the individual, such as former, nickname, alternate or alias name.", + "$ref": "#/definitions/personNameTypeType" + }, + "gender": { + "description": "Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "birthDate": { + "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "birthDateMasked": { + "description": "Indicates the date of birth as masked.", + "type": "string" + }, + "currencyCode": { + "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "currencySymbol": { + "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", + "type": "string", + "minLength": 0, + "maxLength": 10 + }, + "decimalPlaces": { + "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", + "type": "integer" + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "customerValue": { + "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "altName": { + "description": "Profile Name information for this profile.", + "$ref": "#/definitions/profileNameType" + }, + "anonymization": { + "description": "Provides information about the guest's anonymization status", + "$ref": "#/definitions/anonymizationType" + }, + "addressInfo": { + "description": "Detailed information on an address for the customer.", + "$ref": "#/definitions/addressInfoType" + }, + "telephoneInfo": { + "description": "Detailed information on telephone/ fax for the customer.", + "$ref": "#/definitions/telephoneInfoType" + }, + "emailInfo": { + "description": "Detailed information on an eMail address for the customer.", + "$ref": "#/definitions/emailInfoType" + }, + "profileMembership": { + "description": "Information on membership for the customer.", + "$ref": "#/definitions/profileMembershipType" + }, + "uRLInfo": { + "description": "Detailed information on web url/address for the customer.", + "$ref": "#/definitions/uRLInfoType" + }, + "citizenCountry": { + "description": "Name of the (self-professed) country that is claimed for citizenship.", + "$ref": "#/definitions/countryNameType" + }, + "profileIndicators": { + "description": "Indicators of additional information attached to the profile", + "$ref": "#/definitions/indicatorsType" + }, + "searchMatches": { + "description": "Super Search matching terms.", + "$ref": "#/definitions/searchMatchesType" + }, + "profileAccessType": { + "description": "Detailed information on access type associated with the profile.Information on whether the profile is created in CRO/Hotel/Chain.", + "$ref": "#/definitions/profileAccessType" + }, + "profileRestrictions": { + "description": "Detailed information on restrictions associated with the profile.", + "$ref": "#/definitions/profileRestrictions" }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "vipStatus": { + "description": "VIP status of the customer.", + "$ref": "#/definitions/vIPStatusType" }, - "count": { - "description": "Total number of rows returned", - "type": "integer" - } - } - }, - "roomOwnershipType": { - "type": "object", - "description": "Define the search criteria for retrieving room ownership records", - "properties": { - "roomOwnershipId": { - "description": "Unique Id for Room Owner record.", - "type": "integer" + "owners": { + "description": "Owner of the customer.", + "$ref": "#/definitions/ownersType" }, - "contractNumber": { - "description": "Contract number for room owner.", + "primaryCompany": { + "description": "Primary Company of the profile.", "type": "string" }, - "roomId": { - "description": "Room Id of room owner.", - "type": "string" + "aRAccount": { + "description": "AR Account information.", + "$ref": "#/definitions/directBillingType" }, - "roomCategory": { - "description": "Room Category of the room ownership record.", - "type": "string" + "commission": { + "description": "Commission Code and description of the requested HotelCode.", + "$ref": "#/definitions/codeDescriptionType" }, - "roomType": { - "description": "Room Type of the room ownership record.", - "type": "string" + "taxInfo": { + "description": "Profile information about tax.", + "$ref": "#/definitions/profileTaxInfoType" }, - "startDate": { - "description": "Start Date of the room ownership record.", - "type": "string", - "format": "date", - "maxLength": 8 + "cashiering": { + "description": "Contains cashiering related details for the profile", + "$ref": "#/definitions/profileCashieringType" }, - "endDate": { - "description": "End Date of the room ownership record.", - "type": "string", - "format": "date", - "maxLength": 8 + "lastStayInfo": { + "description": "Information on last stay of the profile.", + "$ref": "#/definitions/lastStayInfoType" }, - "profileId": { - "description": "Profile ID of the room ownership record.", - "$ref": "#/definitions/uniqueID_Type" + "allowedActions": { + "description": "Collection of allowed actions for profile search.", + "$ref": "#/definitions/profileAllowedActionsType" }, - "status": { - "description": "Status of the room ownership record.", - "type": "string" - } - } - }, - "hotelStaysType": { - "type": "array", - "description": "Detailed information of the hotel stay.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/hotelStayType" - } - }, - "hotelStayType": { - "type": "object", - "description": "Type provides the hotel stay information.", - "properties": { - "hotelName": { - "description": "Hotel Name.", + "primaryAccountInfo": { + "description": "Contains primary account information (Profile Id, Profile Type and Profile Name) for the contacts.", + "$ref": "#/definitions/primaryProfileInfoType" + }, + "salesInfo": { + "description": "Sales information of the profile.", + "$ref": "#/definitions/salesInfoType" + }, + "additionalInfo": { + "description": "Additional Information about the profile.", + "$ref": "#/definitions/profileAdditionalInfoType" + }, + "profileType": { + "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", + "$ref": "#/definitions/profileTypeType" + }, + "subscription": { + "description": "This element tells If there is an active subscription for this external profile .", + "type": "boolean" + }, + "statusCode": { + "description": "Status of the profile. Active/Inactive", + "$ref": "#/definitions/profileStatusType" + }, + "protected": { + "description": "What level this profile is protected.", "type": "string", "minLength": 0, "maxLength": 40 }, - "pointsMiles": { - "description": "Points or Miles.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "privateProfile": { + "description": "This element tells profile is property exclusive or not.", + "type": "boolean" }, - "pointsMilesEarned": { - "description": "Guest stay points or miles earned", - "type": "string", - "minLength": 0, - "maxLength": 20 + "inheritedNegRates": { + "description": "Flag to indicate if the negotiated rates are inherited from master profile. Flag is available only when the profile is linked to master profile and master profile has negotiated rate codes attached.", + "type": "boolean" }, - "arrivalDate": { - "description": "Guest arrival date.", - "type": "string", - "format": "date", - "maxLength": 8 - } - } - }, - "roomPreferencesType": { - "type": "object", - "description": "Indicates the guest's room preferences.", - "properties": { - "bedType": { - "description": "Indicates the bed type preference.", + "createDateTime": { + "description": "Time stamp of the creation.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date-time" }, - "smoking": { - "description": "Indicates the smoking preference.", + "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": 20 + "maxLength": 200 }, - "precedence": { - "description": "Indicates which room preference takes priority, bed type or smoking type.", + "lastModifyDateTime": { + "description": "Time stamp of last modification.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date-time" }, - "floor": { - "description": "Indicates the floor type preference.", + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 200 }, - "newspapers": { - "description": "Indicates the newspaper preference.", + "registeredProperty": { + "description": "Property this profile is registered with.", "type": "string", "minLength": 0, "maxLength": 20 }, - "snack": { - "description": "Indicates the snack preference.", + "profileSourceCode": { + "description": "Original Source Code for profile. It is used as reference to identify the source of Profile.", "type": "string", "minLength": 0, - "maxLength": 20 - }, - "beverage": { - "description": "Indicates the beverage preference.", + "maxLength": 2000 + } + } + }, + "vIPStatusType": { + "type": "object", + "description": "VIP status of the customer.", + "properties": { + "value": { "type": "string", + "description": "Used for Character Strings, length 0 to 2000.", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "pillow": { - "description": "Indicates the pillow type preference.", + "code": { + "description": "VIP status of the customer.", "type": "string", "minLength": 0, "maxLength": 20 + } + } + }, + "ownersType": { + "type": "array", + "description": "Generic type for a list of owners.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/ownerType" + } + }, + "profileAllowedActionsType": { + "type": "array", + "description": "Allowed actions for profile operations.", + "maxItems": 2, + "items": { + "$ref": "#/definitions/profileAllowedActionType" + } + }, + "profileAllowedActionType": { + "type": "string", + "description": "Flag indicating whether Profile is Enrolled to Primary Membership Program.", + "enum": [ + "NameChange", + "AltNameChange", + "TaxIDChange", + "EnrollToPrimaryMembership" + ] + }, + "primaryProfileInfoType": { + "type": "object", + "description": "Contains basic information of profile.", + "properties": { + "profileId": { + "description": "Unique Identifier for OPERA Profile.", + "$ref": "#/definitions/uniqueID_Type" }, - "roomAmenities": { - "description": "Indicates the room amenities requested.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "profileType": { + "description": "Type of account such as Agent, Company, and Source.", + "$ref": "#/definitions/profileTypeType" }, - "interests": { - "description": "Indicates guest preferred interests.", + "profileName": { + "description": "Name of the account.", "type": "string", "minLength": 0, - "maxLength": 2000 - }, - "accessible": { - "description": "Indicates if the member requires accessible rooms.", - "type": "boolean" + "maxLength": 40 } } }, - "earningPreferencesType": { + "profileAdditionalInfoType": { "type": "object", - "description": "Indicates guest's rewards earning preferences.", "properties": { - "earningPreference": { - "description": "Indicates the earning preference, Points or Miles.", + "primaryOwnerCode": { + "description": "Primary Owner of the profile", "type": "string", "minLength": 0, "maxLength": 20 }, - "airline": { - "description": "Indicates preferred airline code and name.", + "territory": { + "description": "Territory associated to the profile.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 40 }, - "frequentFlyerNumber": { - "description": "Indicates frequent flyer's number of the guest.", + "masterAccount": { + "description": "Indicates if the profile is a Master Account for one or more Subsidiary Accounts.", + "type": "boolean" + }, + "subsidiaryAccount": { + "description": "Indicates if the profile is a Subsidiary Account of a Master/Parent Account.", + "type": "boolean" + }, + "businessPosition": { + "description": "Business Title or Position of the profile.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 40 } } }, - "mailingPreferencesType": { + "masterInfoType": { "type": "object", - "description": "Indicates guest's mailing preferences.", "properties": { - "eFolio": { - "description": "Defines if an E-Folio is required.", - "type": "boolean" + "codeInfo": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/codeInfoType" + } }, - "mailings": { - "description": "Defines mailings only.", - "type": "boolean" + "codeType": { + "$ref": "#/definitions/masterType" } } }, - "rewardsInfoType": { + "codeInfoType": { "type": "object", - "description": "Indicates membership base information like CurrentBalance,association and Owned card.", + "description": "", "properties": { - "mVCIOwner": { - "description": "Indicates if the member is an MVCI owner.", - "type": "string", - "minLength": 0, - "maxLength": 3 - }, - "ownsVisaCard": { - "description": "Indicates if guest owns a visa card.", - "type": "boolean" - }, - "meetingPlanner": { - "description": "Indicates if meeting planner is requested.", - "type": "boolean" - }, - "association": { - "description": "Indicates guest association.", + "description": { "type": "string", "minLength": 0, - "maxLength": 2000 - }, - "currentBalance": { - "description": "Current membership points.", - "type": "number" + "maxLength": 80 }, - "membershipId": { - "description": "Indicates membership id of the guest.", - "type": "number" + "addtionalCodeInfo": { + "$ref": "#/definitions/addtionalCodeInfoType" }, - "membershipNo": { - "description": "Indicates membership number of the guest", + "hotelId": { "type": "string", "minLength": 0, - "maxLength": 50 + "maxLength": 20 }, - "membershipLevel": { - "description": "Indicates membership level of the guest", + "code": { "type": "string", "minLength": 0, "maxLength": 20 - }, - "membershipDate": { - "description": "Indicates membership date of the guest", - "type": "string", - "format": "date", - "maxLength": 8 } } }, - "reservationId": { + "addtionalCodeInfoType": { + "type": "array", + "description": "Holds name of additional code information", + "maxItems": 4000, + "items": { + "type": "object", + "properties": { + "name": { + "description": "Holds name of additional code information", + "$ref": "#/definitions/masterInfoCodeDetailType" + }, + "value": { + "description": "Holds value of additional code information", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } + } + }, + "masterInfoCodeDetailType": { + "type": "string", + "enum": [ + "LongDescription", + "ShortDescription" + ] + }, + "masterType": { + "type": "string", + "enum": [ + "Country", + "State", + "AddressType", + "PhoneType", + "RateCategory", + "CalculationRule", + "PostingRythym", + "BillingInstruction", + "TransactionCode", + "DisplaySet", + "MailingActions", + "DistanceType", + "District", + "Territory", + "FiscalRegion", + "InventoryItem", + "Package", + "RoomFeaturePreference", + "SpecialPreference", + "Promotion", + "Department", + "ReservationPreference", + "FacilityTask", + "RoomType", + "RateCode", + "OutOfOrderReason", + "Block" + ] + }, + "profile": { "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).", + "description": "Object for creation of profiles. This object contains profile details with unique identifiers for each profile.", "properties": { - "url": { - "description": "URL that identifies the location associated with the record identified by the UniqueID.", - "type": "string" + "profileIdList": { + "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as ID.", + "$ref": "#/definitions/profileIdList" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "externalReferences": { + "description": "External Reference information for Profile.", + "$ref": "#/definitions/externalReferencesType" }, - "instance": { - "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "profileDetails": { + "description": "Provides detailed information regarding either a company or a customer profile.", + "$ref": "#/definitions/profileType" }, - "idContext": { - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "type": "string", - "minLength": 0, - "maxLength": 80 + "profileAllowedActions": { + "description": "Provides the actions needed to apply on the profile", + "$ref": "#/definitions/profileAllowedActionsType" }, - "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 + "copyInstructions": { + "description": "Indicates which details of the master profile should be copied to subsidiary profiles, when a master-sub relationship is created for profile types Company, TravelAgent and Source", + "$ref": "#/definitions/copyInstructionsType" }, - "idExtension": { - "description": "Additional identifying value assigned by the creating system.", - "type": "integer" + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "enrollmentPaymentDetailsType": { + "profileType": { "type": "object", - "description": "Payment details to enrolll profile to the membership program.", + "description": "Type provides the detailed information about the profile and its children.", "properties": { - "paymentMethod": { - "description": "Indicate which method of payment will be used for enrollment to membership program.", - "$ref": "#/definitions/codeDescriptionType" + "customer": { + "description": "Detailed customer information for this profile.", + "$ref": "#/definitions/customerType" }, - "amount": { - "description": "Amount/Fee to enroll to membership Program.", - "type": "number" + "company": { + "description": "Detailed company information for this profile.", + "$ref": "#/definitions/companyType" + }, + "profileImage": { + "description": "The profile image.", + "$ref": "#/definitions/imageSetType" + }, + "addresses": { + "description": "List of customer addresses.", + "type": "object", + "properties": { + "addressInfo": { + "description": "Collection of Detailed information on an address for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/addressInfoType" + } + }, + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "businessSegments": { + "description": "Business/Market Segment associated to the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "territory": { + "description": "Territory associated to the profile.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "amountCode": { - "description": "Code of Amount/Fee to enroll to membership Program.", - "$ref": "#/definitions/codeDescriptionType" + "traceCode": { + "description": "Trace Code associated to the profile.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "paymentDate": { - "description": "The date of Payment for enrollment to membership program.", + "ownerCode": { + "description": "Owner Code associated to the profile.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 40 }, - "comments": { - "description": "Payment Comments.", + "influenceCode": { + "description": "Influence Code associated to the profile.", "type": "string", "minLength": 0, - "maxLength": 4000 - } - } - }, - "enrollmentTypeType": { - "type": "string", - "description": "The type of external system that the guest is enrolling in, such as Loyalty, Gaming or Activities.", - "enum": [ - "Gaming", - "Loyalty", - "Activities" - ] - }, - "profileSummaryInfoType": { - "type": "object", - "description": "Summary information about a profile and the associated Unique IDs.", - "properties": { - "profileIdList": { - "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code.", - "$ref": "#/definitions/profileIdList" + "maxLength": 40 }, - "profile": { - "description": "Provides summary information regarding profile.", - "$ref": "#/definitions/profileSummaryType" - } - } - }, - "profileSummaryType": { - "type": "object", - "description": "Type provides the basic information about the profile.", - "properties": { - "formerName": { - "description": "This provides name information for a person.", + "telephones": { + "description": "List of Telephone Number Information", "type": "object", "properties": { - "name": { - "description": "Family name, last name or Company Name.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "telephoneInfo": { + "description": "Collection of Detailed information on telephone/fax for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/telephoneInfoType" + } }, - "fullName": { - "description": "Full display Name.", - "type": "string", - "minLength": 0, - "maxLength": 200 + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "namePrefix": { - "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)", - "type": "string", - "minLength": 0, - "maxLength": 40 + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "emails": { + "description": "List of email address for the customer.", + "type": "object", + "properties": { + "emailInfo": { + "description": "Collection of Detailed information on an eMail address for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/emailInfoType" + } }, - "givenName": { - "description": "Given name, first name or names.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "middleName": { - "description": "The middle name of the person name.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "uRLs": { + "description": "List of Information on a URL for the customer.", + "type": "object", + "properties": { + "uRLInfo": { + "description": "Collection of Detailed information on web url/address for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/uRLInfoType" + } }, - "nameSuffix": { - "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)", - "type": "string", - "minLength": 0, - "maxLength": 40 + "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" }, - "nameTitle": { - "description": "Degree or honors (e.g., Ph.D., M.D.)", - "type": "string", - "minLength": 0, - "maxLength": 80 + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "nameType": { - "description": "Type of name of the individual, such as former, nickname, alternate or alias name.", - "$ref": "#/definitions/personNameTypeType" + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "comments": { + "description": "List of Notes for the customer.", + "type": "object", + "properties": { + "commentInfo": { + "description": "Collection of Detailed information on comments for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/commentInfoType" + } }, - "gender": { - "description": "Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "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" }, - "birthDate": { - "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", - "type": "string", - "format": "date", - "maxLength": 8 + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "birthDateMasked": { - "description": "Indicates the date of birth as masked.", - "type": "string" + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "profileDeliveryMethods": { + "description": "List of Delivery methods configured against a Property for this Profile.", + "type": "object", + "properties": { + "profileDeliveryMethod": { + "description": "Collection of delivery methods for this Profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileDeliveryMethod" + } }, - "currencyCode": { - "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "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" }, - "currencySymbol": { - "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", - "type": "string", - "minLength": 0, - "maxLength": 10 + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "decimalPlaces": { - "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", + "count": { + "description": "Total number of rows returned", "type": "integer" + } + } + }, + "profileMemberships": { + "description": "List of loyalty program(s) the profile is subscribed to.", + "type": "object", + "properties": { + "profileMembership": { + "description": "Collection of Detailed information on memberships for the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileMembershipType" + } }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "customerValue": { - "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).", - "type": "string", - "minLength": 0, - "maxLength": 20 + "count": { + "description": "Total number of rows returned", + "type": "integer" } } }, - "altName": { - "description": "Profile Name information for this profile.", - "$ref": "#/definitions/profileNameType" - }, - "anonymization": { - "description": "Provides information about the guest's anonymization status", - "$ref": "#/definitions/anonymizationType" - }, - "addressInfo": { - "description": "Detailed information on an address for the customer.", - "$ref": "#/definitions/addressInfoType" - }, - "telephoneInfo": { - "description": "Detailed information on telephone/ fax for the customer.", - "$ref": "#/definitions/telephoneInfoType" - }, - "emailInfo": { - "description": "Detailed information on an eMail address for the customer.", - "$ref": "#/definitions/emailInfoType" + "preferenceCollection": { + "description": "List of customer preferences.", + "type": "object", + "properties": { + "preferenceType": { + "description": "Collection of Detailed information on preferences of the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/preferenceTypeType" + } + }, + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } }, - "profileMembership": { - "description": "Information on membership for the customer.", - "$ref": "#/definitions/profileMembershipType" + "keywords": { + "description": "List of customer keywords.", + "type": "object", + "properties": { + "keyword": { + "description": "Collection of keywords attached to the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/keywordType" + } + }, + "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" + } + } }, - "uRLInfo": { - "description": "Detailed information on web url/address for the customer.", - "$ref": "#/definitions/uRLInfoType" + "negotiatedRates": { + "description": "List of profile negotiated rates.", + "type": "object", + "properties": { + "negotiatedRate": { + "description": "Collection of Detailed information on profile negotiated rates.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/negotiatedType" + } + }, + "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" + } + } }, - "citizenCountry": { - "description": "Name of the (self-professed) country that is claimed for citizenship.", - "$ref": "#/definitions/countryNameType" + "gdsNegotiatedRates": { + "description": "List of channel negotiated rates that this profile has been assigned to.", + "type": "object", + "properties": { + "gdsNegotiatedRate": { + "description": "Collection of Detailed information on channel negotiated rates for the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/gdsNegotiatedType" + } + }, + "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" + } + } }, "profileIndicators": { "description": "Indicators of additional information attached to the profile", "$ref": "#/definitions/indicatorsType" }, - "searchMatches": { - "description": "Super Search matching terms.", - "$ref": "#/definitions/searchMatchesType" + "relationships": { + "description": "Contains a collection of profiles that have a relationship with this profile.", + "type": "object", + "properties": { + "relationship": { + "description": "A collection of the profiles that have a relationship with this profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/relationshipInfoType" + } + }, + "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" + } + } + }, + "relationshipsSummary": { + "description": "Contains a collection of profiles that have a relationship with this profile.", + "type": "object", + "properties": { + "relationship": { + "description": "A collection of the profiles summary that have a relationship with this profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/relationshipInfoSummaryType" + } + }, + "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" + } + } + }, + "stayReservationInfoList": { + "description": "Collection of Detailed information on history and future reservations associated with the profile.", + "$ref": "#/definitions/reservationStayHistoryFutureInfoType" + }, + "lastStayInfo": { + "description": "Information on last stay of the profile.", + "$ref": "#/definitions/lastStayInfoType" }, "profileAccessType": { - "description": "Detailed information on access type associated with the profile.Information on whether the profile is created in CRO/Hotel/Chain.", + "description": "Detailed information on access type associated with the profile.", "$ref": "#/definitions/profileAccessType" }, "profileRestrictions": { "description": "Detailed information on restrictions associated with the profile.", "$ref": "#/definitions/profileRestrictions" }, - "vipStatus": { - "description": "VIP status of the customer.", - "$ref": "#/definitions/vIPStatusType" + "mailingActions": { + "description": "Contains collection of mailing action list associated with the profile", + "$ref": "#/definitions/mailingActionsType" }, - "owners": { - "description": "Owner of the customer.", - "$ref": "#/definitions/ownersType" + "privacyInfo": { + "description": "Contains privacy related information associated with the profile", + "$ref": "#/definitions/privacyInfoType" }, - "primaryCompany": { - "description": "Primary Company of the profile.", - "type": "string" + "cashiering": { + "description": "Contains cashiering related details for the profile", + "$ref": "#/definitions/profileCashieringType" }, - "aRAccount": { - "description": "AR Account information.", - "$ref": "#/definitions/directBillingType" + "commissionInfoList": { + "description": "Contains commission related details for the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileCommissionType" + } }, - "commission": { - "description": "Commission Code and description of the requested HotelCode.", - "$ref": "#/definitions/codeDescriptionType" + "userDefinedFields": { + "description": "Collections of user defined fields.", + "$ref": "#/definitions/userDefinedFieldsType" + }, + "webUserAccounts": { + "description": "List of Web User Accounts of the profile.", + "$ref": "#/definitions/webUserAccountsType" }, "taxInfo": { "description": "Profile information about tax.", "$ref": "#/definitions/profileTaxInfoType" }, - "cashiering": { - "description": "Contains cashiering related details for the profile", - "$ref": "#/definitions/profileCashieringType" + "salesInfo": { + "description": "Sales information of the profiles.", + "$ref": "#/definitions/salesInfoType" }, - "lastStayInfo": { - "description": "Information on last stay of the profile.", - "$ref": "#/definitions/lastStayInfoType" + "eCertificates": { + "description": "E-Certificate assosiated with the profile.", + "$ref": "#/definitions/eCertificatesType" }, - "allowedActions": { - "description": "Collection of allowed actions for profile search.", - "$ref": "#/definitions/profileAllowedActionsType" + "subscriptions": { + "description": "List of profile subscriptions.", + "$ref": "#/definitions/profileSubscriptionListType" }, - "primaryAccountInfo": { - "description": "Contains primary account information (Profile Id, Profile Type and Profile Name) for the contacts.", - "$ref": "#/definitions/primaryProfileInfoType" + "localizationGuestType": { + "description": "Localization Guest Type assocaited to the profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "salesInfo": { - "description": "Sales information of the profile.", - "$ref": "#/definitions/salesInfoType" + "eligibleForFiscalFolio": { + "description": "Eligible for Fiscal Folio/Payload generation.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "additionalInfo": { - "description": "Additional Information about the profile.", - "$ref": "#/definitions/profileAdditionalInfoType" + "roomOwnershipsList": { + "description": "Room Ownership records.", + "type": "object", + "properties": { + "roomOwnershipInfo": { + "description": "Collection of Detailed information on Room Ownership records.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/roomOwnershipType" + } + }, + "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" + } + } }, "profileType": { "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", "$ref": "#/definitions/profileTypeType" }, - "subscription": { - "description": "This element tells If there is an active subscription for this external profile .", - "type": "boolean" - }, "statusCode": { "description": "Status of the profile. Active/Inactive", "$ref": "#/definitions/profileStatusType" }, - "protected": { - "description": "What level this profile is protected.", + "inactiveReason": { + "description": "Inactive reason associated with the current profile.", "type": "string", "minLength": 0, - "maxLength": 40 + "maxLength": 20 }, - "privateProfile": { - "description": "This element tells profile is property exclusive or not.", - "type": "boolean" + "registeredProperty": { + "description": "Hotel which this profile is registered with. This attribute is not used for configuration.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "inheritedNegRates": { - "description": "Flag to indicate if the negotiated rates are inherited from master profile. Flag is available only when the profile is linked to master profile and master profile has negotiated rate codes attached.", - "type": "boolean" + "requestForHotel": { + "description": "Hotel which this profile is to be registered. This attribute is only used during creation of profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "protectedBy": { + "description": "What level this profile is protected.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, "createDateTime": { "description": "Time stamp of the creation.", @@ -27761,236 +31933,210 @@ "minLength": 0, "maxLength": 200 }, - "registeredProperty": { - "description": "Property this profile is registered with.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "markAsRecentlyAccessed": { + "description": "Mark this profile as recently accessed.", + "type": "boolean" }, - "profileSourceCode": { - "description": "Original Source Code for profile. It is used as reference to identify the source of Profile.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - } - } - }, - "vIPStatusType": { - "type": "object", - "description": "VIP status of the customer.", - "properties": { - "value": { - "type": "string", - "description": "Used for Character Strings, length 0 to 2000.", - "minLength": 0, - "maxLength": 2000 + "markForHistory": { + "description": "\"true\" setting marks the profile to be kept from being purged, once the profile is marked inactive.", + "type": "boolean" }, - "code": { - "description": "VIP status of the customer.", + "hasCommission": { + "description": "Populates true if the profile has commission configured false otherwise.", + "type": "boolean" + }, + "inheritedNegRates": { + "description": "Flag to indicate if the negotiated rates are inherited from master profile. Flag is available only when the profile is linked to master profile and master profile has negotiated rate codes attached.", + "type": "boolean" + }, + "showInactiveRoomOwners": { + "description": "Flag to show inactive Room Owners.", + "type": "boolean" + }, + "fiscalGuestType": { + "description": "Fiscal Guest Type is used for Fiscal Folio funcionality", "type": "string", "minLength": 0, "maxLength": 20 + }, + "internalFolio": { + "description": "Flag considered during folio settlement, to select the corresponding Folio Type when the value is true. Only used in Poland country mode.", + "type": "boolean" } } }, - "ownersType": { - "type": "array", - "description": "Generic type for a list of owners.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/ownerType" - } + "awardKindType": { + "type": "string", + "description": "Indicates that this is electronic certificate.", + "enum": [ + "Paper", + "ECertificate" + ] }, - "profileAllowedActionsType": { - "type": "array", - "description": "Allowed actions for profile operations.", - "maxItems": 2, - "items": { - "$ref": "#/definitions/profileAllowedActionType" - } + "reservationCertificateType": { + "type": "string", + "description": "Certificate is incentive.", + "enum": [ + "Reward", + "Incentive" + ] }, - "profileAllowedActionType": { + "rewardCertificateType": { "type": "string", - "description": "Flag indicating whether Profile is Enrolled to Primary Membership Program.", + "description": "Point Saver reward.", "enum": [ - "NameChange", - "AltNameChange", - "TaxIDChange", - "EnrollToPrimaryMembership" + "Regular", + "StayAnytime", + "PointSaver" ] }, - "primaryProfileInfoType": { + "awardStatusType": { + "type": "string", + "description": "Indicates that certificate is in use.", + "enum": [ + "Available", + "NotAvailable", + "InUse" + ] + }, + "fBAInfoType": { "type": "object", - "description": "Contains basic information of profile.", + "description": "FBA ( Flexible Benefits Awards ) related fields.", "properties": { - "profileId": { - "description": "Unique Identifier for OPERA Profile.", - "$ref": "#/definitions/uniqueID_Type" + "status": { + "description": "Possible FBA statuses.", + "$ref": "#/definitions/fBAStatusType" }, - "profileType": { - "description": "Type of account such as Agent, Company, and Source.", - "$ref": "#/definitions/profileTypeType" + "monetaryValue": { + "description": "Award's FBA monetary values.", + "type": "number" }, - "profileName": { - "description": "Name of the account.", - "type": "string", - "minLength": 0, - "maxLength": 40 - } - } - }, - "profileAdditionalInfoType": { - "type": "object", - "properties": { - "primaryOwnerCode": { - "description": "Primary Owner of the profile", + "amount": { + "description": "Award's FBA amount.", + "type": "number" + }, + "postedAmount": { + "description": "Award's FBA posted amount.", + "type": "number" + }, + "reimbursedAmount": { + "description": "Award's FBA reimbursed amount.", + "type": "number" + }, + "postingDateTime": { + "description": "Date and time of the FBA posting.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date", + "maxLength": 8 }, - "territory": { - "description": "Territory associated to the profile.", + "postingBusinessDate": { + "description": "Business date of the FBA posting.", "type": "string", - "minLength": 0, - "maxLength": 40 + "format": "date", + "maxLength": 8 }, - "masterAccount": { - "description": "Indicates if the profile is a Master Account for one or more Subsidiary Accounts.", - "type": "boolean" + "settlementDateTime": { + "description": "Date and time of the FBA settlement.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "subsidiaryAccount": { - "description": "Indicates if the profile is a Subsidiary Account of a Master/Parent Account.", - "type": "boolean" + "settlementBusinessDate": { + "description": "Business date of the FBA settlement.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "businessPosition": { - "description": "Business Title or Position of the profile.", + "reimbursementDateTime": { + "description": "Date and time of the FBA reimbursement.", "type": "string", - "minLength": 0, - "maxLength": 40 - } - } - }, - "masterInfoType": { - "type": "object", - "properties": { - "codeInfo": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/codeInfoType" - } + "format": "date", + "maxLength": 8 }, - "codeType": { - "$ref": "#/definitions/masterType" - } - } - }, - "codeInfoType": { - "type": "object", - "description": "", - "properties": { - "description": { + "reimbursementBusinessDate": { + "description": "Business date of the FBA reimbursement.", "type": "string", - "minLength": 0, - "maxLength": 80 + "format": "date", + "maxLength": 8 }, - "addtionalCodeInfo": { - "$ref": "#/definitions/addtionalCodeInfoType" + "fbaBillGenDate": { + "description": "Business date of the FBA bill generation.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "hotelId": { + "currencyCode": { + "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", "type": "string", "minLength": 0, "maxLength": 20 }, - "code": { + "currencySymbol": { + "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", "type": "string", "minLength": 0, - "maxLength": 20 - } - } - }, - "addtionalCodeInfoType": { - "type": "array", - "description": "Holds name of additional code information", - "maxItems": 4000, - "items": { - "type": "object", - "properties": { - "name": { - "description": "Holds name of additional code information", - "$ref": "#/definitions/masterInfoCodeDetailType" - }, - "value": { - "description": "Holds value of additional code information", - "type": "string", - "minLength": 0, - "maxLength": 2000 - } + "maxLength": 10 + }, + "decimalPlaces": { + "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", + "type": "integer" + }, + "flexibleBenefitAward": { + "description": "Indicates if this certificate is a Flexible Benefit Award certificate.", + "type": "boolean" + }, + "posted": { + "description": "Indicates whether FBA has been posted.", + "type": "boolean" + }, + "settled": { + "description": "Indicates whether FBA has been settled.", + "type": "boolean" + }, + "reimbursed": { + "description": "Indicates whether FBA has been reimbursed.", + "type": "boolean" + }, + "resettleAllowed": { + "description": "Marks if the certificate is eligible for resettlement", + "type": "boolean" + }, + "reimburseAllowed": { + "description": "Marks if the certificate is eligible for reimbursement.", + "type": "boolean" + }, + "orphanCertificate": { + "description": "Indicates whether the certificate is Orphan or not.", + "type": "boolean" } } }, - "masterInfoCodeDetailType": { - "type": "string", - "enum": [ - "LongDescription", - "ShortDescription" - ] - }, - "masterType": { + "fBAStatusType": { "type": "string", + "description": "Flexible benefit award has been reimbursed.", "enum": [ - "Country", - "State", - "AddressType", - "PhoneType", - "RateCategory", - "CalculationRule", - "PostingRythym", - "BillingInstruction", - "TransactionCode", - "DisplaySet", - "MailingActions", - "DistanceType", - "District", - "Territory", - "FiscalRegion", - "InventoryItem", - "Package", - "RoomFeaturePreference", - "SpecialPreference", - "Promotion", - "Department", - "ReservationPreference", - "FacilityTask", - "RoomType", - "RateCode", - "OutOfOrderReason", - "Block" + "Ordered", + "Attached", + "Posted", + "Settled", + "Reimbursed" ] }, - "profile": { + "guest": { "type": "object", - "description": "Object for creation of profiles. This object contains profile details with unique identifiers for each profile.", + "description": "Request object for creation of guest/contact/employee profile. This object contains profile details with unique identifiers of a profile. The standard optional Opera Context element is also included.", "properties": { - "profileIdList": { - "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as ID.", + "guestIdList": { + "description": "Unique identifiers of Profile for both internal and external systems.", "$ref": "#/definitions/profileIdList" }, "externalReferences": { "description": "External Reference information for Profile.", "$ref": "#/definitions/externalReferencesType" }, - "profileDetails": { - "description": "Provides detailed information regarding either a company or a customer profile.", - "$ref": "#/definitions/profileType" - }, - "profileAllowedActions": { - "description": "Provides the actions needed to apply on the profile", - "$ref": "#/definitions/profileAllowedActionsType" - }, - "copyInstructions": { - "description": "Indicates which details of the master profile should be copied to subsidiary profiles, when a master-sub relationship is created for profile types Company, TravelAgent and Source", - "$ref": "#/definitions/copyInstructionsType" + "guestDetails": { + "description": "Provides detailed information of a customer profile.", + "$ref": "#/definitions/guestProfileType" }, "links": { "$ref": "#/definitions/links" @@ -28000,7 +32146,7 @@ } } }, - "profileType": { + "guestProfileType": { "type": "object", "description": "Type provides the detailed information about the profile and its children.", "properties": { @@ -28008,10 +32154,6 @@ "description": "Detailed customer information for this profile.", "$ref": "#/definitions/customerType" }, - "company": { - "description": "Detailed company information for this profile.", - "$ref": "#/definitions/companyType" - }, "profileImage": { "description": "The profile image.", "$ref": "#/definitions/imageSetType" @@ -28028,6 +32170,10 @@ "$ref": "#/definitions/addressInfoType" } }, + "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" @@ -28038,22 +32184,6 @@ } } }, - "businessSegments": { - "description": "Business/Market Segment associated to the profile.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "minLength": 0, - "maxLength": 20 - } - }, - "territory": { - "description": "Territory associated to the profile.", - "type": "string", - "minLength": 0, - "maxLength": 40 - }, "traceCode": { "description": "Trace Code associated to the profile.", "type": "string", @@ -28168,32 +32298,6 @@ } } }, - "profileDeliveryMethods": { - "description": "List of Delivery methods configured against a Property for this Profile.", - "type": "object", - "properties": { - "profileDeliveryMethod": { - "description": "Collection of delivery methods for this Profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileDeliveryMethod" - } - }, - "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" - } - } - }, "profileMemberships": { "description": "List of loyalty program(s) the profile is subscribed to.", "type": "object", @@ -28346,36 +32450,6 @@ } } }, - "relationshipsSummary": { - "description": "Contains a collection of profiles that have a relationship with this profile.", - "type": "object", - "properties": { - "relationship": { - "description": "A collection of the profiles summary that have a relationship with this profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/relationshipInfoSummaryType" - } - }, - "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" - } - } - }, - "stayReservationInfoList": { - "description": "Collection of Detailed information on history and future reservations associated with the profile.", - "$ref": "#/definitions/reservationStayHistoryFutureInfoType" - }, "lastStayInfo": { "description": "Information on last stay of the profile.", "$ref": "#/definitions/lastStayInfoType" @@ -28425,7 +32499,7 @@ "$ref": "#/definitions/salesInfoType" }, "eCertificates": { - "description": "E-Certificate assosiated with the profile.", + "description": "E-Certificate associated with the profile.", "$ref": "#/definitions/eCertificatesType" }, "subscriptions": { @@ -28433,7 +32507,7 @@ "$ref": "#/definitions/profileSubscriptionListType" }, "localizationGuestType": { - "description": "Localization Guest Type assocaited to the profile.", + "description": "Localization Guest Type associated to the profile.", "type": "string", "minLength": 0, "maxLength": 20 @@ -28444,45 +32518,13 @@ "minLength": 0, "maxLength": 20 }, - "roomOwnershipsList": { - "description": "Room Ownership records.", - "type": "object", - "properties": { - "roomOwnershipInfo": { - "description": "Collection of Detailed information on Room Ownership records.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/roomOwnershipType" - } - }, - "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" - } - } - }, "profileType": { - "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", - "$ref": "#/definitions/profileTypeType" + "description": "Type of profile such as Guest, Employee or Contact.", + "$ref": "#/definitions/guestProfileTypeType" }, "statusCode": { "description": "Status of the profile. Active/Inactive", - "$ref": "#/definitions/profileStatusType" - }, - "inactiveReason": { - "description": "Inactive reason associated with the current profile.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "$ref": "#/definitions/profileStatusType" }, "registeredProperty": { "description": "Hotel which this profile is registered with. This attribute is not used for configuration.", @@ -28539,191 +32581,665 @@ "inheritedNegRates": { "description": "Flag to indicate if the negotiated rates are inherited from master profile. Flag is available only when the profile is linked to master profile and master profile has negotiated rate codes attached.", "type": "boolean" + } + } + }, + "guestProfileTypeType": { + "type": "string", + "description": "The types of Profile handled by the web service.", + "enum": [ + "Guest", + "Employee", + "Contact" + ] + }, + "membershipAwardPointsByHotel": { + "type": "object", + "description": "Response object for fetching member award points by Hotel.", + "properties": { + "membershipAwardPoints": { + "description": "Collection of member award points list.", + "$ref": "#/definitions/membershipAwardPointsByHotelType" }, - "showInactiveRoomOwners": { - "description": "Flag to show inactive Room Owners.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "fiscalGuestType": { - "description": "Fiscal Guest Type is used for Fiscal Folio funcionality", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipAwardPointsByHotelType": { + "type": "array", + "description": "List of available award points information by Hotel.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipAwardPointByHotelType" + } + }, + "membershipAwardPointByHotelType": { + "type": "object", + "description": "Award points information group by Hotel.", + "properties": { + "hotelId": { + "description": "Award points issued at Property level.", "type": "string", "minLength": 0, "maxLength": 20 + }, + "totalPoints": { + "description": "Sum of total positive and negative points.", + "type": "number" } } }, - "awardKindType": { - "type": "string", - "description": "Indicates that this is electronic certificate.", - "enum": [ - "Paper", - "ECertificate" - ] + "profileCommissionAccountCopy": { + "type": "object", + "description": "Request object for copying transaction groups configuration.", + "properties": { + "profileCommissionAccountsInfo": { + "description": "List of resorts with profile commission account information to be copied.", + "$ref": "#/definitions/copyProfileCommissionInfoType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } }, - "reservationCertificateType": { + "copyProfileCommissionInfoType": { + "type": "object", + "description": "Contains base info to determine profile commission bank account and code.", + "properties": { + "hotelId": { + "description": "Hotel code from which the profile bank account and code belongs to", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "profileId": { + "description": "Unique profile identifier.", + "$ref": "#/definitions/profileId" + }, + "bankAccountId": { + "description": "Bank account ID.", + "$ref": "#/definitions/uniqueID_Type" + }, + "commissionCode": { + "description": "Profile commission code", + "$ref": "#/definitions/codeDescriptionType" + }, + "validatePending": { + "description": "Used in CRUD operations. When set to true, proceed validating pending commissions", + "type": "boolean" + }, + "targetHotelCodes": { + "description": "Property to which configuration code type to be copied to.", + "$ref": "#/definitions/codeListType" + } + } + }, + "codeListType": { + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "membershipClaim": { + "type": "object", + "description": "Request object for creating membership claim.", + "properties": { + "membershipClaimDetails": { + "$ref": "#/definitions/membershipClaimDetailsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipClaimDetailsType": { + "type": "object", + "description": "Detailed information of a claim.", + "properties": { + "claimNo": { + "description": "Unique ID Number assigned to the claim when the claim was created.", + "$ref": "#/definitions/uniqueID_Type" + }, + "claimDate": { + "description": "Date the claim was made.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "closeDate": { + "description": "If the status is closed, the date the claim was closed.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "source": { + "description": "Source of the claim. This will be either OCIS, OPMS or WEB.", + "$ref": "#/definitions/claimSourceType" + }, + "callerName": { + "description": "Name of the person placing the claim. This name may be different from the name on the membership card.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "owner": { + "description": "User who is assigned to handle this claim.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "claimStatus": { + "description": "Status of the claim.(Open, Closed, Pending Review, Waiting for Manager, etc.)", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "claimType": { + "description": "Type of user-definable claim such as New Card, Stay, etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "origin": { + "description": "Origin of the membership claim. User definable values like Email, Fax, Phone Call, etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "callerInformation": { + "description": "More information related to call that help to resolve the claim..", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "replyBy": { + "description": "The date, if any, by which a response to the caller was promised.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "comments": { + "description": "Additional comments or steps taken to resolve the claim..", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "approvalStatus": { + "description": "Filter claims by approved or rejected status.", + "$ref": "#/definitions/claimApprovalStatusType" + }, + "recordType": { + "description": "Record type of the claim.", + "$ref": "#/definitions/claimRecordType" + }, + "profileId": { + "description": "Profile ID of the membership holder.", + "$ref": "#/definitions/profileId" + }, + "membership": { + "description": "Membership Type details.", + "$ref": "#/definitions/claimMembershipType" + }, + "reservation": { + "description": "Reservation or Stay information for the claim.", + "$ref": "#/definitions/claimReservationInfoType" + }, + "claimPoints": { + "description": "Membership claims award points and tier points.", + "$ref": "#/definitions/claimAdjustmentPointsType" + }, + "activityLog": { + "description": "Contains summary information of the claim.", + "$ref": "#/definitions/claimActivityLogListType" + }, + "submitter": { + "description": "User who entered this claim.", + "type": "string", + "minLength": 0, + "maxLength": 50 + } + } + }, + "claimSourceType": { "type": "string", - "description": "Certificate is incentive.", + "description": "Source of the membership claim.", "enum": [ - "Reward", - "Incentive" + "Ocis", + "Opms", + "Web" ] }, - "rewardCertificateType": { + "claimApprovalStatusType": { "type": "string", - "description": "Point Saver reward.", + "description": "Claim approve or reject status.", "enum": [ - "Regular", - "StayAnytime", - "PointSaver" + "Approved", + "Rejected", + "Pending" ] }, - "awardStatusType": { + "claimRecordType": { "type": "string", - "description": "Indicates that certificate is in use.", + "description": "Record Type associated with a claim.", "enum": [ - "Available", - "NotAvailable", - "InUse" + "Stay", + "Other", + "LimitedAdjustment" ] }, - "fBAInfoType": { + "claimMembershipType": { "type": "object", - "description": "FBA ( Flexible Benefits Awards ) related fields.", + "description": "Summary of claim activity log information.", "properties": { - "status": { - "description": "Possible FBA statuses.", - "$ref": "#/definitions/fBAStatusType" + "nameOnCard": { + "description": "Name to be displayed on the membership card.", + "type": "string" }, - "monetaryValue": { - "description": "Award's FBA monetary values.", - "type": "number" + "membershipClass": { + "description": "Indicates the membership class.", + "type": "string" }, - "amount": { - "description": "Award's FBA amount.", - "type": "number" + "membershipId": { + "description": "Card Number of the membership.", + "type": "string" }, - "postedAmount": { - "description": "Award's FBA posted amount.", + "membershipIdNo": { + "description": "Membership ID Number.", "type": "number" }, - "reimbursedAmount": { - "description": "Award's FBA reimbursed amount.", - "type": "number" + "membershipType": { + "description": "Membership Type code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "postingDateTime": { - "description": "Date and time of the FBA posting.", + "membershipLevel": { + "description": "The current level of the membership.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "postingBusinessDate": { - "description": "Business date of the FBA posting.", + "effectiveDate": { + "description": "Indicates the starting date.", "type": "string", "format": "date", "maxLength": 8 }, - "settlementDateTime": { - "description": "Date and time of the FBA settlement.", + "expireDate": { + "description": "Indicates the ending date.", "type": "string", "format": "date", "maxLength": 8 }, - "settlementBusinessDate": { - "description": "Business date of the FBA settlement.", + "expireDateExclusiveIndicator": { + "description": "When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).", + "type": "boolean" + } + } + }, + "claimReservationInfoType": { + "type": "object", + "description": "Summary of claim activity log information.", + "properties": { + "hotelId": { + "description": "Property where the stay associated with this claim.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "reimbursementDateTime": { - "description": "Date and time of the FBA reimbursement.", + "confirmationNo": { + "description": "List of reservation confirmation or reference numbers associated with this claim. Like PMS reservation number, Central(ORS) booking number.", + "$ref": "#/definitions/uniqueIDListType" + }, + "arrival": { + "description": "Arrival date for the stay associated with this claim.", "type": "string", "format": "date", "maxLength": 8 }, - "reimbursementBusinessDate": { - "description": "Business date of the FBA reimbursement.", + "departure": { + "description": "Departure date for the stay associated with this claim.", "type": "string", "format": "date", "maxLength": 8 + } + } + }, + "claimAdjustmentPointsType": { + "type": "object", + "description": "Summary of membership claim award points and tier points.", + "properties": { + "adjustmentCode": { + "description": "The selected adjustment code's Award, Stay, Nights, and Revenue thresholds will display.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "totalBasePointsLimits": { + "description": "Total base points limits for adjustment.", + "type": "string" + }, + "baseStayLimits": { + "description": "Base stay limits for adjustment.", + "type": "string" + }, + "baseNightsLimits": { + "description": "Base nights limits for adjustment.", + "type": "string" + }, + "baseRevenueLimits": { + "description": "Base revenue limits for adjustment.", + "type": "string" + }, + "awardBasePoints": { + "description": "Base award points for adjustment.", + "type": "integer" + }, + "awardBonusPoints": { + "description": "Bonus award points for adjustment.", + "type": "integer" + }, + "awardMiscPoints": { + "description": "Miscellaneous award points for adjustment.", + "type": "integer" + }, + "awardTotalPoints": { + "description": "Total award points for adjustment.", + "type": "integer" + }, + "tierBaseStayPoints": { + "description": "Tier base stay points for adjustment.", + "type": "integer" + }, + "tierBonusStayPoints": { + "description": "Tier bonus stay points for adjustment.", + "type": "integer" + }, + "tierTotalStayPoints": { + "description": "Tier total stay points for adjustment.", + "type": "integer" + }, + "tierBaseNightsPoints": { + "description": "Tier base nights points for adjustment.", + "type": "integer" + }, + "tierBonusNightsPoints": { + "description": "Tier bonus nights points for adjustment.", + "type": "integer" + }, + "tierTotalNightsPoints": { + "description": "Tier total nights points for adjustment.", + "type": "integer" + }, + "tierBaseRevenuePoints": { + "description": "Tier Base revenue points for adjustment.", + "type": "integer" + }, + "tierBonusRevenuePoints": { + "description": "Tier Bonus revenue points for adjustment.", + "type": "integer" + }, + "tierTotalRevenuePoints": { + "description": "Tier Total tier revenue points for adjustment.", + "type": "integer" + } + } + }, + "claimActivityLogListType": { + "type": "array", + "description": "Summary of claim activity log information.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/claimActivityLogType" + } + }, + "claimActivityLogType": { + "type": "object", + "description": "Summary of claim activity log information.", + "properties": { + "sequence": { + "description": "Sequence number for claim activity.", + "type": "integer" + }, + "type": { + "description": "Claim activity type such as Reply, Call Property for Verification, Caller Called Back, and Remarks.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "comments": { + "description": "Name of the application user who created the activity record.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" + }, + "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 + }, + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 + } + } + }, + "membershipPointsToCalculate": { + "type": "object", + "description": "Request to run membership points calculation job.", + "properties": { + "membershipPointsCalculation": { + "description": "Membership point calculation details needed to run job.", + "$ref": "#/definitions/membershipPointsCalculationType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipPointsCalculationType": { + "type": "object", + "description": "Details needed for calculating membership points.", + "properties": { + "processType": { + "description": "Points Calculation Process Type.", + "$ref": "#/definitions/membershipPointsCalculationProcessType" + }, + "membershipType": { + "description": "Membership type for which point calculation process is to be run.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "awardCode": { + "description": "Award Code to be used to generate awards for the membership type. Available for Automatic Generation of Awards (Issue Awards) only.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "fbaBillGenDate": { - "description": "Business date of the FBA bill generation.", + "calculateUntilDate": { + "description": "The last date for which calculate or expire points. Available for Calculate Points and Expire Award Points only.", "type": "string", "format": "date", "maxLength": 8 + } + } + }, + "membershipPointsCalculationProcessType": { + "type": "string", + "description": "Issuing awards for guests belonging to a membership type, with a specific award code that is of Other type.", + "enum": [ + "CalculatePoints", + "ExpirePoints", + "IssueAwards" + ] + }, + "membershipTierProjections": { + "type": "object", + "description": "Response object for fetching Membership Tier Process Text.", + "properties": { + "membershipTierProjection": { + "description": "Membership tier upgrade/downgrade projection.", + "$ref": "#/definitions/membershipTierProjectionType" }, - "currencyCode": { - "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipTierProjectionType": { + "type": "object", + "description": "Membership Upgrade/Downgrade Projection.", + "properties": { + "upgrade": { + "description": "Upgrade information which includes member's next tier level requirements for next upgrade.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 32000 }, - "currencySymbol": { - "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", + "downgrade": { + "description": "Information regarding member's possible downgrades.", "type": "string", "minLength": 0, - "maxLength": 10 + "maxLength": 32000 + } + } + }, + "calculatedPoints": { + "type": "object", + "description": "Response object for fetching membership transaction points information.", + "properties": { + "calculatedPoint": { + "description": "Details of Points Accrued for the current points transaction.", + "$ref": "#/definitions/calculatedPointsType" }, - "decimalPlaces": { - "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "calculatedPointsType": { + "type": "object", + "description": "Summary of Points Accrued for current transaction.", + "properties": { + "calculatedPoint": { + "description": "Details of Points Accrued for the current points transaction.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/calculatedPointType" + } + }, + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", "type": "integer" }, - "flexibleBenefitAward": { - "description": "Indicates if this certificate is a Flexible Benefit Award certificate.", - "type": "boolean" + "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" }, - "posted": { - "description": "Indicates whether FBA has been posted.", - "type": "boolean" + "limit": { + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, - "settled": { - "description": "Indicates whether FBA has been settled.", + "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" }, - "reimbursed": { - "description": "Indicates whether FBA has been reimbursed.", - "type": "boolean" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "resettleAllowed": { - "description": "Marks if the certificate is eligible for resettlement", - "type": "boolean" + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "calculatedPointType": { + "type": "object", + "description": "Information related to a Calculated Points.", + "properties": { + "rule": { + "description": "Indicates rule description for membership rule.", + "type": "string" }, - "reimburseAllowed": { - "description": "Marks if the certificate is eligible for reimbursement.", - "type": "boolean" + "type": { + "description": "Indicates the type of points.", + "$ref": "#/definitions/rulePointsTypeType" }, - "orphanCertificate": { - "description": "Indicates whether the certificate is Orphan or not.", - "type": "boolean" + "points": { + "description": "Indicates the total award/tier points generated.", + "type": "number" + }, + "costPerNight": { + "description": "Indicates the cost incurred per minght.", + "$ref": "#/definitions/currencyAmountType" + }, + "ruleCode": { + "description": "Indicates rule code for membership rule.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "billingGroup": { + "description": "Indicates the billing group the points belong to.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "fBAStatusType": { + "rulePointsTypeType": { "type": "string", - "description": "Flexible benefit award has been reimbursed.", + "description": "Possible membership points types.", "enum": [ - "Ordered", - "Attached", - "Posted", - "Settled", - "Reimbursed" + "Base", + "Bonus" ] }, - "guest": { + "pointsRejectionReasons": { "type": "object", - "description": "Request object for creation of guest/contact/employee profile. This object contains profile details with unique identifiers of a profile. The standard optional Opera Context element is also included.", + "description": "Response object for fetching member transactions points rejection reasons information.", "properties": { - "guestIdList": { - "description": "Unique identifiers of Profile for both internal and external systems.", - "$ref": "#/definitions/profileIdList" - }, - "externalReferences": { - "description": "External Reference information for Profile.", - "$ref": "#/definitions/externalReferencesType" - }, - "guestDetails": { - "description": "Provides detailed information of a customer profile.", - "$ref": "#/definitions/guestProfileType" + "pointsRejectionReason": { + "description": "Details on rule and reason the points were not awarded for a given point transaction.", + "$ref": "#/definitions/pointsRejectionReasonsType" }, "links": { "$ref": "#/definitions/links" @@ -28733,500 +33249,533 @@ } } }, - "guestProfileType": { + "pointsRejectionReasonsType": { "type": "object", - "description": "Type provides the detailed information about the profile and its children.", + "description": "Summary of reason points were not awarded for a given points transaction.", "properties": { - "customer": { - "description": "Detailed customer information for this profile.", - "$ref": "#/definitions/customerType" - }, - "profileImage": { - "description": "The profile image.", - "$ref": "#/definitions/imageSetType" - }, - "addresses": { - "description": "List of customer addresses.", - "type": "object", - "properties": { - "addressInfo": { - "description": "Collection of Detailed information on an address for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/addressInfoType" - } - }, - "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" - } + "pointsRejectionReason": { + "description": "Details on rule and reason the points were not awarded for a given point transaction.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/pointsRejectionReasonType" } }, - "traceCode": { - "description": "Trace Code associated to the profile.", - "type": "string", - "minLength": 0, - "maxLength": 40 - }, - "ownerCode": { - "description": "Owner Code associated to the profile.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" }, - "influenceCode": { - "description": "Influence Code associated to the profile.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "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" }, - "telephones": { - "description": "List of Telephone Number Information", - "type": "object", - "properties": { - "telephoneInfo": { - "description": "Collection of Detailed information on telephone/fax for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/telephoneInfoType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - }, - "count": { - "description": "Total number of rows returned", - "type": "integer" - } - } + "limit": { + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, - "emails": { - "description": "List of email address for the customer.", - "type": "object", - "properties": { - "emailInfo": { - "description": "Collection of Detailed information on an eMail address for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/emailInfoType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - }, - "count": { - "description": "Total number of rows returned", - "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" }, - "uRLs": { - "description": "List of Information on a URL for the customer.", - "type": "object", - "properties": { - "uRLInfo": { - "description": "Collection of Detailed information on web url/address for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/uRLInfoType" - } - }, - "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" - } - } + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "comments": { - "description": "List of Notes for the customer.", - "type": "object", - "properties": { - "commentInfo": { - "description": "Collection of Detailed information on comments for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/commentInfoType" - } - }, - "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" - } - } + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "pointsRejectionReasonType": { + "type": "object", + "description": "Information related to a Points Rejection Reason summary.", + "properties": { + "rule": { + "description": "Indicates rule description for membership rule.", + "type": "string" }, - "profileMemberships": { - "description": "List of loyalty program(s) the profile is subscribed to.", - "type": "object", - "properties": { - "profileMembership": { - "description": "Collection of Detailed information on memberships for the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileMembershipType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - }, - "count": { - "description": "Total number of rows returned", - "type": "integer" - } - } + "code": { + "description": "Indicates rule code for membership rule.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "preferenceCollection": { - "description": "List of customer preferences.", - "type": "object", - "properties": { - "preferenceType": { - "description": "Collection of Detailed information on preferences of the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/preferenceTypeType" - } - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - }, - "count": { - "description": "Total number of rows returned", - "type": "integer" - } - } + "rejectionReason": { + "description": "Indicates the reason the points were not awarded (e.g. Membership level requirements not met).", + "type": "string", + "minLength": 0, + "maxLength": 200 + } + } + }, + "rates": { + "type": "object", + "description": "Response object for fetching Membership Transaction Rates information.", + "properties": { + "rate": { + "description": "Details of rate for the current points transaction.", + "$ref": "#/definitions/membershipTransactionRatesType" }, - "keywords": { - "description": "List of customer keywords.", - "type": "object", - "properties": { - "keyword": { - "description": "Collection of keywords attached to the profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/keywordType" - } - }, - "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" }, - "negotiatedRates": { - "description": "List of profile negotiated rates.", - "type": "object", - "properties": { - "negotiatedRate": { - "description": "Collection of Detailed information on profile negotiated rates.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/negotiatedType" - } - }, - "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" - } + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipTransactionRatesType": { + "type": "object", + "description": "Summary of rate details of current transaction associated with the stay.", + "properties": { + "rate": { + "description": "Details of rate for the current points transaction.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipTransactionRateType" } }, - "gdsNegotiatedRates": { - "description": "List of channel negotiated rates that this profile has been assigned to.", - "type": "object", - "properties": { - "gdsNegotiatedRate": { - "description": "Collection of Detailed information on channel negotiated rates for the profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/gdsNegotiatedType" - } - }, - "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" - } - } + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" }, - "profileIndicators": { - "description": "Indicators of additional information attached to the profile", - "$ref": "#/definitions/indicatorsType" + "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" }, - "relationships": { - "description": "Contains a collection of profiles that have a relationship with this profile.", - "type": "object", - "properties": { - "relationship": { - "description": "A collection of the profiles that have a relationship with this profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/relationshipInfoType" - } - }, - "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" - } - } + "limit": { + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, - "lastStayInfo": { - "description": "Information on last stay of the profile.", - "$ref": "#/definitions/lastStayInfoType" + "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" }, - "profileAccessType": { - "description": "Detailed information on access type associated with the profile.", - "$ref": "#/definitions/profileAccessType" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "profileRestrictions": { - "description": "Detailed information on restrictions associated with the profile.", - "$ref": "#/definitions/profileRestrictions" + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "membershipTransactionRateType": { + "type": "object", + "description": "Information related to a membership transaction rate.", + "properties": { + "fromDate": { + "description": "Indicates start date of the reservation.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "mailingActions": { - "description": "Contains collection of mailing action list associated with the profile", - "$ref": "#/definitions/mailingActionsType" + "toDate": { + "description": "Indicates end date of the reservation.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "privacyInfo": { - "description": "Contains privacy related information associated with the profile", - "$ref": "#/definitions/privacyInfoType" + "rateCode": { + "description": "Indicates the Rate code used in the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "cashiering": { - "description": "Contains cashiering related details for the profile", - "$ref": "#/definitions/profileCashieringType" + "pMSRateAmount": { + "description": "Indicates the Rate code amount in the property currency.", + "$ref": "#/definitions/currencyAmountType" }, - "commissionInfoList": { - "description": "Contains commission related details for the profile.", + "centralRateAmount": { + "description": "Indicates the Central rate amount in central currency.", + "$ref": "#/definitions/currencyAmountType" + }, + "currency": { + "description": "Indicates the Property currency code.", + "type": "string" + }, + "marketCode": { + "description": "Indicates the Market code linked to rate code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "revenues": { + "type": "object", + "description": "Response object for fetching Membership Transaction Revenue.", + "properties": { + "revenue": { + "description": "Details on stay details for current point transaction.", + "$ref": "#/definitions/membershipTransactionRevenuesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipTransactionRevenuesType": { + "type": "object", + "description": "Summary of stay details for current transaction.", + "properties": { + "revenue": { + "description": "Details on stay details for current point transaction.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/profileCommissionType" + "$ref": "#/definitions/membershipTransactionRevenueType" } }, - "userDefinedFields": { - "description": "Collections of user defined fields.", - "$ref": "#/definitions/userDefinedFieldsType" + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" }, - "webUserAccounts": { - "description": "List of Web User Accounts of the profile.", - "$ref": "#/definitions/webUserAccountsType" + "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" }, - "taxInfo": { - "description": "Profile information about tax.", - "$ref": "#/definitions/profileTaxInfoType" + "limit": { + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, - "salesInfo": { - "description": "Sales information of the profiles.", - "$ref": "#/definitions/salesInfoType" + "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" }, - "eCertificates": { - "description": "E-Certificate associated with the profile.", - "$ref": "#/definitions/eCertificatesType" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "subscriptions": { - "description": "List of profile subscriptions.", - "$ref": "#/definitions/profileSubscriptionListType" + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "membershipTransactionRevenueType": { + "type": "object", + "description": "Information related to a membership transactions Revenue.", + "properties": { + "date": { + "description": "Indicates the Date when the revenue was recognized.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "localizationGuestType": { - "description": "Localization Guest Type associated to the profile.", + "revenueType": { + "description": "Indicates the Revenue type associated to Revenue.", + "type": "string" + }, + "pMSRevenue": { + "description": "Indicates the Total PMS Revenue accrued.", + "$ref": "#/definitions/currencyAmountType" + }, + "centralRevenue": { + "description": "Indicates the Total central revenue Accrued.", + "$ref": "#/definitions/currencyAmountType" + }, + "qualified": { + "description": "Indicates if the stay is qualified for points calculation.", + "type": "boolean" + } + } + }, + "membershipTransaction": { + "type": "object", + "description": "Response object for fetching a membership transaction.", + "properties": { + "membershipTransactionDetails": { + "description": "Membership transaction details for the requested membership transaction ID.", + "$ref": "#/definitions/membershipTransactionType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipTransactionType": { + "type": "object", + "description": "Detailed transaction information related to a membership.", + "properties": { + "membershipDetails": { + "description": "Membership details for the requested membership transaction ID.", + "$ref": "#/definitions/membershipDetailsType" + }, + "membershipTransactionDetails": { + "description": "Membership transaction details for the requested membership transaction ID.", + "$ref": "#/definitions/membershipTransactionDetailsType" + } + } + }, + "membershipDetailsType": { + "type": "object", + "description": "Details of membership transactions summary such as the membership details, transactions summary, points summary, etc.", + "properties": { + "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", "minLength": 0, - "maxLength": 20 + "maxLength": 128 }, - "eligibleForFiscalFolio": { - "description": "Eligible for Fiscal Folio/Payload generation.", + "membershipId": { + "description": "Unique identifier of this membership.", + "$ref": "#/definitions/uniqueID_Type" + }, + "membershipCardNo": { + "description": "The card number associated with this membership.", "type": "string", "minLength": 0, - "maxLength": 20 - }, - "profileType": { - "description": "Type of profile such as Guest, Employee or Contact.", - "$ref": "#/definitions/guestProfileTypeType" + "maxLength": 50 }, - "statusCode": { - "description": "Status of the profile. Active/Inactive", - "$ref": "#/definitions/profileStatusType" + "membershipType": { + "description": "The type of the membership.", + "$ref": "#/definitions/codeDescriptionType" }, - "registeredProperty": { - "description": "Hotel which this profile is registered with. This attribute is not used for configuration.", + "membershipLevel": { + "description": "The current level of the membership.", "type": "string", "minLength": 0, "maxLength": 20 }, - "requestForHotel": { - "description": "Hotel which this profile is to be registered. This attribute is only used during creation of profile.", + "joinedDate": { + "description": "Date when the member enrolled for the membership.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "cardExpirationDate": { + "description": "Membership card expiration date.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "membershipTransactionDetailsType": { + "type": "object", + "description": "Detailed information related to a membership transaction.", + "properties": { + "membershipTransactionId": { + "description": "Unique identifier associated with the membership transaction.", + "$ref": "#/definitions/membershipTransactionId" + }, + "hotelId": { + "description": "Property from which the membership stay information was received.", "type": "string", "minLength": 0, "maxLength": 20 }, - "protectedBy": { - "description": "What level this profile is protected.", + "transactionType": { + "description": "The type of membership points transaction.", "type": "string", "minLength": 0, - "maxLength": 40 + "maxLength": 20 }, - "createDateTime": { - "description": "Time stamp of the creation.", + "transactionDate": { + "description": "The date when the points were calculated.", "type": "string", - "format": "date-time" + "format": "date", + "maxLength": 8 }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "reservationIdList": { + "description": "Unique reservation identifiers associated with this transaction like PMS Confirmation Number and CRS Booking Number.", + "$ref": "#/definitions/reservationIdList" + }, + "currency": { + "description": "The property currency at the originating PMS.", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 20 }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" + "stayTimeSpan": { + "description": "Arrival and Departure date for the stay.", + "$ref": "#/definitions/timeSpanType" }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", + "ratePromotion": { + "description": "Promotion code assigned on reservation.", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 20 }, - "markAsRecentlyAccessed": { - "description": "Mark this profile as recently accessed.", + "profilePromotions": { + "description": "Promotion code assigned on reservation.", + "$ref": "#/definitions/codeListType" + }, + "pointsCreditDate": { + "description": "For adjustments, the date when the points are to be credited.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "averageRateAmount": { + "description": "The average cost of the room per night.", + "type": "number" + }, + "adjustment": { + "description": "Indicates if the transaction was created as an adjustment.", "type": "boolean" }, - "markForHistory": { - "description": "\"true\" setting marks the profile to be kept from being purged, once the profile is marked inactive.", + "pointsCalculated": { + "description": "Indicates if the points have been calculated on this transaction.", "type": "boolean" }, - "hasCommission": { - "description": "Populates true if the profile has commission configured false otherwise.", + "exceptionRejected": { + "description": "Indicates if the exception points were rejected.", "type": "boolean" }, - "inheritedNegRates": { - "description": "Flag to indicate if the negotiated rates are inherited from master profile. Flag is available only when the profile is linked to master profile and master profile has negotiated rate codes attached.", + "exception": { + "description": "Indicates if the transaction was flagged as an exception.", "type": "boolean" + }, + "roomLabel": { + "description": "The room type for this transaction.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "bookedRoomLabel": { + "description": "The booked room type for this transaction.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "notes": { + "description": "Notes associated with this transaction.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "statementId": { + "description": "Statement batch ID.", + "$ref": "#/definitions/uniqueID_Type" + }, + "memberStatementId": { + "description": "Member statement batch ID.", + "$ref": "#/definitions/uniqueID_Type" + }, + "billingGroup": { + "description": "Billing group the points belong to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "baseBillingGroup": { + "description": "Base billing group the points belong to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "bonusBillingGroup": { + "description": "Bonus billing group the points belong to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "pointsCost": { + "description": "The total cost associated with points earned by this transaction.", + "type": "integer" + }, + "processingMessages": { + "description": "Messages generated by the system during points calculation.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "awardPoints": { + "description": "Details if this transaction is associated with award points.", + "$ref": "#/definitions/membershipAwardPointsType" + }, + "tierPoints": { + "description": "Details if this transaction is associated with tier points.", + "$ref": "#/definitions/membershipTransactionTierPointsType" } } }, - "guestProfileTypeType": { - "type": "string", - "description": "The types of Profile handled by the web service.", - "enum": [ - "Guest", - "Employee", - "Contact" - ] - }, - "membershipAwardPointsByHotel": { + "membershipAwardPointsType": { "type": "object", - "description": "Response object for fetching member award points by Hotel.", + "description": "Details associated with award points.", "properties": { - "membershipAwardPoints": { - "description": "Collection of member award points list.", - "$ref": "#/definitions/membershipAwardPointsByHotelType" + "basePoints": { + "description": "Total number of base award points for a membership points transaction.", + "type": "integer" }, - "links": { - "$ref": "#/definitions/links" + "bonusPoints": { + "description": "If a membership points transaction involves bonus points, the total number of bonus points.", + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "miscPoints": { + "description": "If a membership points transaction involves points imported into ORS from a third-party system, the total number of points.", + "type": "integer" + }, + "totalPoints": { + "description": "The total number of award points.", + "type": "integer" + }, + "pointsExpiryDate": { + "description": "The date until points are eligible for redemption based on membership type configuration.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "ruleCode": { + "description": "Rule Code for award points.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "membershipAwardPointsByHotelType": { - "type": "array", - "description": "List of available award points information by Hotel.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipAwardPointByHotelType" - } - }, - "membershipAwardPointByHotelType": { + "membershipTransactionTierPointsType": { "type": "object", - "description": "Award points information group by Hotel.", + "description": "Details associated with tier points.", "properties": { - "hotelId": { - "description": "Award points issued at Property level.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "baseStay": { + "description": "Total number of base stay tier points for a membership points transaction.", + "type": "integer" }, - "totalPoints": { - "description": "Sum of total positive and negative points.", - "type": "number" + "baseNights": { + "description": "Total number of base nights tier points for a membership points transaction.", + "type": "integer" + }, + "baseRevenue": { + "description": "Total number of base revenue tier points for a membership points transaction.", + "type": "integer" + }, + "bonusStay": { + "description": "The total number of bonus stay tier points.", + "type": "integer" + }, + "bonusNights": { + "description": "The total number of bonus nights tier points.", + "type": "integer" + }, + "bonusRevenue": { + "description": "The total number of bonus revenue tier points.", + "type": "integer" } } }, - "profileCommissionAccountCopy": { + "membershipAwardExportInfo": { "type": "object", - "description": "Request object for copying transaction groups configuration.", + "description": "Response object to fetch members information for Fulfillment house processing.", "properties": { - "profileCommissionAccountsInfo": { - "description": "List of resorts with profile commission account information to be copied.", - "$ref": "#/definitions/copyProfileCommissionInfoType" + "exportInfo": { + "description": "Collection of member information.", + "$ref": "#/definitions/membershipAwardsExportType" }, "links": { "$ref": "#/definitions/links" @@ -29236,53 +33785,87 @@ } } }, - "copyProfileCommissionInfoType": { + "membershipAwardsExportType": { + "type": "array", + "description": "List of member's information.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipAwardExportType" + } + }, + "membershipAwardExportType": { "type": "object", - "description": "Contains base info to determine profile commission bank account and code.", + "description": "Types holds the details of Member.", "properties": { - "hotelId": { - "description": "Hotel code from which the profile bank account and code belongs to", - "type": "string", - "minLength": 0, - "maxLength": 20 + "awardNumber": { + "description": "Award Number to identify member's information.", + "type": "number" }, - "profileId": { - "description": "Unique profile identifier.", - "$ref": "#/definitions/profileId" + "recipientInfo": { + "description": "Recipient information.", + "$ref": "#/definitions/membershipAwardRecipientInfoType" }, - "bankAccountId": { - "description": "Bank account ID.", - "$ref": "#/definitions/uniqueID_Type" + "userDefinedFields": { + "description": "Collections of user defined fields.", + "$ref": "#/definitions/userDefinedFieldsType" + } + } + }, + "membershipAwardRecipientInfoType": { + "type": "object", + "description": "Type holds details of member.", + "properties": { + "memberInfo": { + "description": "Member Name.", + "$ref": "#/definitions/profileNameType" }, - "commissionCode": { - "description": "Profile commission code", - "$ref": "#/definitions/codeDescriptionType" + "phoneNumber": { + "description": "Phone Number.", + "$ref": "#/definitions/phoneNumberType" }, - "validatePending": { - "description": "Used in CRUD operations. When set to true, proceed validating pending commissions", - "type": "boolean" + "companyName": { + "description": "It returns a Company Name,If the member is associated with a company.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "targetHotelCodes": { - "description": "Property to which configuration code type to be copied to.", - "$ref": "#/definitions/codeListType" + "addressInfo": { + "description": "Member's Mailing Address infomation.", + "$ref": "#/definitions/addressInfoType" } } }, - "codeListType": { - "type": "array", - "maxItems": 4000, - "items": { - "type": "string", - "minLength": 0, - "maxLength": 20 - } - }, - "membershipClaim": { + "membershipIssueAwards": { "type": "object", - "description": "Request object for creating membership claim.", + "description": "Response object for fetching member issued award list.", "properties": { - "membershipClaimDetails": { - "$ref": "#/definitions/membershipClaimDetailsType" + "membershipAwardsList": { + "description": "Collection of member award list.", + "$ref": "#/definitions/membershipAwardsListType" + }, + "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" @@ -29292,358 +33875,408 @@ } } }, - "membershipClaimDetailsType": { + "membershipAwardsListType": { + "type": "array", + "description": "List of Member Awards information.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipAwardListType" + } + }, + "membershipAwardListType": { "type": "object", - "description": "Detailed information of a claim.", + "description": "Information related to Member Award Issue List.", "properties": { - "claimNo": { - "description": "Unique ID Number assigned to the claim when the claim was created.", - "$ref": "#/definitions/uniqueID_Type" + "membershipId": { + "description": "Card number of the membership.", + "type": "number" }, - "claimDate": { - "description": "Date the claim was made.", + "membershipType": { + "description": "Membership type for which awards are defined.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "closeDate": { - "description": "If the status is closed, the date the claim was closed.", + "membershipLevel": { + "description": "Level of this Membership Type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "nameOnCard": { + "description": "Name to be displayed on the membership card.", + "type": "string" + }, + "joinDate": { + "description": "Joined date on the Card.", "type": "string", "format": "date", "maxLength": 8 }, - "source": { - "description": "Source of the claim. This will be either OCIS, OPMS or WEB.", - "$ref": "#/definitions/claimSourceType" - }, - "callerName": { - "description": "Name of the person placing the claim. This name may be different from the name on the membership card.", + "expireDate": { + "description": "Expiry date on the Card.", "type": "string", - "minLength": 0, - "maxLength": 100 + "format": "date", + "maxLength": 8 }, - "owner": { - "description": "User who is assigned to handle this claim.", + "membershipCardNo": { + "description": "Indicates Membership Card Number.", "type": "string", "minLength": 0, "maxLength": 50 }, - "claimStatus": { - "description": "Status of the claim.(Open, Closed, Pending Review, Waiting for Manager, etc.)", + "totalAvailablePoints": { + "description": "Total award points available for redemption.", + "type": "number" + }, + "hotelId": { + "description": "Property at which the award was issued.", "type": "string", "minLength": 0, "maxLength": 20 }, - "claimType": { - "description": "Type of user-definable claim such as New Card, Stay, etc.", + "awardNumber": { + "description": "An identifying number of the award, assigned by the system when the award was issued.", + "type": "number" + }, + "awardPoints": { + "description": "Number of points required by the award.", + "type": "number" + }, + "thresholdPoints": { + "description": "Indicates member is below the threshold limit or not to request award.", + "type": "number" + }, + "awardCode": { + "description": "Code assigned to this membership award.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 40 }, - "origin": { - "description": "Origin of the membership claim. User definable values like Email, Fax, Phone Call, etc.", + "cancelDays": { + "description": "The cancel days, set up in awards configuration that establishes the number of days before arrival when a reservation may be cancelled without an award points penalty.", + "type": "integer" + }, + "dateAwarded": { + "description": "Date when the award was issued", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "bookingNumber": { + "description": "Reservation confirmation number.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 50 }, - "callerInformation": { - "description": "More information related to call that help to resolve the claim..", + "hotelBookingNumber": { + "description": "Property Reservation number.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 30 }, - "replyBy": { - "description": "The date, if any, by which a response to the caller was promised.", + "arrivalDate": { + "description": "The arrival date of the stay for when the award is associated.", "type": "string", "format": "date", "maxLength": 8 }, - "comments": { - "description": "Additional comments or steps taken to resolve the claim..", + "cancelPenaltyPoints": { + "description": "The award points that will be deducted (based on a cancel days restriction) if the award is cancelled. (Cancel days, set up in awards configuration, and establish the number of days before arrival when a reservation may be cancelled without an award points penalty.)", + "type": "integer" + }, + "awardCancellationNumber": { + "description": "If the award was cancelled, the system-generated award cancellation number appears here.", + "type": "integer" + }, + "awardCancelDate": { + "description": "If the reservation associated with the award was cancelled, the reservation cancellation date appears here.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "actualCancelPoints": { + "description": "The number of points actually deducted from the member's total award points if there is a penalty points restriction associated with the award cancellation.", + "type": "number" + }, + "reservationCancellationNumber": { + "description": "If the reservation associated with the award was cancelled, the reservation cancellation number appears here.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 30 }, - "approvalStatus": { - "description": "Filter claims by approved or rejected status.", - "$ref": "#/definitions/claimApprovalStatusType" + "statementId": { + "description": "If this award was included on a statement, the statement ID appears here. The field is blank if the award has not yet been reported on a statement", + "type": "integer" }, - "recordType": { - "description": "Record type of the claim.", - "$ref": "#/definitions/claimRecordType" + "cancelStatementID": { + "description": "If this award was included on a statement, the cancel statement ID appears here. The field is blank if the award has not yet been reported on a statement", + "type": "integer" }, - "profileId": { - "description": "Profile ID of the membership holder.", - "$ref": "#/definitions/profileId" + "memberStatementId": { + "description": "If this award was included on a statement, the member statement ID appears here. The field is blank if the award has not yet been reported on a statement", + "type": "integer" }, - "membership": { - "description": "Membership Type details.", - "$ref": "#/definitions/claimMembershipType" + "cancelMemberStatementID": { + "description": "If this award was included on a statement, the cancel member statement ID appears here. The field is blank if the award has not yet been reported on a statement", + "type": "integer" }, - "reservation": { - "description": "Reservation or Stay information for the claim.", - "$ref": "#/definitions/claimReservationInfoType" + "numberOfNights": { + "description": "Number of nights cancel policy is applicable.", + "type": "integer" }, - "claimPoints": { - "description": "Membership claims award points and tier points.", - "$ref": "#/definitions/claimAdjustmentPointsType" + "stayDate": { + "description": "The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award", + "type": "string", + "format": "date", + "maxLength": 8 }, - "activityLog": { - "description": "Contains summary information of the claim.", - "$ref": "#/definitions/claimActivityLogListType" + "departureDate": { + "description": "The date of the departure of the reservation associated with the award. There may be more than one date (multiple nights) associated with award", + "type": "string", + "format": "date", + "maxLength": 8 }, - "submitter": { - "description": "User who entered this claim.", + "cancelPolicyType": { + "description": "Type of cancel policy.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "awardSource": { + "description": "The source for the reservation associated with the award.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "calculatedCancelPoints": { + "description": "Total calculated points to cancel an issued award.", + "type": "number" + }, + "awardBasedOn": { + "description": "Indicates if the Award is based on RATE, PRODUCT,UPGRADE,FT or OTHER.", + "$ref": "#/definitions/membershipAwardBasedOnType" + }, + "pmsResvNo": { + "description": "Indicates PMS Reservation Number.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "crsBookNo": { + "description": "Indicates CRS Booking Number.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "product": { + "description": "Indicates the Product associated with the award.", "type": "string", "minLength": 0, "maxLength": 50 + }, + "ratePlanCode": { + "description": "Rate plan code associated with the award.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "claimSourceType": { - "type": "string", - "description": "Source of the membership claim.", - "enum": [ - "Ocis", - "Opms", - "Web" - ] - }, - "claimApprovalStatusType": { - "type": "string", - "description": "Claim approve or reject status.", - "enum": [ - "Approved", - "Rejected", - "Pending" - ] - }, - "claimRecordType": { + "membershipAwardBasedOnType": { "type": "string", - "description": "Record Type associated with a claim.", + "description": "This award allows a guest to apply available membership points towards the balance of his or her bill.", "enum": [ - "Stay", + "Rate", + "Product", + "Upgrade", "Other", - "LimitedAdjustment" + "Ft" ] }, - "claimMembershipType": { + "membershipClaims": { "type": "object", - "description": "Summary of claim activity log information.", + "description": "Response object for fetching membership claims.", "properties": { - "nameOnCard": { - "description": "Name to be displayed on the membership card.", - "type": "string" + "membershipClaimsDetail": { + "description": "A collection of membership claims.", + "$ref": "#/definitions/membershipClaimSummaryListType" }, - "membershipClass": { - "description": "Indicates the membership class.", - "type": "string" + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" }, - "membershipId": { - "description": "Card Number of the membership.", - "type": "string" + "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" }, - "membershipIdNo": { - "description": "Membership ID Number.", - "type": "number" + "limit": { + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, - "membershipType": { - "description": "Membership Type code.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "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" }, - "membershipLevel": { - "description": "The current level of the membership.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "effectiveDate": { - "description": "Indicates the starting date.", - "type": "string", - "format": "date", - "maxLength": 8 + "count": { + "description": "Total number of rows returned", + "type": "integer" }, - "expireDate": { - "description": "Indicates the ending date.", - "type": "string", - "format": "date", - "maxLength": 8 + "links": { + "$ref": "#/definitions/links" }, - "expireDateExclusiveIndicator": { - "description": "When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "claimReservationInfoType": { + "membershipClaimSummaryListType": { + "type": "array", + "description": "Contains summary information of the claim.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipClaimSummaryType" + } + }, + "membershipClaimSummaryType": { "type": "object", - "description": "Summary of claim activity log information.", + "description": "Summary information of a claim.", "properties": { - "hotelId": { - "description": "Property where the stay associated with this claim.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "confirmationNo": { - "description": "List of reservation confirmation or reference numbers associated with this claim. Like PMS reservation number, Central(ORS) booking number.", - "$ref": "#/definitions/uniqueIDListType" + "claimNo": { + "description": "Unique ID Number assigned to the claim when the claim was created.", + "$ref": "#/definitions/uniqueID_Type" }, - "arrival": { - "description": "Arrival date for the stay associated with this claim.", + "claimDate": { + "description": "Date the claim was made.", "type": "string", "format": "date", "maxLength": 8 }, - "departure": { - "description": "Departure date for the stay associated with this claim.", + "callerName": { + "description": "Name of the person placing the claim. This name may be different from the name on the membership card.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "replyBy": { + "description": "The date, if any, by which a response to the caller was promised.", "type": "string", "format": "date", "maxLength": 8 - } - } - }, - "claimAdjustmentPointsType": { - "type": "object", - "description": "Summary of membership claim award points and tier points.", - "properties": { - "adjustmentCode": { - "description": "The selected adjustment code's Award, Stay, Nights, and Revenue thresholds will display.", + }, + "membershipType": { + "description": "Membership Type code.", "type": "string", "minLength": 0, "maxLength": 20 }, - "totalBasePointsLimits": { - "description": "Total base points limits for adjustment.", - "type": "string" - }, - "baseStayLimits": { - "description": "Base stay limits for adjustment.", - "type": "string" - }, - "baseNightsLimits": { - "description": "Base nights limits for adjustment.", - "type": "string" - }, - "baseRevenueLimits": { - "description": "Base revenue limits for adjustment.", - "type": "string" - }, - "awardBasePoints": { - "description": "Base award points for adjustment.", - "type": "integer" - }, - "awardBonusPoints": { - "description": "Bonus award points for adjustment.", - "type": "integer" - }, - "awardMiscPoints": { - "description": "Miscellaneous award points for adjustment.", - "type": "integer" - }, - "awardTotalPoints": { - "description": "Total award points for adjustment.", - "type": "integer" - }, - "tierBaseStayPoints": { - "description": "Tier base stay points for adjustment.", - "type": "integer" + "membershipId": { + "description": "Indicates membership card number of the guest.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "tierBonusStayPoints": { - "description": "Tier bonus stay points for adjustment.", - "type": "integer" + "claimStatus": { + "description": "Status of the claim.(Open, Closed, Pending Review, Waiting for Manager, etc.)", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "tierTotalStayPoints": { - "description": "Tier total stay points for adjustment.", - "type": "integer" + "claimType": { + "description": "Type of user-definable claim such as New Card, Stay, etc.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "tierBaseNightsPoints": { - "description": "Tier base nights points for adjustment.", - "type": "integer" + "closeDate": { + "description": "If the status is closed, the date the claim was closed.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "tierBonusNightsPoints": { - "description": "Tier bonus nights points for adjustment.", - "type": "integer" + "recordType": { + "description": "Record type of the claim.", + "$ref": "#/definitions/claimRecordType" }, - "tierTotalNightsPoints": { - "description": "Tier total nights points for adjustment.", - "type": "integer" + "hotelId": { + "description": "Property where the stay took place.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "tierBaseRevenuePoints": { - "description": "Tier Base revenue points for adjustment.", - "type": "integer" + "confirmationNo": { + "description": "List of reservation confirmation or reference numbers associated with this claim. Like PMS reservation number, Central(ORS) booking number.", + "$ref": "#/definitions/uniqueIDListType" }, - "tierBonusRevenuePoints": { - "description": "Tier Bonus revenue points for adjustment.", - "type": "integer" + "arrival": { + "description": "Arrival date for the stay associated with this claim.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "tierTotalRevenuePoints": { - "description": "Tier Total tier revenue points for adjustment.", - "type": "integer" - } - } - }, - "claimActivityLogListType": { - "type": "array", - "description": "Summary of claim activity log information.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/claimActivityLogType" - } - }, - "claimActivityLogType": { - "type": "object", - "description": "Summary of claim activity log information.", - "properties": { - "sequence": { - "description": "Sequence number for claim activity.", - "type": "integer" + "departure": { + "description": "Departure date for the stay associated with this claim.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "type": { - "description": "Claim activity type such as Reply, Call Property for Verification, Caller Called Back, and Remarks.", + "owner": { + "description": "User who is assigned to handle this claim.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 50 }, - "comments": { - "description": "Name of the application user who created the activity record.", + "submitter": { + "description": "User who entered this claim.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 50 }, - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" + "source": { + "description": "Source of the claim. This will be either OCIS, OPMS or WEB.", + "$ref": "#/definitions/claimSourceType" }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "origin": { + "description": "Origin of the membership claim. User definable values like Email, Fax, Phone Call, etc.", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 20 }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" + "approvalStatus": { + "description": "Filter claims by approved,rejected or pending status.", + "$ref": "#/definitions/claimApprovalStatusType" }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", + "callerInformation": { + "description": "More information related to call that help to resolve the claim..", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 2000 + }, + "profileId": { + "description": "Unique ID of the profile.", + "$ref": "#/definitions/profileId" + }, + "membershipIdNo": { + "description": "Membership ID Number.", + "type": "number" + }, + "activityLog": { + "description": "Contains summary information of the claim.", + "$ref": "#/definitions/claimActivityLogListType" } } }, - "membershipPointsToCalculate": { + "fulfillmentExportedLogs": { "type": "object", - "description": "Request to run membership points calculation job.", + "description": "Optional elements whether to update exclude extract or delivery status in membership fulfillment", "properties": { - "membershipPointsCalculation": { - "description": "Membership point calculation details needed to run job.", - "$ref": "#/definitions/membershipPointsCalculationType" + "fulfillmentExportLogs": { + "description": "This type holds list of export logs information for the membership fulfillment .", + "$ref": "#/definitions/fulfillmentExportLogsType" }, "links": { "$ref": "#/definitions/links" @@ -29653,50 +34286,78 @@ } } }, - "membershipPointsCalculationType": { + "fulfillmentExportLogsType": { + "type": "array", + "description": "This type holds the export log information for the membership fulfillment record.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/fulfillmentExportInfoType" + } + }, + "fulfillmentExportInfoType": { "type": "object", - "description": "Details needed for calculating membership points.", + "description": "This type holds the export log information for the membership fulfillment record.", "properties": { - "processType": { - "description": "Points Calculation Process Type.", - "$ref": "#/definitions/membershipPointsCalculationProcessType" + "extractLogId": { + "description": "Unique Id that references an object uniquely in the fulfillment export logs table.", + "$ref": "#/definitions/uniqueID_Type" }, - "membershipType": { - "description": "Membership type for which point calculation process is to be run.", + "membershipId": { + "description": "Id Number of the membership.", + "$ref": "#/definitions/uniqueID_Type" + }, + "membershipCard": { + "description": "The card number for the guest membership.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 50 }, - "awardCode": { - "description": "Award Code to be used to generate awards for the membership type. Available for Automatic Generation of Awards (Issue Awards) only.", + "extractCode": { + "description": "ExtractCode of the membership fulfillment export logs.", "type": "string", "minLength": 0, - "maxLength": 40 + "maxLength": 20 }, - "calculateUntilDate": { - "description": "The last date for which calculate or expire points. Available for Calculate Points and Expire Award Points only.", + "extractDate": { + "description": "ExtractDate of the membership fulfillment export logs.", "type": "string", "format": "date", "maxLength": 8 + }, + "deliveryStatus": { + "description": "The Delivery Status for export logs will default to \"Unknown.\"(Unknown/Delivered/NotDelivered).", + "$ref": "#/definitions/exportLogsDeliveryStatusType" + }, + "extractId": { + "description": "ExtractId of Membership Extracts.", + "$ref": "#/definitions/uniqueID_Type" + }, + "extractBatchId": { + "description": "Export run will populate the Extract Batch Id in export logs.", + "$ref": "#/definitions/uniqueID_Type" + }, + "excludeExtract": { + "description": "To exclude the extract record from membership exports. Once the membership export has run, this check box will be grayed out and the extract batch Id will be populated in the Extract Batch Id read-only field.", + "type": "boolean" } } }, - "membershipPointsCalculationProcessType": { + "exportLogsDeliveryStatusType": { "type": "string", - "description": "Issuing awards for guests belonging to a membership type, with a specific award code that is of Other type.", + "description": "Delivery Status for export logs - Not Delivered.", "enum": [ - "CalculatePoints", - "ExpirePoints", - "IssueAwards" + "Unknown", + "Delivered", + "Notdelivered" ] }, - "membershipTierProjections": { + "memberPointsToExpire": { "type": "object", - "description": "Response object for fetching Membership Tier Process Text.", + "description": "Response object for fetching member points to expire information.", "properties": { - "membershipTierProjection": { - "description": "Membership tier upgrade/downgrade projection.", - "$ref": "#/definitions/membershipTierProjectionType" + "memberPointsToExpireList": { + "description": "Collection of member points to expire.", + "$ref": "#/definitions/memberPointsToExpireListType" }, "links": { "$ref": "#/definitions/links" @@ -29706,31 +34367,56 @@ } } }, - "membershipTierProjectionType": { + "memberPointsToExpireListType": { + "type": "array", + "description": "List of of member points to expire.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/memberPointToExpireType" + } + }, + "memberPointToExpireType": { "type": "object", - "description": "Membership Upgrade/Downgrade Projection.", + "description": "Information related to a member point to expire.", "properties": { - "upgrade": { - "description": "Upgrade information which includes member's next tier level requirements for next upgrade.", + "pointsExpiryDate": { + "description": "The date when the member future award points will expire.", "type": "string", - "minLength": 0, - "maxLength": 32000 + "format": "date", + "maxLength": 8 }, - "downgrade": { - "description": "Information regarding member's possible downgrades.", + "pointsToExpire": { + "description": "Displays the total number of points that will expire on the expiration date.", + "type": "integer" + }, + "previousPointsToExpire": { + "description": "Displays the number of points that are relevant for extension. Points that were already extended from the previous year are not considered for extension.", + "type": "integer" + }, + "extend": { + "description": "Indicates if the points is extendable.", + "type": "boolean" + }, + "awardGenerationMethod": { + "description": "The method of award generation.", "type": "string", "minLength": 0, - "maxLength": 32000 + "maxLength": 20 } } }, - "calculatedPoints": { + "extendMemberPointsToExpire": { "type": "object", - "description": "Response object for fetching membership transaction points information.", + "description": "Request object to extend a member points to expire.", "properties": { - "calculatedPoint": { - "description": "Details of Points Accrued for the current points transaction.", - "$ref": "#/definitions/calculatedPointsType" + "membershipId": { + "description": "Unique Membership ID.", + "type": "number" + }, + "expirationDate": { + "description": "Expiration date to be extended.", + "type": "string", + "format": "date" }, "links": { "$ref": "#/definitions/links" @@ -29740,169 +34426,215 @@ } } }, - "calculatedPointsType": { + "membershipTransactionsSummary": { "type": "object", - "description": "Summary of Points Accrued for current transaction.", + "description": "Response object for fetching member point totals information.", "properties": { - "calculatedPoint": { - "description": "Details of Points Accrued for the current points transaction.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/calculatedPointType" - } - }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", - "type": "integer" + "membershipDetails": { + "description": "Member details for the requested membership ID.", + "$ref": "#/definitions/membershipDetailsType" }, - "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" + "transactionsSummary": { + "description": "Member transaction Summary for the requested membership ID.", + "$ref": "#/definitions/memberTransactionSummaryType" }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "recentTransactionsSummary": { + "description": "Member transaction Summary(Range) for the requested membership ID.", + "$ref": "#/definitions/memberTransactionRecentSummaryType" }, - "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" + "pointsSummary": { + "description": "Member points summary for the requested membership ID.", + "$ref": "#/definitions/memberPointsSummaryType" }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "links": { + "$ref": "#/definitions/links" }, - "count": { - "description": "Total number of rows returned", - "type": "integer" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "calculatedPointType": { + "memberTransactionSummaryType": { "type": "object", - "description": "Information related to a Calculated Points.", + "description": "Itemized information related to a membership transactions summary.", "properties": { - "rule": { - "description": "Indicates rule description for membership rule.", - "type": "string" + "awardPoints": { + "description": "Summary of transactions associated with award points.", + "$ref": "#/definitions/memberTransactionSummaryAwardPointsType" }, - "type": { - "description": "Indicates the type of points.", - "$ref": "#/definitions/rulePointsTypeType" + "tierPoints": { + "description": "Summary of transactions associated with tier points.", + "$ref": "#/definitions/memberTransactionSummaryTierPointsType" }, - "points": { - "description": "Indicates the total award/tier points generated.", - "type": "number" + "guestStays": { + "description": "Summary of transactions associated with guest stays.", + "$ref": "#/definitions/memberTransactionSummaryGuestStaysType" + } + } + }, + "memberTransactionSummaryAwardPointsType": { + "type": "object", + "description": "Items summary associated with award points.", + "properties": { + "basePoints": { + "description": "Total number of base award points for the requested membership transaction ID.", + "$ref": "#/definitions/transactionSummaryAttributeType" }, - "costPerNight": { - "description": "Indicates the cost incurred per minght.", - "$ref": "#/definitions/currencyAmountType" + "bonusPoints": { + "description": "If a membership points transaction involves bonus points, the total number of bonus points.", + "$ref": "#/definitions/transactionSummaryAttributeType" }, - "ruleCode": { - "description": "Indicates rule code for membership rule.", + "miscPoints": { + "description": "If a membership points transaction involves points imported into ORS from a third-party system, the total number of points.", + "$ref": "#/definitions/transactionSummaryAttributeType" + }, + "totalPoints": { + "description": "The total number of award points.", + "$ref": "#/definitions/transactionSummaryAttributeType" + } + } + }, + "transactionSummaryAttributeType": { + "type": "object", + "description": "Attributes of Summary transactions.", + "properties": { + "customLabel": { + "description": "Attribute Label", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 100 }, - "billingGroup": { - "description": "Indicates the billing group the points belong to.", + "value": { + "description": "Attribute Value", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 80 } } }, - "rulePointsTypeType": { - "type": "string", - "description": "Possible membership points types.", - "enum": [ - "Base", - "Bonus" - ] - }, - "pointsRejectionReasons": { + "memberTransactionSummaryTierPointsType": { "type": "object", - "description": "Response object for fetching member transactions points rejection reasons information.", + "description": "Items summary associated with Tier points.", "properties": { - "pointsRejectionReason": { - "description": "Details on rule and reason the points were not awarded for a given point transaction.", - "$ref": "#/definitions/pointsRejectionReasonsType" + "bonusRevenue": { + "description": "Total number of bonus revenue tier points for the requested membership transaction ID.", + "$ref": "#/definitions/transactionSummaryAttributeType" }, - "links": { - "$ref": "#/definitions/links" + "bonusStay": { + "description": "Total number of bonus stay tier points for the requested membership transaction ID.", + "$ref": "#/definitions/transactionSummaryAttributeType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "bonusNights": { + "description": "Total number of bonus nights tier points for the requested membership transaction ID.", + "$ref": "#/definitions/transactionSummaryAttributeType" + }, + "baseRevenue": { + "description": "Total number of base revenue tier points for the requested membership transaction ID.", + "$ref": "#/definitions/transactionSummaryAttributeType" + }, + "baseStay": { + "description": "Total number of base stay tier points for the requested membership transaction ID.", + "$ref": "#/definitions/transactionSummaryAttributeType" + }, + "baseNights": { + "description": "Total number of base nights tier points for the requested membership transaction ID.", + "$ref": "#/definitions/transactionSummaryAttributeType" + }, + "totalStays": { + "description": "Total number of stays tier points for the requested membership transaction ID.", + "$ref": "#/definitions/transactionSummaryAttributeType" + }, + "totalNights": { + "description": "Total number of nights tier points for the requested membership transaction ID.", + "$ref": "#/definitions/transactionSummaryAttributeType" } } }, - "pointsRejectionReasonsType": { + "memberTransactionSummaryGuestStaysType": { "type": "object", - "description": "Summary of reason points were not awarded for a given points transaction.", + "description": "Items summary associated with guest stays.", "properties": { - "pointsRejectionReason": { - "description": "Details on rule and reason the points were not awarded for a given point transaction.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/pointsRejectionReasonType" - } - }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", - "type": "integer" + "stays": { + "description": "Total number of stays for the requested membership transaction ID.", + "$ref": "#/definitions/transactionSummaryAttributeType" }, - "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" + "nights": { + "description": "Total number of nights for the requested membership transaction ID.", + "$ref": "#/definitions/transactionSummaryAttributeType" + } + } + }, + "memberTransactionRecentSummaryType": { + "type": "object", + "description": "Itemized information related to a membership transactions summary.", + "properties": { + "awardPoints": { + "description": "Summary of transactions associated with award points.", + "$ref": "#/definitions/memberTransactionSummaryAwardPointsType" }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "tierPoints": { + "description": "Summary of transactions associated with tier points.", + "$ref": "#/definitions/memberTransactionSummaryTierPointsType" }, - "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" + "guestStays": { + "description": "Summary of transactions associated with guest stays.", + "$ref": "#/definitions/memberTransactionSummaryGuestStaysType" }, - "totalResults": { - "description": "Total number of rows queried", + "years": { + "description": "Range in Years.", "type": "integer" + } + } + }, + "memberPointsSummaryType": { + "type": "object", + "description": "Member Points Summary.", + "properties": { + "nextTierPoints": { + "description": "Points required for the next Level.", + "$ref": "#/definitions/transactionSummaryAttributeType" }, - "count": { - "description": "Total number of rows returned", - "type": "integer" + "availablePoints": { + "description": "Total Points Available.", + "$ref": "#/definitions/transactionSummaryAttributeType" } } }, - "pointsRejectionReasonType": { + "membershipNumber": { "type": "object", - "description": "Information related to a Points Rejection Reason summary.", + "description": "Request object for generating membership number.", "properties": { - "rule": { - "description": "Indicates rule description for membership rule.", - "type": "string" + "generateMembershipNumberCriteria": { + "description": "Generate Membership Number criteria.", + "$ref": "#/definitions/generateMembershipNumberCriteriaType" }, - "code": { - "description": "Indicates rule code for membership rule.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "links": { + "$ref": "#/definitions/links" }, - "rejectionReason": { - "description": "Indicates the reason the points were not awarded (e.g. Membership level requirements not met).", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "generateMembershipNumberCriteriaType": { + "type": "object", + "description": "Auto generate membership number criteria.", + "properties": { + "membershipType": { + "description": "Indicates the Membership Type where membership number to be generated will be based on.", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 20 } } }, - "rates": { + "enrollmentMatchProfiles": { "type": "object", - "description": "Response object for fetching Membership Transaction Rates information.", + "description": "Response object to fetch match profiles for enrollment.", "properties": { - "rate": { - "description": "Details of rate for the current points transaction.", - "$ref": "#/definitions/membershipTransactionRatesType" + "enrollmentMatchProfilesDetail": { + "description": "Type contains detail information regarding match profiles.", + "$ref": "#/definitions/enrollmentMatchProfilesType" }, "links": { "$ref": "#/definitions/links" @@ -29912,93 +34644,42 @@ } } }, - "membershipTransactionRatesType": { + "enrollmentMatchProfilesType": { + "type": "array", + "description": "Provide match profile details for enrollment.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileEnrollmentType" + } + }, + "availableARAddresses": { "type": "object", - "description": "Summary of rate details of current transaction associated with the stay.", + "description": "Response to the request to fetch the available Accounts Receivables(AR) Addresses for a Profile.", "properties": { - "rate": { - "description": "Details of rate for the current points transaction.", + "addresses": { + "description": "Collection of Detailed information on an address for the customer.", "type": "array", - "maxItems": 4000, "items": { - "$ref": "#/definitions/membershipTransactionRateType" + "$ref": "#/definitions/addressInfoType" } }, - "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" - } - } - }, - "membershipTransactionRateType": { - "type": "object", - "description": "Information related to a membership transaction rate.", - "properties": { - "fromDate": { - "description": "Indicates start date of the reservation.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "toDate": { - "description": "Indicates end date of the reservation.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "rateCode": { - "description": "Indicates the Rate code used in the reservation.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "pMSRateAmount": { - "description": "Indicates the Rate code amount in the property currency.", - "$ref": "#/definitions/currencyAmountType" - }, - "centralRateAmount": { - "description": "Indicates the Central rate amount in central currency.", - "$ref": "#/definitions/currencyAmountType" - }, - "currency": { - "description": "Indicates the Property currency code.", - "type": "string" + "links": { + "$ref": "#/definitions/links" }, - "marketCode": { - "description": "Indicates the Market code linked to rate code.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "revenues": { + "availablePreferences": { "type": "object", - "description": "Response object for fetching Membership Transaction Revenue.", "properties": { - "revenue": { - "description": "Details on stay details for current point transaction.", - "$ref": "#/definitions/membershipTransactionRevenuesType" + "preferenceCollection": { + "type": "array", + "description": "A collection of preferences", + "items": { + "$ref": "#/definitions/preferenceTypeType" + } }, "links": { "$ref": "#/definitions/links" @@ -30008,17 +34689,13 @@ } } }, - "membershipTransactionRevenuesType": { + "profileMembershipStatistics": { "type": "object", - "description": "Summary of stay details for current transaction.", + "description": "Response of the WS operation FetchProfileMembershipPoints. It contains the summary statistics and/or the details of each of the membership transactions and its points.", "properties": { - "revenue": { - "description": "Details on stay details for current point transaction.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipTransactionRevenueType" - } + "membershipStatistics": { + "description": "the summary statistics and/or the details of each of the membership transactions and its points.", + "$ref": "#/definitions/membershipStatisticsType" }, "totalPages": { "description": "Evaluated total page count based on the requested max fetch count.", @@ -30043,1133 +34720,976 @@ "count": { "description": "Total number of rows returned", "type": "integer" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "membershipTransactionRevenueType": { + "membershipStatisticsType": { "type": "object", - "description": "Information related to a membership transactions Revenue.", + "description": "List of membership transactions and the summary of the different total points statistics.", "properties": { - "date": { - "description": "Indicates the Date when the revenue was recognized.", - "type": "string", - "format": "date", - "maxLength": 8 + "statisticsSummary": { + "description": "Totals summary of the several points.", + "$ref": "#/definitions/membershipStatisticsSummaryType" }, - "revenueType": { - "description": "Indicates the Revenue type associated to Revenue.", - "type": "string" + "transactions": { + "description": "Activity or a transaction related to the Membership.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipTransactionSummaryType" + } }, - "pMSRevenue": { - "description": "Indicates the Total PMS Revenue accrued.", - "$ref": "#/definitions/currencyAmountType" + "type": { + "description": "The type of membership.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "centralRevenue": { - "description": "Indicates the Total central revenue Accrued.", - "$ref": "#/definitions/currencyAmountType" + "cardNumber": { + "description": "The membership card number.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "qualified": { - "description": "Indicates if the stay is qualified for points calculation.", - "type": "boolean" + "level": { + "description": "The level of the membership.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "membershipTransaction": { + "membershipStatisticsSummaryType": { "type": "object", - "description": "Response object for fetching a membership transaction.", + "description": "Totals of the each of the points.", "properties": { - "membershipTransactionDetails": { - "description": "Membership transaction details for the requested membership transaction ID.", - "$ref": "#/definitions/membershipTransactionType" + "awardPoints": { + "description": "Total of the award points from all the transactions.", + "type": "integer" }, - "links": { - "$ref": "#/definitions/links" + "tierRevenuePoints": { + "description": "Total of the Tier Revenue points from all the transactions.", + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "membershipTransactionType": { - "type": "object", - "description": "Detailed transaction information related to a membership.", - "properties": { - "membershipDetails": { - "description": "Membership details for the requested membership transaction ID.", - "$ref": "#/definitions/membershipDetailsType" + "tierNightPoints": { + "description": "Total of the Tier Night points from all the transactions.", + "type": "integer" }, - "membershipTransactionDetails": { - "description": "Membership transaction details for the requested membership transaction ID.", - "$ref": "#/definitions/membershipTransactionDetailsType" + "tierStayPoints": { + "description": "Total of the Tier Stay points from all the transactions.", + "type": "integer" + }, + "pointsCost": { + "description": "Total of the Points Cost from all the transactions.", + "type": "integer" } } }, - "membershipDetailsType": { + "membershipTransactionSummaryType": { "type": "object", - "description": "Details about a membership like ProfileID, Card Number, Type, Level, etc.", + "description": "Details regarding a transaction of a profile membership.", "properties": { - "profileId": { - "description": "The profile to which this membership is associated with.", - "$ref": "#/definitions/profileId" + "transactionInfo": { + "description": "Transaction type fields.", + "$ref": "#/definitions/membershipTransactionInfoType" }, - "name": { - "description": "The profile name associated with this membership.", - "type": "string", - "minLength": 0, - "maxLength": 128 + "pointsCalculated": { + "description": "Flag to indicate if points are calculated.", + "type": "boolean" }, - "membershipId": { - "description": "Unique identifier of this membership.", - "$ref": "#/definitions/uniqueID_Type" + "awardPoints": { + "description": "Award Points.", + "type": "integer" }, - "membershipCardNo": { - "description": "The card number associated with this membership.", + "tierPoints": { + "description": "Collection of tier points.", + "$ref": "#/definitions/membershipTierPointsType" + }, + "userName": { + "description": "User who inserted or updated the record.", "type": "string", "minLength": 0, - "maxLength": 50 + "maxLength": 200 }, - "membershipType": { - "description": "The type of the membership.", - "$ref": "#/definitions/codeDescriptionType" + "url": { + "description": "URL that identifies the location associated with the record identified by the UniqueID.", + "type": "string" }, - "membershipLevel": { - "description": "The current level of the membership.", + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 20 }, - "joinedDate": { - "description": "Date when the member enrolled for the membership.", + "instance": { + "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 80 }, - "cardExpirationDate": { - "description": "Membership card expiration date.", + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 80 + }, + "id": { + "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "idExtension": { + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" } } }, - "membershipTransactionDetailsType": { + "membershipTransactionInfoType": { "type": "object", - "description": "Detailed information related to a membership transaction.", + "description": "Specific details regarding the transaction.", "properties": { - "membershipTransactionId": { - "description": "Unique identifier associated with the membership transaction.", - "$ref": "#/definitions/membershipTransactionId" - }, - "hotelId": { - "description": "Property from which the membership stay information was received.", + "transactionDate": { + "description": "Membership Transaction Date.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date", + "maxLength": 8 }, "transactionType": { - "description": "The type of membership points transaction.", + "description": "Membership Transaction Type.", "type": "string", "minLength": 0, "maxLength": 20 }, - "transactionDate": { - "description": "The date when the points were calculated.", - "type": "string", - "format": "date", - "maxLength": 8 + "stayTimeSpan": { + "description": "Begin and end dates of the reservation.", + "$ref": "#/definitions/timeSpanType" }, "reservationIdList": { - "description": "Unique reservation identifiers associated with this transaction like PMS Confirmation Number and CRS Booking Number.", + "description": "The different reservation related ids. e.g. ResvNameId, ConfirmationNo or from an unknown PMS system.", "$ref": "#/definitions/reservationIdList" }, - "currency": { - "description": "The property currency at the originating PMS.", + "stay": { + "description": "Total stay.", + "type": "integer" + }, + "nights": { + "description": "Total nights.", + "type": "integer" + }, + "hotelId": { + "description": "Resort of the transaction.", "type": "string", "minLength": 0, "maxLength": 20 }, - "stayTimeSpan": { - "description": "Arrival and Departure date for the stay.", - "$ref": "#/definitions/timeSpanType" - }, - "ratePromotion": { - "description": "Promotion code assigned on reservation.", + "currencyCode": { + "description": "Code type of the type of currency.", "type": "string", "minLength": 0, "maxLength": 20 + } + } + }, + "membershipTierPointsType": { + "type": "object", + "description": "Collection of the tier points.", + "properties": { + "revenuePoints": { + "description": "Sum of the base revenue and bonus revenue points.", + "type": "integer" }, - "profilePromotions": { - "description": "Promotion code assigned on reservation.", - "$ref": "#/definitions/codeListType" + "nightPoints": { + "description": "Sum of the base night and bonus night points.", + "type": "integer" + }, + "stayPoints": { + "description": "Sum of the base stay and bonus stay points.", + "type": "integer" + }, + "pointsCost": { + "description": "Points Cost.", + "type": "integer" }, "pointsCreditDate": { - "description": "For adjustments, the date when the points are to be credited.", + "description": "Date when points were created.", "type": "string", "format": "date", "maxLength": 8 + } + } + }, + "profileStatistics": { + "type": "object", + "description": "Response object for fetching profile stay/reservation/revenue statistics. This object contains collection of summary or detail,Success,Warnings and Errors related to this operation.", + "properties": { + "profileStatistic": { + "description": "Contains summary/detail/revenue statistics information.", + "$ref": "#/definitions/profileStatisticsType" }, - "averageRateAmount": { - "description": "The average cost of the room per night.", - "type": "number" - }, - "adjustment": { - "description": "Indicates if the transaction was created as an adjustment.", - "type": "boolean" + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" }, - "pointsCalculated": { - "description": "Indicates if the points have been calculated on this transaction.", - "type": "boolean" + "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" }, - "exceptionRejected": { - "description": "Indicates if the exception points were rejected.", - "type": "boolean" + "limit": { + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, - "exception": { - "description": "Indicates if the transaction was flagged as an exception.", + "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" }, - "roomLabel": { - "description": "The room type for this transaction.", - "type": "string", - "minLength": 0, - "maxLength": 50 - }, - "bookedRoomLabel": { - "description": "The booked room type for this transaction.", - "type": "string", - "minLength": 0, - "maxLength": 50 - }, - "notes": { - "description": "Notes associated with this transaction.", - "type": "string", - "minLength": 0, - "maxLength": 4000 - }, - "statementId": { - "description": "Statement batch ID.", - "$ref": "#/definitions/uniqueID_Type" - }, - "memberStatementId": { - "description": "Member statement batch ID.", - "$ref": "#/definitions/uniqueID_Type" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "billingGroup": { - "description": "Billing group the points belong to.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "count": { + "description": "Total number of rows returned", + "type": "integer" }, - "baseBillingGroup": { - "description": "Base billing group the points belong to.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "links": { + "$ref": "#/definitions/links" }, - "bonusBillingGroup": { - "description": "Bonus billing group the points belong to.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "profileStatisticsType": { + "type": "object", + "description": "Contains summary/detail/Revenue statistics information for Profile.", + "properties": { + "profileIdList": { + "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", + "$ref": "#/definitions/profileIdList" }, - "pointsCost": { - "description": "The total cost associated with points earned by this transaction.", - "type": "integer" + "stayStatisticsSummaryList": { + "description": "List of summary profile stay statistics.", + "$ref": "#/definitions/statisticsSummaryListType" }, - "processingMessages": { - "description": "Messages generated by the system during points calculation.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "stayStatisticsDetailList": { + "description": "List of detailed profile stay statistics.", + "$ref": "#/definitions/stayStatisticsDetailListType" }, - "awardPoints": { - "description": "Details if this transaction is associated with award points.", - "$ref": "#/definitions/membershipAwardPointsType" + "revenueStatisticsSummaryList": { + "description": "List of summary profile revenue statistics.", + "$ref": "#/definitions/revenueStatisticsSummaryListType" }, - "tierPoints": { - "description": "Details if this transaction is associated with tier points.", - "$ref": "#/definitions/membershipTransactionTierPointsType" + "reportType": { + "description": "Contains the statistical report(Reservation, Revenue, Stay Records) type.", + "$ref": "#/definitions/statisticsReportType" } } }, - "membershipAwardPointsType": { + "statisticsSummaryListType": { "type": "object", - "description": "Details associated with award points.", + "description": "Collection of Profile statistics summary information", "properties": { - "basePoints": { - "description": "Total number of base award points for a membership points transaction.", - "type": "integer" - }, - "bonusPoints": { - "description": "If a membership points transaction involves bonus points, the total number of bonus points.", - "type": "integer" + "profileHotelStatisticsbyYearSummary": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileHotelStatisticsbyYearSummaryType" + } }, - "miscPoints": { - "description": "If a membership points transaction involves points imported into ORS from a third-party system, the total number of points.", - "type": "integer" + "profileStatisticsbyYearSummary": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileStatisticsbyYearSummaryType" + } + } + } + }, + "profileHotelStatisticsbyYearSummaryType": { + "type": "object", + "description": "Contains stay statistics summary information by year", + "properties": { + "stayDetail": { + "type": "array", + "maxItems": 2, + "items": { + "$ref": "#/definitions/stayDetailSummaryType" + } }, - "totalPoints": { - "description": "The total number of award points.", - "type": "integer" + "netRevenue": { + "type": "array", + "maxItems": 2, + "items": { + "$ref": "#/definitions/stayStatisticsRevenueType" + } }, - "pointsExpiryDate": { - "description": "The date until points are eligible for redemption based on membership type configuration.", - "type": "string", - "format": "date", - "maxLength": 8 + "year": { + "type": "string" }, - "ruleCode": { - "description": "Rule Code for award points.", + "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 } } }, - "membershipTransactionTierPointsType": { + "stayDetailSummaryType": { "type": "object", - "description": "Details associated with tier points.", + "description": "Contains stay related information such as reservation nights,room nights,arrival rooms,cancel rooms,etc.", "properties": { - "baseStay": { - "description": "Total number of base stay tier points for a membership points transaction.", + "roomNights": { "type": "integer" }, - "baseNights": { - "description": "Total number of base nights tier points for a membership points transaction.", + "arrivalRooms": { "type": "integer" }, - "baseRevenue": { - "description": "Total number of base revenue tier points for a membership points transaction.", + "cancelRooms": { "type": "integer" }, - "bonusStay": { - "description": "The total number of bonus stay tier points.", + "noShowRooms": { "type": "integer" }, - "bonusNights": { - "description": "The total number of bonus nights tier points.", + "dayUseRooms": { "type": "integer" }, - "bonusRevenue": { - "description": "The total number of bonus revenue tier points.", + "totalBooked": { + "description": "Total Booked Stays/Reservations for Profile", "type": "integer" - } - } - }, - "membershipAwardExportInfo": { - "type": "object", - "description": "Response object to fetch members information for Fulfillment house processing.", - "properties": { - "exportInfo": { - "description": "Collection of member information.", - "$ref": "#/definitions/membershipAwardsExportType" }, - "links": { - "$ref": "#/definitions/links" + "totalStays": { + "description": "Total Stayed Reservations for Profile", + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "stayReservation": { + "$ref": "#/definitions/stayReservationType" } } }, - "membershipAwardsExportType": { - "type": "array", - "description": "List of member's information.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipAwardExportType" - } + "stayReservationType": { + "type": "string", + "description": "Enumeration for stay types.", + "enum": [ + "Transient", + "Block" + ] }, - "membershipAwardExportType": { + "stayStatisticsRevenueType": { "type": "object", - "description": "Types holds the details of Member.", + "description": "Contains different list of stay statistics revenue information", "properties": { - "awardNumber": { - "description": "Award Number to identify member's information.", - "type": "number" + "averageDailyRate": { + "$ref": "#/definitions/statisticsRevenueTypeType" }, - "recipientInfo": { - "description": "Recipient information.", - "$ref": "#/definitions/membershipAwardRecipientInfoType" + "totalRevenue": { + "$ref": "#/definitions/statisticsRevenueTypeType" }, - "userDefinedFields": { - "description": "Collections of user defined fields.", - "$ref": "#/definitions/userDefinedFieldsType" + "roomRevenue": { + "$ref": "#/definitions/statisticsRevenueTypeType" + }, + "fBRevenue": { + "$ref": "#/definitions/statisticsRevenueTypeType" + }, + "extraRevenue": { + "$ref": "#/definitions/statisticsRevenueTypeType" + }, + "nonRevenue": { + "$ref": "#/definitions/statisticsRevenueTypeType" + }, + "currency": { + "type": "string" + }, + "stayReservation": { + "$ref": "#/definitions/stayReservationType" } } }, - "membershipAwardRecipientInfoType": { + "statisticsRevenueTypeType": { "type": "object", - "description": "Type holds details of member.", + "description": "Contains Revenue information", "properties": { - "memberInfo": { - "description": "Member Name.", - "$ref": "#/definitions/profileNameType" - }, - "phoneNumber": { - "description": "Phone Number.", - "$ref": "#/definitions/phoneNumberType" + "revenueAmount": { + "type": "number" }, - "companyName": { - "description": "It returns a Company Name,If the member is associated with a company.", + "revenueLabel": { "type": "string", "minLength": 0, - "maxLength": 40 - }, - "addressInfo": { - "description": "Member's Mailing Address infomation.", - "$ref": "#/definitions/addressInfoType" + "maxLength": 20 } } }, - "membershipIssueAwards": { + "profileStatisticsbyYearSummaryType": { "type": "object", - "description": "Response object for fetching member issued award list.", + "description": "Contains stay statistics summary information by year", "properties": { - "membershipAwardsList": { - "description": "Collection of member award list.", - "$ref": "#/definitions/membershipAwardsListType" - }, - "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" + "stayDetail": { + "type": "array", + "maxItems": 2, + "items": { + "$ref": "#/definitions/stayDetailSummaryType" + } }, - "links": { - "$ref": "#/definitions/links" + "netRevenue": { + "type": "array", + "maxItems": 2, + "items": { + "$ref": "#/definitions/stayStatisticsRevenueType" + } }, - "warnings": { - "$ref": "#/definitions/warningsType" + "year": { + "type": "string" } } }, - "membershipAwardsListType": { + "stayStatisticsDetailListType": { "type": "array", - "description": "List of Member Awards information.", + "description": "Collection of stay statistics detail information", "maxItems": 4000, "items": { - "$ref": "#/definitions/membershipAwardListType" + "$ref": "#/definitions/stayStatisticsDetailType" } }, - "membershipAwardListType": { + "stayStatisticsDetailType": { "type": "object", - "description": "Information related to Member Award Issue List.", + "description": "Contains stay statistics detail information", "properties": { - "membershipId": { - "description": "Card number of the membership.", - "type": "number" - }, - "membershipType": { - "description": "Membership type for which awards are defined.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "stayDetail": { + "$ref": "#/definitions/stayDetailType" }, - "membershipLevel": { - "description": "Level of this Membership Type.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "revenue": { + "$ref": "#/definitions/stayStatisticsRevenueType" }, - "nameOnCard": { - "description": "Name to be displayed on the membership card.", + "year": { "type": "string" }, - "joinDate": { - "description": "Joined date on the Card.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "expireDate": { - "description": "Expiry date on the Card.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "membershipCardNo": { - "description": "Indicates Membership Card Number.", - "type": "string", - "minLength": 0, - "maxLength": 50 - }, - "totalAvailablePoints": { - "description": "Total award points available for redemption.", - "type": "number" - }, "hotelId": { - "description": "Property at which the award was issued.", "type": "string", "minLength": 0, "maxLength": 20 + } + } + }, + "stayDetailType": { + "type": "object", + "description": "The Reservation class contains the current reservation being created or altered.", + "properties": { + "reservationIdList": { + "description": "Unique identifiers for the reservation for both internal and external systems", + "$ref": "#/definitions/reservationIdList" }, - "awardNumber": { - "description": "An identifying number of the award, assigned by the system when the award was issued.", - "type": "number" - }, - "awardPoints": { - "description": "Number of points required by the award.", - "type": "number" + "roomStay": { + "description": "Collection of room stays.", + "$ref": "#/definitions/stayInfoType" }, - "thresholdPoints": { - "description": "Indicates member is below the threshold limit or not to request award.", - "type": "number" + "reservationGuest": { + "description": "Collection of guests associated with the reservation.", + "$ref": "#/definitions/resGuestInfoType" }, - "awardCode": { - "description": "Code assigned to this membership award.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "sharedGuests": { + "description": "Collection of guests who share this reservation.", + "$ref": "#/definitions/resSharedGuestListType" }, - "cancelDays": { - "description": "The cancel days, set up in awards configuration that establishes the number of days before arrival when a reservation may be cancelled without an award points penalty.", - "type": "integer" + "attachedProfiles": { + "description": "List of attached profiles", + "$ref": "#/definitions/resAttachedProfileListType" }, - "dateAwarded": { - "description": "Date when the award was issued", - "type": "string", - "format": "date", - "maxLength": 8 + "reservationPaymentMethod": { + "description": "Payment method used for this reservation", + "$ref": "#/definitions/reservationPaymentMethodType" }, - "bookingNumber": { - "description": "Reservation confirmation number.", - "type": "string", - "minLength": 0, - "maxLength": 50 + "reservationFolioWindows": { + "description": "Collection of reservation folio windows.", + "$ref": "#/definitions/reservationFolioWindowsType" }, - "hotelBookingNumber": { - "description": "Property Reservation number.", + "specials": { + "description": "Set of reservation preferences which belongs to the Specials group.", "type": "string", "minLength": 0, - "maxLength": 30 + "maxLength": 4000 }, - "arrivalDate": { - "description": "The arrival date of the stay for when the award is associated.", + "lastPrivacyPromptDate": { + "description": "Last Privacy Prompt Date", "type": "string", "format": "date", "maxLength": 8 }, - "cancelPenaltyPoints": { - "description": "The award points that will be deducted (based on a cancel days restriction) if the award is cancelled. (Cancel days, set up in awards configuration, and establish the number of days before arrival when a reservation may be cancelled without an award points penalty.)", - "type": "integer" - }, - "awardCancellationNumber": { - "description": "If the award was cancelled, the system-generated award cancellation number appears here.", - "type": "integer" - }, - "awardCancelDate": { - "description": "If the reservation associated with the award was cancelled, the reservation cancellation date appears here.", + "displayColor": { + "description": "Color setting of the reservation.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "actualCancelPoints": { - "description": "The number of points actually deducted from the member's total award points if there is a penalty points restriction associated with the award cancellation.", - "type": "number" + "reservationIndicators": { + "description": "Indicators of additional information attached to the reservation", + "$ref": "#/definitions/indicatorsType" }, - "reservationCancellationNumber": { - "description": "If the reservation associated with the award was cancelled, the reservation cancellation number appears here.", - "type": "string", - "minLength": 0, - "maxLength": 30 + "roomStatus": { + "description": "Current room status", + "$ref": "#/definitions/housekeepingRoomStatusType" }, - "statementId": { - "description": "If this award was included on a statement, the statement ID appears here. The field is blank if the award has not yet been reported on a statement", - "type": "integer" + "searchMatches": { + "description": "Super Search matching terms.", + "$ref": "#/definitions/searchMatchesType" }, - "cancelStatementID": { - "description": "If this award was included on a statement, the cancel statement ID appears here. The field is blank if the award has not yet been reported on a statement", - "type": "integer" + "sourceOfSale": { + "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.", + "$ref": "#/definitions/sourceOfSaleType" }, - "memberStatementId": { - "description": "If this award was included on a statement, the member statement ID appears here. The field is blank if the award has not yet been reported on a statement", - "type": "integer" + "waitlist": { + "description": "Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore.", + "$ref": "#/definitions/waitlistResType" }, - "cancelMemberStatementID": { - "description": "If this award was included on a statement, the cancel member statement ID appears here. The field is blank if the award has not yet been reported on a statement", - "type": "integer" + "queue": { + "description": "Information about the time and duration this reservation was on Queue for Checkin.", + "$ref": "#/definitions/reservationQueueInformationType" }, - "numberOfNights": { - "description": "Number of nights cancel policy is applicable.", - "type": "integer" + "housekeeping": { + "description": "Information regarding housekeeping for this reservation.", + "$ref": "#/definitions/resHousekeepingType" }, - "stayDate": { - "description": "The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award", - "type": "string", - "format": "date", - "maxLength": 8 + "cashiering": { + "description": "Holds cashiering related information for the reservation.", + "$ref": "#/definitions/resCashieringType" }, - "departureDate": { - "description": "The date of the departure of the reservation associated with the award. There may be more than one date (multiple nights) associated with award", - "type": "string", - "format": "date", - "maxLength": 8 + "taxType": { + "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.", + "$ref": "#/definitions/taxTypeType" }, - "cancelPolicyType": { - "description": "Type of cancel policy.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "deposit": { + "description": "Holds reservation deposit information.", + "$ref": "#/definitions/reservationDepositType" }, - "awardSource": { - "description": "The source for the reservation associated with the award.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "allowedActions": { + "description": "Collection of reservation allowed actions.", + "$ref": "#/definitions/reservationAllowedActionsType" }, - "calculatedCancelPoints": { - "description": "Total calculated points to cancel an issued award.", - "type": "number" + "revenuesAndBalances": { + "description": "Revenues and Balances Amount summary for the reservation.", + "$ref": "#/definitions/resRevenueBalanceType" }, - "awardBasedOn": { - "description": "Indicates if the Award is based on RATE, PRODUCT,UPGRADE,FT or OTHER.", - "$ref": "#/definitions/membershipAwardBasedOnType" + "hotelInterfaceStatusList": { + "description": "Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationInterfaceStatusType" + } }, - "pmsResvNo": { - "description": "Indicates PMS Reservation Number.", + "guestPreferredCurrency": { + "description": "Currency code preferred by guest.", "type": "string", "minLength": 0, - "maxLength": 50 + "maxLength": 20 }, - "crsBookNo": { - "description": "Indicates CRS Booking Number.", - "type": "string", - "minLength": 0, - "maxLength": 50 + "turndownInfo": { + "description": "Currency code preferred by guest.", + "$ref": "#/definitions/reservationTurndownInfoType" }, - "product": { - "description": "Indicates the Product associated with the award.", - "type": "string", - "minLength": 0, - "maxLength": 50 + "mobileNotifications": { + "description": "Denotes the status of Room Ready, Key Ready messages.", + "$ref": "#/definitions/resMobileNotificationsType" }, - "ratePlanCode": { - "description": "Rate plan code associated with the award.", - "type": "string", - "minLength": 0, - "maxLength": 20 - } - } - }, - "membershipAwardBasedOnType": { - "type": "string", - "description": "This award allows a guest to apply available membership points towards the balance of his or her bill.", - "enum": [ - "Rate", - "Product", - "Upgrade", - "Other", - "Ft" - ] - }, - "membershipClaims": { - "type": "object", - "description": "Response object for fetching membership claims.", - "properties": { - "membershipClaimsDetail": { - "description": "A collection of membership claims.", - "$ref": "#/definitions/membershipClaimSummaryListType" + "reservationCommunication": { + "description": "Collection of reservation communication details.", + "$ref": "#/definitions/resCommunicationType" }, - "links": { - "$ref": "#/definitions/links" + "advanceCheckIn": { + "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", + "$ref": "#/definitions/advanceCheckInType" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "membershipClaimSummaryListType": { - "type": "array", - "description": "Contains summary information of the claim.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipClaimSummaryType" - } - }, - "membershipClaimSummaryType": { - "type": "object", - "description": "Summary information of a claim.", - "properties": { - "claimNo": { - "description": "Unique ID Number assigned to the claim when the claim was created.", - "$ref": "#/definitions/uniqueID_Type" + "welcomeOffer": { + "description": "This flag will determine wheather the reservation is eligible for Welcome Offer or not.", + "type": "boolean" + }, + "cancellationInfo": { + "description": "Information regarding why reservation has been/was cancelled.", + "type": "object", + "properties": { + "description": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "code": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "date": { + "description": "Date when reservation was last cancelled.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } }, - "claimDate": { - "description": "Date the claim was made.", - "type": "string", - "format": "date", - "maxLength": 8 + "keyCount": { + "description": "Number of keys created for the reservation.", + "type": "integer" }, - "callerName": { - "description": "Name of the person placing the claim. This name may be different from the name on the membership card.", + "hotelId": { "type": "string", "minLength": 0, - "maxLength": 100 + "maxLength": 20 }, - "replyBy": { - "description": "The date, if any, by which a response to the caller was promised.", + "hotelName": { "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 80 }, - "membershipType": { - "description": "Membership Type code.", + "expectedServiceTime": { "type": "string", "minLength": 0, "maxLength": 20 }, - "membershipId": { - "description": "Indicates membership card number of the guest.", - "type": "string", - "minLength": 0, - "maxLength": 50 + "roomStayReservation": { + "description": "Boolean True if this reservation is reserving rooms. False if it is only reserving services.", + "type": "boolean" }, - "claimStatus": { - "description": "Status of the claim.(Open, Closed, Pending Review, Waiting for Manager, etc.)", + "createDateTime": { + "description": "Time stamp of the creation.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date-time" }, - "claimType": { - "description": "Type of user-definable claim such as New Card, Stay, etc.", + "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": 40 + "maxLength": 200 }, - "closeDate": { - "description": "If the status is closed, the date the claim was closed.", + "lastModifyDateTime": { + "description": "Time stamp of last modification.", "type": "string", - "format": "date", - "maxLength": 8 - }, - "recordType": { - "description": "Record type of the claim.", - "$ref": "#/definitions/claimRecordType" + "format": "date-time" }, - "hotelId": { - "description": "Property where the stay took place.", + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", "type": "string", "minLength": 0, - "maxLength": 20 - }, - "confirmationNo": { - "description": "List of reservation confirmation or reference numbers associated with this claim. Like PMS reservation number, Central(ORS) booking number.", - "$ref": "#/definitions/uniqueIDListType" + "maxLength": 200 }, - "arrival": { - "description": "Arrival date for the stay associated with this claim.", + "purgeDate": { + "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", "format": "date", "maxLength": 8 }, - "departure": { - "description": "Departure date for the stay associated with this claim.", - "type": "string", - "format": "date", - "maxLength": 8 + "reservationStatus": { + "description": "Indicates the status of the reservation.", + "$ref": "#/definitions/pMS_ResStatusType" }, - "owner": { - "description": "User who is assigned to handle this claim.", - "type": "string", - "minLength": 0, - "maxLength": 50 + "computedReservationStatus": { + "description": "Indicates the status of the reservation.", + "$ref": "#/definitions/pMS_ResStatusType" }, - "submitter": { - "description": "User who entered this claim.", - "type": "string", - "minLength": 0, - "maxLength": 50 + "walkInIndicator": { + "description": "When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.", + "type": "boolean" }, - "source": { - "description": "Source of the claim. This will be either OCIS, OPMS or WEB.", - "$ref": "#/definitions/claimSourceType" + "accessRestriction": { + "description": "Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both.", + "$ref": "#/definitions/resAccessRestrictionType" }, - "origin": { - "description": "Origin of the membership claim. User definable values like Email, Fax, Phone Call, etc.", + "commissionPayoutTo": { + "description": "If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.", + "$ref": "#/definitions/commissionPayoutToType" + }, + "paymentMethod": { + "description": "Payment Method.", "type": "string", "minLength": 0, "maxLength": 20 }, - "approvalStatus": { - "description": "Filter claims by approved,rejected or pending status.", - "$ref": "#/definitions/claimApprovalStatusType" - }, - "callerInformation": { - "description": "More information related to call that help to resolve the claim..", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "preRegistered": { + "description": "Defines if the reservation is pre-registered or not.", + "type": "boolean" }, - "profileId": { - "description": "Unique ID of the profile.", - "$ref": "#/definitions/profileId" + "openFolio": { + "description": "Returns true when reservation has an open folio.", + "type": "boolean" }, - "membershipIdNo": { - "description": "Membership ID Number.", - "type": "number" + "allowMobileCheckout": { + "description": "Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.", + "type": "boolean" }, - "activityLog": { - "description": "Contains summary information of the claim.", - "$ref": "#/definitions/claimActivityLogListType" - } - } - }, - "fulfillmentExportedLogs": { - "type": "object", - "description": "Optional elements whether to update exclude extract or delivery status in membership fulfillment", - "properties": { - "fulfillmentExportLogs": { - "description": "This type holds list of export logs information for the membership fulfillment .", - "$ref": "#/definitions/fulfillmentExportLogsType" + "allowMobileViewFolio": { + "description": "Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.", + "type": "boolean" }, - "links": { - "$ref": "#/definitions/links" + "optedForCommunication": { + "description": "Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "fulfillmentExportLogsType": { - "type": "array", - "description": "This type holds the export log information for the membership fulfillment record.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/fulfillmentExportInfoType" - } - }, - "fulfillmentExportInfoType": { - "type": "object", - "description": "This type holds the export log information for the membership fulfillment record.", - "properties": { - "extractLogId": { - "description": "Unique Id that references an object uniquely in the fulfillment export logs table.", - "$ref": "#/definitions/uniqueID_Type" + "complimentaray": { + "description": "Indicates the profile stay record is complimentaray.", + "type": "boolean" }, - "membershipId": { - "description": "Id Number of the membership.", - "$ref": "#/definitions/uniqueID_Type" + "reservationSourceCode": { + "description": "Indicates the profile stay record reservation source code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "membershipCard": { - "description": "The card number for the guest membership.", + "reservationSourceType": { + "description": "Indicates the profile stay record reservation source Type.", "type": "string", "minLength": 0, "maxLength": 50 }, - "extractCode": { - "description": "ExtractCode of the membership fulfillment export logs.", + "shareNumber": { + "description": "Indicates the share Number for Stay if reservation was a share.", "type": "string", "minLength": 0, "maxLength": 20 }, - "extractDate": { - "description": "ExtractDate of the membership fulfillment export logs.", + "bookingDate": { + "description": "Booking date of the stay record.", "type": "string", "format": "date", "maxLength": 8 }, - "deliveryStatus": { - "description": "The Delivery Status for export logs will default to \"Unknown.\"(Unknown/Delivered/NotDelivered).", - "$ref": "#/definitions/exportLogsDeliveryStatusType" - }, - "extractId": { - "description": "ExtractId of Membership Extracts.", - "$ref": "#/definitions/uniqueID_Type" - }, - "extractBatchId": { - "description": "Export run will populate the Extract Batch Id in export logs.", - "$ref": "#/definitions/uniqueID_Type" - }, - "excludeExtract": { - "description": "To exclude the extract record from membership exports. Once the membership export has run, this check box will be grayed out and the extract batch Id will be populated in the Extract Batch Id read-only field.", - "type": "boolean" - } - } - }, - "exportLogsDeliveryStatusType": { - "type": "string", - "description": "Delivery Status for export logs - Not Delivered.", - "enum": [ - "Unknown", - "Delivered", - "Notdelivered" - ] - }, - "memberPointsToExpire": { - "type": "object", - "description": "Response object for fetching member points to expire information.", - "properties": { - "memberPointsToExpireList": { - "description": "Collection of member points to expire.", - "$ref": "#/definitions/memberPointsToExpireListType" + "bookedArrivalDate": { + "description": "Booked arrival date of the stay record.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "links": { - "$ref": "#/definitions/links" + "bookedDepartureDate": { + "description": "Booked departure date of the stay record.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "memberPointsToExpireListType": { - "type": "array", - "description": "List of of member points to expire.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/memberPointToExpireType" - } - }, - "memberPointToExpireType": { - "type": "object", - "description": "Information related to a member point to expire.", - "properties": { - "pointsExpiryDate": { - "description": "The date when the member future award points will expire.", + "cancellationDate": { + "description": "Cancellation date of the stay record.", "type": "string", "format": "date", "maxLength": 8 }, - "pointsToExpire": { - "description": "Displays the total number of points that will expire on the expiration date.", + "cancelledRoomNights": { + "description": "Number of cancelled room nights.", "type": "integer" }, - "previousPointsToExpire": { - "description": "Displays the number of points that are relevant for extension. Points that were already extended from the previous year are not considered for extension.", + "noShowRoomNights": { + "description": "Number of no show room nights.", "type": "integer" }, - "extend": { - "description": "Indicates if the points is extendable.", - "type": "boolean" - }, - "awardGenerationMethod": { - "description": "The method of award generation.", + "travelAgentReferenceId": { + "description": "Travel Agent reference number for stay record.", "type": "string", "minLength": 0, - "maxLength": 20 - } - } - }, - "extendMemberPointsToExpire": { - "type": "object", - "description": "Request object to extend a member points to expire.", - "properties": { - "membershipId": { - "description": "Unique Membership ID.", - "type": "number" + "maxLength": 60 }, - "expirationDate": { - "description": "Expiration date to be extended.", + "allotmentCode": { + "description": "Allotment Code for stay record.", "type": "string", - "format": "date" + "minLength": 0, + "maxLength": 20 }, - "links": { - "$ref": "#/definitions/links" + "primarySharer": { + "description": "Indicates whether the guest was the primary sharer or not.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "membershipTransactionsSummary": { - "type": "object", - "description": "Response object for fetching member point totals information.", - "properties": { - "membershipDetails": { - "description": "Member details for the requested membership ID.", - "$ref": "#/definitions/membershipDetailsType" + "exchangeRate": { + "description": "Exchange Rate.", + "type": "number" }, - "transactionsSummary": { - "description": "Member transaction Summary for the requested membership ID.", - "$ref": "#/definitions/memberTransactionSummaryType" + "promotionCode": { + "description": "Promotion code associated with the stay.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "recentTransactionsSummary": { - "description": "Member transaction Summary(Range) for the requested membership ID.", - "$ref": "#/definitions/memberTransactionRecentSummaryType" + "bookedRoomType": { + "description": "Indicate the category of room originally booked.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "pointsSummary": { - "description": "Member points summary for the requested membership ID.", - "$ref": "#/definitions/memberPointsSummaryType" + "channelCode": { + "description": "Indicate channel for stay.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "links": { - "$ref": "#/definitions/links" + "stayRecordId": { + "description": "Stay Record identifier.", + "$ref": "#/definitions/uniqueID_Type" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "userDefinedFields": { + "description": "Collection of user defined fields.", + "$ref": "#/definitions/userDefinedFieldsType" } } }, - "memberTransactionSummaryType": { - "type": "object", - "description": "Itemized information related to a membership transactions summary.", - "properties": { - "awardPoints": { - "description": "Summary of transactions associated with award points.", - "$ref": "#/definitions/memberTransactionSummaryAwardPointsType" - }, - "tierPoints": { - "description": "Summary of transactions associated with tier points.", - "$ref": "#/definitions/memberTransactionSummaryTierPointsType" - }, - "guestStays": { - "description": "Summary of transactions associated with guest stays.", - "$ref": "#/definitions/memberTransactionSummaryGuestStaysType" - } + "revenueStatisticsSummaryListType": { + "type": "array", + "description": "List of the detailed and yearly summarized information about the profile revenue.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/revenueStatisticsSummaryType" } }, - "memberTransactionSummaryAwardPointsType": { + "revenueStatisticsSummaryType": { "type": "object", - "description": "Items summary associated with award points.", + "description": "Summary of the revenue for a year", "properties": { - "basePoints": { - "description": "Total number of base award points for the requested membership transaction ID.", - "$ref": "#/definitions/transactionSummaryAttributeType" - }, - "bonusPoints": { - "description": "If a membership points transaction involves bonus points, the total number of bonus points.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "revenueDetails": { + "description": "Details regarding the profile revenue belonging to the specified year.", + "$ref": "#/definitions/revenueStatisticsDetailListType" }, - "miscPoints": { - "description": "If a membership points transaction involves points imported into ORS from a third-party system, the total number of points.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "revenueBucketsSummary": { + "description": "Details about revenue summary.", + "$ref": "#/definitions/revenueBucketListType" }, - "totalPoints": { - "description": "The total number of award points.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "year": { + "description": "Year of the revenue.", + "type": "string", + "minLength": 4, + "maxLength": 4 } } }, - "transactionSummaryAttributeType": { + "revenueStatisticsDetailListType": { + "type": "array", + "description": "The collection of profile revenue statistics.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/revenueStatisticsDetailType" + } + }, + "revenueStatisticsDetailType": { "type": "object", - "description": "Attributes of Summary transactions.", + "description": "The different statistics from the revenue of a profile.", "properties": { - "customLabel": { - "description": "Attribute Label", - "type": "string", - "minLength": 0, - "maxLength": 100 + "stayTimeSpan": { + "description": "The stay time span of the reservation.", + "$ref": "#/definitions/timeSpanType" }, - "value": { - "description": "Attribute Value", + "guestName": { + "description": "Name Of The Guest.", "type": "string", "minLength": 0, - "maxLength": 80 - } - } - }, - "memberTransactionSummaryTierPointsType": { - "type": "object", - "description": "Items summary associated with Tier points.", - "properties": { - "bonusRevenue": { - "description": "Total number of bonus revenue tier points for the requested membership transaction ID.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "maxLength": 200 }, - "bonusStay": { - "description": "Total number of bonus stay tier points for the requested membership transaction ID.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "profileIdList": { + "description": "Id of the guest profile in the reservation.", + "$ref": "#/definitions/profileIdList" }, - "bonusNights": { - "description": "Total number of bonus nights tier points for the requested membership transaction ID.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "reservationIdList": { + "description": "Id of the reservation.", + "$ref": "#/definitions/reservationIdList" }, - "baseRevenue": { - "description": "Total number of base revenue tier points for the requested membership transaction ID.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "revenueType": { + "description": "Revenue Type for Stay.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "baseStay": { - "description": "Total number of base stay tier points for the requested membership transaction ID.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "revenueBuckets": { + "description": "The different revenue buckets of a profile.", + "$ref": "#/definitions/revenueBucketListType" }, - "baseNights": { - "description": "Total number of base nights tier points for the requested membership transaction ID.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "centralRevenue": { + "description": "Central Revenue Type for Stay.", + "type": "number" }, - "totalStays": { - "description": "Total number of stays tier points for the requested membership transaction ID.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "localRevenue": { + "description": "Local Revenue Type for Stay.", + "type": "number" }, - "totalNights": { - "description": "Total number of nights tier points for the requested membership transaction ID.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "hotelId": { + "description": "Hotel of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "memberTransactionSummaryGuestStaysType": { - "type": "object", - "description": "Items summary associated with guest stays.", - "properties": { - "stays": { - "description": "Total number of stays for the requested membership transaction ID.", - "$ref": "#/definitions/transactionSummaryAttributeType" - }, - "nights": { - "description": "Total number of nights for the requested membership transaction ID.", - "$ref": "#/definitions/transactionSummaryAttributeType" - } - } + "statisticsReportType": { + "type": "string", + "enum": [ + "Reservation", + "Revenue", + "ProfileStayRecords", + "DetailStayRecordsRevenue", + "ProfileStayRecordUdfs" + ], + "description": "Indicate to get revenue of Stay Records." }, - "memberTransactionRecentSummaryType": { + "profileSummaries": { "type": "object", - "description": "Itemized information related to a membership transactions summary.", + "description": "Response object for fetching profiles. This object contains profile primary details,profile summary details,master info list containing code and description used as lookup for description.", "properties": { - "awardPoints": { - "description": "Summary of transactions associated with award points.", - "$ref": "#/definitions/memberTransactionSummaryAwardPointsType" + "profileSummaries": { + "description": "Type contains Profile's summary information.", + "$ref": "#/definitions/profileSummariesType" }, - "tierPoints": { - "description": "Summary of transactions associated with tier points.", - "$ref": "#/definitions/memberTransactionSummaryTierPointsType" + "masterInfoList": { + "description": "Refer to Generic common types document.", + "type": "array", + "items": { + "$ref": "#/definitions/masterInfoType" + } }, - "guestStays": { - "description": "Summary of transactions associated with guest stays.", - "$ref": "#/definitions/memberTransactionSummaryGuestStaysType" + "links": { + "$ref": "#/definitions/links" }, - "years": { - "description": "Range in Years.", - "type": "integer" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "memberPointsSummaryType": { + "profileSummariesType": { "type": "object", - "description": "Member Points Summary.", + "description": "A complex type containing the collection of Profile objects or Unique IDs of Profiles.", "properties": { - "nextTierPoints": { - "description": "Points required for the next Level.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "profileInfo": { + "description": "A collection of Profiles or Unique IDs of Profiles.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileSummaryInfoType" + } }, - "availablePoints": { - "description": "Total Points Available.", - "$ref": "#/definitions/transactionSummaryAttributeType" + "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" } } }, - "membershipNumber": { + "checkedProfiles": { "type": "object", - "description": "Request object for generating membership number.", + "description": "Response for checking allowed actions, existence of attached records, or indicators of a profile.", "properties": { - "generateMembershipNumberCriteria": { - "description": "Generate Membership Number criteria.", - "$ref": "#/definitions/generateMembershipNumberCriteriaType" + "checkProfilesDetail": { + "description": "Collection of profiles and the status of its allowed actions, attached records, and indicators.", + "$ref": "#/definitions/checkProfilesType" }, "links": { "$ref": "#/definitions/links" @@ -31179,70 +35699,64 @@ } } }, - "generateMembershipNumberCriteriaType": { - "type": "object", - "description": "Auto generate membership number criteria.", - "properties": { - "membershipType": { - "description": "Indicates the Membership Type where membership number to be generated will be based on.", - "type": "string", - "minLength": 0, - "maxLength": 20 - } + "checkProfilesType": { + "type": "array", + "description": "Collection of profiles and the status of its allowed actions, attached records, and indicators.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/checkProfileType" } }, - "enrollmentMatchProfiles": { + "checkProfileType": { "type": "object", - "description": "Response object to fetch match profiles for enrollment.", + "description": "Profile and the status of its allowed actions, attached records, and indicators.", "properties": { - "enrollmentMatchProfilesDetail": { - "description": "Type contains detail information regarding match profiles.", - "$ref": "#/definitions/enrollmentMatchProfilesType" - }, - "links": { - "$ref": "#/definitions/links" + "profileId": { + "description": "Unique identifier of the profile.", + "$ref": "#/definitions/profileId" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "results": { + "description": "Collection of status of allowed actions, attached records, and indicators of the profile.", + "$ref": "#/definitions/checkProfileResultsType" } } }, - "enrollmentMatchProfilesType": { + "checkProfileResultsType": { "type": "array", - "description": "Provide match profile details for enrollment.", + "description": "Collection of status of allowed actions, attached records, and indicators of the profile.", "maxItems": 4000, "items": { - "$ref": "#/definitions/profileEnrollmentType" + "$ref": "#/definitions/checkProfileResultType" } }, - "availableARAddresses": { + "checkProfileResultType": { "type": "object", - "description": "Response to the request to fetch the available Accounts Receivables(AR) Addresses for a Profile.", + "description": "Status of allowed actions, attached records, and indicators of the profile.", "properties": { - "addresses": { - "description": "Collection of Detailed information on an address for the customer.", - "type": "array", - "items": { - "$ref": "#/definitions/addressInfoType" - } - }, - "links": { - "$ref": "#/definitions/links" + "checkProfileInstruction": { + "description": "Indicates status of allowed actions, total number of attached records, or number of occurrences of indicator of a profile.", + "$ref": "#/definitions/checkProfileInstructionType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "exists": { + "description": "Indicates status of allowed actions, total number of attached records, or number of occurrences of indicator of a profile.", + "type": "boolean" } } }, - "availablePreferences": { + "checkProfileInstructionType": { + "type": "string", + "description": "Simple type that corresponds to check profile instructions.", + "enum": [ + "HasWebAccounts" + ] + }, + "profileActivityLog": { "type": "object", + "description": "Response object for fetching profile activity log. This object contains collection of user activity log for the profile,Success,Warnings and Errors related to this operation", "properties": { - "preferenceCollection": { - "type": "array", - "description": "A collection of preferences", - "items": { - "$ref": "#/definitions/preferenceTypeType" - } + "activityLog": { + "description": "Collection of user activity log for the profile.", + "$ref": "#/definitions/activityLogListType" }, "links": { "$ref": "#/definitions/links" @@ -31252,13 +35766,15 @@ } } }, - "profileMembershipStatistics": { + "activityLogListType": { "type": "object", - "description": "Response of the WS operation FetchProfileMembershipPoints. It contains the summary statistics and/or the details of each of the membership transactions and its points.", "properties": { - "membershipStatistics": { - "description": "the summary statistics and/or the details of each of the membership transactions and its points.", - "$ref": "#/definitions/membershipStatisticsType" + "activityLog": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/activityLogType" + } }, "totalPages": { "description": "Evaluated total page count based on the requested max fetch count.", @@ -31283,6 +35799,72 @@ "count": { "description": "Total number of rows returned", "type": "integer" + } + } + }, + "activityLogType": { + "type": "object", + "properties": { + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "module": { + "type": "string" + }, + "logDate": { + "type": "string", + "format": "date-time" + }, + "refActionId": { + "type": "number" + }, + "logUserId": { + "type": "integer" + }, + "logUserName": { + "type": "string" + }, + "machineStation": { + "type": "string" + }, + "croCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "actionType": { + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "actionDescription": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "iPAddress": { + "description": "The IP Address of the machine that performed the activity", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "deviceCode": { + "description": "The selected device code", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } + }, + "profileAccounts": { + "type": "object", + "description": "Response of profile accounts.", + "properties": { + "accounts": { + "description": "Collection of profile accounts.", + "$ref": "#/definitions/aRAccountsType" }, "links": { "$ref": "#/definitions/links" @@ -31292,93 +35874,258 @@ } } }, - "membershipStatisticsType": { + "aRAccountsType": { + "type": "array", + "description": "Information regarding the AR Account.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/aRAccountType" + } + }, + "aRAccountType": { "type": "object", - "description": "List of membership transactions and the summary of the different total points statistics.", + "description": "Accounts Receivabales Account details type.", "properties": { - "statisticsSummary": { - "description": "Totals summary of the several points.", - "$ref": "#/definitions/membershipStatisticsSummaryType" + "hotelId": { + "description": "Property where the AR Account exists.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "transactions": { - "description": "Activity or a transaction related to the Membership.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipTransactionSummaryType" - } + "accountName": { + "description": "Name of the AR Account.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "type": { - "description": "The type of membership.", + "accountId": { + "description": "The unique ID for the Account.", + "$ref": "#/definitions/uniqueID_Type" + }, + "accountNo": { + "description": "The Account Number for the Account.", "type": "string", "minLength": 0, "maxLength": 20 }, - "cardNumber": { - "description": "The membership card number.", + "profileId": { + "description": "Internal Profile ID for the AR Account.", + "$ref": "#/definitions/profileId" + }, + "balance": { + "description": "Open Balance of the Account for this property.", + "$ref": "#/definitions/currencyAmountType" + }, + "creditLimit": { + "description": "The maximum credit allowed for the Account.", + "$ref": "#/definitions/currencyAmountType" + }, + "contactName": { + "description": "The person to contact for this Account.", "type": "string", "minLength": 0, - "maxLength": 50 + "maxLength": 200 }, - "level": { - "description": "The level of the membership.", + "paymentDueDays": { + "description": "Number of days on which person can make payment.", "type": "string", "minLength": 0, "maxLength": 20 - } - } - }, - "membershipStatisticsSummaryType": { - "type": "object", - "description": "Totals of the each of the points.", - "properties": { - "awardPoints": { - "description": "Total of the award points from all the transactions.", - "type": "integer" }, - "tierRevenuePoints": { - "description": "Total of the Tier Revenue points from all the transactions.", - "type": "integer" + "monthEndCalcYN": { + "description": "Month End Calculation.", + "type": "boolean" }, - "tierNightPoints": { - "description": "Total of the Tier Night points from all the transactions.", - "type": "integer" + "address": { + "description": "Address information for the address which is attached to this AR Account.", + "$ref": "#/definitions/addressInfoType" }, - "tierStayPoints": { - "description": "Total of the Tier Stay points from all the transactions.", - "type": "integer" + "email": { + "description": "Email information for the Account. This is the Email that is attached to this AR Account.", + "$ref": "#/definitions/emailInfoType" }, - "pointsCost": { - "description": "Total of the Points Cost from all the transactions.", - "type": "integer" + "telephones": { + "description": "The Telephone and Fax details attached to the Account.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/telephoneInfoType" + } + }, + "lastReminderInfo": { + "description": "Report History Type used as based type for Remiders and Statements History types.", + "type": "object", + "properties": { + "reportName": { + "description": "Report Name.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "reportFileName": { + "description": "Report file name when exists to allow report re-printing.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "dateSent": { + "description": "The Reminder Letter name which is to be used for this Reminder based on the setup on the Account Type.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "age": { + "description": "The minimum age(days) of the invoices to be included in the Reminder", + "type": "integer" + }, + "historyExists": { + "description": "Indicates that reminders history exists.", + "type": "boolean" + } + } + }, + "lastStatementInfo": { + "description": "Report History Type used as based type for Remiders and Statements History types.", + "type": "object", + "properties": { + "reportName": { + "description": "Report Name.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "reportFileName": { + "description": "Report file name when exists to allow report re-printing.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "dateSent": { + "description": "The Reminder Letter name which is to be used for this Reminder based on the setup on the Account Type.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "statementNo": { + "description": "When using Statement Numbering, a unique number is associated to the Statement.", + "type": "integer" + }, + "historyExists": { + "description": "Indicates that statement history exists.", + "type": "boolean" + } + } + }, + "notes": { + "description": "The Note details attached to the Account.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/commentInfoType" + } + }, + "traces": { + "description": "The Trace details attached to the Account.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/traceType" + } + }, + "fixedCharges": { + "description": "Fixed charges attached to this AR Account.", + "$ref": "#/definitions/fixedChargesType" + }, + "accountIndicators": { + "description": "Indicators of additional information attached to the Account.", + "$ref": "#/definitions/indicatorsType" + }, + "agingInfo": { + "description": "The Aging balance information for this account, by Aging Buckets.", + "$ref": "#/definitions/aRAgingInfoType" + }, + "yearViewInfo": { + "description": "The Year View balance information for this account.", + "$ref": "#/definitions/aRYearViewInfoType" + }, + "invoices": { + "description": "List of all Invoices.", + "$ref": "#/definitions/aRInvoicesType" + }, + "payments": { + "description": "List of all Payments made.", + "$ref": "#/definitions/aRPaymentsType" + }, + "summary": { + "description": "The Summary Information of the Invoices for the Account.", + "$ref": "#/definitions/aRBalanceType" + }, + "status": { + "description": "The status of the account.", + "$ref": "#/definitions/aRAccountStatusType" + }, + "batchStatement": { + "description": "Include In Batch Statement", + "type": "boolean" + }, + "printFoliosWithStatement": { + "description": "Indicates if associated folios should be printed by default with the statement.", + "type": "boolean" + }, + "emailStatementsReminders": { + "description": "Indicates if the Account has opted to send the statements and reminders to the Account email address by default.", + "type": "boolean" + }, + "searchMatches": { + "description": "Super Search matching terms.", + "$ref": "#/definitions/searchMatchesType" + }, + "primary": { + "description": "Indicates if this Account is the Primary Account for this Guest/Company.", + "type": "boolean" + }, + "type": { + "description": "The type of Account.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "accountTypeDescription": { + "description": "The description of the Account Type.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "permanent": { + "description": "Indicates if this is a Permanent Account. Permanent Accounts cannot be deleted.", + "type": "boolean" } } }, - "membershipTransactionSummaryType": { + "traceType": { "type": "object", - "description": "Details regarding a transaction of a profile membership.", "properties": { - "transactionInfo": { - "description": "Transaction type fields.", - "$ref": "#/definitions/membershipTransactionInfoType" - }, - "pointsCalculated": { - "description": "Flag to indicate if points are calculated.", - "type": "boolean" - }, - "awardPoints": { - "description": "Award Points.", - "type": "integer" + "timeInfo": { + "description": "Date of the trace.", + "$ref": "#/definitions/traceTimeInfoType" }, - "tierPoints": { - "description": "Collection of tier points.", - "$ref": "#/definitions/membershipTierPointsType" + "reservationId": { + "description": "Reservation ID of the reservation for which the traces are to be retrieved.", + "$ref": "#/definitions/reservationId" }, - "userName": { - "description": "User who inserted or updated the record.", + "departmentId": { + "description": "Indicates the Department code.", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 20 + }, + "traceText": { + "description": "The information this trace contains.", + "type": "string" + }, + "resolveInfo": { + "description": "Information regarding the status of the trace", + "$ref": "#/definitions/traceResolveType" }, "url": { "description": "URL that identifies the location associated with the record identified by the UniqueID.", @@ -31411,1255 +36158,1061 @@ "idExtension": { "description": "Additional identifying value assigned by the creating system.", "type": "integer" - } - } - }, - "membershipTransactionInfoType": { - "type": "object", - "description": "Specific details regarding the transaction.", - "properties": { - "transactionDate": { - "description": "Membership Transaction Date.", + }, + "createDateTime": { + "description": "Time stamp of the creation.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date-time" }, - "transactionType": { - "description": "Membership Transaction Type.", + "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": 20 - }, - "stayTimeSpan": { - "description": "Begin and end dates of the reservation.", - "$ref": "#/definitions/timeSpanType" - }, - "reservationIdList": { - "description": "The different reservation related ids. e.g. ResvNameId, ConfirmationNo or from an unknown PMS system.", - "$ref": "#/definitions/reservationIdList" - }, - "stay": { - "description": "Total stay.", - "type": "integer" - }, - "nights": { - "description": "Total nights.", - "type": "integer" + "maxLength": 200 }, - "hotelId": { - "description": "Resort of the transaction.", + "lastModifyDateTime": { + "description": "Time stamp of last modification.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date-time" }, - "currencyCode": { - "description": "Code type of the type of currency.", + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 200 } } }, - "membershipTierPointsType": { + "traceTimeInfoType": { "type": "object", - "description": "Collection of the tier points.", "properties": { - "revenuePoints": { - "description": "Sum of the base revenue and bonus revenue points.", - "type": "integer" - }, - "nightPoints": { - "description": "Sum of the base night and bonus night points.", - "type": "integer" - }, - "stayPoints": { - "description": "Sum of the base stay and bonus stay points.", - "type": "integer" + "dateTimeSpan": { + "description": "Time span for the trace.", + "$ref": "#/definitions/dateTimeSpanType" }, - "pointsCost": { - "description": "Points Cost.", - "type": "integer" + "traceOn": { + "description": "Date of the trace.", + "type": "string", + "format": "date-time" }, - "pointsCreditDate": { - "description": "Date when points were created.", + "traceTime": { + "description": "Time of the trace", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 + }, + "enteredBy": { + "description": "User that entered this trace.", + "type": "string" } } }, - "profileStatistics": { + "dateTimeSpanType": { "type": "object", - "description": "Response object for fetching profile stay/reservation/revenue statistics. This object contains collection of summary or detail,Success,Warnings and Errors related to this operation.", + "description": "Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.", "properties": { - "profileStatistic": { - "description": "Contains summary/detail/revenue statistics information.", - "$ref": "#/definitions/profileStatisticsType" - }, - "links": { - "$ref": "#/definitions/links" + "startDateTime": { + "type": "string", + "format": "date-time" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "endDateTime": { + "type": "string", + "format": "date-time" } } }, - "profileStatisticsType": { + "traceResolveType": { "type": "object", - "description": "Contains summary/detail/Revenue statistics information for Profile.", "properties": { - "profileIdList": { - "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", - "$ref": "#/definitions/profileIdList" - }, - "stayStatisticsSummaryList": { - "description": "List of summary profile stay statistics.", - "$ref": "#/definitions/statisticsSummaryListType" - }, - "stayStatisticsDetailList": { - "description": "List of detailed profile stay statistics.", - "$ref": "#/definitions/stayStatisticsDetailListType" - }, - "revenueStatisticsSummaryList": { - "description": "List of summary profile revenue statistics.", - "$ref": "#/definitions/revenueStatisticsSummaryListType" + "resolvedOn": { + "description": "Date the trace was resolved", + "type": "string", + "format": "date", + "maxLength": 8 }, - "reportType": { - "description": "Contains the statistical report(Reservation, Revenue, Stay Records) type.", - "$ref": "#/definitions/statisticsReportType" + "resolvedBy": { + "description": "User that resolved the trace", + "type": "string" } } }, - "statisticsSummaryListType": { - "type": "object", - "description": "Collection of Profile statistics summary information", - "properties": { - "profileHotelStatisticsbyYearSummary": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileHotelStatisticsbyYearSummaryType" - } - }, - "profileStatisticsbyYearSummary": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileStatisticsbyYearSummaryType" - } - } + "fixedChargesType": { + "type": "array", + "description": "Holds fixed charge detail.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/fixedChargeType" } }, - "profileHotelStatisticsbyYearSummaryType": { + "fixedChargeType": { "type": "object", - "description": "Contains stay statistics summary information by year", + "description": "Holds fixed charge information.", "properties": { - "stayDetail": { - "type": "array", - "maxItems": 2, - "items": { - "$ref": "#/definitions/stayDetailSummaryType" - } + "schedule": { + "description": "Holds schedule of fixed charge.", + "$ref": "#/definitions/fixedChargeScheduleType" }, - "netRevenue": { - "type": "array", - "maxItems": 2, - "items": { - "$ref": "#/definitions/stayStatisticsRevenueType" - } + "charge": { + "description": "Holds specific details of fixed charge.", + "$ref": "#/definitions/fixedChargeDetailType" }, - "year": { + "url": { + "description": "URL that identifies the location associated with the record identified by the UniqueID.", "type": "string" }, - "hotelId": { + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 20 + }, + "instance": { + "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "id": { + "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "idExtension": { + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" } } }, - "stayDetailSummaryType": { + "fixedChargeScheduleType": { "type": "object", - "description": "Contains stay related information such as reservation nights,room nights,arrival rooms,cancel rooms,etc.", + "description": "Holds schedule of fixed charge.", "properties": { - "roomNights": { - "type": "integer" - }, - "arrivalRooms": { - "type": "integer" - }, - "cancelRooms": { - "type": "integer" - }, - "noShowRooms": { - "type": "integer" + "start": { + "description": "The starting value of the date range.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "dayUseRooms": { - "type": "integer" + "end": { + "description": "The ending value of the date range.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "totalBooked": { - "description": "Total Booked Stays/Reservations for Profile", - "type": "integer" + "frequency": { + "description": "Frequency of a fixed charge.", + "$ref": "#/definitions/fixedChargeFrequencyType" }, - "totalStays": { - "description": "Total Stayed Reservations for Profile", - "type": "integer" + "dayToExecute": { + "description": "Day of when to execute fixed charge. Applicable when frequency is Daily or Weekly.", + "type": "string", + "minLength": 0, + "maxLength": 3 }, - "stayReservation": { - "$ref": "#/definitions/stayReservationType" + "dateToExecute": { + "description": "Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.", + "type": "string", + "format": "date", + "maxLength": 8 } } }, - "stayReservationType": { + "fixedChargeFrequencyType": { "type": "string", - "description": "Enumeration for stay types.", + "description": "Yearly.", "enum": [ - "Transient", - "Block" + "O", + "D", + "W", + "M", + "Q", + "Y" ] }, - "stayStatisticsRevenueType": { + "fixedChargeDetailType": { "type": "object", - "description": "Contains different list of stay statistics revenue information", + "description": "Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.", "properties": { - "averageDailyRate": { - "$ref": "#/definitions/statisticsRevenueTypeType" - }, - "totalRevenue": { - "$ref": "#/definitions/statisticsRevenueTypeType" - }, - "roomRevenue": { - "$ref": "#/definitions/statisticsRevenueTypeType" - }, - "fBRevenue": { - "$ref": "#/definitions/statisticsRevenueTypeType" - }, - "extraRevenue": { - "$ref": "#/definitions/statisticsRevenueTypeType" + "transaction": { + "description": "Transaction code and description of a fixed charge.", + "$ref": "#/definitions/codeDescriptionType" }, - "nonRevenue": { - "$ref": "#/definitions/statisticsRevenueTypeType" + "quantity": { + "description": "Quantity of the product.", + "type": "integer" }, - "currency": { - "type": "string" + "chargeAmount": { + "description": "Price of the product.", + "$ref": "#/definitions/currencyAmountType" }, - "stayReservation": { - "$ref": "#/definitions/stayReservationType" - } - } - }, - "statisticsRevenueTypeType": { - "type": "object", - "description": "Contains Revenue information", - "properties": { - "revenueAmount": { - "type": "number" + "percent": { + "description": "Percentage of the rate amount.", + "type": "number", + "minimum": 0, + "maximum": 100 }, - "revenueLabel": { + "supplement": { + "description": "Additional information regarding the fixed charge.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 + }, + "article": { + "description": "Holds related article code and description.", + "$ref": "#/definitions/codeDescriptionType" + }, + "roomNights": { + "description": "Holds number of comp or cash room night to allocate.", + "type": "integer" } } }, - "profileStatisticsbyYearSummaryType": { + "aRAgingInfoType": { "type": "object", - "description": "Contains stay statistics summary information by year", + "description": "Information regarding the aging balances for an account.", "properties": { - "stayDetail": { - "type": "array", - "maxItems": 2, - "items": { - "$ref": "#/definitions/stayDetailSummaryType" - } + "totalOutstanding": { + "description": "The total debit and credit balance of the account.", + "$ref": "#/definitions/aRBalanceType" }, - "netRevenue": { + "aging": { + "description": "The debit and credit balance per Aging bucket.", "type": "array", - "maxItems": 2, + "maxItems": 4000, "items": { - "$ref": "#/definitions/stayStatisticsRevenueType" + "$ref": "#/definitions/aRAgingType" } - }, - "year": { - "type": "string" } } }, - "stayStatisticsDetailListType": { - "type": "array", - "description": "Collection of stay statistics detail information", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stayStatisticsDetailType" - } - }, - "stayStatisticsDetailType": { + "aRBalanceType": { "type": "object", - "description": "Contains stay statistics detail information", + "description": "Balance information for AR.", "properties": { - "stayDetail": { - "$ref": "#/definitions/stayDetailType" - }, - "revenue": { - "$ref": "#/definitions/stayStatisticsRevenueType" + "debit": { + "description": "Debit Balance amount. The amount owed by the Account.", + "$ref": "#/definitions/currencyAmountType" }, - "year": { - "type": "string" + "credit": { + "description": "The credit Balance amount. Any payment that is Unallocated i.e not applied against an invoice, is included in this.", + "$ref": "#/definitions/currencyAmountType" }, - "hotelId": { - "type": "string", - "minLength": 0, - "maxLength": 20 + "total": { + "description": "The total balance i.e Debit minus Credit amounts.", + "$ref": "#/definitions/currencyAmountType" } } }, - "stayDetailType": { + "aRAgingType": { "type": "object", - "description": "The Reservation class contains the current reservation being created or altered.", + "description": "Aging information for an Aging Bucket.", "properties": { - "reservationIdList": { - "description": "Unique identifiers for the reservation for both internal and external systems", - "$ref": "#/definitions/reservationIdList" - }, - "roomStay": { - "description": "Collection of room stays.", - "$ref": "#/definitions/stayInfoType" - }, - "reservationGuest": { - "description": "Collection of guests associated with the reservation.", - "$ref": "#/definitions/resGuestInfoType" - }, - "sharedGuests": { - "description": "Collection of guests who share this reservation.", - "$ref": "#/definitions/resSharedGuestListType" + "agingBucketRange": { + "description": "The bucket description in terms of days. Example : 0-31 days", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "attachedProfiles": { - "description": "List of attached profiles", - "$ref": "#/definitions/resAttachedProfileListType" + "agingDate": { + "description": "The start date and end date for this Aging bucket.", + "$ref": "#/definitions/dateRangeType" }, - "reservationPaymentMethod": { - "description": "Payment method used for this reservation", - "$ref": "#/definitions/reservationPaymentMethodType" + "balanceInfo": { + "description": "The balance amounts for this bucket. Contains the Debit Balance, Credit Balance and the Total Balance.", + "$ref": "#/definitions/aRBalanceType" }, - "reservationFolioWindows": { - "description": "Collection of reservation folio windows.", - "$ref": "#/definitions/reservationFolioWindowsType" + "agingStartDay": { + "description": "The start number of days for this Aging bucket. Example: For the range 31-60 days, this would be 31.", + "type": "integer" }, - "specials": { - "description": "Set of reservation preferences which belongs to the Specials group.", - "type": "string", - "minLength": 0, - "maxLength": 4000 + "agingEndDay": { + "description": "The end number of days for this Aging bucket. Example: For the range 31-60 days, this would be 60.", + "type": "integer" }, - "lastPrivacyPromptDate": { - "description": "Last Privacy Prompt Date", + "sequence": { + "description": "The sequence for display.", + "type": "integer" + } + } + }, + "dateRangeType": { + "type": "object", + "description": "Date Range with Start and End dates.", + "properties": { + "start": { + "description": "The starting value of the date range.", "type": "string", "format": "date", "maxLength": 8 }, - "displayColor": { - "description": "Color setting of the reservation.", + "end": { + "description": "The ending value of the date range.", "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "reservationIndicators": { - "description": "Indicators of additional information attached to the reservation", - "$ref": "#/definitions/indicatorsType" - }, - "roomStatus": { - "description": "Current room status", - "$ref": "#/definitions/housekeepingRoomStatusType" - }, - "searchMatches": { - "description": "Super Search matching terms.", - "$ref": "#/definitions/searchMatchesType" - }, - "sourceOfSale": { - "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.", - "$ref": "#/definitions/sourceOfSaleType" - }, - "waitlist": { - "description": "Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore.", - "$ref": "#/definitions/waitlistResType" - }, - "queue": { - "description": "Information about the time and duration this reservation was on Queue for Checkin.", - "$ref": "#/definitions/reservationQueueInformationType" - }, - "housekeeping": { - "description": "Information regarding housekeeping for this reservation.", - "$ref": "#/definitions/resHousekeepingType" - }, - "cashiering": { - "description": "Holds cashiering related information for the reservation.", - "$ref": "#/definitions/resCashieringType" - }, - "taxType": { - "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.", - "$ref": "#/definitions/taxTypeType" - }, - "deposit": { - "description": "Holds reservation deposit information.", - "$ref": "#/definitions/reservationDepositType" - }, - "allowedActions": { - "description": "Collection of reservation allowed actions.", - "$ref": "#/definitions/reservationAllowedActionsType" - }, - "revenuesAndBalances": { - "description": "Revenues and Balances Amount summary for the reservation.", - "$ref": "#/definitions/resRevenueBalanceType" + "format": "date", + "maxLength": 8 + } + } + }, + "aRYearViewInfoType": { + "type": "object", + "description": "Information regarding Year View balances for an account.", + "properties": { + "totalOutstanding": { + "description": "The total debit and credit balance of the account.", + "$ref": "#/definitions/aRBalanceType" }, - "hotelInterfaceStatusList": { - "description": "Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.", + "yearView": { + "description": "The debit and credit balance per account.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/reservationInterfaceStatusType" + "$ref": "#/definitions/aRYearViewType" } + } + } + }, + "aRYearViewType": { + "type": "object", + "description": "Year information for an Year View.", + "properties": { + "dateRange": { + "description": "The period start and end date.", + "$ref": "#/definitions/dateRangeType" }, - "guestPreferredCurrency": { - "description": "Currency code preferred by guest.", + "balanceInfo": { + "description": "The balance amounts for this date range. Contains the Debit Balance, Credit Balance and the Total Balance.", + "$ref": "#/definitions/aRBalanceType" + }, + "runningTotal": { + "description": "The running total balance for the date range.", + "$ref": "#/definitions/currencyAmountType" + } + } + }, + "aRInvoicesType": { + "type": "array", + "description": "A collection of AR Invoices.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/aRInvoiceType" + } + }, + "aRInvoiceType": { + "type": "object", + "description": "Details of an AR Invoice.", + "properties": { + "hotelId": { + "description": "Property where the invoice exists.", "type": "string", "minLength": 0, "maxLength": 20 }, - "turndownInfo": { - "description": "Currency code preferred by guest.", - "$ref": "#/definitions/reservationTurndownInfoType" + "reservationId": { + "description": "Reservation ID of the invoice.", + "$ref": "#/definitions/reservationId" }, - "mobileNotifications": { - "description": "Denotes the status of Room Ready, Key Ready messages.", - "$ref": "#/definitions/resMobileNotificationsType" + "guestProfileId": { + "description": "Guest Profile ID of the invoice.", + "$ref": "#/definitions/uniqueID_Type" }, - "reservationCommunication": { - "description": "Collection of reservation communication details.", - "$ref": "#/definitions/resCommunicationType" + "age": { + "description": "The Aging age of the invoice", + "type": "integer" }, - "advanceCheckIn": { - "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", - "$ref": "#/definitions/advanceCheckInType" + "guestName": { + "description": "Name of the Guest who consumed these transactions.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "welcomeOffer": { - "description": "This flag will determine wheather the reservation is eligible for Welcome Offer or not.", - "type": "boolean" + "originalAmount": { + "description": "Original Amount of the Invoice", + "$ref": "#/definitions/currencyAmountType" }, - "cancellationInfo": { - "description": "Information regarding why reservation has been/was cancelled.", - "type": "object", - "properties": { - "description": { - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "code": { - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "date": { - "description": "Date when reservation was last cancelled.", - "type": "string", - "format": "date", - "maxLength": 8 - } - } + "amount": { + "description": "Current Amount of the Invoice.", + "$ref": "#/definitions/currencyAmountType" }, - "keyCount": { - "description": "Number of keys created for the reservation.", - "type": "integer" + "payments": { + "description": "Total Payments made to this Invoice.", + "$ref": "#/definitions/currencyAmountType" }, - "hotelId": { - "type": "string", - "minLength": 0, - "maxLength": 20 + "balance": { + "description": "Amount still open which has not been paid", + "$ref": "#/definitions/currencyAmountType" }, - "hotelName": { + "reference": { + "description": "User-defined posting reference.", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 2000 }, - "expectedServiceTime": { + "remark": { + "description": "User-defined posting remark.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "roomStayReservation": { - "description": "Boolean True if this reservation is reserving rooms. False if it is only reserving services.", + "adjusted": { "type": "boolean" }, - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "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 - }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" + "parentInvoiceNo": { + "type": "number" }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", - "type": "string", - "minLength": 0, - "maxLength": 200 + "compressed": { + "type": "boolean" }, - "purgeDate": { - "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", + "compressedDate": { "type": "string", "format": "date", "maxLength": 8 }, - "reservationStatus": { - "description": "Indicates the status of the reservation.", - "$ref": "#/definitions/pMS_ResStatusType" - }, - "computedReservationStatus": { - "description": "Indicates the status of the reservation.", - "$ref": "#/definitions/pMS_ResStatusType" + "transferredOut": { + "type": "boolean" }, - "walkInIndicator": { - "description": "When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in.", + "transferredIn": { "type": "boolean" }, - "accessRestriction": { - "description": "Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both.", - "$ref": "#/definitions/resAccessRestrictionType" + "market": { + "description": "Invoice market code.", + "$ref": "#/definitions/marketCodeInfoType" }, - "commissionPayoutTo": { - "description": "If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.", - "$ref": "#/definitions/commissionPayoutToType" + "roomClass": { + "description": "Invoice room class code.", + "$ref": "#/definitions/roomClassCodeInfoType" }, - "paymentMethod": { - "description": "Payment Method.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "source": { + "description": "Invoice source code.", + "$ref": "#/definitions/sourceCodeInfoType" }, - "preRegistered": { - "description": "Defines if the reservation is pre-registered or not.", - "type": "boolean" + "reservationInfo": { + "description": "Reservation guest details.", + "$ref": "#/definitions/reservationInfoType" }, - "openFolio": { - "description": "Returns true when reservation has an open folio.", - "type": "boolean" + "cashierInfo": { + "description": "Cashier information. Contains Id and Name details of the cashier.", + "$ref": "#/definitions/cashierInfoType" }, - "allowMobileCheckout": { - "description": "Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.", - "type": "boolean" + "transactionInfo": { + "description": "Transaction information .", + "$ref": "#/definitions/trxInfoType" }, - "allowMobileViewFolio": { - "description": "Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.", - "type": "boolean" + "paymentCard": { + "description": "Payment card details.", + "$ref": "#/definitions/resPaymentCardType" }, - "optedForCommunication": { - "description": "Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.", + "addresseeInfo": { + "description": "Addressee Information for the folio. This is available when the Addressee functionality is used and and Addressee is attached to the folio of the Invoice.", + "$ref": "#/definitions/profileInfoType" + }, + "allowPartialTransferYn": { + "description": "Flag to check Partail Transfer Allowed.", "type": "boolean" }, - "complimentaray": { - "description": "Indicates the profile stay record is complimentaray.", + "printed": { + "description": "Flag to check Invoice Statement is Printed.", "type": "boolean" }, - "reservationSourceCode": { - "description": "Indicates the profile stay record reservation source code.", + "printedDate": { + "description": "Invoice Statement Printed Date.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date", + "maxLength": 8 }, - "reservationSourceType": { - "description": "Indicates the profile stay record reservation source Type.", - "type": "string", - "minLength": 0, - "maxLength": 50 + "storedFolioId": { + "description": "ID of the Stored Folio.", + "$ref": "#/definitions/uniqueID_Type" }, - "shareNumber": { - "description": "Indicates the share Number for Stay if reservation was a share.", + "storedFolioName": { + "description": "Name of the Stored Folio.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "bookingDate": { - "description": "Booking date of the stay record.", - "type": "string", - "format": "date", - "maxLength": 8 + "storedDebitFolioId": { + "description": "ID of the Stored Debit Folio.", + "$ref": "#/definitions/uniqueID_Type" }, - "bookedArrivalDate": { - "description": "Booked arrival date of the stay record.", + "storedDebitFolioName": { + "description": "Name of the Stored Debit Folio.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 2000 }, - "bookedDepartureDate": { - "description": "Booked departure date of the stay record.", - "type": "string", - "format": "date", - "maxLength": 8 + "folioTexts": { + "description": "Additional text fields to display on the folio.", + "$ref": "#/definitions/folioTextsType" }, - "cancellationDate": { - "description": "Cancellation date of the stay record.", + "transactionNo": { + "description": "Unique Transaction Identifier of the Invoice.", + "type": "number" + }, + "transactionDate": { + "description": "Transaction Date of the invoice.", "type": "string", "format": "date", "maxLength": 8 }, - "cancelledRoomNights": { - "description": "Number of cancelled room nights.", - "type": "integer" - }, - "noShowRoomNights": { - "description": "Number of no show room nights.", - "type": "integer" - }, - "travelAgentReferenceId": { - "description": "Travel Agent reference number for stay record.", + "status": { + "description": "Status of the invoice.", "type": "string", "minLength": 0, - "maxLength": 60 + "maxLength": 20 }, - "allotmentCode": { - "description": "Allotment Code for stay record.", + "transactionCode": { + "description": "Transaction code of the invoice.", "type": "string", "minLength": 0, "maxLength": 20 }, - "primarySharer": { - "description": "Indicates whether the guest was the primary sharer or not.", - "type": "boolean" + "folioNo": { + "description": "Folio Number.", + "type": "number" }, - "exchangeRate": { - "description": "Exchange Rate.", + "invoiceNo": { + "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios", "type": "number" }, - "promotionCode": { - "description": "Promotion code associated with the stay.", + "fiscalBillNo": { + "description": "The Fiscal Bill number of this posting", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "bookedRoomType": { - "description": "Indicate the category of room originally booked.", + "folioTypeName": { + "description": "The name of the Folio Type used for the Folio Number sequence.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 100 }, - "channelCode": { - "description": "Indicate channel for stay.", + "internalFolioWindowID": { + "description": "Internal window ID which is unique to the reservation. This ID can only be used for reference.", "type": "string", "minLength": 0, "maxLength": 20 }, - "stayRecordId": { - "description": "Stay Record identifier.", - "$ref": "#/definitions/uniqueID_Type" - } - } - }, - "revenueStatisticsSummaryListType": { - "type": "array", - "description": "List of the detailed and yearly summarized information about the profile revenue.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/revenueStatisticsSummaryType" - } - }, - "revenueStatisticsSummaryType": { - "type": "object", - "description": "Summary of the revenue for a year", - "properties": { - "revenueDetails": { - "description": "Details regarding the profile revenue belonging to the specified year.", - "$ref": "#/definitions/revenueStatisticsDetailListType" - }, - "revenueBucketsSummary": { - "description": "Details about revenue summary.", - "$ref": "#/definitions/revenueBucketListType" - }, - "year": { - "description": "Year of the revenue.", + "folioDate": { + "description": "Date of Folio Generation.", "type": "string", - "minLength": 4, - "maxLength": 4 - } - } - }, - "revenueStatisticsDetailListType": { - "type": "array", - "description": "The collection of profile revenue statistics.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/revenueStatisticsDetailType" - } - }, - "revenueStatisticsDetailType": { - "type": "object", - "description": "The different statistics from the revenue of a profile.", - "properties": { - "stayTimeSpan": { - "description": "The stay time span of the reservation.", - "$ref": "#/definitions/timeSpanType" + "format": "date", + "maxLength": 8 }, - "guestName": { - "description": "Name Of The Guest.", + "folioStatus": { + "$ref": "#/definitions/folioStatusType" + }, + "folioNoWithPrefix": { + "description": "The folio number with prefix value.", "type": "string", "minLength": 0, "maxLength": 200 }, - "profileIdList": { - "description": "Id of the guest profile in the reservation.", - "$ref": "#/definitions/profileIdList" - }, - "reservationIdList": { - "description": "Id of the reservation.", - "$ref": "#/definitions/reservationIdList" - }, - "revenueType": { - "description": "Revenue Type for Stay.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "folioSeqNo": { + "description": "Unique sequence number. Used to identify the current folio tax record.", + "type": "number" }, - "revenueBuckets": { - "description": "The different revenue buckets of a profile.", - "$ref": "#/definitions/revenueBucketListType" + "invoiceType": { + "description": "Invoice code of the invoice.", + "$ref": "#/definitions/aRInvoiceCategory" }, - "centralRevenue": { - "description": "Central Revenue Type for Stay.", - "type": "number" + "statementNo": { + "description": "Statementno of the invoice.", + "type": "integer" }, - "localRevenue": { - "description": "Local Revenue Type for Stay.", - "type": "number" + "revenueDate": { + "description": "Revenue date ID of the invoice.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "hotelId": { - "description": "Hotel of the reservation.", + "closeDate": { + "description": "Close date of the invoice.", "type": "string", - "minLength": 0, - "maxLength": 20 - } - } - }, - "statisticsReportType": { - "type": "string", - "enum": [ - "Reservation", - "Revenue", - "ProfileStayRecords", - "DetailStayRecordsRevenue" - ], - "description": "Indicate to get revenue of Stay Records." - }, - "profileSummaries": { - "type": "object", - "description": "Response object for fetching profiles. This object contains profile primary details,profile summary details,master info list containing code and description used as lookup for description.", - "properties": { - "profileSummaries": { - "description": "Type contains Profile's summary information.", - "$ref": "#/definitions/profileSummariesType" + "format": "date", + "maxLength": 8 }, - "masterInfoList": { - "description": "Refer to Generic common types document.", - "type": "array", - "items": { - "$ref": "#/definitions/masterInfoType" - } + "postingDate": { + "description": "Posting date of the invoice.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "links": { - "$ref": "#/definitions/links" + "transferDate": { + "description": "Transfer date of the invoice.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "canBeModified": { + "description": "Flag to indicate if postings or adjustments can be made to the invoice.", + "type": "boolean" } } }, - "profileSummariesType": { + "marketCodeInfoType": { "type": "object", - "description": "A complex type containing the collection of Profile objects or Unique IDs of Profiles.", "properties": { - "profileInfo": { - "description": "A collection of Profiles or Unique IDs of Profiles.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileSummaryInfoType" - } - }, - "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" + "marketCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "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" + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "marketGroup": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "count": { - "description": "Total number of rows returned", - "type": "integer" + "description": { + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "checkedProfiles": { + "roomClassCodeInfoType": { "type": "object", - "description": "Response for checking allowed actions, existence of attached records, or indicators of a profile.", + "description": "Code of the room class type.", "properties": { - "checkProfilesDetail": { - "description": "Collection of profiles and the status of its allowed actions, attached records, and indicators.", - "$ref": "#/definitions/checkProfilesType" + "roomClassCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "links": { - "$ref": "#/definitions/links" + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "description": { + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "checkProfilesType": { - "type": "array", - "description": "Collection of profiles and the status of its allowed actions, attached records, and indicators.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/checkProfileType" - } - }, - "checkProfileType": { + "sourceCodeInfoType": { "type": "object", - "description": "Profile and the status of its allowed actions, attached records, and indicators.", "properties": { - "profileId": { - "description": "Unique identifier of the profile.", - "$ref": "#/definitions/profileId" + "sourceCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "results": { - "description": "Collection of status of allowed actions, attached records, and indicators of the profile.", - "$ref": "#/definitions/checkProfileResultsType" + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "sourceGroup": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "checkProfileResultsType": { - "type": "array", - "description": "Collection of status of allowed actions, attached records, and indicators of the profile.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/checkProfileResultType" - } - }, - "checkProfileResultType": { + "cashierInfoType": { "type": "object", - "description": "Status of allowed actions, attached records, and indicators of the profile.", + "description": "Cashier information. Contains Id and Name details of the cashier.", "properties": { - "checkProfileInstruction": { - "description": "Indicates status of allowed actions, total number of attached records, or number of occurrences of indicator of a profile.", - "$ref": "#/definitions/checkProfileInstructionType" + "cashierId": { + "description": "Cashier Id of the Cashier.", + "type": "number" }, - "exists": { - "description": "Indicates status of allowed actions, total number of attached records, or number of occurrences of indicator of a profile.", - "type": "boolean" + "cashierName": { + "description": "Cashier Name.", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "checkProfileInstructionType": { - "type": "string", - "description": "Simple type that corresponds to check profile instructions.", - "enum": [ - "HasWebAccounts" - ] - }, - "profileActivityLog": { + "trxInfoType": { "type": "object", - "description": "Response object for fetching profile activity log. This object contains collection of user activity log for the profile,Success,Warnings and Errors related to this operation", + "description": "Transaction codes info.", "properties": { - "activityLog": { - "description": "Collection of user activity log for the profile.", - "$ref": "#/definitions/activityLogListType" + "description": { + "description": "Transaction codes info.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "links": { - "$ref": "#/definitions/links" + "transactionGroup": { + "description": "Category of the transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "activityLogListType": { - "type": "object", - "properties": { - "activityLog": { + "transactionSubGroup": { + "description": "Sub category of the transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "universalProductCode": { + "description": "Unique Universal product code of the transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "routingInstructionsId": { + "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.", + "type": "number" + }, + "articles": { + "description": "The List of Articles defined for this transaction code, when using the Articles functionality.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/activityLogType" + "$ref": "#/definitions/articleInfoType" } }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", - "type": "integer" + "trxServiceType": { + "description": "Contains service type for transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "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" + "transactionCode": { + "description": "Unique identifier for the Transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "hotelId": { + "description": "Hotel context of the Transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "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.", + "printTrxReceipt": { + "description": "Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.", "type": "boolean" - }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" - }, - "count": { - "description": "Total number of rows returned", - "type": "integer" } } }, - "activityLogType": { + "articleInfoType": { "type": "object", + "description": "Information regarding an article.", "properties": { - "hotelId": { + "description": { + "description": "Description of the article.", "type": "string", "minLength": 0, - "maxLength": 20 - }, - "module": { - "type": "string" + "maxLength": 2000 }, - "logDate": { + "transactionCode": { + "description": "Transaction code to which the article belongs.", "type": "string", - "format": "date-time" - }, - "refActionId": { - "type": "number" - }, - "logUserId": { - "type": "integer" + "minLength": 0, + "maxLength": 20 }, - "logUserName": { - "type": "string" + "price": { + "description": "Default price of the article.", + "$ref": "#/definitions/currencyAmountType" }, - "machineStation": { - "type": "string" + "postIt": { + "description": "Post it information of the article.", + "$ref": "#/definitions/articlePostItType" }, - "croCode": { + "universalProductCode": { + "description": "Unique Universal product code of the article.", "type": "string", "minLength": 0, "maxLength": 20 }, - "actionType": { + "hotelId": { + "description": "Hotel code to which the article belongs.", "type": "string", "minLength": 0, - "maxLength": 100 + "maxLength": 20 }, - "actionDescription": { + "articleCode": { + "description": "Unique code of the article.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "iPAddress": { - "description": "The IP Address of the machine that performed the activity", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "inactive": { + "description": "Indicates whether the article is inactive or not.", + "type": "boolean" }, - "deviceCode": { - "description": "The selected device code", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" } } }, - "profileAccounts": { + "articlePostItType": { "type": "object", - "description": "Response of profile accounts.", + "description": "Post it information of an article.", "properties": { - "accounts": { - "description": "Collection of profile accounts.", - "$ref": "#/definitions/aRAccountsType" - }, - "links": { - "$ref": "#/definitions/links" + "availableForPostIt": { + "description": "Indicates whether the article is available for post it.", + "type": "boolean" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "color": { + "description": "Color indicator which is only configurable if article is available for post it.", + "$ref": "#/definitions/colorType" } } }, - "aRAccountsType": { - "type": "array", - "description": "Information regarding the AR Account.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/aRAccountType" - } + "colorType": { + "type": "string", + "description": "Color configuration type. This color configuration provides a visual category of entities.", + "enum": [ + "Red", + "DarkRed", + "Green", + "DarkGreen", + "LightGreen", + "Orange", + "White", + "Yellow", + "DarkYellow", + "Purple", + "Brown", + "Gray", + "Aqua", + "Chocolate", + "Blue", + "LightBlue", + "DarkBlue", + "Cyan", + "DarkCyan", + "Magenta", + "DarkMagenta", + "Black" + ] }, - "aRAccountType": { + "profileInfoType": { "type": "object", - "description": "Accounts Receivabales Account details type.", + "description": "Provides information about attached profiles to the block.", "properties": { - "hotelId": { - "description": "Property where the AR Account exists.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "profileId": { + "description": "Opera ID for the profile attached to the block.", + "$ref": "#/definitions/uniqueID_Type" }, - "accountName": { - "description": "Name of the AR Account.", + "name": { + "description": "Name for the profile attached to the block.", "type": "string", "minLength": 0, "maxLength": 200 }, - "accountId": { - "description": "The unique ID for the Account.", - "$ref": "#/definitions/uniqueID_Type" - }, - "accountNo": { - "description": "The Account Number for the Account.", + "city": { + "description": "City for the profile attached to the block.", "type": "string", "minLength": 0, - "maxLength": 20 - }, - "profileId": { - "description": "Internal Profile ID for the AR Account.", - "$ref": "#/definitions/profileId" - }, - "balance": { - "description": "Open Balance of the Account for this property.", - "$ref": "#/definitions/currencyAmountType" - }, - "creditLimit": { - "description": "The maximum credit allowed for the Account.", - "$ref": "#/definitions/currencyAmountType" + "maxLength": 80 }, - "contactName": { - "description": "The person to contact for this Account.", + "phone": { + "description": "Phone for the profile attached to the block.", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 80 }, - "paymentDueDays": { - "description": "Number of days on which person can make payment.", + "type": { + "description": "Defines the type of Linked profiles for a block.", "type": "string", "minLength": 0, "maxLength": 20 + } + } + }, + "folioStatusType": { + "type": "string", + "description": "The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.", + "enum": [ + "Deposit", + "Void", + "Ok", + "Zero", + "Compress", + "Converted", + "Internal" + ] + }, + "aRInvoiceCategory": { + "type": "string", + "enum": [ + "Normal", + "Credit", + "OldBalance", + "PasserBy" + ] + }, + "aRPaymentsType": { + "type": "array", + "description": "A collection of AR Payments.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/aRPaymentType" + } + }, + "aRPaymentType": { + "type": "object", + "description": "Details of an AR Payment.", + "properties": { + "age": { + "description": "The Aging age of the payment.", + "type": "integer" }, - "monthEndCalcYN": { - "description": "Month End Calculation.", - "type": "boolean" - }, - "address": { - "description": "Address information for the address which is attached to this AR Account.", - "$ref": "#/definitions/addressInfoType" - }, - "email": { - "description": "Email information for the Account. This is the Email that is attached to this AR Account.", - "$ref": "#/definitions/emailInfoType" - }, - "telephones": { - "description": "The Telephone and Fax details attached to the Account.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/telephoneInfoType" - } - }, - "lastReminderInfo": { - "description": "Report History Type used as based type for Remiders and Statements History types.", - "type": "object", - "properties": { - "reportName": { - "description": "Report Name.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "reportFileName": { - "description": "Report file name when exists to allow report re-printing.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "dateSent": { - "description": "The Reminder Letter name which is to be used for this Reminder based on the setup on the Account Type.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "age": { - "description": "The minimum age(days) of the invoices to be included in the Reminder", - "type": "integer" - }, - "historyExists": { - "description": "Indicates that reminders history exists.", - "type": "boolean" - } - } - }, - "lastStatementInfo": { - "description": "Report History Type used as based type for Remiders and Statements History types.", - "type": "object", - "properties": { - "reportName": { - "description": "Report Name.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "reportFileName": { - "description": "Report file name when exists to allow report re-printing.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "dateSent": { - "description": "The Reminder Letter name which is to be used for this Reminder based on the setup on the Account Type.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "statementNo": { - "description": "When using Statement Numbering, a unique number is associated to the Statement.", - "type": "integer" - }, - "historyExists": { - "description": "Indicates that statement history exists.", - "type": "boolean" - } - } - }, - "notes": { - "description": "The Note details attached to the Account.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/commentInfoType" - } - }, - "traces": { - "description": "The Trace details attached to the Account.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/traceType" - } - }, - "fixedCharges": { - "description": "Fixed charges attached to this AR Account.", - "$ref": "#/definitions/fixedChargesType" - }, - "accountIndicators": { - "description": "Indicators of additional information attached to the Account.", - "$ref": "#/definitions/indicatorsType" + "amount": { + "description": "Amount of the Payment.", + "$ref": "#/definitions/currencyAmountType" }, - "agingInfo": { - "description": "The Aging balance information for this account, by Aging Buckets.", - "$ref": "#/definitions/aRAgingInfoType" + "amountUsed": { + "description": "Total amount applied against an invoice.", + "$ref": "#/definitions/currencyAmountType" }, - "yearViewInfo": { - "description": "The Year View balance information for this account.", - "$ref": "#/definitions/aRYearViewInfoType" + "balance": { + "description": "Amount still open which has not been applied against any invoice.", + "$ref": "#/definitions/currencyAmountType" }, - "invoices": { - "description": "List of all Invoices.", - "$ref": "#/definitions/aRInvoicesType" + "reference": { + "description": "User-defined posting reference.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "payments": { - "description": "List of all Payments made.", - "$ref": "#/definitions/aRPaymentsType" + "remark": { + "description": "User-defined posting remark.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "summary": { - "description": "The Summary Information of the Invoices for the Account.", - "$ref": "#/definitions/aRBalanceType" + "cashierInfo": { + "description": "Cashier information. Contains Id and Name details of the cashier.", + "$ref": "#/definitions/cashierInfoType" }, - "status": { - "description": "The status of the account.", - "$ref": "#/definitions/aRAccountStatusType" + "paymentCard": { + "description": "Payment card details.", + "$ref": "#/definitions/resPaymentCardType" }, - "batchStatement": { - "description": "Include In Batch Statement", + "transferredOut": { "type": "boolean" }, - "printFoliosWithStatement": { - "description": "Indicates if associated folios should be printed by default with the statement.", + "transferredIn": { "type": "boolean" }, - "emailStatementsReminders": { - "description": "Indicates if the Account has opted to send the statements and reminders to the Account email address by default.", - "type": "boolean" + "hotelId": { + "description": "Property code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "searchMatches": { - "description": "Super Search matching terms.", - "$ref": "#/definitions/searchMatchesType" + "transactionNo": { + "description": "Unique Transaction Identifier of the Payment.", + "type": "number" }, - "primary": { - "description": "Indicates if this Account is the Primary Account for this Guest/Company.", - "type": "boolean" + "transactionDate": { + "description": "Date of the Payment.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "type": { - "description": "The type of Account.", + "transactionCode": { + "description": "Transaction code of the Payment.", "type": "string", "minLength": 0, "maxLength": 20 }, - "accountTypeDescription": { - "description": "The description of the Account Type.", + "postingDate": { + "description": "Posting date of the invoice.", "type": "string", - "minLength": 0, - "maxLength": 2000 + "format": "date", + "maxLength": 8 }, - "permanent": { - "description": "Indicates if this is a Permanent Account. Permanent Accounts cannot be deleted.", - "type": "boolean" + "revenueDate": { + "description": "Revenue date ID of the invoice.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "transferDate": { + "description": "Transfer of the invoice.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "sequenceNo": { + "description": "When this PostingType is used to return the postings generated by a batch request, the sequence number is used to relate to the Request's sequence number.", + "type": "integer" } } }, - "traceType": { + "profileAttachments": { "type": "object", + "description": "Response object with the details of the attachments of a profile.", "properties": { - "timeInfo": { - "description": "Date of the trace.", - "$ref": "#/definitions/traceTimeInfoType" + "profileAttachments": { + "description": "List of Attachments associated with the requesting Profile.", + "$ref": "#/definitions/attachmentsType" }, - "reservationId": { - "description": "Reservation ID of the reservation for which the traces are to be retrieved.", - "$ref": "#/definitions/reservationId" + "links": { + "$ref": "#/definitions/links" }, - "departmentId": { - "description": "Indicates the Department code.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "attachmentsType": { + "type": "array", + "description": "Attachment List.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/attachmentType" + } + }, + "attachmentType": { + "type": "object", + "description": "Attached files.", + "properties": { + "fileName": { + "description": "Name of the file.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "traceText": { - "description": "The information this trace contains.", - "type": "string" + "fileSize": { + "description": "Size of the file.", + "type": "integer" }, - "resolveInfo": { - "description": "Information regarding the status of the trace", - "$ref": "#/definitions/traceResolveType" + "description": { + "description": "Description for the file.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "global": { + "description": "Flag to say if attachment is available across properties.", + "type": "boolean" + }, + "hotelId": { + "description": "Hotel Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "history": { + "description": "History data associated with Attachment.", + "$ref": "#/definitions/dateTimeStampGroupType" }, "url": { "description": "URL that identifies the location associated with the record identified by the UniqueID.", @@ -32692,7 +37245,12 @@ "idExtension": { "description": "Additional identifying value assigned by the creating system.", "type": "integer" - }, + } + } + }, + "dateTimeStampGroupType": { + "type": "object", + "properties": { "createDateTime": { "description": "Time stamp of the creation.", "type": "string", @@ -32717,1104 +37275,1145 @@ } } }, - "traceTimeInfoType": { + "award": { "type": "object", + "description": "Request object to redeem award.", "properties": { - "dateTimeSpan": { - "description": "Time span for the trace.", - "$ref": "#/definitions/dateTimeSpanType" - }, - "traceOn": { - "description": "Date of the trace.", - "type": "string", - "format": "date-time" + "memberAward": { + "$ref": "#/definitions/memberAwardType" }, - "traceTime": { - "description": "Time of the trace", - "type": "string", - "minLength": 0, - "maxLength": 20 + "links": { + "$ref": "#/definitions/links" }, - "enteredBy": { - "description": "User that entered this trace.", - "type": "string" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "dateTimeSpanType": { + "memberAwardType": { "type": "object", - "description": "Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date.", "properties": { - "startDateTime": { + "profileIdList": { + "description": "Unique identifiers for the Profile for both internal and external systems.", + "$ref": "#/definitions/profileIdList" + }, + "membershipType": { + "description": "The type of the membership.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 20 }, - "endDateTime": { + "membershipCardNo": { + "description": "The card number associated with this membership.", "type": "string", - "format": "date-time" - } - } - }, - "traceResolveType": { - "type": "object", - "properties": { - "resolvedOn": { - "description": "Date the trace was resolved", + "minLength": 0, + "maxLength": 50 + }, + "membershipLevel": { + "description": "The current level of the membership.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "resolvedBy": { - "description": "User that resolved the trace", - "type": "string" + "sourceCode": { + "description": "To specify where the business came from e.g. radio, newspaper ad, etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "reservationIdList": { + "description": "Unique identifiers for the Reservation like Confirmation Number.", + "$ref": "#/definitions/reservationIdList" + }, + "adults": { + "description": "Number of adults associated with the reservation.", + "type": "integer" + }, + "reservationTimeSpan": { + "description": "Arrival and Departure dates of the reservation.", + "$ref": "#/definitions/timeSpanType" + }, + "memberPointsBefore": { + "description": "Member points before award transaction.", + "type": "integer" + }, + "memberPointsAfter": { + "description": "Member points after award transaction.", + "type": "integer" + }, + "awardPoints": { + "description": "Points associated with the award.", + "type": "integer" + }, + "cancelPointsReturn": { + "description": "Number of cancel points returned.", + "type": "integer" + }, + "actualCancelPoints": { + "description": "Actual number of cancel points.", + "type": "integer" + }, + "expiryPoints": { + "description": "Points that will expire.", + "type": "integer" + }, + "awardProcessType": { + "description": "Processing type of the award like Actual , Projected or Inactive.", + "$ref": "#/definitions/memberAwardProcessType" + }, + "memberAwardDetails": { + "description": "Details related to member award per stay date.", + "$ref": "#/definitions/memberAwardDetailsType" + }, + "hotelId": { + "description": "Property associated with the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, - "fixedChargesType": { + "memberAwardProcessType": { + "type": "string", + "description": "Processing type of the award like Actual , Projected or Inactive.", + "enum": [ + "Actual", + "Projected", + "Inactive" + ] + }, + "memberAwardDetailsType": { "type": "array", - "description": "Holds fixed charge detail.", + "description": "Details related to member award per stay date.", "maxItems": 4000, "items": { - "$ref": "#/definitions/fixedChargeType" + "$ref": "#/definitions/memberAwardDetailType" } }, - "fixedChargeType": { + "memberAwardDetailType": { "type": "object", - "description": "Holds fixed charge information.", + "description": "Details related to member award like award type, stay date, rate code, etc.", "properties": { - "schedule": { - "description": "Holds schedule of fixed charge.", - "$ref": "#/definitions/fixedChargeScheduleType" - }, - "charge": { - "description": "Holds specific details of fixed charge.", - "$ref": "#/definitions/fixedChargeDetailType" + "awardType": { + "description": "The award type or code.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "url": { - "description": "URL that identifies the location associated with the record identified by the UniqueID.", - "type": "string" + "actionType": { + "description": "Award issue , cancel or update action.", + "$ref": "#/definitions/memberAwardActionType" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", + "awardBasedOn": { + "description": "Indicates if award is a Stay, Package Element or other.", "type": "string", "minLength": 0, "maxLength": 20 }, - "instance": { - "description": "The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "cancelPenaltyDays": { + "description": "Number days before arrival to apply penalty for cancellation.", + "type": "integer" }, - "idContext": { - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "type": "string", - "minLength": 0, - "maxLength": 80 + "cancelPenaltyCharge": { + "description": "Number points deducted if award is cancelled.", + "type": "integer" }, - "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.", + "cancelPenaltyType": { + "description": "Type of cancel penalty like Points, etc.", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 20 }, - "idExtension": { - "description": "Additional identifying value assigned by the creating system.", + "cancelPenaltyPoints": { + "description": "Number of penalty points if cancelled.", "type": "integer" - } - } - }, - "fixedChargeScheduleType": { - "type": "object", - "description": "Holds schedule of fixed charge.", - "properties": { - "start": { - "description": "The starting value of the date range.", + }, + "numberOfNights": { + "description": "Number of nights cancel policy is applicable.", + "type": "integer" + }, + "cancelPolicyType": { + "description": "Type of cancel policy.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "end": { - "description": "The ending value of the date range.", + "stayDate": { + "description": "Date of stay.", "type": "string", "format": "date", "maxLength": 8 }, - "frequency": { - "description": "Frequency of a fixed charge.", - "$ref": "#/definitions/fixedChargeFrequencyType" - }, - "dayToExecute": { - "description": "Day of when to execute fixed charge. Applicable when frequency is Daily or Weekly.", + "rateCode": { + "description": "Rate code associated with the reservation.", "type": "string", "minLength": 0, - "maxLength": 3 + "maxLength": 20 }, - "dateToExecute": { - "description": "Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.", + "roomType": { + "description": "Room type label associated with the reservation.", "type": "string", - "format": "date", - "maxLength": 8 - } - } - }, - "fixedChargeFrequencyType": { - "type": "string", - "description": "Yearly.", - "enum": [ - "O", - "D", - "W", - "M", - "Q", - "Y" - ] - }, - "fixedChargeDetailType": { - "type": "object", - "description": "Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.", - "properties": { - "transaction": { - "description": "Transaction code and description of a fixed charge.", - "$ref": "#/definitions/codeDescriptionType" - }, - "quantity": { - "description": "Quantity of the product.", - "type": "integer" + "minLength": 0, + "maxLength": 20 }, - "chargeAmount": { - "description": "Price of the product.", - "$ref": "#/definitions/currencyAmountType" + "product": { + "description": "Product code for which the award was issued, in case of a product award.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "percent": { - "description": "Percentage of the rate amount.", - "type": "number", - "minimum": 0, - "maximum": 100 + "fromRoomType": { + "description": "Room type label before the upgrade in case of an upgrade award.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "supplement": { - "description": "Additional information regarding the fixed charge.", + "toRoomType": { + "description": "Room type label after the upgrade for an upgrade award.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "article": { - "description": "Holds related article code and description.", - "$ref": "#/definitions/codeDescriptionType" + "totalLocalAmount": { + "description": "Total Local Amount on bill in Hotel Currency.", + "type": "number" }, - "roomNights": { - "description": "Holds number of comp or cash room night to allocate.", - "type": "integer" - } - } - }, - "aRAgingInfoType": { - "type": "object", - "description": "Information regarding the aging balances for an account.", - "properties": { - "totalOutstanding": { - "description": "The total debit and credit balance of the account.", - "$ref": "#/definitions/aRBalanceType" + "redeemedLocalAmount": { + "description": "Redeemed Local Amount on bill in Hotel Currency.", + "type": "number" }, - "aging": { - "description": "The debit and credit balance per Aging bucket.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/aRAgingType" - } - } - } - }, - "aRBalanceType": { - "type": "object", - "description": "Balance information for AR.", - "properties": { - "debit": { - "description": "Debit Balance amount. The amount owed by the Account.", - "$ref": "#/definitions/currencyAmountType" + "totalCentralAmount": { + "description": "Total Central Amount on bill in External System Currency.", + "type": "number" }, - "credit": { - "description": "The credit Balance amount. Any payment that is Unallocated i.e not applied against an invoice, is included in this.", - "$ref": "#/definitions/currencyAmountType" + "redeemedCentralAmount": { + "description": "Redeemed Central Amount on bill in External System Currency.", + "type": "number" }, - "total": { - "description": "The total balance i.e Debit minus Credit amounts.", - "$ref": "#/definitions/currencyAmountType" - } - } - }, - "aRAgingType": { - "type": "object", - "description": "Aging information for an Aging Bucket.", - "properties": { - "agingBucketRange": { - "description": "The bucket description in terms of days. Example : 0-31 days", + "transactionCode": { + "description": "The Payment Transaction Code for which the Surcharge Applies.", "type": "string", "minLength": 0, "maxLength": 20 }, - "agingDate": { - "description": "The start date and end date for this Aging bucket.", - "$ref": "#/definitions/dateRangeType" + "transactionNo": { + "description": "Unique Transaction Identifier.", + "type": "number" + }, + "exchangeRateType": { + "description": "Exchange Rate Type for the Currency Exchange.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "awardVoucherNo": { + "description": "Award Voucher Number.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "awardProductId": { + "description": "Unique ID for the award product if issued.", + "$ref": "#/definitions/uniqueID_Type" }, - "balanceInfo": { - "description": "The balance amounts for this bucket. Contains the Debit Balance, Credit Balance and the Total Balance.", - "$ref": "#/definitions/aRBalanceType" + "awardCancellationNo": { + "description": "Unique ID for the award cancellation if cancelled.", + "$ref": "#/definitions/uniqueID_Type" }, - "agingStartDay": { - "description": "The start number of days for this Aging bucket. Example: For the range 31-60 days, this would be 31.", - "type": "integer" + "inactive": { + "description": "If the award detail is inactive.", + "type": "boolean" }, - "agingEndDay": { - "description": "The end number of days for this Aging bucket. Example: For the range 31-60 days, this would be 60.", + "pointsRequired": { + "description": "Points required for the stay date.", "type": "integer" }, - "sequence": { - "description": "The sequence for display.", + "actualCancelPoints": { + "description": "Actual number of cancel points.", "type": "integer" } } }, - "dateRangeType": { - "type": "object", - "description": "Date Range with Start and End dates.", - "properties": { - "start": { - "description": "The starting value of the date range.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "end": { - "description": "The ending value of the date range.", - "type": "string", - "format": "date", - "maxLength": 8 - } - } - }, - "aRYearViewInfoType": { - "type": "object", - "description": "Information regarding Year View balances for an account.", - "properties": { - "totalOutstanding": { - "description": "The total debit and credit balance of the account.", - "$ref": "#/definitions/aRBalanceType" - }, - "yearView": { - "description": "The debit and credit balance per account.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/aRYearViewType" - } - } - } + "memberAwardActionType": { + "type": "string", + "description": "Specify whether award is to issue, cancel or update.", + "enum": [ + "Issue", + "Cancel", + "InfoUpdate", + "CxlWithoutPenalty" + ] }, - "aRYearViewType": { + "awardDetails": { "type": "object", - "description": "Year information for an Year View.", + "description": "Response of fetch awards request.", "properties": { - "dateRange": { - "description": "The period start and end date.", - "$ref": "#/definitions/dateRangeType" + "profileAwards": { + "description": "Profile awards and certificates.", + "$ref": "#/definitions/awardsType" }, - "balanceInfo": { - "description": "The balance amounts for this date range. Contains the Debit Balance, Credit Balance and the Total Balance.", - "$ref": "#/definitions/aRBalanceType" + "links": { + "$ref": "#/definitions/links" }, - "runningTotal": { - "description": "The running total balance for the date range.", - "$ref": "#/definitions/currencyAmountType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "aRInvoicesType": { + "awardsType": { "type": "array", - "description": "A collection of AR Invoices.", + "description": "List of awards.", "maxItems": 4000, "items": { - "$ref": "#/definitions/aRInvoiceType" + "$ref": "#/definitions/awardType" } }, - "aRInvoiceType": { + "awardType": { "type": "object", - "description": "Details of an AR Invoice.", + "description": "Detailed information of the awards.", "properties": { - "hotelId": { - "description": "Property where the invoice exists.", + "awardCode": { + "description": "Award category.", "type": "string", "minLength": 0, "maxLength": 20 }, - "reservationId": { - "description": "Reservation ID of the invoice.", - "$ref": "#/definitions/reservationId" - }, - "guestProfileId": { - "description": "Guest Profile ID of the invoice.", - "$ref": "#/definitions/uniqueID_Type" + "awardType": { + "description": "Can be P (Paper) or E (E-Certificate).", + "$ref": "#/definitions/awardKindType" }, - "age": { - "description": "The Aging age of the invoice", - "type": "integer" + "description": { + "description": "Description of the award/certificate.", + "type": "string" }, - "guestName": { - "description": "Name of the Guest who consumed these transactions.", + "certificateNo": { + "description": "Certificate No.", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 20 }, - "originalAmount": { - "description": "Original Amount of the Invoice", - "$ref": "#/definitions/currencyAmountType" + "masterCertificiateNo": { + "description": "Master Certificate No.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "amount": { - "description": "Current Amount of the Invoice.", - "$ref": "#/definitions/currencyAmountType" + "membershipNo": { + "description": "Membership No.", + "type": "string" }, - "payments": { - "description": "Total Payments made to this Invoice.", - "$ref": "#/definitions/currencyAmountType" + "hotelId": { + "description": "Hotel Code for which the routing instructions are provided for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "balance": { - "description": "Amount still open which has not been paid", - "$ref": "#/definitions/currencyAmountType" + "hotelCategory": { + "description": "Indicates the lowest hotel category for which the certificate is valid.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "reference": { - "description": "User-defined posting reference.", + "externalHotelCode": { + "description": "Hotel Code of the CRS application that this certificate belongs to.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "remark": { - "description": "User-defined posting remark.", + "externalConfirmationNo": { + "description": "Confirmation Number given by a CRS application for this reservation.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "adjusted": { + "categoryValid": { + "description": "Indicates whether the category of certificate is valid or not for this resort.", "type": "boolean" }, - "parentInvoiceNo": { - "type": "number" + "reservationCertificateType": { + "description": "[R]=Reward, [I]=Incentive.", + "$ref": "#/definitions/reservationCertificateType" }, - "compressed": { - "type": "boolean" + "rewardCertificateType": { + "description": "[RE]=Regular Certificate, [SA]=Stay Anytime Certificate, [PS]=Point Saver Certificate.", + "$ref": "#/definitions/rewardCertificateType" }, - "compressedDate": { + "status": { + "description": "Status of the award aka available.", + "$ref": "#/definitions/awardStatusType" + }, + "expirationDate": { + "description": "Expiration Date.", "type": "string", "format": "date", "maxLength": 8 }, - "transferredOut": { + "gift": { + "description": "Signifies whether award is gift or not.", "type": "boolean" }, - "transferredIn": { + "upgrade": { + "description": "Signifies whether upgrade award or not.", "type": "boolean" }, - "market": { - "description": "Invoice market code.", - "$ref": "#/definitions/marketCodeInfoType" + "package": { + "description": "Signifies whether upgrade is package or not.", + "type": "boolean" }, - "roomClass": { - "description": "Invoice room class code.", - "$ref": "#/definitions/roomClassCodeInfoType" + "instantlyRedeemable": { + "description": "Indicates if the award is an Instant Redemption award.", + "type": "boolean" }, - "source": { - "description": "Invoice source code.", - "$ref": "#/definitions/sourceCodeInfoType" + "paidUpgrade": { + "description": "Indicates if this certificate was ordered using the \"Paid Upgrade\" option in the E-Certs screen.", + "type": "boolean" }, - "reservationInfo": { - "description": "Reservation guest details.", - "$ref": "#/definitions/reservationInfoType" + "detailedCertificate": { + "description": "Indicates if this certificate is detailed or not.", + "type": "boolean" }, - "cashierInfo": { - "description": "Cashier information. Contains Id and Name details of the cashier.", - "$ref": "#/definitions/cashierInfoType" + "nights": { + "description": "Award Nights.", + "type": "integer" }, - "transactionInfo": { - "description": "Transaction information .", - "$ref": "#/definitions/trxInfoType" + "sourceType": { + "description": "MRW : From MRW MAN:Entered manually.", + "type": "string" }, - "paymentCard": { - "description": "Payment card details.", - "$ref": "#/definitions/resPaymentCardType" + "points": { + "description": "No. of points used to order this award.", + "type": "number" }, - "addresseeInfo": { - "description": "Addressee Information for the folio. This is available when the Addressee functionality is used and and Addressee is attached to the folio of the Invoice.", - "$ref": "#/definitions/profileInfoType" + "fBAInfo": { + "description": "FBA related fields.", + "$ref": "#/definitions/fBAInfoType" }, - "allowPartialTransferYn": { - "description": "Flag to check Partail Transfer Allowed.", - "type": "boolean" + "reservationId": { + "description": "Reservation IDs will be empty if award is not attached.", + "$ref": "#/definitions/reservationId" }, - "printed": { - "description": "Flag to check Invoice Statement is Printed.", - "type": "boolean" + "profileId": { + "description": "Unique profile identifier requested to be fetched.", + "$ref": "#/definitions/profileId" }, - "printedDate": { - "description": "Invoice Statement Printed Date.", - "type": "string", - "format": "date", - "maxLength": 8 + "quantity": { + "description": "Quantity of such awards needed to be ordered.", + "type": "integer" }, - "storedFolioId": { - "description": "ID of the Stored Folio.", - "$ref": "#/definitions/uniqueID_Type" + "displaySequence": { + "description": "Indicates the order in which the certificates received from MRW.", + "type": "number" }, - "storedFolioName": { - "description": "Name of the Stored Folio.", + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" + }, + "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": 2000 + "maxLength": 200 }, - "storedDebitFolioId": { - "description": "ID of the Stored Debit Folio.", - "$ref": "#/definitions/uniqueID_Type" + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" }, - "storedDebitFolioName": { - "description": "Name of the Stored Debit Folio.", + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 200 + } + } + }, + "profileCashieringDetailsInfo": { + "type": "object", + "description": "Response object containing profile routing instructions.", + "properties": { + "profileCashieringDetailList": { + "description": "Cashiering details for the profile.", + "type": "array", + "items": { + "$ref": "#/definitions/profileCashieringDetailType" + } }, - "folioTexts": { - "description": "Additional text fields to display on the folio.", - "$ref": "#/definitions/folioTextsType" + "links": { + "$ref": "#/definitions/links" }, - "transactionNo": { - "description": "Unique Transaction Identifier of the Invoice.", - "type": "number" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "profileCashieringDetailType": { + "type": "object", + "description": "The type contains routing instructions for the profile.", + "properties": { + "paymentMethod": { + "description": "Payment Method Details.", + "$ref": "#/definitions/codeDescriptionType" }, - "transactionDate": { - "description": "Transaction Date of the invoice.", - "type": "string", - "format": "date", - "maxLength": 8 + "eCommerceId": { + "description": "E-Commerce ID of the Profile", + "$ref": "#/definitions/uniqueID_Type" }, - "status": { - "description": "Status of the invoice.", + "routingInstructions": { + "description": "Set of preconfigured transaction codes.", + "$ref": "#/definitions/profileRoutingInstructionsType" + }, + "taxType": { + "description": "Tax type code.", "type": "string", "minLength": 0, "maxLength": 20 }, - "transactionCode": { - "description": "Transaction code of the invoice.", + "fiscalGuestType": { + "description": "Guest type code.", "type": "string", "minLength": 0, "maxLength": 20 }, - "folioNo": { - "description": "Folio Number.", - "type": "number" + "hotelId": { + "description": "Hotel Code for which the routing instructions are provided for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "profileRoutingInstructionsType": { + "type": "object", + "description": "The type contains routing instructions for the profile.", + "properties": { + "transactionCodes": { + "description": "Set of preconfigured transaction codes.", + "$ref": "#/definitions/trxCodesInfoType" }, - "invoiceNo": { - "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios", - "type": "number" + "billingInstructions": { + "description": "Set of preconfigured Billing Instruction results.", + "$ref": "#/definitions/billingInstructionsType" }, - "fiscalBillNo": { - "description": "The Fiscal Bill number of this posting", + "autoPopulateRouting": { + "description": "A flag which determines whether the instructions has to be automatically populated for this profile or not.", + "type": "boolean" + } + } + }, + "trxCodesInfoType": { + "type": "array", + "description": "List of Transaction codes info.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/trxInfoType" + } + }, + "billingInstructionsType": { + "type": "array", + "description": "Set of Billing Instruction codes.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/billingInstructionType" + } + }, + "billingInstructionType": { + "type": "object", + "description": "Configured Billing Instruction which represents a set of Transaction Codes.", + "properties": { + "desc": { + "description": "Billing Instruction code description.", "type": "string", "minLength": 0, "maxLength": 2000 }, - "folioTypeName": { - "description": "The name of the Folio Type used for the Folio Number sequence.", - "type": "string", - "minLength": 0, - "maxLength": 100 + "routingInstructionsId": { + "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.", + "type": "number" }, - "internalFolioWindowID": { - "description": "Internal window ID which is unique to the reservation. This ID can only be used for reference.", + "billingCode": { + "description": "Unique identifier for the Billing Instruction.", "type": "string", "minLength": 0, "maxLength": 20 }, - "folioDate": { - "description": "Date of Folio Generation.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "folioStatus": { - "$ref": "#/definitions/folioStatusType" - }, - "folioNoWithPrefix": { - "description": "The folio number with prefix value.", + "hotelId": { + "description": "Hotel context of the Billing Instruction.", "type": "string", "minLength": 0, - "maxLength": 200 - }, - "folioSeqNo": { - "description": "Unique sequence number. Used to identify the current folio tax record.", - "type": "number" + "maxLength": 20 + } + } + }, + "profileCashieringDetails": { + "type": "object", + "description": "Request object for changing the profile cashiering details.", + "properties": { + "profileIdList": { + "description": "Unique identifier for the profile for both internal and external systems.", + "$ref": "#/definitions/profileIdList" }, - "invoiceType": { - "description": "Invoice code of the invoice.", - "$ref": "#/definitions/aRInvoiceCategory" + "profileCashieringDetailList": { + "description": "Cashiering details for the profile.", + "type": "array", + "items": { + "$ref": "#/definitions/profileCashieringDetailType" + } }, - "statementNo": { - "description": "Statementno of the invoice.", - "type": "integer" + "links": { + "$ref": "#/definitions/links" }, - "revenueDate": { - "description": "Revenue date ID of the invoice.", - "type": "string", - "format": "date", - "maxLength": 8 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "profileCommissionAccountInfo": { + "type": "object", + "description": "Response object for fetching profile commission detail.", + "properties": { + "profileCommissionAccountInfoList": { + "$ref": "#/definitions/profileCommissionAccountInfoListType" }, - "closeDate": { - "description": "Close date of the invoice.", - "type": "string", - "format": "date", - "maxLength": 8 + "links": { + "$ref": "#/definitions/links" }, - "postingDate": { - "description": "Posting date of the invoice.", - "type": "string", - "format": "date", - "maxLength": 8 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "profileCommissionAccountInfoListType": { + "type": "array", + "description": "Profile commission info which contains bank account and commission code details.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileCommissionAccountInfoType" + } + }, + "profileCommissionAccountInfoType": { + "type": "object", + "description": "Profile commission info which contains bank account and commission code details", + "properties": { + "profileId": { + "description": "Unique profile identifier.", + "$ref": "#/definitions/profileId" }, - "transferDate": { - "description": "Transfer date of the invoice.", - "type": "string", - "format": "date", - "maxLength": 8 + "bankAccount": { + "description": "Bank account details", + "$ref": "#/definitions/bankAccountType" }, - "canBeModified": { - "description": "Flag to indicate if postings or adjustments can be made to the invoice.", - "type": "boolean" + "commissionCode": { + "description": "Commission code details", + "$ref": "#/definitions/codeDescriptionType" } } }, - "marketCodeInfoType": { + "bankAccountType": { "type": "object", + "description": "Bank account information like Account ID, Bank Name, Currency, etc.", "properties": { - "marketCode": { + "hotelId": { + "description": "Property of the bank account.", "type": "string", "minLength": 0, "maxLength": 20 }, - "hotelId": { + "bankAccountId": { + "description": "Bank account ID.", + "$ref": "#/definitions/uniqueID_Type" + }, + "bankAccountNo": { + "description": "Account number at the bank.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 80 }, - "marketGroup": { + "bankCode": { + "description": "Unique code of the bank account.", "type": "string", "minLength": 0, "maxLength": 20 }, - "description": { + "branchCode": { + "description": "Code for the branch of the bank.", "type": "string", "minLength": 0, - "maxLength": 2000 - } - } - }, - "roomClassCodeInfoType": { - "type": "object", - "description": "Code of the room class type.", - "properties": { - "roomClassCode": { + "maxLength": 20 + }, + "bankName": { + "description": "Name of the bank account.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "hotelId": { + "paymentMethod": { + "description": "Type of payment associated with the bank account.", + "$ref": "#/definitions/commissionPaymentMethodType" + }, + "checkFormat": { + "description": "Type of format for Payment Method.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 80 }, - "description": { + "currency": { + "description": "Currency associated with the bank account.", + "$ref": "#/definitions/codeDescriptionType" + }, + "currentCheckNo": { + "description": "Current check no of the bank account.", + "type": "number" + }, + "hotelName": { + "description": "Property name of the bank account.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 80 + }, + "default": { + "description": "Whether this bank account is to be the default in case no bank account is associated with the travel agent or source.", + "type": "boolean" + }, + "linkedToProfile": { + "description": "Whether this bank account is associated with the travel agent or source.", + "type": "boolean" } } }, - "sourceCodeInfoType": { + "commissionPaymentMethodType": { "type": "object", + "description": "This contains a generic code and description information.", "properties": { - "sourceCode": { - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "hotelId": { + "code": { + "description": "Code.", "type": "string", "minLength": 0, "maxLength": 20 }, - "sourceGroup": { + "description": { + "description": "description.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "description": { + "format": { + "description": "Payment format if the payment method is EFT.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 3 } } }, - "cashierInfoType": { + "profileCommissionAccount": { "type": "object", - "description": "Cashier information. Contains Id and Name details of the cashier.", + "description": "Request object for creating profile commission detail.", "properties": { - "cashierId": { - "description": "Cashier Id of the Cashier.", - "type": "number" + "criteria": { + "$ref": "#/definitions/profileCommissionAccountCriteriaType" }, - "cashierName": { - "description": "Cashier Name.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "trxInfoType": { + "profileCommissionAccountCriteriaType": { "type": "object", - "description": "Transaction codes info.", + "description": "Contains base info to determine profile commission bank account and code.", "properties": { - "description": { - "description": "Transaction codes info.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "transactionGroup": { - "description": "Category of the transaction code.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "transactionSubGroup": { - "description": "Sub category of the transaction code.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "universalProductCode": { - "description": "Unique Universal product code of the transaction code.", + "hotelId": { + "description": "Hotel code from which the profile bank account and code belongs to", "type": "string", "minLength": 0, "maxLength": 20 }, - "routingInstructionsId": { - "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.", - "type": "number" - }, - "articles": { - "description": "The List of Articles defined for this transaction code, when using the Articles functionality.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/articleInfoType" - } - }, - "trxServiceType": { - "description": "Contains service type for transaction code.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "profileId": { + "description": "Unique profile identifier.", + "$ref": "#/definitions/profileId" }, - "transactionCode": { - "description": "Unique identifier for the Transaction code.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "bankAccountId": { + "description": "Bank account ID.", + "$ref": "#/definitions/uniqueID_Type" }, - "hotelId": { - "description": "Hotel context of the Transaction code.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "commissionCode": { + "description": "Profile commission code", + "$ref": "#/definitions/codeDescriptionType" }, - "printTrxReceipt": { - "description": "Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.", + "validatePending": { + "description": "Used in CRUD operations. When set to true, proceed validating pending commissions", "type": "boolean" } } }, - "articleInfoType": { + "emailMessageType": { "type": "object", - "description": "Information regarding an article.", + "description": "Request object for storing an email.", "properties": { - "description": { - "description": "Description of the article.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "blockId": { + "description": "ID of the Block that is associated with the email.", + "$ref": "#/definitions/stringLength80" }, - "transactionCode": { - "description": "Transaction code to which the article belongs.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "fromAddress": { + "description": "The address that originated the email.", + "$ref": "#/definitions/basicEmailType" }, - "price": { - "description": "Default price of the article.", - "$ref": "#/definitions/currencyAmountType" + "toAddress": { + "description": "A collection of email addresses for recipients who were sent the email message", + "$ref": "#/definitions/basicEmailListType" }, - "postIt": { - "description": "Post it information of the article.", - "$ref": "#/definitions/articlePostItType" + "subject": { + "description": "The subject line of the email.", + "$ref": "#/definitions/stringLength200" }, - "universalProductCode": { - "description": "Unique Universal product code of the article.", + "emailBody": { + "description": "Email in base64 binary format.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "byte" }, - "hotelId": { - "description": "Hotel code to which the article belongs.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "messageId": { + "description": "Global ID of the email message from the external system.", + "$ref": "#/definitions/stringLength100" }, - "articleCode": { - "description": "Unique code of the article.", + "emailReceiveDate": { + "description": "The date the email was received.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date-time" }, - "inactive": { - "description": "Indicates whether the article is inactive or not.", + "hasAttachment": { + "description": "Indicates whether the email was sent with an attachment (true) or not (false).", "type": "boolean" }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "articlePostItType": { + "stringLength80": { + "type": "string", + "description": "Used for Character Strings, length 0 to 80.", + "maxLength": 80, + "minLength": 0 + }, + "basicEmailListType": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/basicEmailType" + } + }, + "stringLength200": { + "type": "string", + "description": "Used for Character Strings, length 0 to 200.", + "maxLength": 200, + "minLength": 0 + }, + "stringLength100": { + "type": "string", + "description": "Used for Character Strings, length 0 to 100.", + "maxLength": 100, + "minLength": 0 + }, + "accountForecasts": { "type": "object", - "description": "Post it information of an article.", + "description": "Response object for showing forecast information of account profile.", "properties": { - "availableForPostIt": { - "description": "Indicates whether the article is available for post it.", + "accountForecastDetails": { + "description": "Type contains forecast information of the account profile.", + "$ref": "#/definitions/accountForecastsType" + }, + "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" }, - "color": { - "description": "Color indicator which is only configurable if article is available for post it.", - "$ref": "#/definitions/colorType" + "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" } } }, - "colorType": { - "type": "string", - "description": "Color configuration type. This color configuration provides a visual category of entities.", - "enum": [ - "Red", - "DarkRed", - "Green", - "DarkGreen", - "LightGreen", - "Orange", - "White", - "Yellow", - "DarkYellow", - "Purple", - "Brown", - "Gray", - "Aqua", - "Chocolate", - "Blue", - "LightBlue", - "DarkBlue", - "Cyan", - "DarkCyan", - "Magenta", - "DarkMagenta", - "Black" - ] + "accountForecastsType": { + "type": "array", + "description": "Detail Information about Account Forecast.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/accountForecastType" + } }, - "profileInfoType": { + "accountForecastType": { "type": "object", - "description": "Provides information about attached profiles to the block.", + "description": "Detail Information about Account Forecast.", "properties": { - "profileId": { - "description": "Opera ID for the profile attached to the block.", + "hotelId": { + "description": "Hotel Code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "accountId": { + "description": "Unique Account ID", "$ref": "#/definitions/uniqueID_Type" }, - "name": { - "description": "Name for the profile attached to the block.", + "periodCode": { + "description": "Specifies the Fiscal or Calendar Period Code for the forecast", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 20 }, - "city": { - "description": "City for the profile attached to the block.", + "periodDescription": { + "description": "Specifies the Fiscal or Calendar Period Description for the forecast.", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 100 }, - "phone": { - "description": "Phone for the profile attached to the block.", + "periodStartDate": { + "description": "Specifies the Period Start Date", "type": "string", - "minLength": 0, - "maxLength": 80 + "format": "date", + "maxLength": 8 }, - "type": { - "description": "Defines the type of Linked profiles for a block.", + "periodEndDate": { + "description": "Specifies the Period End Date", "type": "string", - "minLength": 0, - "maxLength": 20 - } - } - }, - "folioStatusType": { - "type": "string", - "description": "The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.", - "enum": [ - "Deposit", - "Void", - "Ok", - "Zero", - "Compress", - "Converted", - "Internal" - ] - }, - "aRInvoiceCategory": { - "type": "string", - "enum": [ - "Normal", - "Credit", - "OldBalance", - "PasserBy" - ] - }, - "aRPaymentsType": { - "type": "array", - "description": "A collection of AR Payments.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/aRPaymentType" - } - }, - "aRPaymentType": { - "type": "object", - "description": "Details of an AR Payment.", - "properties": { - "age": { - "description": "The Aging age of the payment.", + "format": "date", + "maxLength": 8 + }, + "roomNights": { + "description": "Room Nights for the forecast", "type": "integer" }, - "amount": { - "description": "Amount of the Payment.", + "averageRate": { + "description": "Average Rate for the forecast", "$ref": "#/definitions/currencyAmountType" }, - "amountUsed": { - "description": "Total amount applied against an invoice.", + "roomRevenue": { + "description": "Room Revenue for the forecast", "$ref": "#/definitions/currencyAmountType" }, - "balance": { - "description": "Amount still open which has not been applied against any invoice.", + "foodAndBeverageRevenue": { + "description": "Food and Beverage revenue for the forecast", "$ref": "#/definitions/currencyAmountType" }, - "reference": { - "description": "User-defined posting reference.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "otherRevenue": { + "description": "Other revenue (For example, function space rental, equipment rental, etc.) of forecast.", + "$ref": "#/definitions/currencyAmountType" }, - "remark": { - "description": "User-defined posting remark.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "totalRevenue": { + "description": "Total revenue for the forecast", + "$ref": "#/definitions/currencyAmountType" }, - "cashierInfo": { - "description": "Cashier information. Contains Id and Name details of the cashier.", - "$ref": "#/definitions/cashierInfoType" + "overrideForecast": { + "description": "This element is used for overriding any existing forecasts for a profile, Please select Default, if you want to be notified of a warning message. No Forecast is overridden or created. Please select Override, if existing forecasts are to be overridden and new forecasts are to be created. Please select DoNotOverride, if existing forecasts are not to be overridden and new forecasts are to be created.", + "$ref": "#/definitions/overrideForecastTypeType" + } + } + }, + "overrideForecastTypeType": { + "type": "string", + "description": "Defines values for OverrideForecastType.", + "enum": [ + "Default", + "Override", + "DoNotOverride" + ] + }, + "forecastsInformation": { + "type": "object", + "properties": { + "forecastsInformation": { + "description": "Account Forecast details to be created.", + "$ref": "#/definitions/accountForecastsType" }, - "paymentCard": { - "description": "Payment card details.", - "$ref": "#/definitions/resPaymentCardType" + "links": { + "$ref": "#/definitions/links" }, - "transferredOut": { - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "changeAccountForecastsRS": { + "type": "object", + "description": "Response Body.", + "properties": { + "success": { + "description": "Refer to Generic common types document.", + "$ref": "#/definitions/successType" }, - "transferredIn": { - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" }, - "hotelId": { - "description": "Property code.", + "errors": { + "description": "Refer to Generic common types document.", + "$ref": "#/definitions/errorsType" + }, + "echoToken": { + "description": "A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.", "type": "string", "minLength": 0, - "maxLength": 20 - }, - "transactionNo": { - "description": "Unique Transaction Identifier of the Payment.", - "type": "number" + "maxLength": 128 }, - "transactionDate": { - "description": "Date of the Payment.", + "timeStamp": { + "description": "Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date-time" }, - "transactionCode": { - "description": "Transaction code of the Payment.", + "version": { + "description": "For all Opera versioned messages, the version of the message is indicated by a Opera Version value.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 40 }, - "postingDate": { - "description": "Posting date of the invoice.", + "correlationId": { + "description": "Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 80 }, - "revenueDate": { - "description": "Revenue date ID of the invoice.", - "type": "string", - "format": "date", - "maxLength": 8 + "retryAllowed": { + "description": "Indicates if the operation supports the ability to retry the request.", + "type": "boolean" }, - "transferDate": { - "description": "Transfer of the invoice.", - "type": "string", - "format": "date", - "maxLength": 8 + "enforceAllowed": { + "description": "Indicates if the operation supports the ability to force the retry request through OPERA services in the case where the external system continues to fail.", + "type": "boolean" }, - "sequenceNo": { - "description": "When this PostingType is used to return the postings generated by a batch request, the sequence number is used to relate to the Request's sequence number.", - "type": "integer" - } - } - }, - "profileAttachments": { - "type": "object", - "description": "Response object with the details of the attachments of a profile.", - "properties": { - "profileAttachments": { - "description": "List of Attachments associated with the requesting Profile.", - "$ref": "#/definitions/attachmentsType" + "useLocalAllowed": { + "description": "This attribute carries the user selected confirmation value on confirmation popup.", + "type": "boolean" }, "links": { "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" } } }, - "attachmentsType": { + "successType": { + "type": "object", + "description": "Returning an empty element of this type indicates the successful processing of an message. This is used in conjunction with the Warning Type to report any warnings or business errors.", + "properties": {} + }, + "errorsType": { "type": "array", - "description": "Attachment List.", - "maxItems": 4000, + "description": "An error that occurred during the processing of a message.", + "maxItems": 99, "items": { - "$ref": "#/definitions/attachmentType" + "$ref": "#/definitions/errorType" } }, - "attachmentType": { + "errorType": { "type": "object", - "description": "Attached files.", + "description": "Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.", "properties": { - "fileName": { - "description": "Name of the file.", + "value": { "type": "string", - "minLength": 0, - "maxLength": 2000 + "description": "Property Value" }, - "fileSize": { - "description": "Size of the file.", - "type": "integer" + "shortText": { + "description": "An abbreviated version of the error in textual format.", + "type": "string" }, - "description": { - "description": "Description for the file.", + "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": 4000 + "maxLength": 20 }, - "global": { - "description": "Flag to say if attachment is available across properties.", - "type": "boolean" + "docURL": { + "description": "If present, this URL refers to an online description of the error that occurred.", + "type": "string" }, - "hotelId": { - "description": "Hotel Code.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "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" }, - "history": { - "description": "History data associated with Attachment.", - "$ref": "#/definitions/dateTimeStampGroupType" + "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" }, - "url": { - "description": "URL that identifies the location associated with the record identified by the UniqueID.", + "recordId": { + "description": "If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.", "type": "string" }, "type": { - "description": "A reference to the type of object defined by the UniqueID element.", + "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 }, - "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.", + "language": { + "description": "Language identification.", "type": "string", - "minLength": 0, - "maxLength": 80 + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, - "idContext": { - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "type": "string", - "minLength": 0, - "maxLength": 80 + "nodeList": { + "description": "An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional contraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.", + "type": "string" + } + } + }, + "linkedProfiles": { + "type": "object", + "description": "Response of fetch set of linked Profiles to the requested Profile.", + "properties": { + "profileSummaries": { + "description": "Linked profile's summary information.", + "$ref": "#/definitions/profileSummariesType" }, - "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 + "links": { + "$ref": "#/definitions/links" }, - "idExtension": { - "description": "Additional identifying value assigned by the creating system.", - "type": "integer" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "dateTimeStampGroupType": { + "matchedProfiles": { "type": "object", + "description": "Response object for the match profiles.", "properties": { - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" - }, - "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 + "matchProfiles": { + "description": "A collection of match profiles.", + "$ref": "#/definitions/matchProfileType" }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" + "links": { + "$ref": "#/definitions/links" }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", - "type": "string", - "minLength": 0, - "maxLength": 200 + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "award": { + "membershipTransactionExceptions": { "type": "object", - "description": "Request object to redeem award.", + "description": "Response object for fetching membership transaction exceptions.", "properties": { - "memberAward": { - "$ref": "#/definitions/memberAwardType" + "memberTransactionExceptions": { + "description": "A collection of membership transaction exceptions.", + "$ref": "#/definitions/membershipTransactionExceptionsType" }, "links": { "$ref": "#/definitions/links" @@ -33824,18 +38423,31 @@ } } }, - "memberAwardType": { + "membershipTransactionExceptionsType": { + "type": "array", + "description": "Contains Membership transaction exception information.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/membershipTransactionExceptionType" + } + }, + "membershipTransactionExceptionType": { "type": "object", + "description": "Details about a membership like ProfileID, Card Number, Type, Level, etc.", "properties": { - "profileIdList": { - "description": "Unique identifiers for the Profile for both internal and external systems.", - "$ref": "#/definitions/profileIdList" + "profileId": { + "description": "The profile to which this membership is associated with.", + "$ref": "#/definitions/profileId" }, - "membershipType": { - "description": "The type of the membership.", + "name": { + "description": "The profile name associated with this membership.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 128 + }, + "membershipId": { + "description": "Unique identifier of this membership.", + "$ref": "#/definitions/uniqueID_Type" }, "membershipCardNo": { "description": "The card number associated with this membership.", @@ -33843,248 +38455,304 @@ "minLength": 0, "maxLength": 50 }, + "membershipType": { + "description": "The type of the membership.", + "$ref": "#/definitions/codeDescriptionType" + }, "membershipLevel": { "description": "The current level of the membership.", "type": "string", "minLength": 0, "maxLength": 20 }, - "sourceCode": { - "description": "To specify where the business came from e.g. radio, newspaper ad, etc.", + "joinedDate": { + "description": "Date when the member enrolled for the membership.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "cardExpirationDate": { + "description": "Membership card expiration date.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "membershipTransactionId": { + "description": "Unique identifier associated with the membership transaction.", + "$ref": "#/definitions/membershipTransactionId" + }, + "hotelId": { + "description": "Hotel code of the membership transaction exceptions.", "type": "string", "minLength": 0, "maxLength": 20 }, - "reservationIdList": { - "description": "Unique identifiers for the Reservation like Confirmation Number.", - "$ref": "#/definitions/reservationIdList" - }, - "adults": { - "description": "Number of adults associated with the reservation.", - "type": "integer" + "fromToRangeDate": { + "description": "Arrival and Departure date of stay for which you are displaying membership transaction exceptions.", + "$ref": "#/definitions/dateRangeType" }, - "reservationTimeSpan": { - "description": "Arrival and Departure dates of the reservation.", - "$ref": "#/definitions/timeSpanType" + "reservationNumber": { + "description": "Any reference like reservation no etc against which the certificate was consumed.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "memberPointsBefore": { - "description": "Member points before award transaction.", + "roomsBooked": { + "description": "If multiple room membership transaction exceptions occurred, the number of rooms booked.(MR)", "type": "integer" }, - "memberPointsAfter": { - "description": "Member points after award transaction.", - "type": "integer" + "backToBack": { + "description": "Indicates if back to back membership transaction exceptions have occurred or not.", + "type": "string", + "minLength": 0, + "maxLength": 2 }, - "awardPoints": { - "description": "Points associated with the award.", - "type": "integer" + "averageRate": { + "description": "The average rate of the stay.", + "type": "number" }, - "cancelPointsReturn": { - "description": "Number of cancel points returned.", - "type": "integer" + "tierStays": { + "description": "Tier stay points associated with this membership points transaction.", + "type": "number" }, - "actualCancelPoints": { - "description": "Actual number of cancel points.", - "type": "integer" + "totalAwardPoints": { + "description": "Award points associated with this membership points transaction.", + "type": "number" }, - "expiryPoints": { - "description": "Points that will expire.", - "type": "integer" + "totalNights": { + "description": "Tier night points associated with this membership points transaction.", + "type": "number" }, - "awardProcessType": { - "description": "Processing type of the award like Actual , Projected or Inactive.", - "$ref": "#/definitions/memberAwardProcessType" + "totalRevenue": { + "description": "Tier revenue points associated with this membership points transaction.", + "type": "number" }, - "memberAwardDetails": { - "description": "Details related to member award per stay date.", - "$ref": "#/definitions/memberAwardDetailsType" + "pointsCalculate": { + "description": "Points Calculated value(Y/N) for the selected transaction.", + "type": "boolean" }, - "hotelId": { - "description": "Property associated with the reservation.", + "userNotes": { + "description": "Notes regarding the resolution of the membership transaction exception or for any other reason.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 4000 + }, + "processingMessages": { + "description": "The systems records and notes identifying the exception criteria.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "totalPoints": { + "description": "The total number of award points associated with this transaction.", + "type": "number" + }, + "awardBasePoints": { + "description": "The total number of base award points for this membership points transaction.", + "type": "number" + }, + "awardBonusPoints": { + "description": "Indicates if this transaction involves bonus points, The total number of bonus points.", + "type": "number" + }, + "tierPoints": { + "description": "Details if this transaction is associated with tier points.", + "$ref": "#/definitions/membershipTransactionTierPointsType" + }, + "computedPoints": { + "description": "Information to compute award and tier points for membership transaction exception.", + "$ref": "#/definitions/membershipTransactionExceptionComputePointsType" + }, + "exceptionType": { + "description": "Indicates the type of Exception like Exception not resolved,Points Rejected on Exception etc.,", + "type": "integer" } } }, - "memberAwardProcessType": { - "type": "string", - "description": "Processing type of the award like Actual , Projected or Inactive.", - "enum": [ - "Actual", - "Projected", - "Inactive" - ] - }, - "memberAwardDetailsType": { - "type": "array", - "description": "Details related to member award per stay date.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/memberAwardDetailType" - } - }, - "memberAwardDetailType": { + "membershipTransactionExceptionComputePointsType": { "type": "object", - "description": "Details related to member award like award type, stay date, rate code, etc.", + "description": "Options to compute award and tier points for membership transaction exception.", "properties": { - "awardType": { - "description": "The award type or code.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "awardBasePoints": { + "description": "Indicates if membership transaction exception should be created for base award points.", + "type": "boolean" }, - "actionType": { - "description": "Award issue , cancel or update action.", - "$ref": "#/definitions/memberAwardActionType" + "awardBonusPoints": { + "description": "Indicates if membership transaction exception should be created for bonus award points.", + "type": "boolean" }, - "awardBasedOn": { - "description": "Indicates if award is a Stay, Package Element or other.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "tierPointsBaseStay": { + "description": "Indicates if membership transaction exception should be created for base tier points for the stay.", + "type": "boolean" }, - "cancelPenaltyDays": { - "description": "Number days before arrival to apply penalty for cancellation.", - "type": "integer" + "tierPointsBonusStay": { + "description": "Indicates if membership transaction exception should be created for tier bonus points for the stay.", + "type": "boolean" }, - "cancelPenaltyCharge": { - "description": "Number points deducted if award is cancelled.", - "type": "integer" + "tierPointsBaseNights": { + "description": "Indicates if membership transaction exception should be created for base tier points for the night.", + "type": "boolean" }, - "cancelPenaltyType": { - "description": "Type of cancel penalty like Points, etc.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "tierPointsBonusNights": { + "description": "Indicates if membership transaction exception should be created for tier bonus points for the night.", + "type": "boolean" }, - "cancelPenaltyPoints": { - "description": "Number of penalty points if cancelled.", - "type": "integer" + "tierPointsBaseRevenue": { + "description": "Indicates if membership transaction exception should be created for base tier points for the revenue.", + "type": "boolean" }, - "numberOfNights": { - "description": "Number of nights cancel policy is applicable.", - "type": "integer" + "tierPointsBonusRevenue": { + "description": "Indicates if membership transaction exception should be created for tier bonus points for the revenue.", + "type": "boolean" + } + } + }, + "membership": { + "type": "object", + "description": "Request object for create membership. This object contains unique identifiers for each profile and list of membership details to be created. The standard optional Opera Context element is also included.", + "properties": { + "profileIdList": { + "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", + "$ref": "#/definitions/profileIdList" }, - "cancelPolicyType": { - "description": "Type of cancel policy.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "profileMemberships": { + "description": "Detailed information of membership related to the profile", + "type": "array", + "items": { + "$ref": "#/definitions/profileMembershipType" + } }, - "stayDate": { - "description": "Date of stay.", - "type": "string", - "format": "date", - "maxLength": 8 + "links": { + "$ref": "#/definitions/links" }, - "rateCode": { - "description": "Rate code associated with the reservation.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "changedMembership": { + "type": "object", + "description": "Response object for change/update membership. This object contains collection of memberships,Success,Warnings and Errors related to this operation", + "properties": { + "profileMemberships": { + "description": "Detailed information of membership related to the profile", + "type": "array", + "items": { + "$ref": "#/definitions/profileMembershipType" + } }, - "roomType": { - "description": "Room type label associated with the reservation.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "links": { + "$ref": "#/definitions/links" }, - "product": { - "description": "Product code for which the award was issued, in case of a product award.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "memberInformation": { + "type": "object", + "description": "Response object for member info.", + "properties": { + "memberInfo": { + "$ref": "#/definitions/memberInfoRSType" }, - "fromRoomType": { - "description": "Room type label before the upgrade in case of an upgrade award.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "memberInfoRSType": { + "type": "object", + "properties": { + "memberInfoDetails": { + "description": "Points and stay details of the membership.", + "$ref": "#/definitions/memberInfoDetailsType" + }, + "memberInfoRangeDetails": { + "description": "Points and stay details for the membership range.", + "$ref": "#/definitions/memberInfoDetailsType" + }, + "nextTierPoints": { + "description": "Points required for next tier of membership.", + "type": "integer" }, - "toRoomType": { - "description": "Room type label after the upgrade for an upgrade award.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "pointsAvailable": { + "description": "Points available for the member.", + "type": "integer" + } + } + }, + "memberInfoDetailsType": { + "type": "object", + "properties": { + "guestTotalNights": { + "description": "Total nights of the guest.", + "type": "integer" }, - "totalLocalAmount": { - "description": "Total Local Amount on bill in Hotel Currency.", - "type": "number" + "guestTotalStay": { + "description": "STotal stays of the guest.", + "type": "integer" }, - "redeemedLocalAmount": { - "description": "Redeemed Local Amount on bill in Hotel Currency.", - "type": "number" + "tierBaseNights": { + "description": "Tier Base Nights Points.", + "type": "integer" }, - "totalCentralAmount": { - "description": "Total Central Amount on bill in External System Currency.", + "tierBaseRevenue": { + "description": "Tier Base Revenue Points.", "type": "number" }, - "redeemedCentralAmount": { - "description": "Redeemed Central Amount on bill in External System Currency.", - "type": "number" + "tierBaseStay": { + "description": "Tier Base Stay Points.", + "type": "integer" }, - "transactionCode": { - "description": "The Payment Transaction Code for which the Surcharge Applies.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "tierBonusNights": { + "description": "Tier Bonus Nights Points.", + "type": "integer" }, - "transactionNo": { - "description": "Unique Transaction Identifier.", + "tierBonusRevenue": { + "description": "Tier Bonus Revenue Points.", "type": "number" }, - "exchangeRateType": { - "description": "Exchange Rate Type for the Currency Exchange.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "tierBonusStay": { + "description": "Tier Bonus Stay Points.", + "type": "integer" }, - "awardVoucherNo": { - "description": "Award Voucher Number.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "membershipTotalNights": { + "description": "Total Nights of the membership.", + "type": "integer" }, - "awardProductId": { - "description": "Unique ID for the award product if issued.", - "$ref": "#/definitions/uniqueID_Type" + "membershipTotalStay": { + "description": "Total Stay of the membership.", + "type": "integer" }, - "awardCancellationNo": { - "description": "Unique ID for the award cancellation if cancelled.", - "$ref": "#/definitions/uniqueID_Type" + "awardBasePoints": { + "description": "Total base points of the award.", + "type": "integer" }, - "inactive": { - "description": "If the award detail is inactive.", - "type": "boolean" + "awardBonusPoints": { + "description": "Total bonus points of the award.", + "type": "integer" }, - "pointsRequired": { - "description": "Points required for the stay date.", + "awardMiscPoints": { + "description": "Total miscellaneous points of the award.", "type": "integer" }, - "actualCancelPoints": { - "description": "Actual number of cancel points.", + "totalAwardPoints": { + "description": "Total points of the award.", "type": "integer" } } }, - "memberAwardActionType": { - "type": "string", - "description": "Specify whether award is to issue, cancel or update.", - "enum": [ - "Issue", - "Cancel", - "InfoUpdate", - "CxlWithoutPenalty" - ] - }, - "awardDetails": { + "profileOwnersDetail": { "type": "object", - "description": "Response of fetch awards request.", + "description": "Response object to fetch the owners of a profile.", "properties": { - "profileAwards": { - "description": "Profile awards and certificates.", - "$ref": "#/definitions/awardsType" + "profileOwnersList": { + "description": "Collection of the profile owners belonging to the profile requested.", + "$ref": "#/definitions/ownersType" }, "links": { "$ref": "#/definitions/links" @@ -34094,184 +38762,277 @@ } } }, - "awardsType": { - "type": "array", - "description": "List of awards.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/awardType" - } - }, - "awardType": { + "profileOwners": { "type": "object", - "description": "Detailed information of the awards.", + "description": "Request object to change profile owners.", "properties": { - "awardCode": { - "description": "Award category.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "awardType": { - "description": "Can be P (Paper) or E (E-Certificate).", - "$ref": "#/definitions/awardKindType" + "criteria": { + "description": "Criteria to change the owners of a profile.", + "$ref": "#/definitions/setProfileOwnersCriteriaType" }, - "description": { - "description": "Description of the award/certificate.", - "type": "string" + "links": { + "$ref": "#/definitions/links" }, - "certificateNo": { - "description": "Certificate No.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "setProfileOwnersCriteriaType": { + "type": "object", + "description": "Criteria to update the profile owners.", + "properties": { + "profileIdList": { + "description": "Id of the profile of which its owners will be updated.", + "$ref": "#/definitions/profileIdList" }, - "masterCertificiateNo": { - "description": "Master Certificate No.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "owners": { + "description": "Collection of owners that will be updated.", + "$ref": "#/definitions/ownersType" + } + } + }, + "preference": { + "type": "object", + "description": "Response object for fetch preference. This object contains collection of preferences,Success,Warnings and Errors related to this operation.", + "properties": { + "preferenceCollections": { + "description": "Detailed information of preferences related to the profile", + "type": "array", + "items": { + "$ref": "#/definitions/preferenceTypeType" + } }, - "membershipNo": { - "description": "Membership No.", - "type": "string" + "profileIdList": { + "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", + "$ref": "#/definitions/profileIdList" }, - "hotelId": { - "description": "Hotel Code for which the routing instructions are provided for a profile.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "links": { + "$ref": "#/definitions/links" }, - "hotelCategory": { - "description": "Indicates the lowest hotel category for which the certificate is valid.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "profileRelationships": { + "type": "object", + "properties": { + "relationships": { + "description": "Contains a collection of profiles that have a relationship with this profile.", + "$ref": "#/definitions/relationshipsSummary" }, - "externalHotelCode": { - "description": "Hotel Code of the CRS application that this certificate belongs to.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "links": { + "$ref": "#/definitions/links" }, - "externalConfirmationNo": { - "description": "Confirmation Number given by a CRS application for this reservation.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "relationshipsSummary": { + "type": "object", + "description": "Contains details relationships related to a profile.", + "properties": { + "relationship": { + "description": "A collection of the profiles summary that have a relationship with this profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/relationshipInfoSummaryType" + } }, - "categoryValid": { - "description": "Indicates whether the category of certificate is valid or not for this resort.", + "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" }, - "reservationCertificateType": { - "description": "[R]=Reward, [I]=Incentive.", - "$ref": "#/definitions/reservationCertificateType" - }, - "rewardCertificateType": { - "description": "[RE]=Regular Certificate, [SA]=Stay Anytime Certificate, [PS]=Point Saver Certificate.", - "$ref": "#/definitions/rewardCertificateType" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "status": { - "description": "Status of the award aka available.", - "$ref": "#/definitions/awardStatusType" + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "futurePastBookingsCriteria": { + "type": "object", + "description": "Request for information regarding existence of profile in future and/or past business blocks and/or reservations.", + "properties": { + "criteria": { + "description": "Criteria to determine if search should be restricted to future and/or past business blocks and/or reservations, restricted to rate code, or restricted to exclude a given list of reservations and/or blocks.", + "$ref": "#/definitions/hasFuturePastBookingsSearchType" }, - "expirationDate": { - "description": "Expiration Date.", - "type": "string", - "format": "date", - "maxLength": 8 + "links": { + "$ref": "#/definitions/links" }, - "gift": { - "description": "Signifies whether award is gift or not.", - "type": "boolean" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "hasFuturePastBookingsSearchType": { + "type": "object", + "description": "Search type for verifying whether there are future and/or past business blocks and/or reservations exist for a Profile.", + "properties": { + "profileIdList": { + "description": "Unique identifier of the profile to be searched.", + "$ref": "#/definitions/profileIdList" }, - "upgrade": { - "description": "Signifies whether upgrade award or not.", - "type": "boolean" + "searchFor": { + "description": "Search for active or past.", + "type": "string", + "enum": [ + "Active", + "Past" + ] }, - "package": { - "description": "Signifies whether upgrade is package or not.", - "type": "boolean" + "searchIn": { + "description": "Search in business blocks or reservations.", + "type": "string", + "enum": [ + "Block", + "Reservation" + ] }, - "instantlyRedeemable": { - "description": "Indicates if the award is an Instant Redemption award.", - "type": "boolean" + "rateCode": { + "description": "Unique identifier of the rate code of business block or reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "paidUpgrade": { - "description": "Indicates if this certificate was ordered using the \"Paid Upgrade\" option in the E-Certs screen.", - "type": "boolean" + "exclusions": { + "description": "Search to exclude list of reservations and/or business blocks.", + "$ref": "#/definitions/hasFuturePastBookingsExclusionsType" + } + } + }, + "hasFuturePastBookingsExclusionsType": { + "type": "object", + "description": "Search type for excluding list of business blocks and/or reservations.", + "properties": { + "reservationIdList": { + "description": "List of unique identifier of reservation.", + "$ref": "#/definitions/uniqueIDListType" }, - "detailedCertificate": { - "description": "Indicates if this certificate is detailed or not.", + "blockIdList": { + "description": "List of Unique identifier of business block.", + "$ref": "#/definitions/uniqueIDListType" + } + } + }, + "futurePastBookings": { + "type": "object", + "description": "This is the Response Message to information regarding existence of profile in future and/or past business blocks and/or reservations.", + "properties": { + "response": { + "description": "response - whether there are future and/or past business blocks or reservations for the profile.", "type": "boolean" }, - "nights": { - "description": "Award Nights.", - "type": "integer" - }, - "sourceType": { - "description": "MRW : From MRW MAN:Entered manually.", - "type": "string" + "links": { + "$ref": "#/definitions/links" }, - "points": { - "description": "No. of points used to order this award.", - "type": "number" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "profileStayHistory": { + "type": "object", + "description": "Response object for showing stay history and future reservations of specific profile.", + "properties": { + "profileStayDetails": { + "description": "Type contains stay history and future reservations of the specific profile.", + "$ref": "#/definitions/profileStayDetailsType" }, - "fBAInfo": { - "description": "FBA related fields.", - "$ref": "#/definitions/fBAInfoType" + "links": { + "$ref": "#/definitions/links" }, - "reservationId": { - "description": "Reservation IDs will be empty if award is not attached.", - "$ref": "#/definitions/reservationId" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "profileStayDetailsType": { + "type": "object", + "description": "Type provides the stay history and future reservations of specific profile.", + "properties": { + "reservationInfoList": { + "description": "Collection of Detailed information on history and future reservations associated with the profile.", + "$ref": "#/definitions/reservationStayHistoryFutureInfoType" + } + } + }, + "profileRelationship": { + "type": "object", + "description": "Request object for creating profile relationship.", + "properties": { + "relationship": { + "description": "Refer to Relationship Profile request criteria.", + "$ref": "#/definitions/relationshipCriteriaType" }, - "profileId": { - "description": "Unique profile identifier requested to be fetched.", - "$ref": "#/definitions/profileId" + "copyInstructions": { + "description": "Indicates which details of the master profile should be copied to subsidiary profiles, when a master-sub relationship is created for profile types Company, TravelAgent and Source", + "$ref": "#/definitions/copyInstructionsType" }, - "quantity": { - "description": "Quantity of such awards needed to be ordered.", - "type": "integer" + "links": { + "$ref": "#/definitions/links" }, - "displaySequence": { - "description": "Indicates the order in which the certificates received from MRW.", - "type": "number" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "relationshipCriteriaType": { + "type": "object", + "description": "Contains Criteria Information for a profile relationship.", + "properties": { + "primary": { + "description": "Indicates if this relationship is the primary relationship.", + "type": "boolean" }, - "createDateTime": { - "description": "Time stamp of the creation.", + "sourceRelation": { + "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).", "type": "string", - "format": "date-time" + "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.", + "sourceRelationDescription": { + "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).This needs to be passed if the attribute primary is sent as true.", "type": "string", "minLength": 0, "maxLength": 200 }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", + "sourceProfileType": { + "description": "Used to specify a source profile type.", + "$ref": "#/definitions/profileTypeType" + }, + "targetRelation": { + "description": "Indicates the type of relationship the related profile(Target Profile) has with the current profile(Source Profile).", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 20 }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", + "targetRelationDescription": { + "description": "Displays the description of relationship the related profile(Target Profile) has with the current profile(Source Profile).", "type": "string", "minLength": 0, "maxLength": 200 + }, + "targetProfileType": { + "description": "Used to specify a target profile type.", + "$ref": "#/definitions/profileTypeType" } } }, - "profileCashieringDetailsInfo": { + "profileRelationshipToBeChanged": { "type": "object", - "description": "Response object containing profile routing instructions.", + "description": "Request object for changing profile relationship.", "properties": { - "profileCashieringDetailList": { - "description": "Cashiering details for the profile.", - "type": "array", - "items": { - "$ref": "#/definitions/profileCashieringDetailType" - } + "relationship": { + "description": "Refer to Relationship Profile request criteria.", + "$ref": "#/definitions/changeRelationshipCriteriaType" }, "links": { "$ref": "#/definitions/links" @@ -34281,118 +39042,107 @@ } } }, - "profileCashieringDetailType": { + "changeRelationshipCriteriaType": { "type": "object", - "description": "The type contains routing instructions for the profile.", + "description": "Information about the changes in relationship for the profile", "properties": { - "paymentMethod": { - "description": "Payment Method Details.", - "$ref": "#/definitions/codeDescriptionType" - }, - "eCommerceId": { - "description": "E-Commerce ID of the Profile", - "$ref": "#/definitions/uniqueID_Type" + "changeRelationship": { + "description": "Information about the changes in relationship for the profile", + "$ref": "#/definitions/changeRelationsInfoType" }, - "routingInstructions": { - "description": "Set of preconfigured transaction codes.", - "$ref": "#/definitions/profileRoutingInstructionsType" + "relationshipID": { + "description": "Relationship identifier.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "taxType": { - "description": "Tax type code.", + "sourceRelation": { + "description": "Indicates the type of existing relationship the current profile(Source Profile) has with the related profile(Target Profile).", "type": "string", "minLength": 0, "maxLength": 20 }, - "fiscalGuestType": { - "description": "Guest type code.", + "sourceRelationDescription": { + "description": "Displays the description of existing relationship the current profile(Source Profile) has with the related profile(Target Profile).", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 200 }, - "hotelId": { - "description": "Hotel Code for which the routing instructions are provided for a profile.", + "targetRelation": { + "description": "Indicates the type of existing relationship the Related profile(Target Profile) has with the current profile(Source Profile).", "type": "string", "minLength": 0, "maxLength": 20 + }, + "targetRelationDescription": { + "description": "Displays the description of existing relationship the related profile(Target Profile) has with the current profile(Source Profile).", + "type": "string", + "minLength": 0, + "maxLength": 200 } } }, - "profileRoutingInstructionsType": { + "changeRelationsInfoType": { "type": "object", - "description": "The type contains routing instructions for the profile.", + "description": "Detailed information regarding to be changed relationships for the profile.", "properties": { - "transactionCodes": { - "description": "Set of preconfigured transaction codes.", - "$ref": "#/definitions/trxCodesInfoType" - }, - "billingInstructions": { - "description": "Set of preconfigured Billing Instruction results.", - "$ref": "#/definitions/billingInstructionsType" + "changeProfileID": { + "description": "Unique id of the profile to be changed to.", + "$ref": "#/definitions/uniqueID_Type" }, - "autoPopulateRouting": { - "description": "A flag which determines whether the instructions has to be automatically populated for this profile or not.", + "primary": { + "description": "Indicates if this relationship is the primary relationship.", "type": "boolean" - } - } - }, - "trxCodesInfoType": { - "type": "array", - "description": "List of Transaction codes info.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/trxInfoType" - } - }, - "billingInstructionsType": { - "type": "array", - "description": "Set of Billing Instruction codes.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/billingInstructionType" - } - }, - "billingInstructionType": { - "type": "object", - "description": "Configured Billing Instruction which represents a set of Transaction Codes.", - "properties": { - "desc": { - "description": "Billing Instruction code description.", + }, + "sourceProfileType": { + "description": "Used to specify a source profile type.", + "$ref": "#/definitions/profileTypeType" + }, + "sourceRelation": { + "description": "Indicates the type of to be changed relationship the current profile(Source Profile) has with the related profile(Target Profile).", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "routingInstructionsId": { - "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.", - "type": "number" + "sourceRelationDescription": { + "description": "Displays the description of to be changed relationship the current profile(Source Profile) has with the related profile(Target Profile).This needs to be passed if the attribute primary is sent as true.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "billingCode": { - "description": "Unique identifier for the Billing Instruction.", + "targetRelation": { + "description": "Indicates the type of to be changed relationship the Related profile(Target Profile) has with the current profile(Source Profile).", "type": "string", "minLength": 0, "maxLength": 20 }, - "hotelId": { - "description": "Hotel context of the Billing Instruction.", + "targetRelationDescription": { + "description": "Displays the description of to be changed relationship the related profile(Target Profile) has with the current profile(Source Profile).", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 200 + }, + "targetProfileType": { + "description": "Used to specify a target profile type.", + "$ref": "#/definitions/profileTypeType" } } }, - "profileCashieringDetails": { + "profileToBeMerged": { "type": "object", - "description": "Request object for changing the profile cashiering details.", + "description": "Profile Resource will be merged.", "properties": { + "victimProfileId": { + "description": "Provides detailed information regarding either a company or a customer profile.", + "$ref": "#/definitions/uniqueIDListType" + }, "profileIdList": { - "description": "Unique identifier for the profile for both internal and external systems.", + "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as ID.", "$ref": "#/definitions/profileIdList" }, - "profileCashieringDetailList": { - "description": "Cashiering details for the profile.", - "type": "array", - "items": { - "$ref": "#/definitions/profileCashieringDetailType" - } + "profileDetails": { + "description": "Provides detailed information regarding either a company or a customer profile.", + "$ref": "#/definitions/profileType" }, "links": { "$ref": "#/definitions/links" @@ -34402,12 +39152,12 @@ } } }, - "profileCommissionAccountInfo": { + "mergedProfilesSnapshotDetails": { "type": "object", - "description": "Response object for fetching profile commission detail.", + "description": "Response object for fetching snapshot of merge profiles result.", "properties": { - "profileCommissionAccountInfoList": { - "$ref": "#/definitions/profileCommissionAccountInfoListType" + "mergedProfileSnapshot": { + "$ref": "#/definitions/mergedProfileType" }, "links": { "$ref": "#/definitions/links" @@ -34417,1310 +39167,1630 @@ } } }, - "profileCommissionAccountInfoListType": { - "type": "array", - "description": "Profile commission info which contains bank account and commission code details.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileCommissionAccountInfoType" + "mergedProfileType": { + "type": "object", + "description": "Provides information for merged profile.", + "properties": { + "profileIdList": { + "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", + "$ref": "#/definitions/profileIdList" + }, + "profile": { + "description": "Provides detailed information regarding either a company or a customer profile.", + "$ref": "#/definitions/profileType" + } } }, - "profileCommissionAccountInfoType": { + "mergedStageProfileSnapshot": { "type": "object", - "description": "Profile commission info which contains bank account and commission code details", + "description": "Response object to fetch merge profile based on stage and opera profile.", "properties": { - "profileId": { - "description": "Unique profile identifier.", - "$ref": "#/definitions/profileId" + "mergeStageProfile": { + "$ref": "#/definitions/stagedProfileType" }, - "bankAccount": { - "description": "Bank account details", - "$ref": "#/definitions/bankAccountType" + "links": { + "$ref": "#/definitions/links" }, - "commissionCode": { - "description": "Commission code details", - "$ref": "#/definitions/codeDescriptionType" + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "bankAccountType": { + "stagedProfileType": { "type": "object", - "description": "Bank account information like Account ID, Bank Name, Currency, etc.", + "description": "Detailed information about the staged profile.", "properties": { - "hotelId": { - "description": "Property of the bank account.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "profileIdList": { + "description": "List of unique identifier of staged profile.", + "$ref": "#/definitions/uniqueIDListType" }, - "bankAccountId": { - "description": "Bank account ID.", - "$ref": "#/definitions/uniqueID_Type" + "customer": { + "description": "Detailed customer information for this profile.", + "$ref": "#/definitions/stagedProfileCustomerType" }, - "bankAccountNo": { - "description": "Account number at the bank.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "company": { + "description": "Detailed company information for this profile.", + "$ref": "#/definitions/stagedProfileCompanyType" }, - "bankCode": { - "description": "Unique code of the bank account.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "addresses": { + "description": "Collection of detailed information about address for the staged profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileAddressType" + } }, - "branchCode": { - "description": "Code for the branch of the bank.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "telephones": { + "description": "Collection of detailed information about telephone/fax for the staged profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfilePhoneType" + } }, - "bankName": { - "description": "Name of the bank account.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "emails": { + "description": "Collection of detailed information about email for the staged profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileEmailType" + } }, - "paymentMethod": { - "description": "Type of payment associated with the bank account.", - "$ref": "#/definitions/commissionPaymentMethodType" + "uRLs": { + "description": "Collection of detailed information about web url/address for the staged profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileURLType" + } }, - "checkFormat": { - "description": "Type of format for Payment Method.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "memberships": { + "description": "Collection of detailed information about memberships for the staged profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileMembershipType" + } }, - "currency": { - "description": "Currency associated with the bank account.", - "$ref": "#/definitions/codeDescriptionType" + "preferences": { + "description": "Collection of detailed information about preferences for the staged profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfilePreferenceType" + } }, - "currentCheckNo": { - "description": "Current check no of the bank account.", - "type": "number" + "keywords": { + "description": "Collection of detailed information about keyword for the staged profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileKeywordType" + } }, - "hotelName": { - "description": "Property name of the bank account.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "negotiatedRates": { + "description": "Collection of detailed information about negotiated rates for the staged profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileNegotiatedRateType" + } }, - "default": { - "description": "Whether this bank account is to be the default in case no bank account is associated with the travel agent or source.", - "type": "boolean" + "identifications": { + "description": "Collection of detailed information about identification for the staged profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileIdentificationsType" + } }, - "linkedToProfile": { - "description": "Whether this bank account is associated with the travel agent or source.", - "type": "boolean" - } - } - }, - "commissionPaymentMethodType": { - "type": "object", - "description": "This contains a generic code and description information.", - "properties": { - "code": { - "description": "Code.", + "routingInstructions": { + "description": "Collection of routing instructions for the staged profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileRoutingInstructionType" + } + }, + "userDefinedFields": { + "description": "List of user defined fields for the staged profile.", + "$ref": "#/definitions/stagedProfileUserDefinedFieldsType" + }, + "mailingActions": { + "description": "Contains collection of mailing action list associated with the profile", + "$ref": "#/definitions/mailingActionsType" + }, + "privacyInfo": { + "description": "Contains privacy related information associated with the profile", + "$ref": "#/definitions/privacyInfoType" + }, + "comments": { + "description": "List of Notes for the customer.", + "$ref": "#/definitions/stagedProfileCommentInfosType" + }, + "hotelId": { + "description": "Hotel code that the staged profile belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, - "description": { - "description": "description.", + "importDate": { + "description": "The date on which the staged profile has been received.", "type": "string", - "minLength": 0, - "maxLength": 2000 + "format": "date", + "maxLength": 8 }, - "format": { - "description": "Payment format if the payment method is EFT.", + "profileType": { + "description": "Type of the staged profile.", "type": "string", "minLength": 0, - "maxLength": 3 - } - } - }, - "profileCommissionAccount": { - "type": "object", - "description": "Request object for creating profile commission detail.", - "properties": { - "criteria": { - "$ref": "#/definitions/profileCommissionAccountCriteriaType" - }, - "links": { - "$ref": "#/definitions/links" + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "profileCommissionAccountCriteriaType": { - "type": "object", - "description": "Contains base info to determine profile commission bank account and code.", - "properties": { - "hotelId": { - "description": "Hotel code from which the profile bank account and code belongs to", + "stageStatus": { + "description": "The status of the staged profile.", "type": "string", "minLength": 0, "maxLength": 20 - }, - "profileId": { - "description": "Unique profile identifier.", - "$ref": "#/definitions/profileId" - }, - "bankAccountId": { - "description": "Bank account ID.", - "$ref": "#/definitions/uniqueID_Type" - }, - "commissionCode": { - "description": "Profile commission code", - "$ref": "#/definitions/codeDescriptionType" - }, - "validatePending": { - "description": "Used in CRUD operations. When set to true, proceed validating pending commissions", - "type": "boolean" } } }, - "emailMessageType": { + "stagedProfileCustomerType": { "type": "object", - "description": "Request object for storing an email.", "properties": { - "blockId": { - "description": "ID of the Block that is associated with the email.", - "$ref": "#/definitions/stringLength80" + "personName": { + "description": "Detailed name information for the customer.", + "type": "array", + "maxItems": 5, + "items": { + "$ref": "#/definitions/personNameType" + } }, - "fromAddress": { - "description": "The address that originated the email.", - "$ref": "#/definitions/basicEmailType" + "anonymization": { + "description": "Provides information about the guest's anonymization status", + "$ref": "#/definitions/anonymizationType" }, - "toAddress": { - "description": "A collection of email addresses for recipients who were sent the email message", - "$ref": "#/definitions/basicEmailListType" + "citizenCountry": { + "description": "Name of the (self-professed) country that is claimed for citizenship.", + "$ref": "#/definitions/countryNameType" }, - "subject": { - "description": "The subject line of the email.", - "$ref": "#/definitions/stringLength200" + "identifications": { + "description": "List of identification of the customer.", + "type": "object", + "properties": { + "identificationInfo": { + "description": "Collection of detailed information on the identification of the customer.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/identificationInfoType" + } + }, + "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" + } + } }, - "emailBody": { - "description": "Email in base64 binary format.", + "profession": { + "description": "Profession of a person.", "type": "string", - "format": "byte" + "minLength": 0, + "maxLength": 80 }, - "messageId": { - "description": "Global ID of the email message from the external system.", - "$ref": "#/definitions/stringLength100" + "alienInfo": { + "description": "Immigration/visa information of a foreign person.", + "$ref": "#/definitions/alienInfoType" }, - "emailReceiveDate": { - "description": "The date the email was received.", + "birthCountry": { + "description": "Country of birth.", + "$ref": "#/definitions/countryNameType" + }, + "legalCompany": { + "description": "Name Of the company the individual is associated with.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 80 }, - "hasAttachment": { - "description": "Indicates whether the email was sent with an attachment (true) or not (false).", - "type": "boolean" + "companyInfo": { + "description": "Company Information of the Profile.", + "$ref": "#/definitions/companyInfoType" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "stringLength80": { - "type": "string", - "description": "Used for Character Strings, length 0 to 80.", - "maxLength": 80, - "minLength": 0 - }, - "basicEmailListType": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/basicEmailType" - } - }, - "stringLength200": { - "type": "string", - "description": "Used for Character Strings, length 0 to 200.", - "maxLength": 200, - "minLength": 0 - }, - "stringLength100": { - "type": "string", - "description": "Used for Character Strings, length 0 to 100.", - "maxLength": 100, - "minLength": 0 - }, - "accountForecasts": { - "type": "object", - "description": "Response object for showing forecast information of account profile.", - "properties": { - "accountForecastDetails": { - "description": "Type contains forecast information of the account profile.", - "$ref": "#/definitions/accountForecastsType" + "businessTitle": { + "description": "Business Title.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", - "type": "integer" + "gender": { + "description": "Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "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" + "birthDate": { + "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "birthDateMasked": { + "description": "Indicates the date of birth as masked.", + "type": "string" }, - "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" + "currencyCode": { + "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "currencySymbol": { + "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", + "type": "string", + "minLength": 0, + "maxLength": 10 }, - "count": { - "description": "Total number of rows returned", + "decimalPlaces": { + "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", "type": "integer" }, - "links": { - "$ref": "#/definitions/links" + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "accountForecastsType": { - "type": "array", - "description": "Detail Information about Account Forecast.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/accountForecastType" - } - }, - "accountForecastType": { - "type": "object", - "description": "Detail Information about Account Forecast.", - "properties": { - "hotelId": { - "description": "Hotel Code", + "nationality": { + "description": "Nationality code identification", "type": "string", "minLength": 0, "maxLength": 20 }, - "accountId": { - "description": "Unique Account ID", - "$ref": "#/definitions/uniqueID_Type" + "nationalityDescription": { + "description": "Nationality code description", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "periodCode": { - "description": "Specifies the Fiscal or Calendar Period Code for the forecast", + "customerValue": { + "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).", "type": "string", "minLength": 0, "maxLength": 20 }, - "periodDescription": { - "description": "Specifies the Fiscal or Calendar Period Description for the forecast.", + "creditRating": { + "description": "Credit Rating of the customer.", "type": "string", "minLength": 0, - "maxLength": 100 + "maxLength": 20 }, - "periodStartDate": { - "description": "Specifies the Period Start Date", + "vipStatus": { + "description": "VIP status of the customer.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 20 }, - "periodEndDate": { - "description": "Specifies the Period End Date", + "vipDescription": { + "description": "Description of the VIP status.", "type": "string", - "format": "date", - "maxLength": 8 - }, - "roomNights": { - "description": "Room Nights for the forecast", - "type": "integer" + "minLength": 0, + "maxLength": 2000 }, - "averageRate": { - "description": "Average Rate for the forecast", - "$ref": "#/definitions/currencyAmountType" + "birthPlace": { + "description": "Place of birth.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "roomRevenue": { - "description": "Room Revenue for the forecast", - "$ref": "#/definitions/currencyAmountType" + "privateProfile": { + "description": "This element tells profile is property exclusive or not.", + "type": "boolean" }, - "foodAndBeverageRevenue": { - "description": "Food and Beverage revenue for the forecast", - "$ref": "#/definitions/currencyAmountType" + "blacklist": { + "description": "This element tells if profile is blacklisted or not.", + "type": "boolean" }, - "otherRevenue": { - "description": "Other revenue (For example, function space rental, equipment rental, etc.) of forecast.", - "$ref": "#/definitions/currencyAmountType" + "errors": { + "description": "The error in stage profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileErrorType" + } }, - "totalRevenue": { - "description": "Total revenue for the forecast", - "$ref": "#/definitions/currencyAmountType" + "alternateLanguage": { + "description": "ALternate language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + } + }, + "description": "Contains basic data on the customer's identity, location, relationships, finances, memberships, etc." + }, + "stagedProfileErrorType": { + "type": "object", + "description": "Criteria to fetch the staged profile.", + "properties": { + "field": { + "description": "The field that has error.", + "$ref": "#/definitions/stagedProfileErrorField" }, - "overrideForecast": { - "description": "This element is used for overriding any existing forecasts for a profile, Please select Default, if you want to be notified of a warning message. No Forecast is overridden or created. Please select Override, if existing forecasts are to be overridden and new forecasts are to be created. Please select DoNotOverride, if existing forecasts are not to be overridden and new forecasts are to be created.", - "$ref": "#/definitions/overrideForecastTypeType" + "errorDescription": { + "description": "The error description for the staged profile.", + "type": "string", + "minLength": 0, + "maxLength": 2000 } } }, - "overrideForecastTypeType": { + "stagedProfileErrorField": { "type": "string", - "description": "Defines values for OverrideForecastType.", + "description": "Simple type for stage profile error filed to specify which filed in the stage profile has error.", "enum": [ - "Default", - "Override", - "DoNotOverride" + "PrimaryLanguage", + "AlternateLanguag", + "Gender", + "ProfileType", + "Nationality", + "Prefix", + "VIPStatus" ] }, - "forecastsInformation": { + "stagedProfileCompanyType": { "type": "object", "properties": { - "forecastsInformation": { - "description": "Account Forecast details to be created.", - "$ref": "#/definitions/accountForecastsType" + "companyName": { + "description": "Name of the company.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "links": { - "$ref": "#/definitions/links" + "companyName2": { + "description": "Second Name of the company.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "changeAccountForecastsRS": { - "type": "object", - "description": "Response Body.", - "properties": { - "success": { - "description": "Refer to Generic common types document.", - "$ref": "#/definitions/successType" + "companyName3": { + "description": "Third Name of the company.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "alternateName": { + "description": "Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "errors": { - "description": "Refer to Generic common types document.", - "$ref": "#/definitions/errorsType" + "alternateLanguage": { + "description": "Alternate Language of the company.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "echoToken": { - "description": "A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.", + "businessLocale": { + "description": "A jurisdiction(Territory) in which a company is authorized to do business.", "type": "string", "minLength": 0, - "maxLength": 128 + "maxLength": 40 }, - "timeStamp": { - "description": "Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).", + "iATAInfo": { + "description": "IATA Information of the profile.", + "$ref": "#/definitions/iATAInfoType" + }, + "businessTitle": { + "description": "Business Title.", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 80 }, - "version": { - "description": "For all Opera versioned messages, the version of the message is indicated by a Opera Version value.", + "currencyCode": { + "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", "type": "string", "minLength": 0, - "maxLength": 40 + "maxLength": 20 }, - "correlationId": { - "description": "Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.", + "currencySymbol": { + "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", + "type": "string", + "minLength": 0, + "maxLength": 10 + }, + "decimalPlaces": { + "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", + "type": "integer" + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "nationality": { + "description": "Nationality code identification", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "nationalityDescription": { + "description": "Nationality code description", "type": "string", "minLength": 0, "maxLength": 80 }, - "retryAllowed": { - "description": "Indicates if the operation supports the ability to retry the request.", - "type": "boolean" + "commissionCode": { + "description": "Commission code of the company.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "enforceAllowed": { - "description": "Indicates if the operation supports the ability to force the retry request through OPERA services in the case where the external system continues to fail.", - "type": "boolean" + "creditRating": { + "description": "Credit Rating of the company.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "useLocalAllowed": { - "description": "This attribute carries the user selected confirmation value on confirmation popup.", + "corporateIdType": { + "description": "The type of corporate ID", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "vipStatus": { + "description": "VIP status of the company.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "vipDescription": { + "description": "Description of the VIP status.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "blacklist": { + "description": "This element tells if profile is blacklisted or not.", "type": "boolean" }, - "links": { - "$ref": "#/definitions/links" + "errors": { + "description": "The error in stage profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileErrorType" + } } } }, - "successType": { - "type": "object", - "description": "Returning an empty element of this type indicates the successful processing of an message. This is used in conjunction with the Warning Type to report any warnings or business errors.", - "properties": {} - }, - "errorsType": { - "type": "array", - "description": "An error that occurred during the processing of a message.", - "maxItems": 99, - "items": { - "$ref": "#/definitions/errorType" - } - }, - "errorType": { + "stagedProfileAddressType": { "type": "object", - "description": "Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.", "properties": { - "value": { - "type": "string", - "description": "Property Value" - }, - "shortText": { - "description": "An abbreviated version of the error in textual format.", - "type": "string" + "address": { + "description": "Address details for the profile.", + "$ref": "#/definitions/addressType" }, - "code": { - "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", + "errorDescription": { + "description": "The error in address information in a staged profile with an invalid status", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "docURL": { - "description": "If present, this URL refers to an online description of the error that occurred.", - "type": "string" + "inactiveDate": { + "description": "Inactivation date of the record.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "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" + "postalCodeExtension": { + "description": "Postal code extension.", + "type": "string", + "minLength": 0, + "maxLength": 15 }, - "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" + "barCode": { + "description": "The postal barcode for the address.", + "type": "string", + "minLength": 0, + "maxLength": 100 }, - "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" + "cleansStatus": { + "description": "Status of Address Cleansing.", + "$ref": "#/definitions/stagedAddressCleansStatus" }, - "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\".", + "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": 20 + "maxLength": 80 }, - "language": { - "description": "Language identification.", + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "nodeList": { - "description": "An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional contraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.", - "type": "string" + "minLength": 0, + "maxLength": 40 } - } + }, + "description": "Provides address information." }, - "linkedProfiles": { + "stagedAddressCleansStatus": { + "type": "string", + "description": "Simple type for status of staged address cleansing.", + "enum": [ + "NotCleansed", + "Cleansed", + "Failure" + ] + }, + "stagedProfilePhoneType": { "type": "object", - "description": "Response of fetch set of linked Profiles to the requested Profile.", "properties": { - "profileSummaries": { - "description": "Linked profile's summary information.", - "$ref": "#/definitions/profileSummariesType" + "telephone": { + "description": "Phone details for the profile.", + "$ref": "#/definitions/telephoneType" }, - "links": { - "$ref": "#/definitions/links" + "errorDescription": { + "description": "The error in telephone information in a staged profile with an invalid status.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "inactiveDate": { + "description": "Inactivation date of the record.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "defaultConfirmation": { + "description": "Indicates whether the phone is the default confirmation method.", + "type": "boolean" + }, + "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 } - } + }, + "description": "Information on a telephone number for the customer." }, - "matchedProfiles": { + "stagedProfileEmailType": { "type": "object", - "description": "Response object for the match profiles.", "properties": { - "matchProfiles": { - "description": "A collection of match profiles.", - "$ref": "#/definitions/matchProfileType" + "email": { + "description": "eMail deatils for the profile.", + "$ref": "#/definitions/emailType" }, - "links": { - "$ref": "#/definitions/links" + "errorDescription": { + "description": "The error in email information in a staged profile with an invalid status", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "inactiveDate": { + "description": "Inactivation date of the record.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "defaultConfirmation": { + "description": "Indicates whether the email is the default confirmation method.", + "type": "boolean" + }, + "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 } - } + }, + "description": "Information on an email for the customer." }, - "membershipTransactionExceptions": { + "stagedProfileURLType": { "type": "object", - "description": "Response object for fetching membership transaction exceptions.", "properties": { - "memberTransactionExceptions": { - "description": "A collection of membership transaction exceptions.", - "$ref": "#/definitions/membershipTransactionExceptionsType" + "errorDescription": { + "description": "The error in URL in a staged profile with an invalid status", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "links": { - "$ref": "#/definitions/links" + "inactiveDate": { + "description": "Inactivation date of the record.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "defaultConfirmation": { + "description": "Indicates whether the phone is the default confirmation method.", + "type": "boolean" + }, + "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 } - } - }, - "membershipTransactionExceptionsType": { - "type": "array", - "description": "Contains Membership transaction exception information.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/membershipTransactionExceptionType" - } + }, + "description": "Web site address." }, - "membershipTransactionExceptionType": { + "stagedProfileMembershipType": { "type": "object", - "description": "Details about a membership like ProfileID, Card Number, Type, Level, etc.", "properties": { - "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", - "minLength": 0, - "maxLength": 128 + "comment": { + "description": "Additional comments regarding to the membership.", + "$ref": "#/definitions/paragraphType" }, - "membershipId": { - "description": "Unique identifier of this membership.", - "$ref": "#/definitions/uniqueID_Type" + "newMembershipNumber": { + "description": "Card Number of the membership.", + "type": "string" }, - "membershipCardNo": { - "description": "The card number associated with this membership.", - "type": "string", - "minLength": 0, - "maxLength": 50 + "nameOnCard": { + "description": "Name to be displayed on the membership card.", + "type": "string" }, - "membershipType": { - "description": "The type of the membership.", - "$ref": "#/definitions/codeDescriptionType" + "programDescription": { + "description": "Description of the membership program.", + "type": "string" }, "membershipLevel": { - "description": "The current level of the membership.", + "description": "Indicates the membership level.", + "type": "string" + }, + "membershipLevelDescription": { + "description": "Indicates the membership level description.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 200 }, - "joinedDate": { - "description": "Date when the member enrolled for the membership.", - "type": "string", - "format": "date", - "maxLength": 8 + "membershipClass": { + "description": "Indicates the membership class.", + "type": "string" }, - "cardExpirationDate": { - "description": "Membership card expiration date.", - "type": "string", - "format": "date", - "maxLength": 8 + "earningPreference": { + "description": "Earning preference to the membership.", + "$ref": "#/definitions/membershipEarningPreferenceType" }, - "membershipTransactionId": { - "description": "Unique identifier associated with the membership transaction.", - "$ref": "#/definitions/membershipTransactionId" + "inactive": { + "description": "Indicates whether membership is active or inactive.", + "type": "boolean" }, - "hotelId": { - "description": "Hotel code of the membership transaction exceptions.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "benefits": { + "description": "benefits for the membership.", + "$ref": "#/definitions/benefitsType" }, - "fromToRangeDate": { - "description": "Arrival and Departure date of stay for which you are displaying membership transaction exceptions.", - "$ref": "#/definitions/dateRangeType" + "tierAdministration": { + "description": "Defines the degree of participation for this membership in the tier management portion of the program.", + "$ref": "#/definitions/tierAdministrationType" }, - "reservationNumber": { - "description": "Any reference like reservation no etc against which the certificate was consumed.", - "type": "string", - "minLength": 0, - "maxLength": 50 + "downgrade": { + "description": "Defines how downgrading will be handled for this membership.", + "$ref": "#/definitions/downgradeType" }, - "roomsBooked": { - "description": "If multiple room membership transaction exceptions occurred, the number of rooms booked.(MR)", - "type": "integer" + "reIssueNewCard": { + "description": "The status of issuing new membership card to the member.", + "$ref": "#/definitions/cardReIssueType" }, - "backToBack": { - "description": "Indicates if back to back membership transaction exceptions have occurred or not.", + "excludeFromBatch": { + "description": "True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.", + "type": "boolean" + }, + "upgradeDescription": { + "description": "Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.", "type": "string", "minLength": 0, - "maxLength": 2 + "maxLength": 32000 }, - "averageRate": { - "description": "The average rate of the stay.", - "type": "number" + "downgradeDescription": { + "description": "Indicates information regarding the member's possible downgrades.", + "type": "string", + "minLength": 0, + "maxLength": 32000 }, - "tierStays": { - "description": "Tier stay points associated with this membership points transaction.", - "type": "number" + "rating": { + "description": "Value Rating Type Description for this membership.", + "type": "string" }, - "totalAwardPoints": { - "description": "Award points associated with this membership points transaction.", - "type": "number" + "membershipEnrollmentCode": { + "description": "Indicates how the guest enrolled in the program.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "totalNights": { - "description": "Tier night points associated with this membership points transaction.", - "type": "number" + "memberStatus": { + "description": "Indicates where the guest is in the membership enrollment process.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "totalRevenue": { - "description": "Tier revenue points associated with this membership points transaction.", + "currentPoints": { + "description": "Profile MemberShip Points.", "type": "number" }, - "pointsCalculate": { - "description": "Points Calculated value(Y/N) for the selected transaction.", - "type": "boolean" + "pointsLabel": { + "description": "Label used to refer to points for this membership type", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "userNotes": { - "description": "Notes regarding the resolution of the membership transaction exception or for any other reason.", + "enrollmentSource": { + "description": "Source from where the enrollment is done.", "type": "string", "minLength": 0, - "maxLength": 4000 + "maxLength": 20 }, - "processingMessages": { - "description": "The systems records and notes identifying the exception criteria.", + "enrollmentResort": { + "description": "Resort/CRO where enrollment is done.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "totalPoints": { - "description": "The total number of award points associated with this transaction.", - "type": "number" + "preferredCard": { + "description": "Preferred Card.", + "type": "boolean" }, - "awardBasePoints": { - "description": "The total number of base award points for this membership points transaction.", - "type": "number" + "membershipId": { + "description": "Card Number of the membership.", + "type": "string" }, - "awardBonusPoints": { - "description": "Indicates if this transaction involves bonus points, The total number of bonus points.", - "type": "number" + "membershipType": { + "description": "Type of membership.", + "type": "string" }, - "tierPoints": { - "description": "Details if this transaction is associated with tier points.", - "$ref": "#/definitions/membershipTransactionTierPointsType" + "primaryMembershipYn": { + "description": "Indicator if Membership is a Primary Membership.", + "type": "string", + "minLength": 0, + "maxLength": 1 }, - "computedPoints": { - "description": "Information to compute award and tier points for membership transaction exception.", - "$ref": "#/definitions/membershipTransactionExceptionComputePointsType" + "primaryMembership": { + "description": "Boolean indicator set to True implies membership is a Primary Membership.", + "type": "boolean" }, - "exceptionType": { - "description": "Indicates the type of Exception like Exception not resolved,Points Rejected on Exception etc.,", + "membershipIdNo": { + "description": "Membership ID Number.", "type": "integer" - } - } - }, - "membershipTransactionExceptionComputePointsType": { - "type": "object", - "description": "Options to compute award and tier points for membership transaction exception.", - "properties": { - "awardBasePoints": { - "description": "Indicates if membership transaction exception should be created for base award points.", - "type": "boolean" }, - "awardBonusPoints": { - "description": "Indicates if membership transaction exception should be created for bonus award points.", - "type": "boolean" + "playerRanking": { + "description": "Ranking assigned to the Player Profile by the Gaming system.", + "type": "integer" }, - "tierPointsBaseStay": { - "description": "Indicates if membership transaction exception should be created for base tier points for the stay.", + "centralSetup": { + "description": "Indicates how the award points for this membership type will be managed.", "type": "boolean" }, - "tierPointsBonusStay": { - "description": "Indicates if membership transaction exception should be created for tier bonus points for the stay.", - "type": "boolean" + "signupDate": { + "description": "Indicates when the member signed up for the loyalty program.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "tierPointsBaseNights": { - "description": "Indicates if membership transaction exception should be created for base tier points for the night.", - "type": "boolean" + "effectiveDate": { + "description": "Indicates the starting date.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "tierPointsBonusNights": { - "description": "Indicates if membership transaction exception should be created for tier bonus points for the night.", - "type": "boolean" + "expireDate": { + "description": "Indicates the ending date.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "tierPointsBaseRevenue": { - "description": "Indicates if membership transaction exception should be created for base tier points for the revenue.", + "expireDateExclusiveIndicator": { + "description": "When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).", "type": "boolean" }, - "tierPointsBonusRevenue": { - "description": "Indicates if membership transaction exception should be created for tier bonus points for the revenue.", - "type": "boolean" - } - } - }, - "membership": { - "type": "object", - "description": "Request object for create membership. This object contains unique identifiers for each profile and list of membership details to be created. The standard optional Opera Context element is also included.", - "properties": { - "profileIdList": { - "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", - "$ref": "#/definitions/profileIdList" + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" }, - "profileMemberships": { - "description": "Detailed information of membership related to the profile", - "type": "array", - "items": { - "$ref": "#/definitions/profileMembershipType" - } + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" }, - "links": { - "$ref": "#/definitions/links" + "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 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "changedMembership": { - "type": "object", - "description": "Response object for change/update membership. This object contains collection of memberships,Success,Warnings and Errors related to this operation", - "properties": { - "profileMemberships": { - "description": "Detailed information of membership related to the profile", - "type": "array", - "items": { - "$ref": "#/definitions/profileMembershipType" - } + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" }, - "links": { - "$ref": "#/definitions/links" + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "memberInformation": { - "type": "object", - "description": "Response object for member info.", - "properties": { - "memberInfo": { - "$ref": "#/definitions/memberInfoRSType" + "errorDescription": { + "description": "The error in membership information in a staged profile with an invalid status.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "links": { - "$ref": "#/definitions/links" + "registrationResort": { + "description": "Registration resort.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "memberInfoRSType": { - "type": "object", - "properties": { - "memberInfoDetails": { - "description": "Points and stay details of the membership.", - "$ref": "#/definitions/memberInfoDetailsType" + "enrollmentCode": { + "description": "Enrollment code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "memberInfoRangeDetails": { - "description": "Points and stay details for the membership range.", - "$ref": "#/definitions/memberInfoDetailsType" + "membershipStatus": { + "description": "Membership status.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "nextTierPoints": { - "description": "Points required for next tier of membership.", - "type": "integer" + "inactiveDate": { + "description": "Inactivation date of the record.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "pointsAvailable": { - "description": "Points available for the member.", - "type": "integer" - } - } - }, - "memberInfoDetailsType": { - "type": "object", - "properties": { - "guestTotalNights": { - "description": "Total nights of the guest.", - "type": "integer" + "deviceCode": { + "description": "Device encoded string.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "guestTotalStay": { - "description": "STotal stays of the guest.", - "type": "integer" + "deviceDisabledDate": { + "description": "Device disabled date.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "tierBaseNights": { - "description": "Tier Base Nights Points.", - "type": "integer" + "updateExistingMembership": { + "description": "Indicates if existing information for primary membership should be overwritten.", + "type": "boolean" }, - "tierBaseRevenue": { - "description": "Tier Base Revenue Points.", - "type": "number" + "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 }, - "tierBaseStay": { - "description": "Tier Base Stay Points.", - "type": "integer" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + }, + "description": "Detailed information of the memberships." + }, + "stagedProfilePreferenceType": { + "type": "object", + "properties": { + "preferenceValue": { + "description": "Preference value for display purposes.", + "type": "string", + "minLength": 0, + "maxLength": 200 }, - "tierBonusNights": { - "description": "Tier Bonus Nights Points.", - "type": "integer" + "description": { + "description": "Preference Description for display purposes.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "tierBonusRevenue": { - "description": "Tier Bonus Revenue Points.", - "type": "number" + "global": { + "description": "Whether this preference is property specific or not.", + "type": "boolean" }, - "tierBonusStay": { - "description": "Tier Bonus Stay Points.", - "type": "integer" + "source": { + "description": "Source of the preference.", + "type": "string", + "minLength": 0, + "maxLength": 40 }, - "membershipTotalNights": { - "description": "Total Nights of the membership.", - "type": "integer" + "hotels": { + "description": "If specified preference belongs to the Hotels listed, otherwise it is a global preference.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } }, - "membershipTotalStay": { - "description": "Total Stay of the membership.", - "type": "integer" + "preferenceCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "awardBasePoints": { - "description": "Total base points of the award.", + "excludedPreferencesCount": { + "description": "Specifies the count of preferences excluded for the attached reservation preference.", "type": "integer" }, - "awardBonusPoints": { - "description": "Total bonus points of the award.", - "type": "integer" + "copyToProfile": { + "description": "Specifies whether to copy the reservation preference to the profile or not.", + "type": "boolean" }, - "awardMiscPoints": { - "description": "Total miscellaneous points of the award.", - "type": "integer" + "errorDescription": { + "description": "The error in Preference information in a staged profile with an invalid status", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "totalAwardPoints": { - "description": "Total points of the award.", - "type": "integer" - } - } - }, - "profileOwnersDetail": { - "type": "object", - "description": "Response object to fetch the owners of a profile.", - "properties": { - "profileOwnersList": { - "description": "Collection of the profile owners belonging to the profile requested.", - "$ref": "#/definitions/ownersType" + "inactiveDate": { + "description": "Inactivation date of the record.", + "type": "string", + "format": "date", + "maxLength": 8 }, - "links": { - "$ref": "#/definitions/links" + "resortPrefernce": { + "description": "Prefernce resort.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "profileOwners": { - "type": "object", - "description": "Request object to change profile owners.", - "properties": { - "criteria": { - "description": "Criteria to change the owners of a profile.", - "$ref": "#/definitions/setProfileOwnersCriteriaType" + "valid": { + "description": "Indicated whether the preference information is valid.", + "type": "boolean" }, - "links": { - "$ref": "#/definitions/links" + "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 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 } - } + }, + "description": "Guest Preference details for the profile." }, - "setProfileOwnersCriteriaType": { + "stagedProfileKeywordType": { "type": "object", - "description": "Criteria to update the profile owners.", "properties": { - "profileIdList": { - "description": "Id of the profile of which its owners will be updated.", - "$ref": "#/definitions/profileIdList" + "keywordDetail": { + "description": "The keyword new value, in case keyword value is modified.", + "$ref": "#/definitions/keywordDetailType" }, - "owners": { - "description": "Collection of owners that will be updated.", - "$ref": "#/definitions/ownersType" + "errorDescription": { + "description": "The error in keyword information in a staged profile with an invalid status", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "keywordType": { + "description": "The type of keyword", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "keyword": { + "description": "The keyword value.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "id": { + "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "preference": { + "stagedProfileNegotiatedRateType": { "type": "object", - "description": "Response object for fetch preference. This object contains collection of preferences,Success,Warnings and Errors related to this operation.", "properties": { - "preferenceCollections": { - "description": "Detailed information of preferences related to the profile", + "negotiatedInfoList": { "type": "array", + "maxItems": 4000, "items": { - "$ref": "#/definitions/preferenceTypeType" + "$ref": "#/definitions/negotiatedInfoType" } }, - "profileIdList": { - "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", - "$ref": "#/definitions/profileIdList" + "hotelId": { + "description": "Hotel code for the negotiated rate.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "links": { - "$ref": "#/definitions/links" + "rateCode": { + "description": "Rate plan code for the negotiated rate.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "profileRelationships": { - "type": "object", - "properties": { - "relationships": { - "description": "Contains a collection of profiles that have a relationship with this profile.", - "$ref": "#/definitions/relationshipsSummary" + "errorDescription": { + "description": "The error in negotiated rate information in a staged profile with an invalid status", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "links": { - "$ref": "#/definitions/links" + "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 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 } - } + }, + "description": "This holds a list of NegotiatedInfoType." }, - "relationshipsSummary": { + "stagedProfileIdentificationsType": { "type": "object", - "description": "Contains details relationships related to a profile.", "properties": { - "relationship": { - "description": "A collection of the profiles summary that have a relationship with this profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/relationshipInfoSummaryType" - } + "identification": { + "description": "Detailed information on the identification of the customer.", + "$ref": "#/definitions/identificationType" }, - "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" + "errorDescription": { + "description": "The error in negotiated rate information in a staged profile with an invalid status", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "documentResort": { + "description": "Hotel code to which the document belongs.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "count": { - "description": "Total number of rows returned", - "type": "integer" + "inactiveDate": { + "description": "The date when the record was inactivated.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "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 } - } + }, + "description": "Information on the identification of the customer." }, - "futurePastBookingsCriteria": { + "stagedProfileRoutingInstructionType": { "type": "object", - "description": "Request for information regarding existence of profile in future and/or past business blocks and/or reservations.", "properties": { - "criteria": { - "description": "Criteria to determine if search should be restricted to future and/or past business blocks and/or reservations, restricted to rate code, or restricted to exclude a given list of reservations and/or blocks.", - "$ref": "#/definitions/hasFuturePastBookingsSearchType" - }, - "links": { - "$ref": "#/definitions/links" + "transactionInfo": { + "description": "Transaction code information in a staged profile with an invalid status", + "$ref": "#/definitions/stagedProfileTrxInfoType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "billingInstruction": { + "description": "Configured Billing Instruction in a staged profile with an invalid status", + "$ref": "#/definitions/stagedProfileBillingInstructionType" } } }, - "hasFuturePastBookingsSearchType": { + "stagedProfileTrxInfoType": { "type": "object", - "description": "Search type for verifying whether there are future and/or past business blocks and/or reservations exist for a Profile.", "properties": { - "profileIdList": { - "description": "Unique identifier of the profile to be searched.", - "$ref": "#/definitions/profileIdList" + "description": { + "description": "Transaction codes info.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "searchFor": { - "description": "Search for active or past.", + "transactionGroup": { + "description": "Category of the transaction code.", "type": "string", - "enum": [ - "Active", - "Past" - ] + "minLength": 0, + "maxLength": 20 }, - "searchIn": { - "description": "Search in business blocks or reservations.", + "transactionSubGroup": { + "description": "Sub category of the transaction code.", "type": "string", - "enum": [ - "Block", - "Reservation" - ] + "minLength": 0, + "maxLength": 20 }, - "rateCode": { - "description": "Unique identifier of the rate code of business block or reservation.", + "universalProductCode": { + "description": "Unique Universal product code of the transaction code.", "type": "string", "minLength": 0, "maxLength": 20 }, - "exclusions": { - "description": "Search to exclude list of reservations and/or business blocks.", - "$ref": "#/definitions/hasFuturePastBookingsExclusionsType" - } - } - }, - "hasFuturePastBookingsExclusionsType": { - "type": "object", - "description": "Search type for excluding list of business blocks and/or reservations.", - "properties": { - "reservationIdList": { - "description": "List of unique identifier of reservation.", - "$ref": "#/definitions/uniqueIDListType" + "routingInstructionsId": { + "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.", + "type": "number" }, - "blockIdList": { - "description": "List of Unique identifier of business block.", - "$ref": "#/definitions/uniqueIDListType" + "articles": { + "description": "The List of Articles defined for this transaction code, when using the Articles functionality.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/articleInfoType" + } + }, + "trxServiceType": { + "description": "Contains service type for transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "transactionCode": { + "description": "Unique identifier for the Transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelId": { + "description": "Hotel context of the Transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "printTrxReceipt": { + "description": "Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.", + "type": "boolean" + }, + "errorDescription": { + "description": "The error in transaction code information in a staged profile with an invalid status", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "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 } - } + }, + "description": "Transaction codes info." }, - "futurePastBookings": { + "stagedProfileBillingInstructionType": { "type": "object", - "description": "This is the Response Message to information regarding existence of profile in future and/or past business blocks and/or reservations.", "properties": { - "response": { - "description": "response - whether there are future and/or past business blocks or reservations for the profile.", - "type": "boolean" + "desc": { + "description": "Billing Instruction code description.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "links": { - "$ref": "#/definitions/links" + "routingInstructionsId": { + "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.", + "type": "number" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "billingCode": { + "description": "Unique identifier for the Billing Instruction.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelId": { + "description": "Hotel context of the Billing Instruction.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "errorDescription": { + "description": "The error in billing instruction information in a staged profile with an invalid status", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "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 } - } + }, + "description": "Configured Billing Instruction which represents a set of Transaction Codes." }, - "profileStayHistory": { + "stagedProfileUserDefinedFieldsType": { "type": "object", - "description": "Response object for showing stay history and future reservations of specific profile.", + "description": "Used to hold user defined fields(UDFs) for staged profile.", "properties": { - "profileStayDetails": { - "description": "Type contains stay history and future reservations of the specific profile.", - "$ref": "#/definitions/profileStayDetailsType" + "characterUDFs": { + "description": "Collection of user defined fields of Character/String Type.", + "$ref": "#/definitions/stagedProfileCharacterUDFsType" }, - "links": { - "$ref": "#/definitions/links" + "numericUDFs": { + "description": "Collection of user defined fields of Numeric Type.", + "$ref": "#/definitions/stagedProfileNumericUDFsType" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "dateUDFs": { + "description": "Collection of user defined fields of Date Type.", + "$ref": "#/definitions/stagedProfileDateUDFsType" } } }, - "profileStayDetailsType": { - "type": "object", - "description": "Type provides the stay history and future reservations of specific profile.", - "properties": { - "reservationInfoList": { - "description": "Collection of Detailed information on history and future reservations associated with the profile.", - "$ref": "#/definitions/reservationStayHistoryFutureInfoType" - } + "stagedProfileCharacterUDFsType": { + "type": "array", + "description": "Used to hold collection of user defined fields of Character/String Type.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileCharacterUDFType" } }, - "profileRelationship": { + "stagedProfileCharacterUDFType": { "type": "object", - "description": "Request object for creating profile relationship.", "properties": { - "relationship": { - "description": "Refer to Relationship Profile request criteria.", - "$ref": "#/definitions/relationshipCriteriaType" + "name": { + "description": "Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "copyInstructions": { - "description": "Indicates which details of the master profile should be copied to subsidiary profiles, when a master-sub relationship is created for profile types Company, TravelAgent and Source", - "$ref": "#/definitions/copyInstructionsType" + "value": { + "description": "Value of user defined field.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "links": { - "$ref": "#/definitions/links" + "alternateName": { + "description": "Label of user defined field used by vendors or customers.", + "type": "string", + "minLength": 0, + "maxLength": 2000 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "errorDescription": { + "description": "The error in a user defined field in a staged profile with an invalid status", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "tableName": { + "description": "PMS table name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "valid": { + "description": "Indicates whether the UDF information is valid.", + "type": "boolean" + }, + "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 } + }, + "description": "Used to hold user defined field of Character/String Type." + }, + "stagedProfileNumericUDFsType": { + "type": "array", + "description": "Used to hold collection of user defined fields of Numeric Type.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileNumericUDFType" } }, - "relationshipCriteriaType": { + "stagedProfileNumericUDFType": { "type": "object", - "description": "Contains Criteria Information for a profile relationship.", "properties": { - "primary": { - "description": "Indicates if this relationship is the primary relationship.", - "type": "boolean" - }, - "sourceRelation": { - "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).", + "name": { + "description": "Name of user defined field.", "type": "string", "minLength": 0, "maxLength": 20 }, - "sourceRelationDescription": { - "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).This needs to be passed if the attribute primary is sent as true.", + "value": { + "description": "Value of user defined field.", + "type": "number" + }, + "alternateName": { + "description": "Label of user defined field used by vendors or customers.", "type": "string", "minLength": 0, - "maxLength": 200 - }, - "sourceProfileType": { - "description": "Used to specify a source profile type.", - "$ref": "#/definitions/profileTypeType" + "maxLength": 2000 }, - "targetRelation": { - "description": "Indicates the type of relationship the related profile(Target Profile) has with the current profile(Source Profile).", + "errorDescription": { + "description": "The error in a user defined field in a staged profile with an invalid status", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "targetRelationDescription": { - "description": "Displays the description of relationship the related profile(Target Profile) has with the current profile(Source Profile).", + "tableName": { + "description": "PMS table name.", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 40 }, - "targetProfileType": { - "description": "Used to specify a target profile type.", - "$ref": "#/definitions/profileTypeType" - } - } - }, - "profileRelationshipToBeChanged": { - "type": "object", - "description": "Request object for changing profile relationship.", - "properties": { - "relationship": { - "description": "Refer to Relationship Profile request criteria.", - "$ref": "#/definitions/changeRelationshipCriteriaType" + "valid": { + "description": "Indicates whether the UDF information is valid.", + "type": "boolean" }, - "links": { - "$ref": "#/definitions/links" + "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 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 40 } + }, + "description": "Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required." + }, + "stagedProfileDateUDFsType": { + "type": "array", + "description": "Used to hold collection of user defined fields of Date Type.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileDateUDFType" } }, - "changeRelationshipCriteriaType": { + "stagedProfileDateUDFType": { "type": "object", - "description": "Information about the changes in relationship for the profile", "properties": { - "changeRelationship": { - "description": "Information about the changes in relationship for the profile", - "$ref": "#/definitions/changeRelationsInfoType" + "name": { + "description": "Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "relationshipID": { - "description": "Relationship identifier.", + "value": { + "description": "Value of user defined field.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "alternateName": { + "description": "Label of user defined field used by vendors or customers.", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 2000 }, - "sourceRelation": { - "description": "Indicates the type of existing relationship the current profile(Source Profile) has with the related profile(Target Profile).", + "errorDescription": { + "description": "The error in a user defined field in a staged profile with an invalid status", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "sourceRelationDescription": { - "description": "Displays the description of existing relationship the current profile(Source Profile) has with the related profile(Target Profile).", + "tableName": { + "description": "PMS table name.", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 40 }, - "targetRelation": { - "description": "Indicates the type of existing relationship the Related profile(Target Profile) has with the current profile(Source Profile).", + "valid": { + "description": "Indicates whether the UDF information is valid.", + "type": "boolean" + }, + "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": 20 + "maxLength": 80 }, - "targetRelationDescription": { - "description": "Displays the description of existing relationship the related profile(Target Profile) has with the current profile(Source Profile).", + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 40 } + }, + "description": "Used to hold user defined field of Date Type." + }, + "stagedProfileCommentInfosType": { + "type": "array", + "description": "List of Notes for the customer.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileCommentInfoType" } }, - "changeRelationsInfoType": { + "stagedProfileCommentInfoType": { "type": "object", - "description": "Detailed information regarding to be changed relationships for the profile.", + "description": "Comment related to the profile/reservation.", "properties": { - "changeProfileID": { - "description": "Unique id of the profile to be changed to.", - "$ref": "#/definitions/uniqueID_Type" - }, - "primary": { - "description": "Indicates if this relationship is the primary relationship.", - "type": "boolean" + "comment": { + "description": "Comment details for the comment. It will be empty in case of delete comment.", + "$ref": "#/definitions/commentType" }, - "sourceProfileType": { - "description": "Used to specify a source profile type.", - "$ref": "#/definitions/profileTypeType" + "createDateTime": { + "description": "Time stamp of the creation.", + "type": "string", + "format": "date-time" }, - "sourceRelation": { - "description": "Indicates the type of to be changed relationship the current profile(Source Profile) has with the related profile(Target Profile).", + "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": 20 + "maxLength": 200 }, - "sourceRelationDescription": { - "description": "Displays the description of to be changed relationship the current profile(Source Profile) has with the related profile(Target Profile).This needs to be passed if the attribute primary is sent as true.", + "lastModifyDateTime": { + "description": "Time stamp of last modification.", + "type": "string", + "format": "date-time" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", "type": "string", "minLength": 0, "maxLength": 200 }, - "targetRelation": { - "description": "Indicates the type of to be changed relationship the Related profile(Target Profile) has with the current profile(Source Profile).", + "lineNo": { + "description": "The line number of the comment.", + "type": "integer" + }, + "inActiveDate": { + "description": "Indicates comment inactive date.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date", + "maxLength": 8 }, - "targetRelationDescription": { - "description": "Displays the description of to be changed relationship the related profile(Target Profile) has with the current profile(Source Profile).", + "errorDescription": { + "description": "The error in a user defined field in a staged profile with an invalid status.", "type": "string", "minLength": 0, - "maxLength": 200 + "maxLength": 2000 }, - "targetProfileType": { - "description": "Used to specify a target profile type.", - "$ref": "#/definitions/profileTypeType" - } - } - }, - "profileToBeMerged": { - "type": "object", - "description": "Profile Resource will be merged.", - "properties": { - "victimProfileId": { - "description": "Provides detailed information regarding either a company or a customer profile.", - "$ref": "#/definitions/uniqueIDListType" + "valid": { + "description": "Indicates whether the comment information is valid.", + "type": "boolean" }, - "profileIdList": { - "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as ID.", - "$ref": "#/definitions/profileIdList" + "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" }, - "profileDetails": { - "description": "Provides detailed information regarding either a company or a customer profile.", - "$ref": "#/definitions/profileType" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "links": { - "$ref": "#/definitions/links" + "count": { + "description": "Total number of rows returned", + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "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 } } }, - "mergedProfilesSnapshotDetails": { + "profileDetails": { "type": "object", - "description": "Response object for fetching snapshot of merge profiles result.", + "description": "Response object for fetching multiple detailed profiles by unique identifiers..", "properties": { - "mergedProfileSnapshot": { - "$ref": "#/definitions/mergedProfileType" + "profiles": { + "description": "Type contains Profile's primary details and it's children details.", + "$ref": "#/definitions/profilesType" }, - "links": { - "$ref": "#/definitions/links" + "masterInfoList": { + "description": "Refer to Generic common types document.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/masterInfoType" + } }, "warnings": { "$ref": "#/definitions/warningsType" } } }, - "mergedProfileType": { + "profilesType": { "type": "object", - "description": "Provides information for merged profile.", + "description": "A collection of Profile objects or Unique IDs of Profiles.", "properties": { - "profileIdList": { - "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", - "$ref": "#/definitions/profileIdList" + "profileInfo": { + "description": "A collection of Profiles or Unique IDs of Profiles.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "object", + "properties": { + "profileIdList": { + "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", + "$ref": "#/definitions/profileIdList" + }, + "profile": { + "description": "Provides detailed information regarding either a company or a customer profile.", + "$ref": "#/definitions/profileType" + }, + "chainCode": { + "description": "Chain code associated with the profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "allowedActions": { + "description": "Collection of allowed actions for profile search.", + "$ref": "#/definitions/profileAllowedActionsType" + } + } + } }, - "profile": { - "description": "Provides detailed information regarding either a company or a customer profile.", - "$ref": "#/definitions/profileType" + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" } } }, - "mergedStageProfileSnapshot": { + "recentlyAccessedProfiles": { "type": "object", - "description": "Response object to fetch merge profile based on stage and opera profile.", + "description": "Response with the fetched recently accessed profiles.", "properties": { - "mergeStageProfile": { - "$ref": "#/definitions/stagedProfileType" + "profiles": { + "description": "List of recently accessed profiles.", + "type": "array", + "items": { + "$ref": "#/definitions/recentlyAccessedProfileType" + } }, "links": { "$ref": "#/definitions/links" @@ -35730,1800 +40800,1957 @@ } } }, - "stagedProfileType": { + "recentlyAccessedProfileType": { "type": "object", - "description": "Detailed information about the staged profile.", + "description": "A recently used profile details.", "properties": { "profileIdList": { - "description": "List of unique identifier of staged profile.", - "$ref": "#/definitions/uniqueIDListType" - }, - "customer": { - "description": "Detailed customer information for this profile.", - "$ref": "#/definitions/stagedProfileCustomerType" - }, - "company": { - "description": "Detailed company information for this profile.", - "$ref": "#/definitions/stagedProfileCompanyType" - }, - "addresses": { - "description": "Collection of detailed information about address for the staged profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileAddressType" - } - }, - "telephones": { - "description": "Collection of detailed information about telephone/fax for the staged profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfilePhoneType" - } - }, - "emails": { - "description": "Collection of detailed information about email for the staged profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileEmailType" - } - }, - "uRLs": { - "description": "Collection of detailed information about web url/address for the staged profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileURLType" - } - }, - "memberships": { - "description": "Collection of detailed information about memberships for the staged profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileMembershipType" - } - }, - "preferences": { - "description": "Collection of detailed information about preferences for the staged profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfilePreferenceType" - } - }, - "keywords": { - "description": "Collection of detailed information about keyword for the staged profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileKeywordType" - } - }, - "negotiatedRates": { - "description": "Collection of detailed information about negotiated rates for the staged profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileNegotiatedRateType" - } - }, - "identifications": { - "description": "Collection of detailed information about identification for the staged profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileIdentificationsType" - } - }, - "routingInstructions": { - "description": "Collection of routing instructions for the staged profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileRoutingInstructionType" - } - }, - "userDefinedFields": { - "description": "List of user defined fields for the staged profile.", - "$ref": "#/definitions/stagedProfileUserDefinedFieldsType" - }, - "mailingActions": { - "description": "Contains collection of mailing action list associated with the profile", - "$ref": "#/definitions/mailingActionsType" - }, - "privacyInfo": { - "description": "Contains privacy related information associated with the profile", - "$ref": "#/definitions/privacyInfoType" + "description": "List of unique ids, consisting of the profile name id.", + "$ref": "#/definitions/profileIdList" }, - "comments": { - "description": "List of Notes for the customer.", - "$ref": "#/definitions/stagedProfileCommentInfosType" + "guestFirstName": { + "description": "First Name of a Profile.", + "$ref": "#/definitions/givenNameType" }, - "hotelId": { - "description": "Hotel code that the staged profile belongs to.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "guestLastName": { + "description": "Last Name of a profile.", + "$ref": "#/definitions/surnameType" }, - "importDate": { - "description": "The date on which the staged profile has been received.", + "accessDate": { + "description": "The date the record was accessed.", "type": "string", "format": "date", "maxLength": 8 }, "profileType": { - "description": "Type of the staged profile.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "stageStatus": { - "description": "The status of the staged profile.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", + "$ref": "#/definitions/profileTypeType" } } }, - "stagedProfileCustomerType": { + "stagedProfileDetails": { "type": "object", + "description": "Response object for the staged profile.", "properties": { - "personName": { - "description": "Detailed name information for the customer.", - "type": "array", - "maxItems": 5, - "items": { - "$ref": "#/definitions/personNameType" - } - }, - "anonymization": { - "description": "Provides information about the guest's anonymization status", - "$ref": "#/definitions/anonymizationType" - }, - "citizenCountry": { - "description": "Name of the (self-professed) country that is claimed for citizenship.", - "$ref": "#/definitions/countryNameType" - }, - "identifications": { - "description": "List of identification of the customer.", - "type": "object", - "properties": { - "identificationInfo": { - "description": "Collection of detailed information on the identification of the customer.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/identificationInfoType" - } - }, - "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" - } - } - }, - "profession": { - "description": "Profession of a person.", - "type": "string", - "minLength": 0, - "maxLength": 80 - }, - "alienInfo": { - "description": "Immigration/visa information of a foreign person.", - "$ref": "#/definitions/alienInfoType" - }, - "birthCountry": { - "description": "Country of birth.", - "$ref": "#/definitions/countryNameType" - }, - "legalCompany": { - "description": "Name Of the company the individual is associated with.", - "type": "string", - "minLength": 0, - "maxLength": 80 - }, - "companyInfo": { - "description": "Company Information of the Profile.", - "$ref": "#/definitions/companyInfoType" - }, - "businessTitle": { - "description": "Business Title.", - "type": "string", - "minLength": 0, - "maxLength": 80 - }, - "gender": { - "description": "Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "birthDate": { - "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "birthDateMasked": { - "description": "Indicates the date of birth as masked.", - "type": "string" - }, - "currencyCode": { - "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "currencySymbol": { - "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", - "type": "string", - "minLength": 0, - "maxLength": 10 - }, - "decimalPlaces": { - "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", - "type": "integer" - }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - }, - "nationality": { - "description": "Nationality code identification", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "nationalityDescription": { - "description": "Nationality code description", - "type": "string", - "minLength": 0, - "maxLength": 80 - }, - "customerValue": { - "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).", - "type": "string", - "minLength": 0, - "maxLength": 20 + "stagedProfile": { + "description": "Response object for the staged profile.", + "$ref": "#/definitions/stagedProfileType" }, - "creditRating": { - "description": "Credit Rating of the customer.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "links": { + "$ref": "#/definitions/links" }, - "vipStatus": { - "description": "VIP status of the customer.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "stagedProfile": { + "type": "object", + "description": "Request object for changing the staged profile.", + "properties": { + "stagedProfile": { + "$ref": "#/definitions/stagedProfileType" }, - "vipDescription": { - "description": "Description of the VIP status.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "changeInstructions": { + "$ref": "#/definitions/stagedProfileChangeInstructionsType" }, - "birthPlace": { - "description": "Place of birth.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "links": { + "$ref": "#/definitions/links" }, - "privateProfile": { - "description": "This element tells profile is property exclusive or not.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "stagedProfileChangeInstructionsType": { + "type": "object", + "description": "Information about instructions to change the staged profile.", + "properties": { + "fullyOverlay": { + "description": "If true then delete and recreat the staged profile details.", "type": "boolean" + } + } + }, + "suspendedAddresses": { + "type": "object", + "description": "Response object for fetching unique company profile.", + "properties": { + "suspendedAddressesInfo": { + "description": "Suspended Addresses List", + "$ref": "#/definitions/suspendedAddressesType" }, - "blacklist": { - "description": "This element tells if profile is blacklisted or not.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "errors": { - "description": "The error in stage profile.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "suspendedAddressesType": { + "type": "object", + "description": "List of suspended addresses returned, based on the entered seach criteria.", + "properties": { + "suspendedAddressesInfo": { + "description": "A collection of suspended Addresses.", "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/stagedProfileErrorType" + "$ref": "#/definitions/suspendedAddressesInfoType" } }, - "alternateLanguage": { - "description": "ALternate language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" - } - }, - "description": "Contains basic data on the customer's identity, location, relationships, finances, memberships, etc." - }, - "stagedProfileErrorType": { - "type": "object", - "description": "Criteria to fetch the staged profile.", - "properties": { - "field": { - "description": "The field that has error.", - "$ref": "#/definitions/stagedProfileErrorField" + "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" }, - "errorDescription": { - "description": "The error description for the staged profile.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "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" + }, + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" } } }, - "stagedProfileErrorField": { - "type": "string", - "description": "Simple type for stage profile error filed to specify which filed in the stage profile has error.", - "enum": [ - "PrimaryLanguage", - "AlternateLanguag", - "Gender", - "ProfileType", - "Nationality", - "Prefix", - "VIPStatus" - ] - }, - "stagedProfileCompanyType": { + "suspendedAddressesInfoType": { "type": "object", "properties": { - "companyName": { - "description": "Name of the company.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "addressId": { + "description": "Corporate id of the profile.", + "type": "integer" }, - "companyName2": { - "description": "Second Name of the company.", + "name": { + "description": "Last Name of the Profile against which the Suspended Addresses are fetched.", "type": "string", "minLength": 0, - "maxLength": 40 + "maxLength": 80 }, - "companyName3": { - "description": "Third Name of the company.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "profileId": { + "description": "Opera ID for the profile attached to the address.", + "$ref": "#/definitions/uniqueID_Type" }, - "alternateName": { - "description": "Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language.", + "firstName": { + "description": "First Name of the Profile against which the Suspended Addresses are fetched.", "type": "string", "minLength": 0, "maxLength": 80 }, - "alternateLanguage": { - "description": "Alternate Language of the company.", + "profileType": { + "description": "Profile Type of the Profile against which the Suspended Addresses are fetched..", "type": "string", "minLength": 0, "maxLength": 20 }, - "businessLocale": { - "description": "A jurisdiction(Territory) in which a company is authorized to do business.", - "type": "string", - "minLength": 0, - "maxLength": 40 - }, - "iATAInfo": { - "description": "IATA Information of the profile.", - "$ref": "#/definitions/iATAInfoType" - }, - "businessTitle": { - "description": "Business Title.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "clientID": { + "description": "Corporate id of the profile.", + "$ref": "#/definitions/uniqueID_Type" }, - "currencyCode": { - "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", + "matchCode": { + "description": "Match Code of the Address Validation Performed from the batch processing", "type": "string", "minLength": 0, "maxLength": 20 }, - "currencySymbol": { - "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", + "validateDate": { + "description": "Validate Date.", "type": "string", - "minLength": 0, - "maxLength": 10 - }, - "decimalPlaces": { - "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", - "type": "integer" + "format": "date", + "maxLength": 8 }, - "language": { - "description": "Language identification.", - "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + "country": { + "description": "The country of residence where the property is located e.", + "$ref": "#/definitions/countryNameType" }, - "nationality": { - "description": "Nationality code identification", + "hotelId": { + "description": "Resort of the Profile", "type": "string", "minLength": 0, "maxLength": 20 + } + } + }, + "suspendedProfileErrorSummaryInfo": { + "type": "object", + "description": "Response object for fetch suspended profile Errors summary. This object contains collection of profile erros and count of how many profiles encountered this error.", + "properties": { + "suspendedProfileErrorSummary": { + "description": "Indicates response of the suspended profile errors summary.", + "$ref": "#/definitions/suspendedProfileErrorsSummaryType" }, - "nationalityDescription": { - "description": "Nationality code description", - "type": "string", - "minLength": 0, - "maxLength": 80 + "links": { + "$ref": "#/definitions/links" }, - "commissionCode": { - "description": "Commission code of the company.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "suspendedProfileErrorsSummaryType": { + "type": "array", + "description": "Collection of profile error summary.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/suspendedProfileErrorSummaryType" + } + }, + "suspendedProfileErrorSummaryType": { + "type": "object", + "description": "Type which represents suspended profile errors information.", + "properties": { + "errorDescription": { + "description": "Represents Error summary of the suspended profiles.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "creditRating": { - "description": "Credit Rating of the company.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "errorCount": { + "description": "Count of how many profiles encountered this error.", + "type": "number" + } + } + }, + "profileSubscriptionsToSynchronize": { + "type": "object", + "description": "Request object for re-subscribing profile subscriptions.", + "properties": { + "criteria": { + "description": "Criteria to re-subscribe profile subscriptions.", + "$ref": "#/definitions/synchronizeProfileSubscriptionsCriteriaType" }, - "corporateIdType": { - "description": "The type of corporate ID", - "type": "string", - "minLength": 0, - "maxLength": 20 + "links": { + "$ref": "#/definitions/links" }, - "vipStatus": { - "description": "VIP status of the company.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "synchronizeProfileSubscriptionsCriteriaType": { + "type": "object", + "description": "Criteria for searching profile subscriptions.", + "properties": { + "profileId": { + "description": "Unique ID of the profile.", + "$ref": "#/definitions/profileId" }, - "vipDescription": { - "description": "Description of the VIP status.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "databaseIds": { + "description": "List of codes identifying the external database record which is linked to external systems.", + "$ref": "#/definitions/databaseIDListType" + } + } + }, + "databaseIDListType": { + "type": "array", + "description": "Code identifying the external database record which is linked to external systems.", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "forgetProfilesCriteria": { + "type": "object", + "description": "Operation to validate profiles for forgetting.", + "properties": { + "validateForgetProfilesCriteria": { + "description": "Criteria to identify the profiles to be validated for forgetting.", + "$ref": "#/definitions/forgetProfilesCriteriaType" }, - "blacklist": { - "description": "This element tells if profile is blacklisted or not.", - "type": "boolean" + "links": { + "$ref": "#/definitions/links" }, - "errors": { - "description": "The error in stage profile.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileErrorType" - } + "warnings": { + "$ref": "#/definitions/warningsType" } } }, - "stagedProfileAddressType": { + "forgetProfilesCriteriaType": { "type": "object", + "description": "Criteria to identify the profiles to be forgotten.", "properties": { - "address": { - "description": "Address details for the profile.", - "$ref": "#/definitions/addressType" + "profiles": { + "description": "Collection of Unique Identifiers of profiles to be forgotten.", + "$ref": "#/definitions/profiles" + } + } + }, + "profiles": { + "type": "array", + "description": "Unique identifier for a profile.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileId" + } + }, + "validatedForgetProfiles": { + "type": "object", + "description": "Response object for validating profiles for forgetting.", + "properties": { + "validateForgetProfilesResults": { + "description": "Results of validation.", + "$ref": "#/definitions/forgetProfileResultListType" }, - "errorDescription": { - "description": "The error in address information in a staged profile with an invalid status", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "links": { + "$ref": "#/definitions/links" }, - "inactiveDate": { - "description": "Inactivation date of the record.", - "type": "string", - "format": "date", - "maxLength": 8 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "forgetProfileResultListType": { + "type": "array", + "description": "Result of processing/validation for forgetting a profile.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/forgetProfileResultType" + } + }, + "forgetProfileResultType": { + "type": "object", + "description": "Results of Anonymization processing/validation.", + "properties": { + "profileId": { + "description": "Unique Identifier for OPERA Profile.", + "$ref": "#/definitions/profileId" }, - "postalCodeExtension": { - "description": "Postal code extension.", - "type": "string", - "minLength": 0, - "maxLength": 15 + "canBeForgotten": { + "description": "Indicates if the profile is eligible to be anonymized.", + "type": "boolean" }, - "barCode": { - "description": "The postal barcode for the address.", + "status": { + "description": "Anonymization Status of the Guest Profile.", + "$ref": "#/definitions/anonymizationStatusType" + }, + "failureReasons": { + "description": "Collection of reasons describing why the profile is not eligible to be anonymized.", + "$ref": "#/definitions/forgetProfileFailureReasonListType" + } + } + }, + "forgetProfileFailureReasonListType": { + "type": "array", + "description": "Reason describing why the profile is not eligible to be forgotten.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/forgetProfileFailureReasonType" + } + }, + "forgetProfileFailureReasonType": { + "type": "object", + "description": "Provides information about the reason why the profile is not eligible to be forgotten.", + "properties": { + "reasonCode": { + "description": "Code representing the reason why the profile is not eligible to be forgotten.", "type": "string", "minLength": 0, - "maxLength": 100 - }, - "cleansStatus": { - "description": "Status of Address Cleansing.", - "$ref": "#/definitions/stagedAddressCleansStatus" + "maxLength": 20 }, - "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.", + "reasonDescription": { + "description": "Reason describing why the profile is not eligible to be forgotten.", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 2000 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", + "expectedResolutionDate": { + "description": "Expected resolution date for this reason.", "type": "string", - "minLength": 0, - "maxLength": 40 + "format": "date", + "maxLength": 8 } - }, - "description": "Provides address information." + } }, - "stagedAddressCleansStatus": { + "actionType": { "type": "string", - "description": "Simple type for status of staged address cleansing.", + "description": "Action types allowed by the event api.", "enum": [ - "NotCleansed", - "Cleansed", - "Failure" + "CREATE", + "UPDATE", + "DELETE" ] }, - "stagedProfilePhoneType": { + "revenueBucketType": { "type": "object", + "description": "The different revenue buckets of a profile.", "properties": { - "telephone": { - "description": "Phone details for the profile.", - "$ref": "#/definitions/telephoneType" - }, - "errorDescription": { - "description": "The error in telephone information in a staged profile with an invalid status.", + "code": { + "description": "Code of revenue type.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 40 }, - "inactiveDate": { - "description": "Inactivation date of the record.", + "description": { + "description": "Description of revenue type.", "type": "string", - "format": "date", - "maxLength": 8 + "minLength": 0, + "maxLength": 100 }, - "defaultConfirmation": { - "description": "Indicates whether the phone is the default confirmation method.", - "type": "boolean" + "value": { + "description": "Value of revenue.", + "type": "number" + } + } + }, + "revenueBucketListType": { + "type": "object", + "description": "Details about revenue summary.", + "properties": { + "bucket": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/revenueBucketType" + } + } + } + }, + "membershipPromotionDetails": { + "type": "object", + "description": "The request element used to create a membership promotion.", + "properties": { + "membershipPromotion": { + "description": "The membership promotion information to add to the database.", + "$ref": "#/definitions/membershipPromotionType" }, - "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 + "links": { + "$ref": "#/definitions/links" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "warnings": { + "$ref": "#/definitions/warningsType" } - }, - "description": "Information on a telephone number for the customer." + } }, - "stagedProfileEmailType": { + "membershipPromotionsDetails": { "type": "object", + "description": "Response object for fetching membership promotions information.", "properties": { - "email": { - "description": "eMail deatils for the profile.", - "$ref": "#/definitions/emailType" - }, - "errorDescription": { - "description": "The error in email information in a staged profile with an invalid status", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "inactiveDate": { - "description": "Inactivation date of the record.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "defaultConfirmation": { - "description": "Indicates whether the email is the default confirmation method.", - "type": "boolean" + "membershipPromotions": { + "type": "array", + "maxItems": 4000, + "description": "Collection of membership promotions.", + "items": { + "$ref": "#/definitions/membershipPromotionType" + } }, - "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 + "links": { + "$ref": "#/definitions/links" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "warnings": { + "$ref": "#/definitions/warningsType" } - }, - "description": "Information on an email for the customer." + } }, - "stagedProfileURLType": { + "membershipPromotionType": { "type": "object", + "description": "Information related to a membership promotion.", "properties": { - "errorDescription": { - "description": "The error in URL in a staged profile with an invalid status", + "promotionCode": { + "description": "The promotion code attached with the member.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "inactiveDate": { - "description": "Inactivation date of the record.", + "startDate": { + "description": "The start date of membership promotion.", "type": "string", "format": "date", "maxLength": 8 }, - "defaultConfirmation": { - "description": "Indicates whether the phone is the default confirmation method.", + "inactive": { + "description": "Indicates if the membership type is inactive.", "type": "boolean" }, - "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.", + "hotelId": { + "description": "Indicates Resort of membership promotion", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 20 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", + "endDate": { + "description": "Indicates the end date of membership promotion.", "type": "string", - "minLength": 0, - "maxLength": 40 + "format": "date" + }, + "global": { + "description": "Specifies whether the promotion code attached is global.", + "type": "boolean" + }, + "membershipPromotionId": { + "description": "The ID of a promotion owned by a membership.", + "type": "number" } - }, - "description": "Web site address." + } }, - "stagedProfileMembershipType": { + "copyInstructionsType": { "type": "object", + "description": "Copy Instructions for a profile", "properties": { - "comment": { - "description": "Additional comments regarding to the membership.", - "$ref": "#/definitions/paragraphType" - }, - "newMembershipNumber": { - "description": "Card Number of the membership.", - "type": "string" - }, - "nameOnCard": { - "description": "Name to be displayed on the membership card.", - "type": "string" - }, - "programDescription": { - "description": "Description of the membership program.", - "type": "string" - }, - "membershipLevel": { - "description": "Indicates the membership level.", - "type": "string" + "instructions": { + "type": "array", + "description": "List of the profile details to be copied", + "items": { + "$ref": "#/definitions/copyInstructionType" + } + } + } + }, + "copyInstructionType": { + "type": "string", + "description": "Copy Instruction for a profile", + "enum": [ + "Keyword" + ] + }, + "profileMatchStatusType": { + "type": "string", + "description": "Status of the match. It can be one of these 3 options: Match Points Computed, Do Not Merge, Can Not Merge.", + "enum": [ + "MPC", + "DNM", + "CNM" + ] + }, + "profilesMatch": { + "type": "object", + "description": "Response object for fetching the profiles match.", + "properties": { + "profilesMatchList": { + "type": "array", + "description": "List of profiles matches. The values are ordered by default using main profile first name.", + "maxItems": 200, + "items": { + "$ref": "#/definitions/profilesMatchType" + } }, - "membershipLevelDescription": { - "description": "Indicates the membership level description.", - "type": "string", - "minLength": 0, - "maxLength": 200 + "offset": { + "description": "Indicates the index of the next applicable set(page).", + "type": "integer" }, - "membershipClass": { - "description": "Indicates the membership class.", - "type": "string" + "limit": { + "description": "Indicates number of records the API can return as per the API request limit sent. A maximum of 200 records can be only returned at a time.", + "type": "integer" }, - "earningPreference": { - "description": "Earning preference to the membership.", - "$ref": "#/definitions/membershipEarningPreferenceType" + "count": { + "description": "Indicates number of records the API has returned actually as per the API request criteria.", + "type": "integer" }, - "inactive": { - "description": "Indicates whether membership is active or inactive.", + "hasMore": { + "description": "Indicates whether there are more records available to be returned as per the API request criteria or not.", "type": "boolean" }, - "benefits": { - "description": "benefits for the membership.", - "$ref": "#/definitions/benefitsType" + "totalResults": { + "description": "Indicates total number of records available that can be returned as per the API request criteria.", + "type": "integer" }, - "tierAdministration": { - "description": "Defines the degree of participation for this membership in the tier management portion of the program.", - "$ref": "#/definitions/tierAdministrationType" + "links": { + "$ref": "#/definitions/links" }, - "downgrade": { - "description": "Defines how downgrading will be handled for this membership.", - "$ref": "#/definitions/downgradeType" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "profilesMatchType": { + "type": "object", + "description": "Type that contains the information of a profile match such as main profile, profile to merge, match id, status of the match, date when the points where computed for last time, etc.", + "properties": { + "matchId": { + "description": "Unique identifier for this particular profile match record.", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "reIssueNewCard": { - "description": "The status of issuing new membership card to the member.", - "$ref": "#/definitions/cardReIssueType" + "mainProfile": { + "description": "Information of main profile.", + "$ref": "#/definitions/shortInfoProfileType" }, - "excludeFromBatch": { - "description": "True if you want to exclude the member from the Membership Fulfillment extract,the member's actions will not be included in the fulfillment extract until this value set to false.", - "type": "boolean" + "profileToMerge": { + "description": "Information of profile that will be merged to the main profile.", + "$ref": "#/definitions/shortInfoProfileType" }, - "upgradeDescription": { - "description": "Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.", + "rule": { + "description": "Match criteria rule code that was used to create that match.", "type": "string", "minLength": 0, - "maxLength": 32000 + "maxLength": 400 }, - "downgradeDescription": { - "description": "Indicates information regarding the member's possible downgrades.", + "matchCriteria": { + "description": "Description of the match point for the profile merge.", "type": "string", "minLength": 0, - "maxLength": 32000 + "maxLength": 4000 }, - "rating": { - "description": "Value Rating Type Description for this membership.", - "type": "string" + "points": { + "description": "Total number of weighing match points that was found between main profile and profile to merge.", + "type": "number", + "minimum": 0 }, - "membershipEnrollmentCode": { - "description": "Indicates how the guest enrolled in the program.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "status": { + "description": "Status of the match. It can be one of these 3 options: Match Points Computed, Do Not Merge, Can Not Merge.", + "$ref": "#/definitions/profileMatchStatusType" }, - "memberStatus": { - "description": "Indicates where the guest is in the membership enrollment process.", + "computedOn": { + "description": "Date when the weighing points were computed for the profiles", "type": "string", + "format": "date", "minLength": 0, "maxLength": 20 }, - "currentPoints": { - "description": "Profile MemberShip Points.", - "type": "number" - }, - "pointsLabel": { - "description": "Label used to refer to points for this membership type", + "doNotMerge": { + "description": "If this value is true, then this record is set as do not merge, if false, it is set as merge.", + "type": "boolean" + } + } + }, + "shortInfoProfileType": { + "type": "object", + "description": "This type contains short information of a profile.", + "properties": { + "nameId": { + "description": "Unique id for the profile.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 80 }, - "enrollmentSource": { - "description": "Source from where the enrollment is done.", + "displayName": { + "description": "Name that will be displayed for the profile, it is the combination of last name and first name of a profile.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 160 }, - "enrollmentResort": { - "description": "Resort/CRO where enrollment is done.", + "clientId": { + "description": "Corporate id of the profile.", "type": "string", "minLength": 0, "maxLength": 20 - }, - "preferredCard": { - "description": "Preferred Card.", - "type": "boolean" - }, - "membershipId": { - "description": "Card Number of the membership.", - "type": "string" - }, - "membershipType": { - "description": "Type of membership.", - "type": "string" - }, - "primaryMembershipYn": { - "description": "Indicator if Membership is a Primary Membership.", + } + } + }, + "matchListType": { + "type": "object", + "description": "Type that contains the list of theh matchIds that will be updated to skip or don't skip profile match.", + "properties": { + "matchList": { + "type": "array", + "description": "List of matchIds that will be updated to skip or don't skip profile match.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/matchType" + } + } + } + }, + "matchType": { + "type": "object", + "description": "Type that contains matchId and if this particular matchId is set to skip profile match or not.", + "properties": { + "matchId": { + "description": "Identifier of the match record.", "type": "string", "minLength": 0, - "maxLength": 1 + "maxLength": 80 }, - "primaryMembership": { - "description": "Boolean indicator set to True implies membership is a Primary Membership.", + "skipProfileMatch": { + "description": "If true, it sets the record to skip profile match for this particular matchId. if false, it sets the record to not skip profile match.", "type": "boolean" + } + } + }, + "membershipPointsExceptionsType": { + "type": "object", + "description": "Contains Membership points exception information.", + "properties": { + "membershipTransactionIds": { + "description": "Unique identifier associated with the membership transaction.", + "type": "array", + "maxItems": 20, + "items": { + "$ref": "#/definitions/membershipTransactionId" + } }, - "membershipIdNo": { - "description": "Membership ID Number.", - "type": "integer" - }, - "playerRanking": { - "description": "Ranking assigned to the Player Profile by the Gaming system.", - "type": "integer" - }, - "centralSetup": { - "description": "Indicates how the award points for this membership type will be managed.", + "acceptPoints": { + "description": "Indicates if the membership points exception are to be accepted or rejected.", "type": "boolean" }, - "signupDate": { - "description": "Indicates when the member signed up for the loyalty program.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "effectiveDate": { - "description": "Indicates the starting date.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "expireDate": { - "description": "Indicates the ending date.", + "userNotes": { + "description": "Notes regarding the resolution of the membership transaction exception or for any other reason.", "type": "string", - "format": "date", - "maxLength": 8 - }, - "expireDateExclusiveIndicator": { - "description": "When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).", - "type": "boolean" - }, - "orderSequence": { - "description": "Display Order sequence.", - "type": "number" + "minLength": 0, + "maxLength": 4000 + } + } + }, + "membershipPointsExceptions": { + "type": "object", + "description": "Response object for fetching membership points exceptions.", + "properties": { + "membershipPointsExceptions": { + "description": "A collection of membership points exceptions.", + "$ref": "#/definitions/membershipPointsExceptionsType" }, - "createDateTime": { - "description": "Time stamp of the creation.", - "type": "string", - "format": "date-time" + "links": { + "$ref": "#/definitions/links" }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "fileType": { + "description": "File Type of the staging file.", + "type": "string", + "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": 200 + "maxLength": 20 }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", - "type": "string", - "format": "date-time" + "profileId": { + "description": "The profile to which this membership is associated with.", + "$ref": "#/definitions/profileId" }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", - "type": "string", - "minLength": 0, - "maxLength": 200 + "name": { + "description": "The profile name associated with this membership.", + "type": "string" }, - "errorDescription": { - "description": "The error in membership information in a staged profile with an invalid status.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "fromToRangeDate": { + "description": "Arrival and Departure date of stay for which you are displaying membership transaction exceptions.", + "$ref": "#/definitions/dateRangeType" }, - "registrationResort": { - "description": "Registration resort.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "membershipIdNo": { + "description": "Unique identifier of this membership.", + "type": "number" }, - "enrollmentCode": { - "description": "Enrollment code.", + "membershipType": { + "description": "The type of the membership.", + "$ref": "#/definitions/codeDescriptionType" + }, + "membershipCardNo": { + "description": "The card number associated with this membership.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 50 }, - "membershipStatus": { - "description": "Membership status.", + "membershipLevel": { + "description": "The current level of the membership.", "type": "string", "minLength": 0, "maxLength": 20 }, - "inactiveDate": { - "description": "Inactivation date of the record.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "deviceCode": { - "description": "Device encoded string.", - "type": "string", - "minLength": 0, - "maxLength": 200 + "membershipTransactionId": { + "description": "Unique identifier associated with the membership transaction.", + "$ref": "#/definitions/membershipTransactionId" }, - "deviceDisabledDate": { - "description": "Device disabled date.", - "type": "string", - "format": "date", - "maxLength": 8 + "roomsBooked": { + "description": "The number of rooms booked.(MR)", + "type": "integer" }, - "updateExistingMembership": { - "description": "Indicates if existing information for primary membership should be overwritten.", + "backToBack": { + "description": "Indicates if back to back membership transaction exceptions have occurred or not.", "type": "boolean" }, - "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 + "averageRate": { + "description": "The average rate of the stay.", + "type": "number" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 40 - } - }, - "description": "Detailed information of the memberships." - }, - "stagedProfilePreferenceType": { - "type": "object", - "properties": { - "preferenceValue": { - "description": "Preference value for display purposes.", - "type": "string", - "minLength": 0, - "maxLength": 200 + "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" }, - "description": { - "description": "Preference Description for display purposes.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "tierStayPoints": { + "description": "Tier stay points associated with this membership points transaction.", + "type": "number" }, - "global": { - "description": "Whether this preference is property specific or not.", + "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" }, - "source": { - "description": "Source of the preference.", + "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": 40 + "maxLength": 2000 }, - "hotels": { - "description": "If specified preference belongs to the Hotels listed, otherwise it is a global preference.", + "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": 4000, + "maxItems": 100, + "description": "A collection of membership points exceptions.", "items": { - "type": "string", - "minLength": 0, - "maxLength": 20 + "$ref": "#/definitions/memberPointsExceptionType" } }, - "preferenceCode": { - "type": "string", - "minLength": 0, - "maxLength": 20 + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", + "type": "integer" }, - "excludedPreferencesCount": { - "description": "Specifies the count of preferences excluded for the attached reservation preference.", + "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" }, - "copyToProfile": { - "description": "Specifies whether to copy the reservation preference to the profile or not.", + "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" }, - "errorDescription": { - "description": "The error in Preference information in a staged profile with an invalid status", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" }, - "inactiveDate": { - "description": "Inactivation date of the record.", - "type": "string", - "format": "date", - "maxLength": 8 + "count": { + "description": "Total number of rows returned", + "type": "integer" }, - "resortPrefernce": { - "description": "Prefernce resort.", + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipExceptionStatusType": { + "type": "string", + "description": "List of possible membership exception type.", + "enum": [ + "AllExceptions", + "PointsAwardedOnException", + "PointsRejectedOnException", + "ExceptionNotResolved" + ] + }, + "membershipReservationDetails": { + "type": "object", + "description": "Response element for membership reservation activity updated.", + "properties": { + "calendarDate": { + "description": "Date for the requested membership reservation details.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date" }, - "valid": { - "description": "Indicated whether the preference information is valid.", - "type": "boolean" + "membershipReservationDetailsList": { + "type": "array", + "description": "List of fetched membership reservation details.", + "maxItems": 200, + "items": { + "$ref": "#/definitions/membershipReservationDetailUnitType" + } }, - "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 + "links": { + "$ref": "#/definitions/links" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "warnings": { + "$ref": "#/definitions/warningsType" } - }, - "description": "Guest Preference details for the profile." + } }, - "stagedProfileKeywordType": { + "membershipReservationDetailUnitType": { "type": "object", + "description": "The filetered membership reservation information.", "properties": { - "keywordDetail": { - "description": "The keyword new value, in case keyword value is modified.", - "$ref": "#/definitions/keywordDetailType" + "value": { + "description": "Membership reservation detail value.", + "type": "number" }, - "errorDescription": { - "description": "The error in keyword information in a staged profile with an invalid status", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "code": { + "$ref": "#/definitions/membershipReservationDetailCodeType" + } + } + }, + "membershipReservationDetailCodeType": { + "type": "string", + "description": "Supported memebership reservation detail code type.", + "enum": [ + "ArrivalsTotal", + "DeparturesTotal", + "InHouseTotal", + "RoomRevenue" + ] + }, + "issueAwardsInfoType": { + "type": "array", + "description": "List of awards info.", + "maxItems": 100, + "items": { + "$ref": "#/definitions/issueAwardInfoType" + } + }, + "issueAwardInfoType": { + "type": "object", + "description": "Information about issue award.", + "properties": { + "pointsRequired": { + "description": "The number of points that must be redeemed for this award.", + "type": "number" }, - "keywordType": { - "description": "The type of keyword", - "type": "string", - "minLength": 0, - "maxLength": 20 + "cancelPenaltyPoints": { + "description": "The award points that will be forfeited if the cancel penalty charge is applied.", + "type": "number" }, - "keyword": { - "description": "The keyword value.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "cancelPenaltyDays": { + "description": "Number of days before arrival when a reservation may be cancelled without an award points penalty.", + "type": "number" }, - "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.", + "awardNumber": { + "description": "An identifying number of the award, assigned by the system when the award was issued.", + "type": "number" + }, + "packageCode": { + "description": "Package/Product code for the award.", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 20 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", + "stayDate": { + "description": "The date of the reservation associated with the award. There may be more than one date (multiple nights) associated with award.", "type": "string", - "minLength": 0, - "maxLength": 40 + "format": "date", + "maxLength": 8 } } }, - "stagedProfileNegotiatedRateType": { + "issuedAward": { "type": "object", + "description": "Response object for issue awards.", "properties": { - "negotiatedInfoList": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/negotiatedInfoType" - } - }, - "hotelId": { - "description": "Hotel code for the negotiated rate.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "issueAwards": { + "description": "Collection of issue awards information.", + "$ref": "#/definitions/issueAwardsInfoType" }, - "rateCode": { - "description": "Rate plan code for the negotiated rate.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "links": { + "$ref": "#/definitions/links" }, - "errorDescription": { - "description": "The error in negotiated rate information in a staged profile with an invalid status", + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "otherAwardAvailabilityType": { + "type": "object", + "description": "Information related to the Other type Award.", + "properties": { + "awardType": { + "description": "Unique code that identifies this award.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 40 }, - "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.", + "shortDescription": { + "description": "Descriptive name of the award.", "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 + "awardValue": { + "description": "The actual currency value of the award.", + "type": "number" + }, + "pointsRequired": { + "description": "The number of points requried to redeem this award.", + "type": "number" } - }, - "description": "This holds a list of NegotiatedInfoType." + } }, - "stagedProfileIdentificationsType": { + "membershipOtherAwardInfoType": { "type": "object", + "description": "Information about the OTHER type Award and profile membership. OTHER type awards can be redeemed based on the points available with a particular member.", "properties": { - "identification": { - "description": "Detailed information on the identification of the customer.", - "$ref": "#/definitions/identificationType" + "otherInfo": { + "description": "Information related to the Other type Award.", + "$ref": "#/definitions/otherAwardAvailabilityType" }, - "errorDescription": { - "description": "The error in negotiated rate information in a staged profile with an invalid status", + "membershipId": { + "description": "Unique Membership ID.", + "type": "number" + }, + "membershipNumber": { + "description": "The card number associated with the membership.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 50 }, - "documentResort": { - "description": "Hotel code to which the document belongs.", + "membershipType": { + "description": "The type of the membership.", "type": "string", "minLength": 0, "maxLength": 20 + } + } + }, + "otherAwardsIssueCriteria": { + "type": "object", + "description": "Request object to issue an OTHER type award to a member's profile.", + "properties": { + "issueAwardsInfo": { + "type": "array", + "description": "List of OTHER type awards information.", + "maxItems": 100, + "items": { + "$ref": "#/definitions/membershipOtherAwardInfoType" + } }, - "inactiveDate": { - "description": "The date when the record was inactivated.", - "type": "string", - "format": "date", - "maxLength": 8 + "links": { + "$ref": "#/definitions/links" }, - "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 + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "profileMatch": { + "type": "object", + "description": "Response object for fetching profile Match.", + "properties": { + "profileId": { + "description": "The profile Id for which the details matched.", + "$ref": "#/definitions/profileId" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" } - }, - "description": "Information on the identification of the customer." + } }, - "stagedProfileRoutingInstructionType": { + "stagedProfileSummariesType": { "type": "object", + "description": "A collection of staged profiles.", "properties": { - "transactionInfo": { - "description": "Transaction code information in a staged profile with an invalid status", - "$ref": "#/definitions/stagedProfileTrxInfoType" + "profileInfo": { + "description": "Basic information about staged profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stagedProfileSummaryType" + } }, - "billingInstruction": { - "description": "Configured Billing Instruction in a staged profile with an invalid status", - "$ref": "#/definitions/stagedProfileBillingInstructionType" + "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" } } }, - "stagedProfileTrxInfoType": { + "stagedProfileSummaryType": { "type": "object", + "description": "Basic information about staged profile.", "properties": { - "description": { - "description": "Transaction codes info.", + "hotelId": { + "description": "Hotel code associated with the staged profile.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "transactionGroup": { - "description": "Category of the transaction code.", + "profileIdList": { + "description": "List of unique identifier of staged profile.", + "$ref": "#/definitions/uniqueIDListType" + }, + "profileName": { + "description": "Name information for the staged profile.", + "$ref": "#/definitions/profileNameType" + }, + "internalProfileName": { + "description": "Indicates name information present in OPERA for a staged profile.", + "$ref": "#/definitions/profileNameType" + }, + "primaryMembershipCardNo": { + "description": "Indicates the primary membership card number of a staged profile", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 40 }, - "transactionSubGroup": { - "description": "Sub category of the transaction code.", + "membershipEnrollmentCode": { + "description": "Membership enrollment code of a staged profile.", "type": "string", - "minLength": 0, - "maxLength": 20 + "maxLength": 40 }, - "universalProductCode": { - "description": "Unique Universal product code of the transaction code.", + "membershipExpirationDate": { + "description": "Indicates the expiry date of a staged membership profile.", + "type": "string", + "format": "date" + }, + "membershipLevel": { + "description": "Indicates the membership level of a staged membership profile.", "type": "string", "minLength": 0, "maxLength": 20 }, - "routingInstructionsId": { - "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.", - "type": "number" - }, - "articles": { - "description": "The List of Articles defined for this transaction code, when using the Articles functionality.", + "stagedProfileReasons": { + "description": "Describes the reasons why a profile got staged.", "type": "array", - "maxItems": 4000, + "maxItems": 8, "items": { - "$ref": "#/definitions/articleInfoType" + "$ref": "#/definitions/stagedReasonsType" } }, - "trxServiceType": { - "description": "Contains service type for transaction code.", + "importDate": { + "description": "The date on which the staged profile has been received.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date", + "maxLength": 8 }, - "transactionCode": { - "description": "Unique identifier for the Transaction code.", + "profileType": { + "description": "Type of the staged profile.", "type": "string", "minLength": 0, "maxLength": 20 }, - "hotelId": { - "description": "Hotel context of the Transaction code.", + "region": { + "description": "The region of the staged profile.", "type": "string", "minLength": 0, "maxLength": 20 }, - "printTrxReceipt": { - "description": "Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.", - "type": "boolean" - }, - "errorDescription": { - "description": "The error in transaction code information in a staged profile with an invalid status", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "country": { + "description": "The country of residence where the property is located that has received the staged profile.", + "$ref": "#/definitions/countryNameType" }, - "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.", + "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" + ] + }, + "stagedProfileProcessType": { + "type": "string", + "enum": [ + "New", + "Match", + "Reprocess", + "ForceMerge" + ] + }, + "stagedProfileId": { + "type": "object", + "description": "Unique identifier for a staged profile.", + "properties": { + "hotelId": { + "description": "Hotel code for the staged profile to be reprocessed.", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 20 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "profileId": { + "description": "External profile ID to be reprocessed.", + "$ref": "#/definitions/profileId" } - }, - "description": "Transaction codes info." + } }, - "stagedProfileBillingInstructionType": { + "processStagedProfileType": { "type": "object", + "description": "Information required to process a atged profile.", "properties": { - "desc": { - "description": "Billing Instruction code description.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "stagedProfileId": { + "description": "Unique Identifier for Staged Profile.", + "$ref": "#/definitions/stagedProfileId" }, - "routingInstructionsId": { - "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer.", - "type": "number" + "processType": { + "description": "Type of processing.", + "$ref": "#/definitions/stagedProfileProcessType" }, - "billingCode": { - "description": "Unique identifier for the Billing Instruction.", + "sourceType": { + "description": "Type of source.", + "$ref": "#/definitions/stagedProfileSourceType" + } + } + }, + "stagedProfileSourceType": { + "type": "string", + "enum": [ + "Screen", + "Interface" + ] + }, + "processStagedProfileResultType": { + "type": "object", + "description": "Information about the staged profile after processing.", + "properties": { + "hotelId": { + "description": "Hotel Code for the staged profile.", "type": "string", "minLength": 0, "maxLength": 20 }, - "hotelId": { - "description": "Hotel context of the Billing Instruction.", + "profileId": { + "description": "The resulting profile ID after processing the staged profile.", + "$ref": "#/definitions/profileId" + }, + "stageStatus": { + "description": "The resulting profile status after processing the staged profile.", "type": "string", "minLength": 0, "maxLength": 20 }, - "errorDescription": { - "description": "The error in billing instruction information in a staged profile with an invalid status", + "result": { + "description": "Processing/Rematching result for the staged profile.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 4000 + } + } + }, + "stagedReasonsType": { + "type": "object", + "description": "This is used to fetch staged profiles based on the reason why it got staged.", + "properties": { + "stagedProfileReasonsType": { + "description": "This is used to fetch staged profiles based on the reason why it got staged.", + "$ref": "#/definitions/stagedReasonType" + } + } + }, + "stagedReasonType": { + "type": "string", + "description": "Reasons why the profile got staged. InvalidExpirationDate indicates the membership expiration date is not matching with OPERA system. InvalidEnrollmentCode indicates the membership enrollment code is not matching with opera. NameChange indicates last name or first name is not matching with OPERA", + "enum": [ + "InvalidEnrollmentCode", + "EmptyEnrollmentCode", + "NameChange", + "InvalidExpirationDate", + "EmptyExpirationDate", + "EmptyMembershipLevel", + "InvalidMembershipLevel", + "DuplicateMembership" + ] + }, + "stagedProfiles": { + "type": "object", + "description": "Response object for the staged profiles.", + "properties": { + "stagedProfiles": { + "description": "A collection of staged profiles.", + "$ref": "#/definitions/stagedProfileSummariesType" }, - "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 + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "stagedProfileCriteria": { + "type": "object", + "properties": { + "stagedProfile": { + "$ref": "#/definitions/processStagedProfileType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "processedStagedProfile": { + "type": "object", + "properties": { + "processResult": { + "$ref": "#/definitions/processStagedProfileResultType" + }, + "links": { + "$ref": "#/definitions/links" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "warnings": { + "$ref": "#/definitions/warningsType" } - }, - "description": "Configured Billing Instruction which represents a set of Transaction Codes." + } }, - "stagedProfileUserDefinedFieldsType": { + "profileDistributionConditionGroupType": { "type": "object", - "description": "Used to hold user defined fields(UDFs) for staged profile.", "properties": { - "characterUDFs": { - "description": "Collection of user defined fields of Character/String Type.", - "$ref": "#/definitions/stagedProfileCharacterUDFsType" + "condition": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileDistributionConditionType" + } }, - "numericUDFs": { - "description": "Collection of user defined fields of Numeric Type.", - "$ref": "#/definitions/stagedProfileNumericUDFsType" + "conditionGroup": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/profileDistributionConditionGroupType" + } }, - "dateUDFs": { - "description": "Collection of user defined fields of Date Type.", - "$ref": "#/definitions/stagedProfileDateUDFsType" + "logicalOperator": { + "$ref": "#/definitions/logicalOperatorType" } } }, - "stagedProfileCharacterUDFsType": { - "type": "array", - "description": "Used to hold collection of user defined fields of Character/String Type.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileCharacterUDFType" - } + "logicalOperatorType": { + "type": "string", + "enum": [ + "And", + "Or" + ] }, - "stagedProfileCharacterUDFType": { + "profileDistributionConditionType": { "type": "object", "properties": { - "name": { - "description": "Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02,...UDFC40 (Total 40) as Character/String UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "leftExpression": { + "$ref": "#/definitions/profileDistributionExpressionFieldType" }, - "value": { - "description": "Value of user defined field.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "operator": { + "$ref": "#/definitions/profileDistributionExpressionOperatorType" }, - "alternateName": { - "description": "Label of user defined field used by vendors or customers.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "rightExpression": { + "$ref": "#/definitions/profileDistributionExpressionParameterType" }, - "errorDescription": { - "description": "The error in a user defined field in a staged profile with an invalid status", + "logicalOperator": { + "$ref": "#/definitions/logicalOperatorType" + } + } + }, + "profileDistributionExpressionFieldType": { + "type": "object", + "properties": { + "fieldName": { + "$ref": "#/definitions/profileDistributionFieldNameType" + }, + "fieldDescription": { "type": "string", "minLength": 0, "maxLength": 2000 }, "tableName": { - "description": "PMS table name.", "type": "string", "minLength": 0, "maxLength": 40 }, - "valid": { - "description": "Indicates whether the UDF information is valid.", + "virtual": { "type": "boolean" }, - "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.", + "dataType": { "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 40 }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", + "lovSelected": { "type": "string", "minLength": 0, - "maxLength": 40 + "maxLength": 20 } - }, - "description": "Used to hold user defined field of Character/String Type." + } }, - "stagedProfileNumericUDFsType": { - "type": "array", - "description": "Used to hold collection of user defined fields of Numeric Type.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileNumericUDFType" + "profileDistributionFieldNameType": { + "type": "object", + "properties": { + "field": { + "description": "Field type.", + "$ref": "#/definitions/fieldType" + } } }, - "stagedProfileNumericUDFType": { + "fieldType": { + "type": "string", + "enum": [ + "NameId" + ] + }, + "profileDistributionExpressionParameterType": { "type": "object", "properties": { - "name": { - "description": "Name of user defined field.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "parameter": { + "type": "array", + "maxItems": 3, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 32000 + } }, - "value": { - "description": "Value of user defined field.", + "functionIdOne": { "type": "number" }, - "alternateName": { - "description": "Label of user defined field used by vendors or customers.", - "type": "string", - "minLength": 0, - "maxLength": 2000 - }, - "errorDescription": { - "description": "The error in a user defined field in a staged profile with an invalid status", + "functionIdTwo": { + "type": "number" + } + } + }, + "profileDistributionExpressionOperatorType": { + "type": "object", + "properties": { + "operatorName": { "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 240 }, - "tableName": { - "description": "PMS table name.", + "operatorDescription": { "type": "string", "minLength": 0, - "maxLength": 40 + "maxLength": 400 }, - "valid": { - "description": "Indicates whether the UDF information is valid.", - "type": "boolean" + "parameterSize": { + "type": "number" + } + } + }, + "membershipTransactionsSummaryCollection": { + "type": "object", + "description": "Response object for fetching multiple memberships transactions summaries.", + "properties": { + "membershipTransactionsSummaryCollection": { + "type": "array", + "maxItems": 4000, + "description": "A collection of membership points exceptions.", + "items": { + "$ref": "#/definitions/membershipTransactionsSummaryType" + } }, - "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 + "links": { + "$ref": "#/definitions/links" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "warnings": { + "$ref": "#/definitions/warningsType" } - }, - "description": "Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required." - }, - "stagedProfileDateUDFsType": { - "type": "array", - "description": "Used to hold collection of user defined fields of Date Type.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileDateUDFType" } }, - "stagedProfileDateUDFType": { + "membershipTransactionsSummaryType": { "type": "object", + "description": "Details of membership transaction like Details, Summary, point, etc.", "properties": { - "name": { - "description": "Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02,...UDFN20 (Total 20) as Date UDF names(commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "membershipDetails": { + "description": "Member details for the requested membership ID.", + "$ref": "#/definitions/membershipDetailsType" }, - "value": { - "description": "Value of user defined field.", - "type": "string", - "format": "date", - "maxLength": 8 + "transactionsSummary": { + "description": "Member transaction Summary for the requested membership ID.", + "$ref": "#/definitions/memberTransactionSummaryType" }, - "alternateName": { - "description": "Label of user defined field used by vendors or customers.", - "type": "string", - "minLength": 0, - "maxLength": 2000 + "recentTransactionsSummary": { + "description": "Member transaction Summary(Range) for the requested membership ID.", + "$ref": "#/definitions/memberTransactionRecentSummaryType" }, - "errorDescription": { - "description": "The error in a user defined field in a staged profile with an invalid status", + "pointsSummary": { + "description": "Member points summary for the requested membership ID.", + "$ref": "#/definitions/memberPointsSummaryType" + } + } + }, + "stayDailyRatesType": { + "type": "object", + "properties": { + "transactionDate": { + "description": "Date on which the transaction was done.", "type": "string", - "minLength": 0, - "maxLength": 2000 + "format": "date" }, - "tableName": { - "description": "PMS table name.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "bookedRoomType": { + "description": "Specifies the type of room booked.", + "type": "string" }, - "valid": { - "description": "Indicates whether the UDF information is valid.", + "currencyCode": { + "description": "Specifies the code assigned to the currency.", + "type": "string" + }, + "pseudoRoom": { + "description": "Specifies if the room is a pseudo room.", "type": "boolean" }, - "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 + "marketCode": { + "description": "Specifies the market code.", + "type": "string" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 40 + "rateCode": { + "description": "Specifies the rate code.", + "type": "string" + }, + "rateAmount": { + "description": "Specifies the amount added to a particular rate code.", + "type": "number" + }, + "roomId": { + "description": "Describes the room id of the room owner.", + "type": "string" + }, + "roomType": { + "description": "Describes the type of the room.", + "type": "string" } }, - "description": "Used to hold user defined field of Date Type." + "required": [ + "transactionDate", + "rateCode" + ] }, - "stagedProfileCommentInfosType": { - "type": "array", - "description": "List of Notes for the customer.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/stagedProfileCommentInfoType" + "stayMembershipsType": { + "type": "object", + "properties": { + "membershipNumber": { + "description": "A unique value given to a membership.", + "type": "string" + }, + "membershipType": { + "description": "Specifies the type of membership.", + "type": "string" + } } }, - "stagedProfileCommentInfoType": { + "stayProfilesType": { "type": "object", - "description": "Comment related to the profile/reservation.", "properties": { - "comment": { - "description": "Comment details for the comment. It will be empty in case of delete comment.", - "$ref": "#/definitions/commentType" + "primary": { + "description": "Checks if the profile is primary.", + "type": "boolean" }, - "createDateTime": { - "description": "Time stamp of the creation.", + "nameId": { + "description": "Specifies the unique id that is assigned to a profile.", + "type": "number" + }, + "pmsNameId": { + "description": "Specifies the pms id that is assigned to a profile.", + "type": "string" + }, + "profileRole": { + "description": "Describes the role associated with the profile.", + "type": "string" + } + }, + "required": [ + "profileRole" + ] + }, + "stayRecordsType": { + "type": "object", + "properties": { + "UDFC01": { + "description": "Describes the user defined field 01", + "type": "string" + }, + "UDFC02": { + "description": "Describes the user defined field 02", + "type": "string" + }, + "UDFC03": { + "description": "Describes the user defined field 03", + "type": "string" + }, + "UDFC04": { + "description": "Describes the user defined field 04", + "type": "string" + }, + "UDFC05": { + "description": "Describes the user defined field 05", + "type": "string" + }, + "UDFC06": { + "description": "Describes the user defined field 06", + "type": "string" + }, + "UDFC07": { + "description": "Describes the user defined field 07", + "type": "string" + }, + "UDFC08": { + "description": "Describes the user defined field 08", + "type": "string" + }, + "UDFC09": { + "description": "Describes the user defined field 09", + "type": "string" + }, + "UDFC10": { + "description": "Describes the user defined field 10", + "type": "string" + }, + "UDFD01": { + "description": "Describes the user defined field 01", "type": "string", - "format": "date-time" + "format": "date" }, - "creatorId": { - "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.", + "UDFD02": { + "description": "Describes the user defined field 02", "type": "string", - "minLength": 0, - "maxLength": 200 + "format": "date" }, - "lastModifyDateTime": { - "description": "Time stamp of last modification.", + "UDFD03": { + "description": "Describes the user defined field 03", "type": "string", - "format": "date-time" + "format": "date" }, - "lastModifierId": { - "description": "Identifies the last software system or person to modify a record.", + "UDFD04": { + "description": "Describes the user defined field 04", "type": "string", - "minLength": 0, - "maxLength": 200 + "format": "date" }, - "lineNo": { - "description": "The line number of the comment.", - "type": "integer" + "UDFD05": { + "description": "Describes the user defined field 05", + "type": "string", + "format": "date" }, - "inActiveDate": { - "description": "Indicates comment inactive date.", + "UDFN01": { + "description": "Describes the user defined field 10", + "type": "number" + }, + "UDFN02": { + "description": "Describes the user defined field 10", + "type": "number" + }, + "UDFN03": { + "description": "Describes the user defined field 10", + "type": "number" + }, + "UDFN04": { + "description": "Describes the user defined field 10", + "type": "number" + }, + "UDFN05": { + "description": "Describes the user defined field 10", + "type": "number" + }, + "adults": { + "description": "Describes the number of adults", + "type": "number" + }, + "arrivalDate": { + "description": "Specifies the date of arrival", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, - "errorDescription": { - "description": "The error in a user defined field in a staged profile with an invalid status.", + "baseRateAmount": { + "description": "Specifies the base rate amount", + "type": "number" + }, + "baseRateCode": { + "description": "Specifies the base rate code", + "type": "string" + }, + "baseRateCurrencyCode": { + "description": "Specifies the currency code of the base rate", + "type": "string" + }, + "blockCode": { + "description": "Specifies the block code", + "type": "string" + }, + "bookedRoomType": { + "description": "Specifies the type of room booked.", + "type": "string" + }, + "bookingDate": { + "description": "Specifies the date of booking.", "type": "string", - "minLength": 0, - "maxLength": 2000 + "format": "date" }, - "valid": { - "description": "Indicates whether the comment information is valid.", + "cancellationDate": { + "description": "Specifies the date of cancellation", + "type": "string", + "format": "date" + }, + "channel": { + "description": "Specifies the channel", + "type": "string" + }, + "children": { + "description": "specifies the number of children", + "type": "number" + }, + "companyId": { + "description": "Specifies the id assigned to the company", + "type": "string" + }, + "confirmationLegNumber": { + "description": "Specifies the confirmation leg number", + "type": "number" + }, + "confirmationNumber": { + "description": "Specifies the confirmation number", + "type": "string" + }, + "currencyCode": { + "description": "Specifies the currency code", + "type": "string" + }, + "departureDate": { + "description": "Specifies the date of departure", + "type": "string", + "format": "date" + }, + "exchangeRate": { + "description": "Specifies the exchange rate", + "type": "number" + }, + "externalReservationId": { + "description": "Describes the id assigned to an external reservation", + "type": "string" + }, + "groupId": { + "description": "Specifies the id assigned to a group", + "type": "string" + }, + "guestNameId": { + "description": "Specifies the id assigned to a guest name", + "type": "string" + }, + "complimentary": { + "description": "Describes if complimentary or not", "type": "boolean" }, - "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.", + "primaryShare": { + "description": "Describes if it is a primary share", "type": "boolean" }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "miscellaneousId": { + "description": "Specifies the miscellaneous id", + "type": "string" }, - "count": { - "description": "Total number of rows returned", - "type": "integer" + "paymentMethod": { + "description": "Specifies the payment method used", + "type": "string" }, - "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 + "posCode": { + "description": "Specifies the postal code", + "type": "string" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 40 - } - } - }, - "profileDetails": { - "type": "object", - "description": "Response object for fetching multiple detailed profiles by unique identifiers..", - "properties": { - "profiles": { - "description": "Type contains Profile's primary details and it's children details.", - "$ref": "#/definitions/profilesType" + "promotionCode": { + "description": "Specifies the promotion code", + "type": "string" }, - "masterInfoList": { - "description": "Refer to Generic common types document.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/masterInfoType" - } + "reservationStatus": { + "description": "Describes the reservation status ie CANCELLED, CHECKED OUT, ARRIVAL etc", + "type": "string" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "profilesType": { - "type": "object", - "description": "A collection of Profile objects or Unique IDs of Profiles.", - "properties": { - "profileInfo": { - "description": "A collection of Profiles or Unique IDs of Profiles.", - "type": "array", - "maxItems": 4000, - "items": { - "type": "object", - "properties": { - "profileIdList": { - "description": "Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id.", - "$ref": "#/definitions/profileIdList" - }, - "profile": { - "description": "Provides detailed information regarding either a company or a customer profile.", - "$ref": "#/definitions/profileType" - }, - "chainCode": { - "description": "Chain code associated with the profile.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "allowedActions": { - "description": "Collection of allowed actions for profile search.", - "$ref": "#/definitions/profileAllowedActionsType" - } - } - } + "reservationExpectedArrivalTime": { + "description": "Specifies the expected arrival time of the reservation", + "type": "string", + "format": "date" }, - "totalResults": { - "description": "Total number of rows queried", - "type": "integer" + "reservationExpectedDepartureTime": { + "description": "Specifies the expected departure time of the reservation", + "type": "string", + "format": "date" }, - "count": { - "description": "Total number of rows returned", - "type": "integer" - } - } - }, - "recentlyAccessedProfiles": { - "type": "object", - "description": "Response with the fetched recently accessed profiles.", - "properties": { - "profiles": { - "description": "List of recently accessed profiles.", - "type": "array", - "items": { - "$ref": "#/definitions/recentlyAccessedProfileType" - } + "reservationInsertSource": { + "description": "Specifies the insert source for the reservation", + "type": "string" }, - "links": { - "$ref": "#/definitions/links" + "reservationInsertSourceType": { + "description": "Specifies the insert source type for the reservation", + "type": "string" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "recentlyAccessedProfileType": { - "type": "object", - "description": "A recently used profile details.", - "properties": { - "profileIdList": { - "description": "List of unique ids, consisting of the profile name id.", - "$ref": "#/definitions/profileIdList" + "roomId": { + "description": "Describes the room id of the room owner.", + "type": "string" }, - "guestFirstName": { - "description": "First Name of a Profile.", - "$ref": "#/definitions/givenNameType" + "roomRevenue": { + "description": "Specifies the revenue for the room.", + "type": "number" }, - "guestLastName": { - "description": "Last Name of a profile.", - "$ref": "#/definitions/surnameType" + "roomType": { + "description": "Describes the type of the room.", + "type": "string" }, - "accessDate": { - "description": "The date the record was accessed.", - "type": "string", - "format": "date", - "maxLength": 8 + "shareId": { + "description": "Specifies the share id.", + "type": "string" }, - "profileType": { - "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", - "$ref": "#/definitions/profileTypeType" - } - } - }, - "stagedProfileDetails": { - "type": "object", - "description": "Response object for the staged profile.", - "properties": { - "stagedProfile": { - "description": "Response object for the staged profile.", - "$ref": "#/definitions/stagedProfileType" + "sourceCode": { + "description": "Specifies the source code.", + "type": "string" }, - "links": { - "$ref": "#/definitions/links" + "sourceId": { + "description": "Specifies the source id.", + "type": "string" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "stagedProfile": { - "type": "object", - "description": "Request object for changing the staged profile.", - "properties": { - "stagedProfile": { - "$ref": "#/definitions/stagedProfileType" + "stageStatus": { + "description": "Specifies the stage status.", + "type": "string" }, - "changeInstructions": { - "$ref": "#/definitions/stagedProfileChangeInstructionsType" + "stageSuspenseReason": { + "description": "Specifies the stage suspense reason.", + "type": "string" }, - "links": { - "$ref": "#/definitions/links" + "totalRevenue": { + "description": "Specifies the total revenue.", + "type": "number" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "travelAgentId": { + "description": "Specifies the travel agent id", + "type": "string" } } }, - "stagedProfileChangeInstructionsType": { + "stayRevenuesDetailsType": { "type": "object", - "description": "Information about instructions to change the staged profile.", "properties": { - "fullyOverlay": { - "description": "If true then delete and recreat the staged profile details.", - "type": "boolean" + "folioView": { + "description": "", + "type": "string" + }, + "revenueAmount": { + "description": "Specifies the amount of revenue.", + "type": "number" + }, + "stayRevenues": { + "type": "array", + "items": { + "$ref": "#/definitions/stayRevenuesType" + } } } }, - "suspendedAddresses": { + "stayRevenuesType": { "type": "object", - "description": "Response object for fetching unique company profile.", "properties": { - "suspendedAddressesInfo": { - "description": "Suspended Addresses List", - "$ref": "#/definitions/suspendedAddressesType" + "revenueAmount": { + "description": "Specifies the amount of revenue.", + "type": "number" }, - "links": { - "$ref": "#/definitions/links" + "revenueBucketCode": { + "description": "Specifies the bucket code to which the revenue belongs.", + "type": "string" }, - "warnings": { - "$ref": "#/definitions/warningsType" + "transactionDate": { + "description": "Date on which the transaction was done.", + "type": "string", + "format": "date" } - } + }, + "required": [ + "revenueBucketCode", + "transactionDate" + ] }, - "suspendedAddressesType": { + "stayRecord": { "type": "object", - "description": "List of suspended addresses returned, based on the entered seach criteria.", "properties": { - "suspendedAddressesInfo": { - "description": "A collection of suspended Addresses.", + "hotelId": { + "description": "Specifies the property name", + "type": "string" + }, + "stayDailyRates": { "type": "array", "maxItems": 4000, "items": { - "$ref": "#/definitions/suspendedAddressesInfoType" + "$ref": "#/definitions/stayDailyRatesType" } }, - "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" + "stayMemberships": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stayMembershipsType" + } }, - "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" + "stayProfiles": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stayProfilesType" + } }, - "limit": { - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" + "stayRecordsList": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stayRecordsType" + } }, - "totalPages": { - "description": "Evaluated total page count based on the requested max fetch count.", - "type": "integer" + "stayRevenuesDetails": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/stayRevenuesDetailsType" + } } } }, - "suspendedAddressesInfoType": { + "stayRecordDetails": { "type": "object", + "description": "Complex type that contains stay record details", "properties": { - "addressId": { - "description": "Corporate id of the profile.", - "type": "integer" - }, - "name": { - "description": "Last Name of the Profile against which the Suspended Addresses are fetched.", - "type": "string", - "minLength": 0, - "maxLength": 80 - }, - "profileId": { - "description": "Opera ID for the profile attached to the address.", - "$ref": "#/definitions/uniqueID_Type" - }, - "firstName": { - "description": "First Name of the Profile against which the Suspended Addresses are fetched.", - "type": "string", - "minLength": 0, - "maxLength": 80 - }, - "profileType": { - "description": "Profile Type of the Profile against which the Suspended Addresses are fetched..", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "clientID": { - "description": "Corporate id of the profile.", - "$ref": "#/definitions/uniqueID_Type" - }, - "matchCode": { - "description": "Match Code of the Address Validation Performed from the batch processing", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "validateDate": { - "description": "Validate Date.", - "type": "string", - "format": "date", - "maxLength": 8 - }, - "country": { - "description": "The country of residence where the property is located e.", - "$ref": "#/definitions/countryNameType" - }, - "hotelId": { - "description": "Resort of the Profile", - "type": "string", - "minLength": 0, - "maxLength": 20 + "stayRecord": { + "description": "Contains stay record details", + "$ref": "#/definitions/stayRecord" } } }, - "suspendedProfileErrorSummaryInfo": { + "flexFieldValues": { "type": "object", - "description": "Response object for fetch suspended profile Errors summary. This object contains collection of profile erros and count of how many profiles encountered this error.", + "description": "Request object for flex fields values.", "properties": { - "suspendedProfileErrorSummary": { - "description": "Indicates response of the suspended profile errors summary.", - "$ref": "#/definitions/suspendedProfileErrorsSummaryType" + "flexFieldInfo": { + "description": "Provides information about flex fields", + "$ref": "#/definitions/flexFieldValueType" }, "links": { "$ref": "#/definitions/links" @@ -37533,77 +42760,85 @@ } } }, - "suspendedProfileErrorsSummaryType": { - "type": "array", - "description": "Collection of profile error summary.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/suspendedProfileErrorSummaryType" - } - }, - "suspendedProfileErrorSummaryType": { + "flexFieldValueType": { "type": "object", - "description": "Type which represents suspended profile errors information.", + "description": "Provides the details of a flex field values", "properties": { - "errorDescription": { - "description": "Represents Error summary of the suspended profiles.", + "code": { + "description": "Flex field code", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "errorCount": { - "description": "Count of how many profiles encountered this error.", - "type": "number" + "flexFieldValue": { + "description": "value of the Dynamic Field ", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "hotelId": { + "description": "Hotel Code", + "type": "string", + "minLength": 1, + "maxLength": 20 } } }, - "profileSubscriptionsToSynchronize": { + "flexFieldsResponse": { "type": "object", - "description": "Request object for re-subscribing profile subscriptions.", + "description": "Response object for flex fields.", "properties": { - "criteria": { - "description": "Criteria to re-subscribe profile subscriptions.", - "$ref": "#/definitions/synchronizeProfileSubscriptionsCriteriaType" + "flexFieldValues": { + "description": "List of flex fields.", + "type": "array", + "maxItems": 100, + "items": { + "$ref": "#/definitions/flexFieldValueType" + } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" - } - } - }, - "synchronizeProfileSubscriptionsCriteriaType": { - "type": "object", - "description": "Criteria for searching profile subscriptions.", - "properties": { - "profileId": { - "description": "Unique ID of the profile.", - "$ref": "#/definitions/profileId" }, - "databaseIds": { - "description": "List of codes identifying the external database record which is linked to external systems.", - "$ref": "#/definitions/databaseIDListType" + "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" } } }, - "databaseIDListType": { - "type": "array", - "description": "Code identifying the external database record which is linked to external systems.", - "maxItems": 4000, - "items": { - "type": "string", - "minLength": 0, - "maxLength": 20 - } - }, - "forgetProfilesCriteria": { + "memberPointsToExpireCollection": { "type": "object", - "description": "Operation to validate profiles for forgetting.", + "description": "Response object for fetching member points to expire information.", "properties": { - "validateForgetProfilesCriteria": { - "description": "Criteria to identify the profiles to be validated for forgetting.", - "$ref": "#/definitions/forgetProfilesCriteriaType" + "memberPointsToExpireCollection": { + "type": "array", + "description": "List of of member points to expire.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/memberPointsToExpireCollectionType" + } }, "links": { "$ref": "#/definitions/links" @@ -37613,31 +42848,37 @@ } } }, - "forgetProfilesCriteriaType": { + "memberPointsToExpireCollectionType": { "type": "object", - "description": "Criteria to identify the profiles to be forgotten.", + "description": "Membership points to expire with the membership details to differentiate.", "properties": { - "profiles": { - "description": "Collection of Unique Identifiers of profiles to be forgotten.", - "$ref": "#/definitions/profiles" + "membershipDetails": { + "description": "Member details for the requested membership ID.", + "$ref": "#/definitions/membershipDetailsType" + }, + "memberPointsToExpireListType": { + "type": "array", + "description": "List of of member points to expire.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/memberPointsToExpireListType" + } } } }, - "profiles": { - "type": "array", - "description": "Unique identifier for a profile.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/profileId" - } + "operaVersionNumberType": { + "type": "string", + "description": "Current Opera Version Number", + "minLength": 0, + "maxLength": 40 }, - "validatedForgetProfiles": { + "operaVersion": { "type": "object", - "description": "Response object for validating profiles for forgetting.", + "description": "Response for Ping operation.", "properties": { - "validateForgetProfilesResults": { - "description": "Results of validation.", - "$ref": "#/definitions/forgetProfileResultListType" + "operaVersion": { + "description": "Opera version number.", + "$ref": "#/definitions/operaVersionNumberType" }, "links": { "$ref": "#/definitions/links" @@ -37647,229 +42888,130 @@ } } }, - "forgetProfileResultListType": { - "type": "array", - "description": "Result of processing/validation for forgetting a profile.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/forgetProfileResultType" - } - }, - "forgetProfileResultType": { + "profileTransactionsType": { "type": "object", - "description": "Results of Anonymization processing/validation.", + "description": "Transaction related to the Profile.", "properties": { - "profileId": { - "description": "Unique Identifier for OPERA Profile.", - "$ref": "#/definitions/profileId" - }, - "canBeForgotten": { - "description": "Indicates if the profile is eligible to be anonymized.", - "type": "boolean" - }, - "status": { - "description": "Anonymization Status of the Guest Profile.", - "$ref": "#/definitions/anonymizationStatusType" + "transactionDate": { + "description": "Stay Record or Membership Transaction Date.", + "type": "string", + "format": "date" }, - "failureReasons": { - "description": "Collection of reasons describing why the profile is not eligible to be anonymized.", - "$ref": "#/definitions/forgetProfileFailureReasonListType" - } - } - }, - "forgetProfileFailureReasonListType": { - "type": "array", - "description": "Reason describing why the profile is not eligible to be forgotten.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/forgetProfileFailureReasonType" - } - }, - "forgetProfileFailureReasonType": { - "type": "object", - "description": "Provides information about the reason why the profile is not eligible to be forgotten.", - "properties": { - "reasonCode": { - "description": "Code representing the reason why the profile is not eligible to be forgotten.", + "transactionType": { + "description": "Stay Record or Membership Transaction Type.", "type": "string", "minLength": 0, "maxLength": 20 }, - "reasonDescription": { - "description": "Reason describing why the profile is not eligible to be forgotten.", + "hotelId": { + "description": "Resort of the transaction.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "expectedResolutionDate": { - "description": "Expected resolution date for this reason.", + "reservationIdList": { + "description": "The PMS confirmation number of the transaction.", + "$ref": "#/definitions/reservationIdList" + }, + "pointsCalculated": { + "description": "Flag to indicate if points are calculated.", + "type": "boolean" + }, + "stayTimeSpan": { + "description": "Begin and end dates of the reservation.", + "$ref": "#/definitions/timeSpanType" + }, + "membershipType": { + "description": "The type of membership.", "type": "string", - "format": "date", - "maxLength": 8 - } - } - }, - "actionType": { - "type": "string", - "description": "Action types allowed by the event api.", - "enum": [ - "CREATE", - "UPDATE", - "DELETE" - ] - }, - "revenueBucketType": { - "type": "object", - "description": "The different revenue buckets of a profile.", - "properties": { - "code": { - "description": "Code of revenue type.", + "minLength": 0, + "maxLength": 20 + }, + "cardNumber": { + "description": "The membership card number.", "type": "string", "minLength": 0, - "maxLength": 40 + "maxLength": 50 }, - "description": { - "description": "Description of revenue type.", + "membershipLevel": { + "description": "The level of the membership.", "type": "string", "minLength": 0, - "maxLength": 100 + "maxLength": 20 }, - "value": { - "description": "Value of revenue.", - "type": "number" - } - } - }, - "revenueBucketListType": { - "type": "object", - "description": "Details about revenue summary.", - "properties": { - "bucket": { - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/revenueBucketType" - } - } - } - }, - "membershipPromotionDetails": { - "type": "object", - "description": "The request element used to create a membership promotion.", - "properties": { - "membershipPromotion": { - "description": "The membership promotion information to add to the database.", - "$ref": "#/definitions/membershipPromotionType" + "awardPoints": { + "description": "Award points for the transactions.", + "type": "integer" }, - "links": { - "$ref": "#/definitions/links" + "tierNightPoints": { + "description": "Tier Night points for the transactions.", + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "membershipPromotionsDetails": { - "type": "object", - "description": "Response object for fetching membership promotions information.", - "properties": { - "membershipPromotions": { - "type": "array", - "maxItems": 4000, - "description": "Collection of membership promotions.", - "items": { - "$ref": "#/definitions/membershipPromotionType" - } + "tierStayPoints": { + "description": "Tier Stay points for the transactions.", + "type": "integer" }, - "links": { - "$ref": "#/definitions/links" + "tierRevenuePoints": { + "description": "Tier Revenue points for the transactions.", + "type": "integer" }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "membershipPromotionType": { - "type": "object", - "description": "Information related to a membership promotion.", - "properties": { - "promotionCode": { - "description": "The promotion code attached with the member.", + "pointsCreditDate": { + "description": "Date when points were created.", "type": "string", - "minLength": 0, - "maxLength": 20 + "format": "date" }, - "startDate": { - "description": "The start date of membership promotion.", - "type": "string", - "format": "date", - "maxLength": 8 + "stayRecordId": { + "description": "Stay Record Id of the transaction.", + "type": "string" }, - "inactive": { - "description": "Indicates if the membership type is inactive.", - "type": "boolean" - } - } - }, - "copyInstructionsType": { - "type": "object", - "description": "Copy Instructions for a profile", - "properties": { - "instructions": { - "type": "array", - "description": "List of the profile details to be copied", - "items": { - "$ref": "#/definitions/copyInstructionType" - } - } - } - }, - "copyInstructionType": { - "type": "string", - "description": "Copy Instruction for a profile", - "enum": [ - "Keyword" - ] - }, - "profileMatchStatusType": { - "type": "string", - "description": "Status of the match. It can be one of these 3 options: Match Points Computed, Do Not Merge, Can Not Merge.", - "enum": [ - "MPC", - "DNM", - "CNM" - ] + "membershipTransactionId": { + "description": "Unique ID of the membership transaction that this record corresponds to", + "$ref": "#/definitions/membershipTransactionId" + }, + "membershipId": { + "description": "Unique identifier of this membership.", + "$ref": "#/definitions/uniqueID_Type" + }, + "profileIdList": { + "description": "Collection of unique profile identifiers", + "$ref": "#/definitions/profileIdList" + } + } }, - "profilesMatch": { + "profileTransactions": { "type": "object", - "description": "Response object for fetching the profiles match.", + "description": "Response of the WS operation FetchProfileTransactions.", "properties": { - "profilesMatchList": { + "profileTransactions": { + "description": "Transactions related to the Profile.", "type": "array", - "description": "List of profiles matches. The values are ordered by default using main profile first name.", - "maxItems": 200, + "maxItems": 100, "items": { - "$ref": "#/definitions/profilesMatchType" + "$ref": "#/definitions/profileTransactionsType" } }, - "offset": { - "description": "Indicates the index of the next applicable set(page).", + "totalPages": { + "description": "Evaluated total page count based on the requested max fetch count.", "type": "integer" }, - "limit": { - "description": "Indicates number of records the API can return as per the API request limit sent. A maximum of 200 records can be only returned at a time.", + "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" }, - "count": { - "description": "Indicates number of records the API has returned actually as per the API request criteria.", + "limit": { + "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, "hasMore": { - "description": "Indicates whether there are more records available to be returned as per the API request criteria or not.", + "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": "Indicates total number of records available that can be returned as per the API request criteria.", + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", "type": "integer" }, "links": { @@ -37880,263 +43022,485 @@ } } }, - "profilesMatchType": { + "suspendedStayRevenueType": { "type": "object", - "description": "Type that contains the information of a profile match such as main profile, profile to merge, match id, status of the match, date when the points where computed for last time, etc.", + "description": "Suspended Stay Revenue information.", "properties": { - "matchId": { - "description": "Unique identifier for this particular profile match record.", - "type": "string", - "minLength": 0, - "maxLength": 80 - }, - "mainProfile": { - "description": "Information of main profile.", - "$ref": "#/definitions/shortInfoProfileType" - }, - "profileToMerge": { - "description": "Information of profile that will be merged to the main profile.", - "$ref": "#/definitions/shortInfoProfileType" - }, - "rule": { - "description": "Match criteria rule code that was used to create that match.", + "suspendedStayRecordId": { + "description": "Suspended Stay Record ID.", "type": "string", "minLength": 0, - "maxLength": 400 + "maxLength": 20 }, - "matchCriteria": { - "description": "Description of the match point for the profile merge.", + "transactionDate": { + "description": "Transaction date of the revenue.", "type": "string", - "minLength": 0, - "maxLength": 4000 - }, - "points": { - "description": "Total number of weighing match points that was found between main profile and profile to merge.", - "type": "number", - "minimum": 0 - }, - "status": { - "description": "Status of the match. It can be one of these 3 options: Match Points Computed, Do Not Merge, Can Not Merge.", - "$ref": "#/definitions/profileMatchStatusType" + "format": "date" }, - "computedOn": { - "description": "Date when the weighing points were computed for the profiles", + "revenueType": { + "description": "Indicates the type of revenue.", "type": "string", - "format": "date", "minLength": 0, "maxLength": 20 }, - "doNotMerge": { - "description": "If this value is true, then this record is set as do not merge, if false, it is set as merge.", - "type": "boolean" + "amount": { + "description": "Revenue amount.", + "type": "number" } } }, - "shortInfoProfileType": { + "suspendedStayErrorType": { "type": "object", - "description": "This type contains short information of a profile.", + "description": "Suspended Stay Error information.", "properties": { - "nameId": { - "description": "Unique id for the profile.", + "suspendedStayRecordId": { + "description": "Suspended Stay Record ID.", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 20 }, - "displayName": { - "description": "Name that will be displayed for the profile, it is the combination of last name and first name of a profile.", + "errorType": { + "description": "Indicates the error type.", "type": "string", "minLength": 0, - "maxLength": 160 + "maxLength": 20 }, - "clientId": { - "description": "Corporate id of the profile.", + "errorDescription": { + "description": "Indicates the description of the error.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 } } }, - "matchListType": { + "suspendedStayErrorsType": { "type": "object", - "description": "Type that contains the list of theh matchIds that will be updated to skip or don't skip profile match.", + "description": "Collection of Suspended Stay Error information.", "properties": { - "matchList": { + "suspendedStays": { + "description": "Suspended Stay Error information.", "type": "array", - "description": "List of matchIds that will be updated to skip or don't skip profile match.", "maxItems": 4000, "items": { - "$ref": "#/definitions/matchType" + "$ref": "#/definitions/suspendedStayErrorType" } } } }, - "matchType": { + "suspendedStayDailyRateType": { "type": "object", - "description": "Type that contains matchId and if this particular matchId is set to skip profile match or not.", + "description": "Suspended Stay Rate information.", "properties": { - "matchId": { - "description": "Identifier of the match record.", + "suspendedStayRecordId": { + "description": "Suspended Stay Record ID.", "type": "string", "minLength": 0, - "maxLength": 80 + "maxLength": 20 }, - "skipProfileMatch": { - "description": "If true, it sets the record to skip profile match for this particular matchId. if false, it sets the record to not skip profile match.", - "type": "boolean" - } - } - }, - "membershipPointsExceptionsType": { - "type": "object", - "description": "Contains Membership points exception information.", - "properties": { - "membershipTransactionIds": { - "description": "Unique identifier associated with the membership transaction.", - "type": "array", - "maxItems": 20, - "items": { - "$ref": "#/definitions/membershipTransactionId" - } + "transactionDate": { + "description": "Transaction date of the rate.", + "type": "string", + "format": "date" }, - "acceptPoints": { - "description": "Indicates if the membership points exception are to be accepted or rejected.", - "type": "boolean" + "rateCode": { + "description": "Rate code used for the stay.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "userNotes": { - "description": "Notes regarding the resolution of the membership transaction exception or for any other reason.", + "marketCode": { + "description": "Market Code of the stay.", "type": "string", "minLength": 0, - "maxLength": 4000 + "maxLength": 20 + }, + "amount": { + "description": "Rate amount.", + "$ref": "#/definitions/currencyAmountType" } } }, - "membershipPointsExceptions": { + "suspendedStayMembershipType": { "type": "object", - "description": "Response object for fetching membership points exceptions.", + "description": "Suspended Stay Membership information.", "properties": { - "membershipPointsExceptions": { - "description": "A collection of membership points exceptions.", - "$ref": "#/definitions/membershipPointsExceptionsType" + "suspendedStayRecordId": { + "description": "Suspended Stay Record ID.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "links": { - "$ref": "#/definitions/links" + "membershipType": { + "description": "Membership Program Code or Membership Type.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "warnings": { - "$ref": "#/definitions/warningsType" + "membershipId": { + "description": "Membership Card Number.", + "type": "string", + "minLength": 0, + "maxLength": 50 } } }, - "fileType": { - "description": "File Type of the staging file.", - "type": "string", - "enum": [ - "IMPORT_TAX_PERC" - ] - }, - "memberPointsExceptionType": { + "suspendedStayType": { "type": "object", - "description": "Details about a membership like ProfileID, Card Number, Type, Level, etc.", + "description": "Suspended Stay information.", "properties": { "hotelId": { - "description": "Hotel code of the membership transaction exceptions.", + "description": "Hotel code of the reservation.", "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" + "externalConfirmationNo": { + "description": "External Confirmation number of the reservation on PMS side.", + "type": "string", + "minLength": 0, + "maxLength": 50 }, - "fromToRangeDate": { - "description": "Arrival and Departure date of stay for which you are displaying membership transaction exceptions.", - "$ref": "#/definitions/dateRangeType" + "reservationStatus": { + "description": "Reservation status.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "membershipIdNo": { - "description": "Unique identifier of this membership.", - "type": "number" + "createBusinessDate": { + "description": "Business Date when the reservation was created.", + "type": "string", + "format": "date" }, - "membershipType": { - "description": "The type of the membership.", - "$ref": "#/definitions/codeDescriptionType" + "importDate": { + "description": "Date when the Suspended Stay record was created or imported.", + "type": "string", + "format": "date" }, - "membershipCardNo": { - "description": "The card number associated with this membership.", + "confirmationNo": { + "description": "Confirmation number of the reservation on central side.", "type": "string", "minLength": 0, "maxLength": 50 }, - "membershipLevel": { - "description": "The current level of the membership.", + "roomType": { + "description": "Room type of the reservation.", "type": "string", "minLength": 0, "maxLength": 20 }, - "membershipTransactionId": { - "description": "Unique identifier associated with the membership transaction.", - "$ref": "#/definitions/membershipTransactionId" + "roomTypeCharged": { + "description": "Room Type used for the Rate calculation.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "roomsBooked": { - "description": "The number of rooms booked.(MR)", - "type": "integer" + "sourceCode": { + "description": "Source of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "backToBack": { - "description": "Indicates if back to back membership transaction exceptions have occurred or not.", - "type": "boolean" + "bookingMedium": { + "description": "Classifies the medium(Channel field on reservation screen) through which the reservation is made.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "averageRate": { - "description": "The average rate of the stay.", - "type": "number" + "currencyCode": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 }, - "awardPoints": { - "description": "Award points associated with this membership points transaction.", - "type": "number" + "arrivalDate": { + "description": "Date of arrival.", + "type": "string", + "format": "date" }, - "tierNightPoints": { - "description": "Tier night points associated with this membership points transaction.", + "departureDate": { + "description": "Date of departure.", + "type": "string", + "format": "date" + }, + "adults": { + "description": "Number of adults on the reservation.", "type": "number" }, - "tierStayPoints": { - "description": "Tier stay points associated with this membership points transaction.", + "children": { + "description": "Number of children on the reservation.", "type": "number" }, - "tierRevenuePoints": { - "description": "Tier revenue points associated with this membership points transaction.", + "cancellationDate": { + "description": "Date of cancellation.", + "type": "string", + "format": "date" + }, + "rateCode": { + "description": "Rate Code of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "rateCurrencyCode": { + "description": "Currency code of the rate.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "rateAmount": { + "description": "Rate amount.", "type": "number" }, - "pointsCalculate": { - "description": "Points Calculated value(Y/N) for the selected transaction.", + "complimentary": { + "description": "Indicates if the reservation is complimentary.", "type": "boolean" }, - "reservationIdList": { - "description": "The reservation related ids.", - "$ref": "#/definitions/reservationIdList" + "paymentMethod": { + "description": "Payment Method.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "processingMessages": { - "description": "The systems records and notes identifying the exception criteria.", + "stayStatus": { + "description": "Status of the stay.", "type": "string", "minLength": 0, - "maxLength": 2000 + "maxLength": 20 }, - "exceptionStatus": { - "description": "Indicates the type of Exception like Exception not resolved,Points Rejected on Exception etc.,", - "$ref": "#/definitions/membershipExceptionStatusType" + "fullGuestName": { + "description": "Full display Name of guest profile.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "fullCompanyName": { + "description": "Full display Name of company profile.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "fullTAName": { + "description": "Full display Name of Travel Agent profile.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "fullSourceName": { + "description": "Full display Name of Source profile.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "fullGroupName": { + "description": "Full display Name of Group profile.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "posCode": { + "description": "Point of Sales Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "interfaceId": { + "description": "Identifier of the Interface.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "userDefinedFields": { + "description": "Collection of user defined fields.", + "$ref": "#/definitions/userDefinedFieldsType" + }, + "suspendedStayRevenues": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/suspendedStayRevenueType" + } + }, + "suspendedStayErrors": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/suspendedStayErrorType" + } + }, + "suspendedStayDailyRates": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/suspendedStayDailyRateType" + } + }, + "suspendedStayMemberships": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/suspendedStayMembershipType" + } } } }, - "memberPointsExceptions": { + "suspendedStaySummaryType": { "type": "object", - "description": "Response object for fetching membership points exceptions.", + "description": "Collection of Suspended Stay information.", "properties": { - "memberPointsExceptions": { + "suspendedStayRecordId": { + "description": "Suspended Stay Record ID.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelId": { + "description": "Hotel code of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "reservationStatus": { + "description": "Reservation status.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "externalConfirmationNo": { + "description": "External Confirmation number of the reservation on PMS side.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "profileIdList": { + "description": "Collection of unique profile identifiers", + "$ref": "#/definitions/profileIdList" + }, + "arrivalDate": { + "description": "Date of arrival.", + "type": "string", + "format": "date" + }, + "departureDate": { + "description": "Date of departure.", + "type": "string", + "format": "date" + }, + "stayStatus": { + "description": "Status of the stay.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "suspendedStaySummariesType": { + "type": "object", + "description": "A complex type containing the collection of Suspended Stay Summaries.", + "properties": { + "suspendedStaySummaries": { + "description": "A collection of Suspended Stay Summaries.", "type": "array", - "maxItems": 100, - "description": "A collection of membership points exceptions.", + "maxItems": 4000, "items": { - "$ref": "#/definitions/memberPointsExceptionType" + "$ref": "#/definitions/suspendedStaySummaryType" + } + }, + "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" + } + } + }, + "suspendedStayDetailType": { + "type": "object", + "description": "Suspended Stay Record ID detail about a Suspended Stay.", + "properties": { + "suspendedStayRecordId": { + "description": "Suspended Stay Record ID.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "suspendedStayDetailsType": { + "type": "object", + "description": "Suspended Stay Record ID details about a Suspended Stay.", + "properties": { + "suspendedStayRecordId": { + "description": "List of Suspended Stay Record IDs.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/suspendedStayDetailType" + } + } + } + }, + "suspendedStayDetails": { + "type": "object", + "description": "Request object for process suspended stays.", + "properties": { + "suspendedStayDetailsInfo": { + "description": "A collection of Suspended Stay Record IDs.", + "$ref": "#/definitions/suspendedStayDetailsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipCardHistoryType": { + "type": "object", + "description": "Contains details of the card history of a member.", + "properties": { + "membershipCardNo": { + "description": "Membership Card Number", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "membershipType": { + "description": "Membership Program Code or Membership Type", + "type": "string", + "minLength": 0, + "maxLength": 50 + } + } + }, + "memberCardHistoryList": { + "type": "object", + "description": "Response object for member card history.", + "properties": { + "memberCardHistoryList": { + "type": "array", + "description": "Contains list of card history of a member.", + "maxItems": 500, + "items": { + "$ref": "#/definitions/membershipCardHistoryType" } }, "totalPages": { @@ -38171,14 +43535,77 @@ } } }, - "membershipExceptionStatusType": { + "stayRecordDetail": { + "type": "object", + "description": "Stay Record details for a single stay record including Revenues, Daily Rates and UDFs.", + "properties": { + "stayDetail": { + "description": "Stay Details of the stay record.", + "$ref": "#/definitions/stayDetailType" + }, + "revenue": { + "description": "Revenue Details for the stay record.", + "type": "array", + "maxItems": 200, + "items": { + "$ref": "#/definitions/membershipTransactionRevenueType" + } + }, + "rate": { + "description": "Rate Details for the stay record.", + "type": "array", + "maxItems": 200, + "items": { + "$ref": "#/definitions/membershipTransactionRateType" + } + }, + "userDefinedFields": { + "description": "Collections of user defined fields (UDFs) for the stay record.", + "$ref": "#/definitions/userDefinedFieldsType" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "stayMembershipDetails": { + "type": "object", + "description": "Complex type that contains stay membership details and instructions to attach or replace.", + "properties": { + "newMembershipCardNo": { + "description": "Specifies the Card Number of new membership being attached.", + "type": "string" + }, + "newMembershipType": { + "description": "Specifies the type of new membership being attached.", + "type": "string" + }, + "oldMembershipCardNo": { + "description": "Specifies the Card Number of old membership that should be replaced.", + "type": "string" + }, + "oldMembershipType": { + "description": "Specifies the type of old membership that should be replaced.", + "type": "string" + }, + "stayRecordId": { + "description": "Stay Record ID", + "type": "number" + }, + "attachMode": { + "$ref": "#/definitions/stayMembershipAttachMode" + } + }, + "required": [ + "attachMode" + ] + }, + "stayMembershipAttachMode": { + "description": "Flag that indicates if membership should be attached or existing membership should be replaced.", "type": "string", - "description": "List of possible membership exception type.", "enum": [ - "AllExceptions", - "PointsAwardedOnException", - "PointsRejectedOnException", - "ExceptionNotResolved" + "ADD", + "REPLACE" ] } }, @@ -38187,6 +43614,10 @@ "name": "Profile", "description": "The Profile APIs allow you to view, create, update, and delete profiles in OPERA Cloud. Each time a new profile in created in OPERA Cloud, a profileID is assigned. Use this profileID to retrieve and update details relating to that profile. The resource 'Companies' includes group, source, company and travel agent profile types. The resource 'Guests' includes individual and contact profile types." }, + { + "name": "ProfileExternal", + "description": "The Profile External module allows you to retrieve and manage profiles from an external system." + }, { "name": "ProfileLOV", "description": "Profiles have many Lists of Values, storing the available options a user can select when updating a profile. This module allows you to get available ListOfValues for Profile Preferences and AR Addresses on a profile." @@ -38198,6 +43629,10 @@ { "name": "ProfileStatistics", "description": "These APIs will allow you to retrieve statistical data for a specified profile." + }, + { + "name": "SuspendedStay", + "description": "These APIs will allow you to view, create, update, and delete profiles in OPERA Cloud." } ], "externalDocs": { diff --git a/rest-api-specs/property/crmasync.json b/rest-api-specs/property/crmasync.json index 62c6e6d..8874d49 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.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", + "description": "APIs to insert Stay Records related asynchronous functionality in OPERA.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.4", "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 0f81258..de036e8 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -13082,7 +13082,7 @@ "/membershipAwards": { "get": { "summary": "Get Membership Awards", - "description": "You can use this API to get Membership Awards.OperationId:getMembershipAwards
", + "description": "You can use this API to get Membership Awards.OperationId:getMembershipAwards
The maximum allowable limit for this API is 200.
", "operationId": "getMembershipAwards", "parameters": [ { @@ -13543,7 +13543,7 @@ "/membershipBenefitPrograms": { "get": { "summary": "Retrieve a Membership Benefit Program", - "description": "This API allows you to fetch Membership Benefit Programs of Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.OperationId:getMembershipBenefitPrograms
", + "description": "This API allows you to fetch Membership Benefit Programs of Membership Type. A Benefit Program is configurable for a Membership Type when OCIS or ORS license is active and Membership Type meets following criteria - primary central setup, not externally controlled and point calculation method is Manual Batch.OperationId:getMembershipBenefitPrograms
This API allows a time span of 90 days.
", "operationId": "getMembershipBenefitPrograms", "parameters": [ { @@ -15705,7 +15705,7 @@ "/membershipEnrollmentGroups": { "get": { "summary": "Get Membership enrollment groups", - "description": "Retrieve a list of membership Enrollment Groups that are configured.OperationId:getMembershipEnrollmentGroups
", + "description": "Retrieve a list of membership Enrollment Groups that are configured.OperationId:getMembershipEnrollmentGroups
The maximum allowable limit for this API is 200.
", "operationId": "getMembershipEnrollmentGroups", "parameters": [ { @@ -17107,19 +17107,12 @@ ] } }, - "/membershipPropertyGroups": { + "/membershipOriginGroups": { "get": { - "summary": "Get Membership property groups", - "description": "You can use this API to get Membership property groups.OperationId:getMembershipPropertyGroups
", - "operationId": "getMembershipPropertyGroups", + "summary": "Get Membership origin groups", + "description": "You can use this API to get Membership origin groups.OperationId:getMembershipOriginGroups
", + "operationId": "getMembershipOriginGroups", "parameters": [ - { - "name": "fetchInactive", - "in": "query", - "required": false, - "description": "Determines wether to fetch inactive records or not.", - "type": "boolean" - }, { "name": "codes", "in": "query", @@ -17132,13 +17125,6 @@ }, "required": false }, - { - "name": "wildCard", - "in": "query", - "required": false, - "description": "Wildcard search on the code.", - "type": "string" - }, { "name": "description", "in": "query", @@ -17172,13 +17158,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching Membership Property Groups configurations.", + "description": "Response object for fetching Membership Origin Groups configurations.", "schema": { - "$ref": "#/definitions/membershipPropertyGroupsInfo" + "$ref": "#/definitions/membershipOriginGroupsDetails" } }, "204": { - "description": "MembershipPropertyGroups not found." + "description": "MembershipOriginGroups not found." }, "400": { "$ref": "#/responses/400" @@ -17228,19 +17214,19 @@ ] }, "post": { - "summary": "Create Membership property groups", - "description": "You can use this API to create Membership property groups.OperationId:postMembershipPropertyGroups
", - "operationId": "postMembershipPropertyGroups", + "summary": "Create a Membership origin group", + "description": "You can use this API to create Membership origin group.OperationId:postMembershipOriginGroup
", + "operationId": "postMembershipOriginGroup", "parameters": [ { - "name": "membershipPropertyGroups", + "name": "membershipOriginGroup", "in": "body", "required": true, - "description": "Request object for creating new Membership Property Groups Configurations.", + "description": "Request object for creating new Membership origin Group Configurations.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipPropertyGroups" + "$ref": "#/definitions/membershipOriginGroupDetails" } ] } @@ -17275,7 +17261,7 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "description": "HATEOAS links which help the consumer to navigate to resource", "schema": { "$ref": "#/definitions/status" } @@ -17328,30 +17314,30 @@ ] } }, - "/membershipPropertyGroups/{membershipPropertyGroupsId}": { + "/membershipOriginGroups/{membershipOriginGroupId}": { "put": { - "summary": "Change Membership property groups", - "description": "You can use this API to change Membership property groups.OperationId:putMembershipPropertyGroups
", - "operationId": "putMembershipPropertyGroups", + "summary": "Change Membership origin group", + "description": "You can use this API to change Membership origin group.OperationId:putMembershipOriginGroup
", + "operationId": "putMembershipOriginGroup", "parameters": [ { - "name": "membershipPropertyGroupsId", + "name": "membershipOriginGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, - "maxLength": 2000, - "description": "Fetch membershipClasses values based on given membershipClassId" + "maxLength": 20, + "description": "Membership origin group code which will be changed." }, { - "name": "membershipPropertyGroups", + "name": "membershipOriginGroup", "in": "body", "required": true, - "description": "Request object for changing existing Membership Property Groups Configurations.", + "description": "Request object for changing existing Membership Origin Group Configurations.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipPropertyGroups" + "$ref": "#/definitions/membershipOriginGroupDetails" } ] } @@ -17439,18 +17425,18 @@ ] }, "delete": { - "summary": "Delete Membership property groups", - "description": "You can use this API to delete Membership property groups.OperationId:deleteMembershipPropertyGroups
", - "operationId": "deleteMembershipPropertyGroups", + "summary": "Delete Membership origin group", + "description": "You can use this API to delete Membership origin group.OperationId:deleteMembershipOriginGroup
", + "operationId": "deleteMembershipOriginGroup", "parameters": [ { - "name": "membershipPropertyGroupsId", + "name": "membershipOriginGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Fetch membershipClasses values based on given membershipClassId" + "description": "Delete delete Membership Origin Group based on given membershipOriginGroupId" }, { "$ref": "#/parameters/authKey" @@ -17535,11 +17521,11 @@ ] } }, - "/membershipRateGroups": { + "/membershipPropertyGroups": { "get": { - "summary": "Get Membership rate groups", - "description": "You can use this API to get Membership rate groups.OperationId:getMembershipRateGroups
", - "operationId": "getMembershipRateGroups", + "summary": "Get Membership property groups", + "description": "You can use this API to get Membership property groups.OperationId:getMembershipPropertyGroups
", + "operationId": "getMembershipPropertyGroups", "parameters": [ { "name": "fetchInactive", @@ -17600,13 +17586,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching Membership Rate Groups.", + "description": "Response object for fetching Membership Property Groups configurations.", "schema": { - "$ref": "#/definitions/membershipRateGroupsInfo" + "$ref": "#/definitions/membershipPropertyGroupsInfo" } }, "204": { - "description": "MembershipRateGroups not found." + "description": "MembershipPropertyGroups not found." }, "400": { "$ref": "#/responses/400" @@ -17656,19 +17642,19 @@ ] }, "post": { - "summary": "Create Membership rate groups", - "description": "You can use this API to create Membership rate groups.OperationId:postMembershipRateGroups
", - "operationId": "postMembershipRateGroups", + "summary": "Create Membership property groups", + "description": "You can use this API to create Membership property groups.OperationId:postMembershipPropertyGroups
", + "operationId": "postMembershipPropertyGroups", "parameters": [ { - "name": "membershipRateGroups", + "name": "membershipPropertyGroups", "in": "body", "required": true, - "description": "Request object for creating new Membership Rate Groups.", + "description": "Request object for creating new Membership Property Groups Configurations.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipRateGroups" + "$ref": "#/definitions/membershipPropertyGroups" } ] } @@ -17756,14 +17742,14 @@ ] } }, - "/membershipRateGroups/{membershipRateGroupId}": { + "/membershipPropertyGroups/{membershipPropertyGroupsId}": { "put": { - "summary": "Change Membership rate groups", - "description": "You can use this API to change Membership rate groups.OperationId:putMembershipRateGroups
", - "operationId": "putMembershipRateGroups", + "summary": "Change Membership property groups", + "description": "You can use this API to change Membership property groups.OperationId:putMembershipPropertyGroups
", + "operationId": "putMembershipPropertyGroups", "parameters": [ { - "name": "membershipRateGroupId", + "name": "membershipPropertyGroupsId", "in": "path", "required": true, "type": "string", @@ -17772,14 +17758,14 @@ "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "name": "membershipRateGroups", + "name": "membershipPropertyGroups", "in": "body", "required": true, - "description": "Request object for modifying Membership Rate Groups.", + "description": "Request object for changing existing Membership Property Groups Configurations.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipRateGroups" + "$ref": "#/definitions/membershipPropertyGroups" } ] } @@ -17867,12 +17853,12 @@ ] }, "delete": { - "summary": "Delete Membership rate groups", - "description": "You can use this API to delete Membership rate groups.OperationId:deleteMembershipRateGroups
", - "operationId": "deleteMembershipRateGroups", + "summary": "Delete Membership property groups", + "description": "You can use this API to delete Membership property groups.OperationId:deleteMembershipPropertyGroups
", + "operationId": "deleteMembershipPropertyGroups", "parameters": [ { - "name": "membershipRateGroupId", + "name": "membershipPropertyGroupsId", "in": "path", "required": true, "type": "string", @@ -17963,42 +17949,25 @@ ] } }, - "/membershipRates": { + "/membershipRateGroups": { "get": { - "summary": "Get Membership rates ", - "description": "You can use this API to get Membership rates.OperationId:getMembershipRates
", - "operationId": "getMembershipRates", + "summary": "Get Membership rate groups", + "description": "You can use this API to get Membership rate groups.OperationId:getMembershipRateGroups
", + "operationId": "getMembershipRateGroups", "parameters": [ { - "name": "hotelIds", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Hotel code of membership rates to be searched.", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "membershipTypes", + "name": "fetchInactive", "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Membership type to be searched.", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" }, { - "name": "ratePlanCodes", + "name": "codes", "in": "query", "type": "array", "collectionFormat": "multi", - "description": "Rate code of the membership rule rate.", + "description": "Codes to be searched.", "items": { "type": "string", "maxItems": 4000 @@ -18006,18 +17975,18 @@ "required": false }, { - "name": "description", + "name": "wildCard", "in": "query", "required": false, - "description": "Description of the Membership Rate.", + "description": "Wildcard search on the code.", "type": "string" }, { - "name": "includeInactive", + "name": "description", "in": "query", "required": false, - "description": "Indicates whether search includes inactive membership rates.", - "type": "boolean" + "description": "Description of the code.", + "type": "string" }, { "$ref": "#/parameters/authKey" @@ -18045,13 +18014,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching membership rates.", + "description": "Response object for fetching Membership Rate Groups.", "schema": { - "$ref": "#/definitions/membershipRatesInfo" + "$ref": "#/definitions/membershipRateGroupsInfo" } }, "204": { - "description": "MembershipRates not found." + "description": "MembershipRateGroups not found." }, "400": { "$ref": "#/responses/400" @@ -18101,19 +18070,19 @@ ] }, "post": { - "summary": "Create Membership rates", - "description": "You can use this API to create Membership rates.OperationId:postMembershipRates
", - "operationId": "postMembershipRates", + "summary": "Create Membership rate groups", + "description": "You can use this API to create Membership rate groups.OperationId:postMembershipRateGroups
", + "operationId": "postMembershipRateGroups", "parameters": [ { - "name": "membershipRates", + "name": "membershipRateGroups", "in": "body", "required": true, - "description": "Request object for creating new membership rate code rules.", + "description": "Request object for creating new Membership Rate Groups.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipRates" + "$ref": "#/definitions/membershipRateGroups" } ] } @@ -18201,14 +18170,14 @@ ] } }, - "/membershipRates/{membershipRatesId}": { + "/membershipRateGroups/{membershipRateGroupId}": { "put": { - "summary": "Change Membership rates", - "description": "You can use this API to change Membership rates.OperationId:putMembershipRates
", - "operationId": "putMembershipRates", + "summary": "Change Membership rate groups", + "description": "You can use this API to change Membership rate groups.OperationId:putMembershipRateGroups
", + "operationId": "putMembershipRateGroups", "parameters": [ { - "name": "membershipRatesId", + "name": "membershipRateGroupId", "in": "path", "required": true, "type": "string", @@ -18217,14 +18186,14 @@ "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "name": "membershipRates", + "name": "membershipRateGroups", "in": "body", "required": true, - "description": "Request object for changing membership rate rules.", + "description": "Request object for modifying Membership Rate Groups.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipRates" + "$ref": "#/definitions/membershipRateGroups" } ] } @@ -18312,12 +18281,12 @@ ] }, "delete": { - "summary": "Delete Membership rates", - "description": "You can use this API to delete Membership rates.OperationId:deleteMembershipRates
", - "operationId": "deleteMembershipRates", + "summary": "Delete Membership rate groups", + "description": "You can use this API to delete Membership rate groups.OperationId:deleteMembershipRateGroups
", + "operationId": "deleteMembershipRateGroups", "parameters": [ { - "name": "membershipRatesId", + "name": "membershipRateGroupId", "in": "path", "required": true, "type": "string", @@ -18325,17 +18294,6 @@ "maxLength": 2000, "description": "Fetch membershipClasses values based on given membershipClassId" }, - { - "name": "hotelId", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Hotel code of membership rate.", - "items": { - "type": "string" - }, - "required": false - }, { "$ref": "#/parameters/authKey" }, @@ -18419,25 +18377,30 @@ ] } }, - "/membershipStatusCodes": { + "/membershipRates": { "get": { - "summary": "Get Membership Status Codes", - "description": "Use this API to get Membership Status Codes.OperationId:getMembershipStatusCodes
", - "operationId": "getMembershipStatusCodes", + "summary": "Get Membership rates ", + "description": "You can use this API to get Membership rates.OperationId:getMembershipRates
", + "operationId": "getMembershipRates", "parameters": [ { - "name": "fetchInactive", + "name": "hotelIds", "in": "query", - "required": false, - "description": "Determines wether to fetch inactive records or not.", - "type": "boolean" + "type": "array", + "collectionFormat": "multi", + "description": "Hotel code of membership rates to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "name": "codes", + "name": "membershipTypes", "in": "query", "type": "array", "collectionFormat": "multi", - "description": "Codes to be searched.", + "description": "Membership type to be searched.", "items": { "type": "string", "maxItems": 4000 @@ -18445,19 +18408,31 @@ "required": false }, { - "name": "wildCard", + "name": "ratePlanCodes", "in": "query", - "required": false, - "description": "Wildcard search on the code.", - "type": "string" + "type": "array", + "collectionFormat": "multi", + "description": "Rate code of the membership rule rate.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { "name": "description", "in": "query", "required": false, - "description": "Description of the code.", + "description": "Description of the Membership Rate.", "type": "string" }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "description": "Indicates whether search includes inactive membership rates.", + "type": "boolean" + }, { "$ref": "#/parameters/authKey" }, @@ -18484,13 +18459,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching Membership Status Codes.", + "description": "Response object for fetching membership rates.", "schema": { - "$ref": "#/definitions/membershipStatusCodesDetails" + "$ref": "#/definitions/membershipRatesInfo" } }, "204": { - "description": "MembershipStatusCodes not found." + "description": "MembershipRates not found." }, "400": { "$ref": "#/responses/400" @@ -18536,23 +18511,23 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "MembershipConfig" ] }, "post": { - "summary": "Create Membership Status Codes", - "description": "Use this API to create Membership Status Codes.OperationId:postMembershipStatusCodes
", - "operationId": "postMembershipStatusCodes", + "summary": "Create Membership rates", + "description": "You can use this API to create Membership rates.OperationId:postMembershipRates
", + "operationId": "postMembershipRates", "parameters": [ { - "name": "membershipStatusCodesCriteria", + "name": "membershipRates", "in": "body", "required": true, - "description": "Request object for creating Membership Status Codes.", + "description": "Request object for creating new membership rate code rules.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipStatusCodesCriteria" + "$ref": "#/definitions/membershipRates" } ] } @@ -18636,34 +18611,34 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "MembershipConfig" ] } }, - "/membershipStatusCodes/{membershipStatusCode}": { + "/membershipRates/{membershipRatesId}": { "put": { - "summary": "Change Membership Status Codes", - "description": "Use this API to update Membership Status Codes.OperationId:changeMembershipStatusCodes
", - "operationId": "changeMembershipStatusCodes", + "summary": "Change Membership rates", + "description": "You can use this API to change Membership rates.OperationId:putMembershipRates
", + "operationId": "putMembershipRates", "parameters": [ { - "name": "membershipStatusCode", + "name": "membershipRatesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique Code of Membership Status." + "description": "Fetch membershipClasses values based on given membershipClassId" }, { - "name": "membershipStatusCodesToBeChanged", + "name": "membershipRates", "in": "body", "required": true, - "description": "Request object for changing Membership Status Codes.", + "description": "Request object for changing membership rate rules.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipStatusCodesToBeChanged" + "$ref": "#/definitions/membershipRates" } ] } @@ -18747,22 +18722,33 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "MembershipConfig" ] }, "delete": { - "summary": "Delete Membership Status Codes", - "description": "Use this API to delete Membership Status Codes.OperationId:removeMembershipStatusCodes
", - "operationId": "removeMembershipStatusCodes", + "summary": "Delete Membership rates", + "description": "You can use this API to delete Membership rates.OperationId:deleteMembershipRates
", + "operationId": "deleteMembershipRates", "parameters": [ { - "name": "membershipStatusCode", + "name": "membershipRatesId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique Code of Membership Status." + "description": "Fetch membershipClasses values based on given membershipClassId" + }, + { + "name": "hotelId", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Hotel code of membership rate.", + "items": { + "type": "string" + }, + "required": false }, { "$ref": "#/parameters/authKey" @@ -18843,21 +18829,22 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "MembershipConfig" ] } }, - "/membershipTypeRules": { + "/membershipSourceGroups": { "get": { - "summary": "Get Membership type rules", - "description": "get Membership type rules based on criteriaOperationId:getMembershipTypeRules
", - "operationId": "getMembershipTypeRules", + "summary": "Get Membership source groups", + "description": "You can use this API to get Membership source groups.OperationId:getMembershipSourceGroups
", + "operationId": "getMembershipSourceGroups", "parameters": [ { - "name": "membershipTypesCodes", + "name": "codes", "in": "query", "type": "array", "collectionFormat": "multi", + "description": "Codes to be searched.", "items": { "type": "string", "maxItems": 4000 @@ -18865,49 +18852,12 @@ "required": false }, { - "name": "programType", - "in": "query", - "required": false, - "type": "string", - "description": "Membership Type/Program rule types.", - "uniqueItems": true, - "enum": [ - "All", - "Points", - "Tier" - ] - }, - { - "name": "ruleCode", + "name": "description", "in": "query", "required": false, - "description": "Rule code of the membership type rule.", + "description": "Description of the code.", "type": "string" }, - { - "name": "ruleBasedOn", - "in": "query", - "required": false, - "type": "string", - "description": "Indicates Membership upgrades/downgrades to the next tier level uses RFM (Recency, Frequency, Monetary Value) score.", - "uniqueItems": true, - "enum": [ - "Revenue", - "Stay", - "Nights", - "Enrollment", - "TierUpgrade", - "Renewal", - "Rfm" - ] - }, - { - "name": "includeInactive", - "in": "query", - "required": false, - "description": "Indicates whether search includes inactive membership type rules.", - "type": "boolean" - }, { "$ref": "#/parameters/authKey" }, @@ -18934,13 +18884,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching membership type rules.", + "description": "Response object for fetching Membership Source Groups configurations.", "schema": { - "$ref": "#/definitions/membershipTypeRulesInfo" + "$ref": "#/definitions/membershipSourceGroupsDetails" } }, "204": { - "description": "MembershipTypeRules not found." + "description": "MembershipSourceGroups not found." }, "400": { "$ref": "#/responses/400" @@ -18990,19 +18940,19 @@ ] }, "post": { - "summary": "Create Membership type rules", - "description": "You can use this API to create Membership type rules.OperationId:postMembershipTypeRules
", - "operationId": "postMembershipTypeRules", + "summary": "Create a Membership source group", + "description": "You can use this API to create Membership source group.OperationId:postMembershipSourceGroup
", + "operationId": "postMembershipSourceGroup", "parameters": [ { - "name": "membershipTypeRules", + "name": "membershipSourceGroup", "in": "body", "required": true, - "description": "Request object for creating new membership type rules.", + "description": "Request object for creating new Membership source Group Configurations.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipTypeRules" + "$ref": "#/definitions/membershipSourceGroupDetails" } ] } @@ -19037,9 +18987,9 @@ "description": "Location of newly created resource" } }, - "description": "Response object for creating membership type rules.", + "description": "HATEOAS links which help the consumer to navigate to resource", "schema": { - "$ref": "#/definitions/membershipTypeRulesDetails" + "$ref": "#/definitions/status" } }, "400": { @@ -19090,156 +19040,30 @@ ] } }, - "/membershipTypeRules/{membershipTypeRulesId}": { - "get": { - "summary": "Get Membership type rule details", - "description": "You can use this API to get Membership type rule details.OperationId:getMembershipTypeRule
", - "operationId": "getMembershipTypeRule", - "parameters": [ - { - "name": "membershipTypeRulesId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Fetch membershipClasses values based on given membershipClassId" - }, - { - "name": "membershipType", - "in": "query", - "required": false, - "description": "Membership type of the Rule.", - "type": "string" - }, - { - "name": "membershipPointsSequence", - "in": "query", - "required": false, - "description": "Sequence number of the membership type rule.", - "type": "integer" - }, - { - "name": "fetchInstructions", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "To include type rule filters information.", - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "RuleDefinition", - "PointsDefinition", - "RuleConditions" - ] - }, - "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 fetching membership type rule.", - "schema": { - "$ref": "#/definitions/membershipTypeRule" - } - }, - "204": { - "description": "MembershipTypeRule 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": [ - "MembershipConfig" - ] - }, + "/membershipSourceGroups/{membershipSourceGroupId}": { "put": { - "summary": "Change Membership type rules", - "description": "You can use this API to change Membership type rules.OperationId:putMembershipTypeRules
", - "operationId": "putMembershipTypeRules", + "summary": "Change Membership source group", + "description": "You can use this API to change Membership source group.OperationId:putMembershipSourceGroup
", + "operationId": "putMembershipSourceGroup", "parameters": [ { - "name": "membershipTypeRulesId", + "name": "membershipSourceGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, - "maxLength": 2000, - "description": "Fetch membershipClasses values based on given membershipClassId" + "maxLength": 20, + "description": "Membership source group code which will be changed." }, { - "name": "membershipTypeRules", + "name": "membershipSourceGroup", "in": "body", "required": true, - "description": "Request object for changing membership type rules.", + "description": "Request object for changing existing Membership Source Group Configurations.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipTypeRules" + "$ref": "#/definitions/membershipSourceGroupDetails" } ] } @@ -19327,29 +19151,18 @@ ] }, "delete": { - "summary": "Delete Membership type rules", - "description": "You can use this API to delete Membership type rules.OperationId:deleteMembershipTypeRules
", - "operationId": "deleteMembershipTypeRules", + "summary": "Delete Membership Source group", + "description": "You can use this API to delete Membership Source group.OperationId:deleteMembershipSourceGroup
", + "operationId": "deleteMembershipSourceGroup", "parameters": [ { - "name": "membershipTypeRulesId", + "name": "membershipSourceGroupId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Fetch membershipClasses values based on given membershipClassId" - }, - { - "name": "membershipPointsSequence", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Sequence number of the membership type rule.", - "items": { - "type": "integer" - }, - "required": false + "description": "Delete delete Membership Source Group based on given membershipSourceGroupId" }, { "$ref": "#/parameters/authKey" @@ -19434,21 +19247,21 @@ ] } }, - "/membershipTypes": { + "/membershipStatusCodes": { "get": { - "summary": "Get membership types", - "description": "Membership types enable you to identify, organize, and manage the membership programs on a profile. For example, your property might have a guest loyalty program that awards guests based on the amount of revenue generated or the number of stays per year. You would create a specific membership type for this program. This API will retrieve all configured Membership Types configured.OperationId:getMembershipTypes
", - "operationId": "getMembershipTypes", + "summary": "Get Membership Status Codes", + "description": "Use this API to get Membership Status Codes.OperationId:getMembershipStatusCodes
", + "operationId": "getMembershipStatusCodes", "parameters": [ { - "name": "includeInactive", + "name": "fetchInactive", "in": "query", "required": false, - "description": "Search criteria for fetching inactive memberships. When set to true, inactive records will be included.", + "description": "Determines wether to fetch inactive records or not.", "type": "boolean" }, { - "name": "membershipTypesCodes", + "name": "codes", "in": "query", "type": "array", "collectionFormat": "multi", @@ -19460,29 +19273,17 @@ "required": false }, { - "name": "membershipTypesWildCard", + "name": "wildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { - "name": "membershipClassesCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Codes to be searched.", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "membershipClassesWildCard", + "name": "description", "in": "query", "required": false, - "description": "Wildcard search on the code.", + "description": "Description of the code.", "type": "string" }, { @@ -19511,13 +19312,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching Membership Types.", + "description": "Response object for fetching Membership Status Codes.", "schema": { - "$ref": "#/definitions/membershipTypes" + "$ref": "#/definitions/membershipStatusCodesDetails" } }, "204": { - "description": "MembershipTypes not found." + "description": "MembershipStatusCodes not found." }, "400": { "$ref": "#/responses/400" @@ -19563,23 +19364,23 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" + "ChainConfig" ] }, "post": { - "summary": "Create Membership types", - "description": "Membership types enable you to identify, organize, and manage the membership programs on a profile. For example, your property might have a guest loyalty program that awards guests based on the amount of revenue generated or the number of stays per year. You would create a specific membership type for this program.OperationId:postMembershipTypes
", - "operationId": "postMembershipTypes", + "summary": "Create Membership Status Codes", + "description": "Use this API to create Membership Status Codes.OperationId:postMembershipStatusCodes
", + "operationId": "postMembershipStatusCodes", "parameters": [ { - "name": "membershipTypes", + "name": "membershipStatusCodesCriteria", "in": "body", "required": true, - "description": "Request object to create Membership types. Includes instructions for information which needs to be returned.", + "description": "Request object for creating Membership Status Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipTypes" + "$ref": "#/definitions/membershipStatusCodesCriteria" } ] } @@ -19663,157 +19464,34 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" + "ChainConfig" ] } }, - "/membershipTypes/{membershipTypeId}": { - "get": { - "summary": "Get a Membership type", - "description": "Use this API to get a specific Membership Type and its details.OperationId:getMembershipType
", - "operationId": "getMembershipType", - "parameters": [ - { - "name": "membershipTypeId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Fetch membershipTypes values based on given membershipTypeId" - }, - { - "name": "membershipTypeCode", - "in": "query", - "required": false, - "description": "Membership type code.", - "type": "string" - }, - { - "name": "fetchInstructions", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Membership levels.", - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "PrimaryDetails", - "CardNumberDetails", - "PointsDetails", - "ExceptionCriteriaDetails", - "AdditionalDetails", - "EnrollmentDetails", - "Levels" - ] - }, - "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 fetching Membership Type.", - "schema": { - "$ref": "#/definitions/membershipTypesDetails" - } - }, - "204": { - "description": "MembershipType 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": [ - "MembershipConfig" - ] - }, + "/membershipStatusCodes/{membershipStatusCode}": { "put": { - "summary": "Change Membership type", - "description": "Use this API to update an existing Membership TypeOperationId:putMembershipType
", - "operationId": "putMembershipType", + "summary": "Change Membership Status Codes", + "description": "Use this API to update Membership Status Codes.OperationId:changeMembershipStatusCodes
", + "operationId": "changeMembershipStatusCodes", "parameters": [ { - "name": "membershipTypeId", + "name": "membershipStatusCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Fetch membershipTypes values based on given membershipTypeId" + "description": "Unique Code of Membership Status." }, { - "name": "membershipTypeChangeInstructions", + "name": "membershipStatusCodesToBeChanged", "in": "body", "required": true, - "description": "Request object for changing membership type.", + "description": "Request object for changing Membership Status Codes.", "schema": { "allOf": [ { - "$ref": "#/definitions/membershipTypeChangeInstructions" + "$ref": "#/definitions/membershipStatusCodesToBeChanged" } ] } @@ -19850,7 +19528,7 @@ }, "description": "Response Body.", "schema": { - "$ref": "#/definitions/membershipTypes" + "$ref": "#/definitions/status" } }, "400": { @@ -19897,22 +19575,22 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" + "ChainConfig" ] }, "delete": { - "summary": "Delete Membership type", - "description": "Use this API to delete an existing Membership TypeOperationId:deleteMembershipTypes
", - "operationId": "deleteMembershipTypes", + "summary": "Delete Membership Status Codes", + "description": "Use this API to delete Membership Status Codes.OperationId:removeMembershipStatusCodes
", + "operationId": "removeMembershipStatusCodes", "parameters": [ { - "name": "membershipTypeId", + "name": "membershipStatusCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Fetch membershipTypes values based on given membershipTypeId" + "description": "Unique Code of Membership Status." }, { "$ref": "#/parameters/authKey" @@ -19993,29 +19671,21 @@ "application/json;charset=UTF-8" ], "tags": [ - "MembershipConfig" + "ChainConfig" ] } }, - "/nationalities": { + "/membershipTypeRules": { "get": { - "summary": "Get nationalities", - "description": "Use this API to get Nationalities codes and description configured in OPERA.OperationId:getNationalities
", - "operationId": "getNationalities", + "summary": "Get Membership type rules", + "description": "get Membership type rules based on criteriaOperationId:getMembershipTypeRules
", + "operationId": "getMembershipTypeRules", "parameters": [ { - "name": "fetchInactive", - "in": "query", - "required": false, - "description": "Determines wether to fetch inactive records or not.", - "type": "boolean" - }, - { - "name": "codes", + "name": "membershipTypesCodes", "in": "query", "type": "array", "collectionFormat": "multi", - "description": "Codes to be searched.", "items": { "type": "string", "maxItems": 4000 @@ -20023,19 +19693,49 @@ "required": false }, { - "name": "wildCard", + "name": "programType", "in": "query", "required": false, - "description": "Wildcard search on the code.", - "type": "string" + "type": "string", + "description": "Membership Type/Program rule types.", + "uniqueItems": true, + "enum": [ + "All", + "Points", + "Tier" + ] }, { - "name": "description", + "name": "ruleCode", "in": "query", "required": false, - "description": "Description of the code.", + "description": "Rule code of the membership type rule.", "type": "string" }, + { + "name": "ruleBasedOn", + "in": "query", + "required": false, + "type": "string", + "description": "Indicates Membership upgrades/downgrades to the next tier level uses RFM (Recency, Frequency, Monetary Value) score.", + "uniqueItems": true, + "enum": [ + "Revenue", + "Stay", + "Nights", + "Enrollment", + "TierUpgrade", + "Renewal", + "Rfm" + ] + }, + { + "name": "includeInactive", + "in": "query", + "required": false, + "description": "Indicates whether search includes inactive membership type rules.", + "type": "boolean" + }, { "$ref": "#/parameters/authKey" }, @@ -20062,13 +19762,1569 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching Nationalities.", + "description": "Response object for fetching membership type rules.", "schema": { - "$ref": "#/definitions/nationalitiesDetails" + "$ref": "#/definitions/membershipTypeRulesInfo" } }, "204": { - "description": "Nationalities not found." + "description": "MembershipTypeRules 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": [ + "MembershipConfig" + ] + }, + "post": { + "summary": "Create Membership type rules", + "description": "You can use this API to create Membership type rules.OperationId:postMembershipTypeRules
", + "operationId": "postMembershipTypeRules", + "parameters": [ + { + "name": "membershipTypeRules", + "in": "body", + "required": true, + "description": "Request object for creating new membership type rules.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipTypeRules" + } + ] + } + }, + { + "$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": "Response object for creating membership type rules.", + "schema": { + "$ref": "#/definitions/membershipTypeRulesDetails" + } + }, + "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": [ + "MembershipConfig" + ] + } + }, + "/membershipTypeRules/{membershipTypeRulesId}": { + "get": { + "summary": "Get Membership type rule details", + "description": "You can use this API to get Membership type rule details.OperationId:getMembershipTypeRule
", + "operationId": "getMembershipTypeRule", + "parameters": [ + { + "name": "membershipTypeRulesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" + }, + { + "name": "membershipType", + "in": "query", + "required": false, + "description": "Membership type of the Rule.", + "type": "string" + }, + { + "name": "membershipPointsSequence", + "in": "query", + "required": false, + "description": "Sequence number of the membership type rule.", + "type": "integer" + }, + { + "name": "fetchInstructions", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "To include type rule filters information.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "RuleDefinition", + "PointsDefinition", + "RuleConditions" + ] + }, + "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 fetching membership type rule.", + "schema": { + "$ref": "#/definitions/membershipTypeRule" + } + }, + "204": { + "description": "MembershipTypeRule 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": [ + "MembershipConfig" + ] + }, + "put": { + "summary": "Change Membership type rules", + "description": "You can use this API to change Membership type rules.OperationId:putMembershipTypeRules
", + "operationId": "putMembershipTypeRules", + "parameters": [ + { + "name": "membershipTypeRulesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" + }, + { + "name": "membershipTypeRules", + "in": "body", + "required": true, + "description": "Request object for changing membership type rules.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipTypeRules" + } + ] + } + }, + { + "$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": [ + "MembershipConfig" + ] + }, + "delete": { + "summary": "Delete Membership type rules", + "description": "You can use this API to delete Membership type rules.OperationId:deleteMembershipTypeRules
", + "operationId": "deleteMembershipTypeRules", + "parameters": [ + { + "name": "membershipTypeRulesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipClasses values based on given membershipClassId" + }, + { + "name": "membershipPointsSequence", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Sequence number of the membership type rule.", + "items": { + "type": "integer" + }, + "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" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "MembershipConfig" + ] + } + }, + "/membershipTypes": { + "get": { + "summary": "Get membership types", + "description": "Membership types enable you to identify, organize, and manage the membership programs on a profile. For example, your property might have a guest loyalty program that awards guests based on the amount of revenue generated or the number of stays per year. You would create a specific membership type for this program. This API will retrieve all configured Membership Types configured.OperationId:getMembershipTypes
", + "operationId": "getMembershipTypes", + "parameters": [ + { + "name": "includeInactive", + "in": "query", + "required": false, + "description": "Search criteria for fetching inactive memberships. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "membershipTypesCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "membershipTypesWildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" + }, + { + "name": "membershipClassesCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "membershipClassesWildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "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": "Response object for fetching Membership Types.", + "schema": { + "$ref": "#/definitions/membershipTypes" + } + }, + "204": { + "description": "MembershipTypes 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": [ + "MembershipConfig" + ] + }, + "post": { + "summary": "Create Membership types", + "description": "Membership types enable you to identify, organize, and manage the membership programs on a profile. For example, your property might have a guest loyalty program that awards guests based on the amount of revenue generated or the number of stays per year. You would create a specific membership type for this program.OperationId:postMembershipTypes
", + "operationId": "postMembershipTypes", + "parameters": [ + { + "name": "membershipTypes", + "in": "body", + "required": true, + "description": "Request object to create Membership types. Includes instructions for information which needs to be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipTypes" + } + ] + } + }, + { + "$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": [ + "MembershipConfig" + ] + } + }, + "/membershipTypes/{membershipTypeId}": { + "get": { + "summary": "Get a Membership type", + "description": "Use this API to get a specific Membership Type and its details.OperationId:getMembershipType
", + "operationId": "getMembershipType", + "parameters": [ + { + "name": "membershipTypeId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipTypes values based on given membershipTypeId" + }, + { + "name": "membershipTypeCode", + "in": "query", + "required": false, + "description": "Membership type code.", + "type": "string" + }, + { + "name": "fetchInstructions", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Membership levels.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "PrimaryDetails", + "CardNumberDetails", + "PointsDetails", + "ExceptionCriteriaDetails", + "AdditionalDetails", + "EnrollmentDetails", + "Levels" + ] + }, + "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 fetching Membership Type.", + "schema": { + "$ref": "#/definitions/membershipTypesDetails" + } + }, + "204": { + "description": "MembershipType 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": [ + "MembershipConfig" + ] + }, + "put": { + "summary": "Change Membership type", + "description": "Use this API to update an existing Membership TypeOperationId:putMembershipType
", + "operationId": "putMembershipType", + "parameters": [ + { + "name": "membershipTypeId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipTypes values based on given membershipTypeId" + }, + { + "name": "membershipTypeChangeInstructions", + "in": "body", + "required": true, + "description": "Request object for changing membership type.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipTypeChangeInstructions" + } + ] + } + }, + { + "$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/membershipTypes" + } + }, + "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": [ + "MembershipConfig" + ] + }, + "delete": { + "summary": "Delete Membership type", + "description": "Use this API to delete an existing Membership TypeOperationId:deleteMembershipTypes
", + "operationId": "deleteMembershipTypes", + "parameters": [ + { + "name": "membershipTypeId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Fetch membershipTypes values based on given membershipTypeId" + }, + { + "$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": [ + "MembershipConfig" + ] + } + }, + "/nationalities": { + "get": { + "summary": "Get nationalities", + "description": "Use this API to get Nationalities codes and description configured in OPERA.OperationId:getNationalities
", + "operationId": "getNationalities", + "parameters": [ + { + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" + }, + { + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" + }, + { + "name": "description", + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/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 Nationalities.", + "schema": { + "$ref": "#/definitions/nationalitiesDetails" + } + }, + "204": { + "description": "Nationalities 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": [ + "ChainConfig" + ] + }, + "post": { + "summary": "Create Nationalities", + "description": "Use this API to create Nationalities.OperationId:postNationalities
", + "operationId": "postNationalities", + "parameters": [ + { + "name": "nationalitiesCriteria", + "in": "body", + "required": true, + "description": "Request object for creating Nationalities.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/nationalitiesCriteria" + } + ] + } + }, + { + "$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": [ + "ChainConfig" + ] + } + }, + "/nationalities/{nationalitiesId}": { + "put": { + "summary": "Change Nationalities", + "description": "Use this API to update Nationalities.OperationId:putNationalities
", + "operationId": "putNationalities", + "parameters": [ + { + "name": "nationalitiesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Nationalities." + }, + { + "name": "nationalitiesToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing Nationalities.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/nationalitiesToBeChanged" + } + ] + } + }, + { + "$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": [ + "ChainConfig" + ] + }, + "delete": { + "summary": "Delete Nationalities", + "description": "Use this API to delete Nationalities.OperationId:deleteNationalities
", + "operationId": "deleteNationalities", + "parameters": [ + { + "name": "nationalitiesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Nationalities." + }, + { + "$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": [ + "ChainConfig" + ] + } + }, + "/ownerTeams": { + "get": { + "summary": "Get Owner Teams", + "description": "Use this API to get Owner Teams.OperationId:getOwnerTeams
", + "operationId": "getOwnerTeams", + "parameters": [ + { + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" + }, + { + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", + "type": "string" + }, + { + "name": "description", + "in": "query", + "required": false, + "description": "Description of the code.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/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 Owner Teams.", + "schema": { + "$ref": "#/definitions/ownerTeamsDetails" + } + }, + "204": { + "description": "OwnerTeams not found." }, "400": { "$ref": "#/responses/400" @@ -20118,19 +21374,19 @@ ] }, "post": { - "summary": "Create Nationalities", - "description": "Use this API to create Nationalities.OperationId:postNationalities
", - "operationId": "postNationalities", + "summary": "Create Owner Teams", + "description": "Use this API to create Owner Teams.OperationId:postOwnerTeams
", + "operationId": "postOwnerTeams", "parameters": [ { - "name": "nationalitiesCriteria", + "name": "ownerTeamsCriteria", "in": "body", "required": true, - "description": "Request object for creating Nationalities.", + "description": "Request object for creating Owner Teams.", "schema": { "allOf": [ { - "$ref": "#/definitions/nationalitiesCriteria" + "$ref": "#/definitions/ownerTeamsCriteria" } ] } @@ -20218,30 +21474,30 @@ ] } }, - "/nationalities/{nationalitiesId}": { + "/ownerTeams/{ownerTeamCode}": { "put": { - "summary": "Change Nationalities", - "description": "Use this API to update Nationalities.OperationId:putNationalities
", - "operationId": "putNationalities", + "summary": "Change Owner Teams", + "description": "Use this API to update Owner Teams.OperationId:changeOwnerTeams
", + "operationId": "changeOwnerTeams", "parameters": [ { - "name": "nationalitiesId", + "name": "ownerTeamCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of Nationalities." + "description": "Unique Code of Owner Teams." }, { - "name": "nationalitiesToBeChanged", + "name": "ownerTeamsToBeChanged", "in": "body", "required": true, - "description": "Request object for changing Nationalities.", + "description": "Request object for changing Owner Teams.", "schema": { "allOf": [ { - "$ref": "#/definitions/nationalitiesToBeChanged" + "$ref": "#/definitions/ownerTeamsToBeChanged" } ] } @@ -20329,18 +21585,18 @@ ] }, "delete": { - "summary": "Delete Nationalities", - "description": "Use this API to delete Nationalities.OperationId:deleteNationalities
", - "operationId": "deleteNationalities", + "summary": "Delete Owner Teams", + "description": "Use this API to delete Owner Teams.OperationId:removeOwnerTeams
", + "operationId": "removeOwnerTeams", "parameters": [ { - "name": "nationalitiesId", + "name": "ownerTeamCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of Nationalities." + "description": "Unique Code of Owner Teams." }, { "$ref": "#/parameters/authKey" @@ -20425,11 +21681,11 @@ ] } }, - "/ownerTeams": { + "/payDays": { "get": { - "summary": "Get Owner Teams", - "description": "Use this API to get Owner Teams.OperationId:getOwnerTeams
", - "operationId": "getOwnerTeams", + "summary": "Get Pay Days", + "description": "Use this API to get Pay Days.OperationId:getPayDays
", + "operationId": "getPayDays", "parameters": [ { "name": "fetchInactive", @@ -20490,13 +21746,113 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching Owner Teams.", + "description": "Response object for fetching Pay Days.", "schema": { - "$ref": "#/definitions/ownerTeamsDetails" + "$ref": "#/definitions/payDaysDetails" } }, "204": { - "description": "OwnerTeams not found." + "description": "PayDays 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": [ + "ChainConfig" + ] + }, + "post": { + "summary": "Create Pay Days", + "description": "Use this API to create Pay Days.OperationId:postPayDays
", + "operationId": "postPayDays", + "parameters": [ + { + "name": "payDaysCriteria", + "in": "body", + "required": true, + "description": "Request object for creating Pay Days.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/payDaysCriteria" + } + ] + } + }, + { + "$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" @@ -20544,21 +21900,32 @@ "tags": [ "ChainConfig" ] - }, - "post": { - "summary": "Create Owner Teams", - "description": "Use this API to create Owner Teams.OperationId:postOwnerTeams
", - "operationId": "postOwnerTeams", + } + }, + "/payDays/{payDaysId}": { + "put": { + "summary": "Change Pay Days", + "description": "Use this API to update Pay Days.OperationId:putPayDays
", + "operationId": "putPayDays", "parameters": [ { - "name": "ownerTeamsCriteria", + "name": "payDaysId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Pay Days." + }, + { + "name": "payDaysToBeChanged", "in": "body", "required": true, - "description": "Request object for creating Owner Teams.", + "description": "Request object for changing Pay Days.", "schema": { "allOf": [ { - "$ref": "#/definitions/ownerTeamsCriteria" + "$ref": "#/definitions/payDaysToBeChanged" } ] } @@ -20580,7 +21947,7 @@ } ], "responses": { - "201": { + "200": { "headers": { "Content-Language": { "type": "string", @@ -20593,7 +21960,7 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } @@ -20644,35 +22011,20 @@ "tags": [ "ChainConfig" ] - } - }, - "/ownerTeams/{ownerTeamCode}": { - "put": { - "summary": "Change Owner Teams", - "description": "Use this API to update Owner Teams.OperationId:changeOwnerTeams
", - "operationId": "changeOwnerTeams", + }, + "delete": { + "summary": "Delete Pay Days", + "description": "Use this API to delete Pay Days.OperationId:deletePayDays
", + "operationId": "deletePayDays", "parameters": [ { - "name": "ownerTeamCode", + "name": "payDaysId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique Code of Owner Teams." - }, - { - "name": "ownerTeamsToBeChanged", - "in": "body", - "required": true, - "description": "Request object for changing Owner Teams.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/ownerTeamsToBeChanged" - } - ] - } + "description": "Unique ID of Pay Days." }, { "$ref": "#/parameters/authKey" @@ -20704,7 +22056,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" } @@ -20755,20 +22107,34 @@ "tags": [ "ChainConfig" ] - }, + } + }, + "/preference": { "delete": { - "summary": "Delete Owner Teams", - "description": "Use this API to delete Owner Teams.OperationId:removeOwnerTeams
", - "operationId": "removeOwnerTeams", + "summary": "Delete preferences", + "description": "Use this API to delete preferences, this API allows us to delete both the Global and Hotel level preferences.OperationId:deleteHotelAndGlobalPreferences
", + "operationId": "deleteHotelAndGlobalPreferences", "parameters": [ { - "name": "ownerTeamCode", - "in": "path", + "name": "preferenceCode", + "in": "query", "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique Code of Owner Teams." + "description": "Specifies the preference code.", + "type": "string" + }, + { + "name": "preferenceGroup", + "in": "query", + "required": true, + "description": "Specifies the preference group the preference belongs to.", + "type": "string" + }, + { + "name": "hotelId", + "in": "query", + "required": false, + "description": "Specifies the hotel code for which the preference is specified.", + "type": "string" }, { "$ref": "#/parameters/authKey" @@ -20849,29 +22215,21 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "ProfileConfiguration" ] } }, - "/payDays": { + "/preferenceGroups": { "get": { - "summary": "Get Pay Days", - "description": "Use this API to get Pay Days.OperationId:getPayDays
", - "operationId": "getPayDays", + "summary": "Get Preference Groups", + "description": "The API can be used to retrieve preference groups that match the given criteria in the request.OperationId:getPreferenceGroups
", + "operationId": "getPreferenceGroups", "parameters": [ { - "name": "fetchInactive", - "in": "query", - "required": false, - "description": "Determines wether to fetch inactive records or not.", - "type": "boolean" - }, - { - "name": "codes", + "name": "preferenceGroupsCodes", "in": "query", "type": "array", "collectionFormat": "multi", - "description": "Codes to be searched.", "items": { "type": "string", "maxItems": 4000 @@ -20882,14 +22240,7 @@ "name": "wildCard", "in": "query", "required": false, - "description": "Wildcard search on the code.", - "type": "string" - }, - { - "name": "description", - "in": "query", - "required": false, - "description": "Description of the code.", + "description": "Preference group description to be searched.", "type": "string" }, { @@ -20918,13 +22269,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching Pay Days.", + "description": "Response object for fetching preference groups.", "schema": { - "$ref": "#/definitions/payDaysDetails" + "$ref": "#/definitions/preferenceGroups" } }, "204": { - "description": "PayDays not found." + "description": "PreferenceGroups not found." }, "400": { "$ref": "#/responses/400" @@ -20970,134 +22321,23 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "ProfileConfiguration" ] }, - "post": { - "summary": "Create Pay Days", - "description": "Use this API to create Pay Days.OperationId:postPayDays
", - "operationId": "postPayDays", - "parameters": [ - { - "name": "payDaysCriteria", - "in": "body", - "required": true, - "description": "Request object for creating Pay Days.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/payDaysCriteria" - } - ] - } - }, - { - "$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": [ - "ChainConfig" - ] - } - }, - "/payDays/{payDaysId}": { "put": { - "summary": "Change Pay Days", - "description": "Use this API to update Pay Days.OperationId:putPayDays
", - "operationId": "putPayDays", + "summary": "Change Preference Groups", + "description": "This API can be used to modify the preference groups. Changes can be made concurrently to multiple groups.OperationId:putPreferenceGroups
", + "operationId": "putPreferenceGroups", "parameters": [ { - "name": "payDaysId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of Pay Days." - }, - { - "name": "payDaysToBeChanged", + "name": "preferenceGroups", "in": "body", "required": true, - "description": "Request object for changing Pay Days.", + "description": "Request object for changing existing preference groups.", "schema": { "allOf": [ { - "$ref": "#/definitions/payDaysToBeChanged" + "$ref": "#/definitions/preferenceGroups" } ] } @@ -21181,22 +22421,20 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "ProfileConfiguration" ] }, "delete": { - "summary": "Delete Pay Days", - "description": "Use this API to delete Pay Days.OperationId:deletePayDays
", - "operationId": "deletePayDays", + "summary": "Delete preference groups", + "description": "This will allow you to delete an existing Preference Group.OperationId:deletePreferenceGroups
", + "operationId": "deletePreferenceGroups", "parameters": [ { - "name": "payDaysId", - "in": "path", + "name": "preferenceGroup", + "in": "query", "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of Pay Days." + "description": "Code identifying the preference group.", + "type": "string" }, { "$ref": "#/parameters/authKey" @@ -21277,36 +22515,26 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "ProfileConfiguration" ] - } - }, - "/preference": { - "delete": { - "summary": "Delete preferences", - "description": "Use this API to delete preferences, this API allows us to delete both the Global and Hotel level preferences.OperationId:deleteHotelAndGlobalPreferences
", - "operationId": "deleteHotelAndGlobalPreferences", + }, + "post": { + "summary": "Create new preference groups ", + "description": "Use this API to create a new Preference group.OperationId:postPreferenceGroups
", + "operationId": "postPreferenceGroups", "parameters": [ { - "name": "preferenceCode", - "in": "query", - "required": true, - "description": "Specifies the preference code.", - "type": "string" - }, - { - "name": "preferenceGroup", - "in": "query", + "name": "preferenceGroups", + "in": "body", "required": true, - "description": "Specifies the preference group the preference belongs to.", - "type": "string" - }, - { - "name": "hotelId", - "in": "query", - "required": false, - "description": "Specifies the hotel code for which the preference is specified.", - "type": "string" + "description": "Request object for creating new preference groups.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/preferenceGroups" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -21325,7 +22553,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -21391,14 +22619,14 @@ ] } }, - "/preferenceGroups": { + "/preferences": { "get": { - "summary": "Get Preference Groups", - "description": "The API can be used to retrieve preference groups that match the given criteria in the request.OperationId:getPreferenceGroups
", - "operationId": "getPreferenceGroups", + "summary": "Get template Preferences", + "description": "You can use this API to get template Preferences.OperationId:getTemplatePreferences
", + "operationId": "getTemplatePreferences", "parameters": [ { - "name": "preferenceGroupsCodes", + "name": "preferenceCodes", "in": "query", "type": "array", "collectionFormat": "multi", @@ -21409,11 +22637,15 @@ "required": false }, { - "name": "wildCard", + "name": "preferenceGroupsCodes", "in": "query", - "required": false, - "description": "Preference group description to be searched.", - "type": "string" + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { "$ref": "#/parameters/authKey" @@ -21441,13 +22673,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching preference groups.", + "description": "Response object for fetching preferences at the template level.", "schema": { - "$ref": "#/definitions/preferenceGroups" + "$ref": "#/definitions/templatePreferences" } }, "204": { - "description": "PreferenceGroups not found." + "description": "TemplatePreferences not found." }, "400": { "$ref": "#/responses/400" @@ -21497,19 +22729,19 @@ ] }, "put": { - "summary": "Change Preference Groups", - "description": "This API can be used to modify the preference groups. Changes can be made concurrently to multiple groups.OperationId:putPreferenceGroups
", - "operationId": "putPreferenceGroups", + "summary": "Change template preferences", + "description": "You can use this API to change template preferences.OperationId:putTemplatePreferences
", + "operationId": "putTemplatePreferences", "parameters": [ { - "name": "preferenceGroups", + "name": "templatePreferences", "in": "body", "required": true, - "description": "Request object for changing existing preference groups.", + "description": "Request object for changing preferences at the template level.", "schema": { "allOf": [ { - "$ref": "#/definitions/preferenceGroups" + "$ref": "#/definitions/templatePreferences" } ] } @@ -21597,15 +22829,22 @@ ] }, "delete": { - "summary": "Delete preference groups", - "description": "This will allow you to delete an existing Preference Group.OperationId:deletePreferenceGroups
", - "operationId": "deletePreferenceGroups", + "summary": "Delete template preferences", + "description": "You can use this API to delete template preferences.OperationId:deleteTemplatePreferences
", + "operationId": "deleteTemplatePreferences", "parameters": [ + { + "name": "preferenceCode", + "in": "query", + "required": true, + "description": "Specifies the preference code.", + "type": "string" + }, { "name": "preferenceGroup", "in": "query", "required": true, - "description": "Code identifying the preference group.", + "description": "Specifies the preference group the preference belongs to.", "type": "string" }, { @@ -21691,19 +22930,19 @@ ] }, "post": { - "summary": "Create new preference groups ", - "description": "Use this API to create a new Preference group.OperationId:postPreferenceGroups
", - "operationId": "postPreferenceGroups", + "summary": "Create template preferences", + "description": "You can use this API to create template preferences.OperationId:postTemplatePreferences
", + "operationId": "postTemplatePreferences", "parameters": [ { - "name": "preferenceGroups", + "name": "templatePreferences", "in": "body", "required": true, - "description": "Request object for creating new preference groups.", + "description": "Request object for creating preferences at the template level.", "schema": { "allOf": [ { - "$ref": "#/definitions/preferenceGroups" + "$ref": "#/definitions/templatePreferences" } ] } @@ -21791,129 +23030,21 @@ ] } }, - "/preferences": { - "get": { - "summary": "Get template Preferences", - "description": "You can use this API to get template Preferences.OperationId:getTemplatePreferences
", - "operationId": "getTemplatePreferences", - "parameters": [ - { - "name": "preferenceCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "preferenceGroupsCodes", - "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 fetching preferences at the template level.", - "schema": { - "$ref": "#/definitions/templatePreferences" - } - }, - "204": { - "description": "TemplatePreferences 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": [ - "ProfileConfiguration" - ] - }, + "/preferences/copy": { "put": { - "summary": "Change template preferences", - "description": "You can use this API to change template preferences.OperationId:putTemplatePreferences
", - "operationId": "putTemplatePreferences", + "summary": "Copy preferences", + "description": "Use this API to copy preferences.OperationId:copyPreferences
", + "operationId": "copyPreferences", "parameters": [ { - "name": "templatePreferences", + "name": "preferencesCopy", "in": "body", "required": true, - "description": "Request object for changing preferences at the template level.", + "description": "Request object for copying template preferences to hotel(s).", "schema": { "allOf": [ { - "$ref": "#/definitions/templatePreferences" + "$ref": "#/definitions/preferencesCopy" } ] } @@ -21999,24 +23130,45 @@ "tags": [ "ProfileConfiguration" ] - }, - "delete": { - "summary": "Delete template preferences", - "description": "You can use this API to delete template preferences.OperationId:deleteTemplatePreferences
", - "operationId": "deleteTemplatePreferences", + } + }, + "/profileInactiveReasons": { + "get": { + "summary": "Get Profile Inactive Reasons", + "description": "Use this API to get Profile Inactive Reasons.OperationId:getProfileInactiveReasons
", + "operationId": "getProfileInactiveReasons", "parameters": [ { - "name": "preferenceCode", + "name": "fetchInactive", "in": "query", - "required": true, - "description": "Specifies the preference code.", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" + }, + { + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Codes to be searched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "wildCard", + "in": "query", + "required": false, + "description": "Wildcard search on the code.", "type": "string" }, { - "name": "preferenceGroup", + "name": "description", "in": "query", - "required": true, - "description": "Specifies the preference group the preference belongs to.", + "required": false, + "description": "Description of the code.", "type": "string" }, { @@ -22043,17 +23195,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": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response object for fetching Profile Inactive Reasons.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/profileInactiveReasonsDetails" } }, + "204": { + "description": "ProfileInactiveReasons not found." + }, "400": { "$ref": "#/responses/400" }, @@ -22098,23 +23249,23 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" + "ChainConfig" ] }, "post": { - "summary": "Create template preferences", - "description": "You can use this API to create template preferences.OperationId:postTemplatePreferences
", - "operationId": "postTemplatePreferences", + "summary": "Create Profile Inactive Reasons", + "description": "Use this API to create Profile Inactive Reasons.OperationId:postProfileInactiveReasons
", + "operationId": "postProfileInactiveReasons", "parameters": [ { - "name": "templatePreferences", + "name": "profileInactiveReasonsCriteria", "in": "body", "required": true, - "description": "Request object for creating preferences at the template level.", + "description": "Request object for creating Profile Inactive Reasons.", "schema": { "allOf": [ { - "$ref": "#/definitions/templatePreferences" + "$ref": "#/definitions/profileInactiveReasonsCriteria" } ] } @@ -22198,25 +23349,34 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" + "ChainConfig" ] } }, - "/preferences/copy": { + "/profileInactiveReasons/{profileInactiveReasonsId}": { "put": { - "summary": "Copy preferences", - "description": "Use this API to copy preferences.OperationId:copyPreferences
", - "operationId": "copyPreferences", + "summary": "Change Profile Inactive Reasons", + "description": "Use this API to update Profile Inactive Reasons.OperationId:putProfileInactiveReasons
", + "operationId": "putProfileInactiveReasons", "parameters": [ { - "name": "preferencesCopy", + "name": "profileInactiveReasonsId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Profile Inactive Reasons." + }, + { + "name": "profileInactiveReasonsToBeChanged", "in": "body", "required": true, - "description": "Request object for copying template preferences to hotel(s).", + "description": "Request object for changing Profile Inactive Reasons.", "schema": { "allOf": [ { - "$ref": "#/definitions/preferencesCopy" + "$ref": "#/definitions/profileInactiveReasonsToBeChanged" } ] } @@ -22300,25 +23460,114 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" + "ChainConfig" + ] + }, + "delete": { + "summary": "Delete Profile Inactive Reasons", + "description": "Use this API to delete Profile Inactive Reasons.OperationId:deleteProfileInactiveReasons
", + "operationId": "deleteProfileInactiveReasons", + "parameters": [ + { + "name": "profileInactiveReasonsId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Profile Inactive Reasons." + }, + { + "$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": [ + "ChainConfig" ] } }, - "/profileInactiveReasons": { + "/profileNameValidations": { "get": { - "summary": "Get Profile Inactive Reasons", - "description": "Use this API to get Profile Inactive Reasons.OperationId:getProfileInactiveReasons
", - "operationId": "getProfileInactiveReasons", + "summary": "Get Profile Name Validations", + "description": "You can use this API to get Profile Name Validations.OperationId:getProfileNameValidations
", + "operationId": "getProfileNameValidations", "parameters": [ { - "name": "fetchInactive", - "in": "query", - "required": false, - "description": "Determines wether to fetch inactive records or not.", - "type": "boolean" - }, - { - "name": "codes", + "name": "typeCodes", "in": "query", "type": "array", "collectionFormat": "multi", @@ -22337,10 +23586,10 @@ "type": "string" }, { - "name": "description", + "name": "name", "in": "query", "required": false, - "description": "Description of the code.", + "description": "Profile Name to be Searched.", "type": "string" }, { @@ -22369,13 +23618,13 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching Profile Inactive Reasons.", + "description": "Response for fetching Profile names.", "schema": { - "$ref": "#/definitions/profileInactiveReasonsDetails" + "$ref": "#/definitions/profileNameValidations" } }, "204": { - "description": "ProfileInactiveReasons not found." + "description": "ProfileNameValidations not found." }, "400": { "$ref": "#/responses/400" @@ -22421,23 +23670,23 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "ProfileConfiguration" ] }, - "post": { - "summary": "Create Profile Inactive Reasons", - "description": "Use this API to create Profile Inactive Reasons.OperationId:postProfileInactiveReasons
", - "operationId": "postProfileInactiveReasons", + "put": { + "summary": "Change Profile Name Validations", + "description": "You can use this API to change Profile Name Validations.OperationId:putProfileNameValidations
", + "operationId": "putProfileNameValidations", "parameters": [ { - "name": "profileInactiveReasonsCriteria", + "name": "profileNameValidationsToChange", "in": "body", "required": true, - "description": "Request object for creating Profile Inactive Reasons.", + "description": "Request object to edit Profile names.", "schema": { "allOf": [ { - "$ref": "#/definitions/profileInactiveReasonsCriteria" + "$ref": "#/definitions/profileNameValidationsToChange" } ] } @@ -22459,7 +23708,7 @@ } ], "responses": { - "201": { + "200": { "headers": { "Content-Language": { "type": "string", @@ -22472,7 +23721,7 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } @@ -22521,37 +23770,33 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "ProfileConfiguration" ] - } - }, - "/profileInactiveReasons/{profileInactiveReasonsId}": { - "put": { - "summary": "Change Profile Inactive Reasons", - "description": "Use this API to update Profile Inactive Reasons.OperationId:putProfileInactiveReasons
", - "operationId": "putProfileInactiveReasons", + }, + "delete": { + "summary": "Delete Profile Name Validations", + "description": "You can use this API to delete Profile Name Validations.OperationId:deleteProfileNameValidations
", + "operationId": "deleteProfileNameValidations", "parameters": [ { - "name": "profileInactiveReasonsId", - "in": "path", + "name": "profileType", + "in": "query", "required": true, "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of Profile Inactive Reasons." + "description": "Simple Type for Profile Name Validations Type. e.g. Company,Travel Agent,Source.", + "uniqueItems": true, + "enum": [ + "Company", + "TravelAgent", + "Source" + ] }, { - "name": "profileInactiveReasonsToBeChanged", - "in": "body", + "name": "profileName", + "in": "query", "required": true, - "description": "Request object for changing Profile Inactive Reasons.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/profileInactiveReasonsToBeChanged" - } - ] - } + "description": "Name of the Profile.", + "type": "string" }, { "$ref": "#/parameters/authKey" @@ -22583,7 +23828,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" } @@ -22632,22 +23877,26 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "ProfileConfiguration" ] }, - "delete": { - "summary": "Delete Profile Inactive Reasons", - "description": "Use this API to delete Profile Inactive Reasons.OperationId:deleteProfileInactiveReasons
", - "operationId": "deleteProfileInactiveReasons", + "post": { + "summary": "Create Profile Name Validations", + "description": "You can use this API to create Profile Name Validations.OperationId:postProfileNameValidations
", + "operationId": "postProfileNameValidations", "parameters": [ { - "name": "profileInactiveReasonsId", - "in": "path", + "name": "profileNameValidations", + "in": "body", "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of Profile Inactive Reasons." + "description": "Request object to create Profile names.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/profileNameValidations" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -22666,7 +23915,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -22728,18 +23977,25 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "ProfileConfiguration" ] } }, - "/profileNameValidations": { + "/profileRestrictionReasons": { "get": { - "summary": "Get Profile Name Validations", - "description": "You can use this API to get Profile Name Validations.OperationId:getProfileNameValidations
", - "operationId": "getProfileNameValidations", + "summary": "Get Profile Restriction Reasons", + "description": "Use this API to get Profile Restriction Reasons.OperationId:getProfileRestrictionReasons
", + "operationId": "getProfileRestrictionReasons", "parameters": [ { - "name": "typeCodes", + "name": "fetchInactive", + "in": "query", + "required": false, + "description": "Determines wether to fetch inactive records or not.", + "type": "boolean" + }, + { + "name": "codes", "in": "query", "type": "array", "collectionFormat": "multi", @@ -22758,10 +24014,10 @@ "type": "string" }, { - "name": "name", + "name": "description", "in": "query", "required": false, - "description": "Profile Name to be Searched.", + "description": "Description of the code.", "type": "string" }, { @@ -22790,13 +24046,13 @@ "x-example": "en-GB" } }, - "description": "Response for fetching Profile names.", + "description": "Response object for fetching Profile Restriction Reasons.", "schema": { - "$ref": "#/definitions/profileNameValidations" + "$ref": "#/definitions/profileRestrictionReasonsDetails" } }, "204": { - "description": "ProfileNameValidations not found." + "description": "ProfileRestrictionReasons not found." }, "400": { "$ref": "#/responses/400" @@ -22842,23 +24098,23 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" + "ChainConfig" ] }, - "put": { - "summary": "Change Profile Name Validations", - "description": "You can use this API to change Profile Name Validations.OperationId:putProfileNameValidations
", - "operationId": "putProfileNameValidations", + "post": { + "summary": "Create Profile Restriction Reasons", + "description": "Use this API to create Profile Restriction Reasons.OperationId:postProfileRestrictionReasons
", + "operationId": "postProfileRestrictionReasons", "parameters": [ { - "name": "profileNameValidationsToChange", + "name": "profileRestrictionReasonsCriteria", "in": "body", "required": true, - "description": "Request object to edit Profile names.", + "description": "Request object for creating Profile Restriction Reasons.", "schema": { "allOf": [ { - "$ref": "#/definitions/profileNameValidationsToChange" + "$ref": "#/definitions/profileRestrictionReasonsCriteria" } ] } @@ -22880,7 +24136,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -22893,7 +24149,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" } @@ -22942,33 +24198,37 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" + "ChainConfig" ] - }, - "delete": { - "summary": "Delete Profile Name Validations", - "description": "You can use this API to delete Profile Name Validations.OperationId:deleteProfileNameValidations
", - "operationId": "deleteProfileNameValidations", + } + }, + "/profileRestrictionReasons/{profileRestrictionReasonsId}": { + "put": { + "summary": "Change Profile Restriction Reasons", + "description": "Use this API to update Profile Restriction Reasons.OperationId:putProfileRestrictionReasons
", + "operationId": "putProfileRestrictionReasons", "parameters": [ { - "name": "profileType", - "in": "query", + "name": "profileRestrictionReasonsId", + "in": "path", "required": true, "type": "string", - "description": "Simple Type for Profile Name Validations Type. e.g. Company,Travel Agent,Source.", - "uniqueItems": true, - "enum": [ - "Company", - "TravelAgent", - "Source" - ] + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Profile Restriction Reasons." }, { - "name": "profileName", - "in": "query", + "name": "profileRestrictionReasonsToBeChanged", + "in": "body", "required": true, - "description": "Name of the Profile.", - "type": "string" + "description": "Request object for changing Profile Restriction Reasons.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/profileRestrictionReasonsToBeChanged" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -23000,7 +24260,7 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } @@ -23049,26 +24309,22 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" + "ChainConfig" ] }, - "post": { - "summary": "Create Profile Name Validations", - "description": "You can use this API to create Profile Name Validations.OperationId:postProfileNameValidations
", - "operationId": "postProfileNameValidations", + "delete": { + "summary": "Delete Profile Restriction Reasons", + "description": "Use this API to delete Profile Restriction Reasons.OperationId:deleteProfileRestrictionReasons
", + "operationId": "deleteProfileRestrictionReasons", "parameters": [ { - "name": "profileNameValidations", - "in": "body", + "name": "profileRestrictionReasonsId", + "in": "path", "required": true, - "description": "Request object to create Profile names.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/profileNameValidations" - } - ] - } + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of Profile Restriction Reasons." }, { "$ref": "#/parameters/authKey" @@ -23087,7 +24343,7 @@ } ], "responses": { - "201": { + "200": { "headers": { "Content-Language": { "type": "string", @@ -23149,47 +24405,29 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" + "ChainConfig" ] } }, - "/profileRestrictionReasons": { + "/profiles/links": { "get": { - "summary": "Get Profile Restriction Reasons", - "description": "Use this API to get Profile Restriction Reasons.OperationId:getProfileRestrictionReasons
", - "operationId": "getProfileRestrictionReasons", + "summary": "Get profile links", + "description": "You can use this API to get profile links.This API is deprecated. Please use getProfileRelationships instead
OperationId:getProfileLinks
", + "operationId": "getProfileLinks", + "deprecated": true, "parameters": [ { - "name": "fetchInactive", - "in": "query", - "required": false, - "description": "Determines wether to fetch inactive records or not.", - "type": "boolean" - }, - { - "name": "codes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Codes to be searched.", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "wildCard", + "name": "fromType", "in": "query", "required": false, - "description": "Wildcard search on the code.", + "description": "From type to process", "type": "string" }, { - "name": "description", + "name": "toType", "in": "query", "required": false, - "description": "Description of the code.", + "description": "To type to process", "type": "string" }, { @@ -23218,13 +24456,114 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching Profile Restriction Reasons.", + "description": "Respose object for fetch profile links", "schema": { - "$ref": "#/definitions/profileRestrictionReasonsDetails" + "$ref": "#/definitions/profileLinks" } }, "204": { - "description": "ProfileRestrictionReasons not found." + "description": "ProfileLinks 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": [ + "ProfileConfiguration" + ] + }, + "put": { + "summary": "Change profile links", + "description": "You can use this API to change profile links.This API is deprecated. Please use putProfileRelationships instead
OperationId:putProfileLinks
", + "operationId": "putProfileLinks", + "deprecated": true, + "parameters": [ + { + "name": "profileLinks", + "in": "body", + "required": true, + "description": "Request Object for change profile links", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/profileLinks" + } + ] + } + }, + { + "$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" @@ -23270,137 +24609,42 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "ProfileConfiguration" ] }, - "post": { - "summary": "Create Profile Restriction Reasons", - "description": "Use this API to create Profile Restriction Reasons.OperationId:postProfileRestrictionReasons
", - "operationId": "postProfileRestrictionReasons", + "delete": { + "summary": "Delete profile links", + "description": "You can use this API to delete profile links.This API is deprecated. Please use deleteProfileRelationships instead
OperationId:deleteProfileLinks
", + "operationId": "deleteProfileLinks", + "deprecated": true, "parameters": [ { - "name": "profileRestrictionReasonsCriteria", - "in": "body", + "name": "fromType", + "in": "query", "required": true, - "description": "Request object for creating Profile Restriction Reasons.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/profileRestrictionReasonsCriteria" - } - ] - } - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$ref": "#/parameters/x-hotelid" - }, - { - "$ref": "#/parameters/x-externalsystem" + "description": "From type to process", + "type": "string" }, { - "$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" + "name": "toType", + "in": "query", + "required": true, + "description": "To type to process", + "type": "string" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "ChainConfig" - ] - } - }, - "/profileRestrictionReasons/{profileRestrictionReasonsId}": { - "put": { - "summary": "Change Profile Restriction Reasons", - "description": "Use this API to update Profile Restriction Reasons.OperationId:putProfileRestrictionReasons
", - "operationId": "putProfileRestrictionReasons", - "parameters": [ { - "name": "profileRestrictionReasonsId", - "in": "path", + "name": "fromCode", + "in": "query", "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of Profile Restriction Reasons." + "description": "From code to process", + "type": "string" }, { - "name": "profileRestrictionReasonsToBeChanged", - "in": "body", + "name": "toCode", + "in": "query", "required": true, - "description": "Request object for changing Profile Restriction Reasons.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/profileRestrictionReasonsToBeChanged" - } - ] - } + "description": "To code to process", + "type": "string" }, { "$ref": "#/parameters/authKey" @@ -23432,7 +24676,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" } @@ -23481,22 +24725,27 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "ProfileConfiguration" ] }, - "delete": { - "summary": "Delete Profile Restriction Reasons", - "description": "Use this API to delete Profile Restriction Reasons.OperationId:deleteProfileRestrictionReasons
", - "operationId": "deleteProfileRestrictionReasons", + "post": { + "summary": "Create profile links", + "description": "You can use this API to create profile links.This API is deprecated. Please use postProfileRelationships instead
OperationId:postProfileLinks
", + "operationId": "postProfileLinks", + "deprecated": true, "parameters": [ { - "name": "profileRestrictionReasonsId", - "in": "path", + "name": "profileLinks", + "in": "body", "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of Profile Restriction Reasons." + "description": "Request Object to create Profile Links", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/profileLinks" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -23515,7 +24764,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -23577,16 +24826,15 @@ "application/json;charset=UTF-8" ], "tags": [ - "ChainConfig" + "ProfileConfiguration" ] } }, - "/profiles/links": { + "/relationships": { "get": { - "summary": "Get profile links", - "description": "You can use this API to get profile links.This API is deprecated. Please use getProfileRelationships instead
OperationId:getProfileLinks
", - "operationId": "getProfileLinks", - "deprecated": true, + "summary": "Get profile relationships", + "description": "You can use this API to get profile relationships.OperationId:getProfileRelationships
", + "operationId": "getProfileRelationships", "parameters": [ { "name": "fromType", @@ -23634,7 +24882,7 @@ } }, "204": { - "description": "ProfileLinks not found." + "description": "ProfileRelationships not found." }, "400": { "$ref": "#/responses/400" @@ -23684,10 +24932,9 @@ ] }, "put": { - "summary": "Change profile links", - "description": "You can use this API to change profile links.This API is deprecated. Please use putProfileRelationships instead
OperationId:putProfileLinks
", - "operationId": "putProfileLinks", - "deprecated": true, + "summary": "Change profile relationships", + "description": "You can use this API to change profile relationships.OperationId:putProfileRelationships
", + "operationId": "putProfileRelationships", "parameters": [ { "name": "profileLinks", @@ -23785,10 +25032,9 @@ ] }, "delete": { - "summary": "Delete profile links", - "description": "You can use this API to delete profile links.This API is deprecated. Please use deleteProfileRelationships instead
OperationId:deleteProfileLinks
", - "operationId": "deleteProfileLinks", - "deprecated": true, + "summary": "Delete profile relationships", + "description": "You can use this API to delete profile relationships.OperationId:deleteProfileRelationships
", + "operationId": "deleteProfileRelationships", "parameters": [ { "name": "fromType", @@ -23901,10 +25147,9 @@ ] }, "post": { - "summary": "Create profile links", - "description": "You can use this API to create profile links.This API is deprecated. Please use postProfileRelationships instead
OperationId:postProfileLinks
", - "operationId": "postProfileLinks", - "deprecated": true, + "summary": "Create profile relationships", + "description": "You can use this API to create profile relationships.OperationId:postProfileRelationships
", + "operationId": "postProfileRelationships", "parameters": [ { "name": "profileLinks", @@ -24002,26 +25247,12 @@ ] } }, - "/relationships": { + "/services/chainConfig/status": { "get": { - "summary": "Get profile relationships", - "description": "You can use this API to get profile relationships.OperationId:getProfileRelationships
", - "operationId": "getProfileRelationships", + "summary": " ping", + "description": "Ping Chain Configuration ServiceOperationId:pingChainConfigServices
", + "operationId": "pingChainConfigServices", "parameters": [ - { - "name": "fromType", - "in": "query", - "required": false, - "description": "From type to process", - "type": "string" - }, - { - "name": "toType", - "in": "query", - "required": false, - "description": "To type to process", - "type": "string" - }, { "$ref": "#/parameters/authKey" }, @@ -24048,13 +25279,13 @@ "x-example": "en-GB" } }, - "description": "Respose object for fetch profile links", + "description": "Response for Ping operation.", "schema": { - "$ref": "#/definitions/profileLinks" + "$ref": "#/definitions/operaVersion" } }, "204": { - "description": "ProfileRelationships not found." + "description": "pingChainConfigServices not found." }, "400": { "$ref": "#/responses/400" @@ -24100,27 +25331,16 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" + "ChainConfig" ] - }, - "put": { - "summary": "Change profile relationships", - "description": "You can use this API to change profile relationships.OperationId:putProfileRelationships
", - "operationId": "putProfileRelationships", + } + }, + "/services/hotelConfig/status": { + "get": { + "summary": " ping", + "description": "Ping Hotel Configuration ServiceOperationId:pingHotelConfigServices
", + "operationId": "pingHotelConfigServices", "parameters": [ - { - "name": "profileLinks", - "in": "body", - "required": true, - "description": "Request Object for change profile links", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/profileLinks" - } - ] - } - }, { "$ref": "#/parameters/authKey" }, @@ -24145,17 +25365,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": "Response Body.", + "description": "Response for Ping operation.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/operaVersion" } }, + "204": { + "description": "pingHotelConfigServices not found." + }, "400": { "$ref": "#/responses/400" }, @@ -24200,42 +25419,16 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" + "HotelConfig" ] - }, - "delete": { - "summary": "Delete profile relationships", - "description": "You can use this API to delete profile relationships.OperationId:deleteProfileRelationships
", - "operationId": "deleteProfileRelationships", + } + }, + "/services/membershipConfig/status": { + "get": { + "summary": " ping", + "description": "Ping Membership Configuration ServiceOperationId:pingMembershipConfigService
", + "operationId": "pingMembershipConfigService", "parameters": [ - { - "name": "fromType", - "in": "query", - "required": true, - "description": "From type to process", - "type": "string" - }, - { - "name": "toType", - "in": "query", - "required": true, - "description": "To type to process", - "type": "string" - }, - { - "name": "fromCode", - "in": "query", - "required": true, - "description": "From code to process", - "type": "string" - }, - { - "name": "toCode", - "in": "query", - "required": true, - "description": "To code to process", - "type": "string" - }, { "$ref": "#/parameters/authKey" }, @@ -24260,17 +25453,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": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response for Ping operation.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/operaVersion" } }, + "204": { + "description": "pingMembershipConfigService not found." + }, "400": { "$ref": "#/responses/400" }, @@ -24315,27 +25507,16 @@ "application/json;charset=UTF-8" ], "tags": [ - "ProfileConfiguration" + "MembershipConfig" ] - }, - "post": { - "summary": "Create profile relationships", - "description": "You can use this API to create profile relationships.OperationId:postProfileRelationships
", - "operationId": "postProfileRelationships", + } + }, + "/services/profile/status": { + "get": { + "summary": " ping", + "description": "Ping Profile Configuration ServiceOperationId:pingProfileConfigService
", + "operationId": "pingProfileConfigService", "parameters": [ - { - "name": "profileLinks", - "in": "body", - "required": true, - "description": "Request Object to create Profile Links", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/profileLinks" - } - ] - } - }, { "$ref": "#/parameters/authKey" }, @@ -24353,24 +25534,23 @@ } ], "responses": { - "201": { + "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", + "description": "Response for Ping operation.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/operaVersion" } }, + "204": { + "description": "pingProfileConfigService not found." + }, "400": { "$ref": "#/responses/400" }, @@ -27103,6 +28283,9 @@ "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -27233,6 +28416,9 @@ "inactive": { "description": "Indicates the account type is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -27331,6 +28517,9 @@ "canDelete": { "description": "Determines whether this address format can be deleted.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -27375,6 +28564,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -27701,6 +28893,9 @@ "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28117,6 +29312,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28197,6 +29395,9 @@ "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28277,6 +29478,9 @@ "inactive": { "description": "Determines whether this credit rating is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28321,6 +29525,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28397,6 +29604,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28592,6 +29802,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28672,6 +29885,9 @@ "protected": { "description": "Determines whether this code is protected from deleting and making inactive", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28748,6 +29964,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28872,6 +30091,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28948,6 +30170,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29104,6 +30329,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29239,6 +30467,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29319,6 +30550,9 @@ "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29399,6 +30633,9 @@ "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29479,6 +30716,9 @@ "masterSubKeyword": { "description": "Indicates if the KEYWORD TYPE is to be copied from a Company Master to a Company Subsidiary.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29559,6 +30799,9 @@ "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29632,7 +30875,7 @@ "description": "Membership Award Code.", "type": "string", "minLength": 0, - "maxLength": 40 + "maxLength": 20 }, "shortDescription": { "description": "Short description of Award.", @@ -30164,6 +31407,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -30240,6 +31486,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -30326,6 +31575,9 @@ "frequentFlyer": { "description": "This flag indicates whether the membership class is eligible for frequent flyer or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -30386,6 +31638,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -30492,6 +31747,9 @@ "enrollmentCodes": { "description": "Collection of code and description of enrollment codes that are associated to the membership enrollment group.", "$ref": "#/definitions/membershipEnrollmentCodesInfoType" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -31024,6 +32282,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -31327,11 +32588,14 @@ }, "pointsRoundingFlagType": { "type": "string", - "description": "This flag tells if the total amount computed will be rounded, rounded up or rounded down.", + "description": "This flag tells if the total points computed will be rounded based on the rounding option selected.", "enum": [ "Round", "Ceil", - "Floor" + "Floor", + "Roundupnd", + "Rounddownnd", + "Universalroundnd" ] }, "membershipTypeRuleConditionsType": { @@ -31365,7 +32629,7 @@ "description": "Membership Type Rules general Conditions.", "properties": { "reservationChannel": { - "description": "Reservation Channel for which the rule is applied.", + "description": "Reservation Channel for which the rule is applied. This attribute is deprecated would not be used further.", "type": "string", "minLength": 0, "maxLength": 20 @@ -31405,6 +32669,22 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "originCode": { + "description": "Origin Code for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "originGroup": { + "description": "Origin group for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "excludeOriginGroup": { + "description": "To specify the exclusion of origin group while applying rule.", + "type": "boolean" } } }, @@ -31517,6 +32797,22 @@ "excludeMarketGroup": { "description": "To specify the exclusion of market group while applying rule.", "type": "boolean" + }, + "sourceCode": { + "description": "Source Code for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "sourceGroup": { + "description": "Source group for which the rule is applied.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "excludeSourceGroup": { + "description": "To specify the exclusion of source group while applying rule.", + "type": "boolean" } } }, @@ -31683,6 +32979,10 @@ "description": "Membership auto card number generation details.", "$ref": "#/definitions/autoGenerateCardNumberType" }, + "cardNumberAutoGenerateDetailsForOWS": { + "description": "Membership auto card number generation details for OWS.", + "$ref": "#/definitions/autoGenerateCardNumberType" + }, "currency": { "description": "The currency in which user would like to calculate the membership points.", "type": "string", @@ -31846,6 +33146,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -32043,7 +33346,7 @@ "$ref": "#/definitions/calendarPeriodType" }, "expiryPeriod": { - "description": "Membership card expiration period.", + "description": "Membership card expiration period. If no value is provided it will be defaulted to 1 year.", "$ref": "#/definitions/numberOfYearsType" }, "expiryMonth": { @@ -32517,6 +33820,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -32593,6 +33899,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -32673,6 +33982,9 @@ "inactive": { "description": "To configure the different pay days.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -32767,6 +34079,9 @@ "allowSubTypes": { "description": "This is a placeholder element for future use. Functionality may not be available for the current implementation.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -32833,6 +34148,9 @@ "global": { "description": "Specifies whether the preference is to be available for selection at all properties .", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -32929,6 +34247,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -33090,6 +34411,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -33263,6 +34587,9 @@ "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -33351,6 +34678,9 @@ "stateID": { "description": "Unique identifier of the state.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -33415,6 +34745,9 @@ "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -33491,6 +34824,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -33575,6 +34911,9 @@ "ranking": { "description": "AI priority order of this code.", "type": "integer" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -33775,6 +35114,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -33825,6 +35167,170 @@ "$ref": "#/definitions/warningsType" } } + }, + "managedByOptions": { + "description": "Describes of the Configuration is Managed by Enterprise or Property.", + "type": "string", + "enum": [ + "EnterpriseManaged", + "PropertyManaged", + "EnterpriseEnforced", + "PropertyOverridden" + ] + }, + "membershipOriginGroupsDetails": { + "type": "object", + "description": "Response object for fetching Membership Origin Groups configurations.", + "properties": { + "membershipOriginGroups": { + "type": "array", + "maxItems": 4000, + "description": "Collection of Membership Origin Groups configurations.", + "items": { + "$ref": "#/definitions/membershipOriginGroupType" + } + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipOriginGroupDetails": { + "type": "object", + "description": "Request object for adding/changing existing Membership Origin Group Configurations.", + "properties": { + "membershipOriginGroup": { + "description": "Membership Origin Groups Configurations to be changed.", + "$ref": "#/definitions/membershipOriginGroupType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipOriginGroupType": { + "type": "object", + "description": "Details for Membership Origin Group along with associated Origin codes.", + "properties": { + "code": { + "description": "Code is used to identify a Membership Origin Group.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "Description of the Membership Origin Group.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "displaySequence": { + "description": "Membership Origin Groups display sequence Number", + "type": "number" + }, + "originCodes": { + "type": "array", + "description": "Membership Origin code and Description.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/codeDescriptionType" + } + } + } + }, + "membershipSourceGroupsDetails": { + "type": "object", + "description": "Response object for fetching Membership Source Groups configurations.", + "properties": { + "membershipSourceGroups": { + "type": "array", + "maxItems": 4000, + "description": "Collection of Membership Source Groups configurations.", + "items": { + "$ref": "#/definitions/membershipSourceGroupType" + } + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipSourceGroupDetails": { + "type": "object", + "description": "Request object for adding/changing existing Membership Source Group Configurations.", + "properties": { + "membershipSourceGroup": { + "description": "Membership Source Groups Configurations to be changed.", + "$ref": "#/definitions/membershipSourceGroupType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "membershipSourceGroupType": { + "type": "object", + "description": "Details for Membership Source Group along with associated Source codes.", + "properties": { + "code": { + "description": "Code is used to identify a Membership Source Group.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "Description of the Membership Source Group.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "displaySequence": { + "description": "Membership Source Groups display sequence Number", + "type": "number" + }, + "sourceCodes": { + "type": "array", + "description": "Membership Source code and Description.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/codeDescriptionType" + } + } + } + }, + "operaVersionNumberType": { + "type": "string", + "description": "Current Opera Version Number", + "minLength": 0, + "maxLength": 40 + }, + "operaVersion": { + "type": "object", + "description": "Response for Ping operation.", + "properties": { + "operaVersion": { + "description": "Opera version number.", + "$ref": "#/definitions/operaVersionNumberType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/csh.json b/rest-api-specs/property/csh.json index 6df31ad..453d953 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.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", + "description": "APIs to cater for Cashiering related functionality in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -24,7 +24,7 @@ "/cashierReportPostings": { "get": { "summary": "Get Cashier Report Postings", - "description": "You can use this API to get Cashier Report postings.OperationId:getCashierReportPostings
", + "description": "You can use this API to get Cashier Report postings.OperationId:getCashierReportPostings
This API allows a time span of 30 days.
", "operationId": "getCashierReportPostings", "parameters": [ { @@ -723,7 +723,7 @@ "/compAccountingJournal": { "get": { "summary": "Get Comp Accounting Journal", - "description": "You can use this API to get Comp Accounting Journal.This API is deprecated. Please use getCompPostingJournal instead
OperationId:getCompAccountingJournal
", + "description": "You can use this API to get Comp Accounting Journal.This API is deprecated. Please use getCompPostingJournal instead
OperationId:getCompAccountingJournal
The maximum allowable limit for this API is 50.
This API allows a time span of 30 days.
", "operationId": "getCompAccountingJournal", "deprecated": true, "parameters": [ @@ -4114,7 +4114,7 @@ "/hotels/{hotelId}/compAccountingJournal": { "get": { "summary": "Get Comp Accounting Journal", - "description": "You can use this API to get Comp Accounting Journal.OperationId:getCompPostingJournal
", + "description": "You can use this API to get Comp Accounting Journal.OperationId:getCompPostingJournal
The maximum allowable limit for this API is 50.
This API allows a time span of 30 days.
", "operationId": "getCompPostingJournal", "parameters": [ { @@ -4344,7 +4344,7 @@ "/hotels/{hotelId}/compRoutingInstructions": { "get": { "summary": "Get Comp Routing Instructions", - "description": "You can use this API to get Comp Routing Instructions.OperationId:getCompRoutingInstructions
", + "description": "You can use this API to get Comp Routing Instructions.OperationId:getCompRoutingInstructions
This API allows a time span of 30 days.
", "operationId": "getCompRoutingInstructions", "parameters": [ { @@ -6570,7 +6570,7 @@ "/hotels/{hotelId}/financialPostings": { "get": { "summary": "Get Financial Postings", - "description": "You can use this API to get Financial postings.OperationId:getFinancialPostings
", + "description": "You can use this API to get Financial postings.OperationId:getFinancialPostings
The maximum allowable limit for this API is 50.
This API allows a time span of 30 days.
", "operationId": "getFinancialPostings", "parameters": [ { @@ -6968,7 +6968,7 @@ "/hotels/{hotelId}/financialPostingsNetVat": { "get": { "summary": "Get Financial Postings with breakdown", - "description": "You can use this API to get Financial postings with Net and Vat breakdown.OperationId:financialPostingsNetVat
", + "description": "You can use this API to get Financial postings with Net and Vat breakdown.OperationId:financialPostingsNetVat
The maximum allowable limit for this API is 50.
", "operationId": "getFinancialPostingsNetVat", "parameters": [ { @@ -7782,7 +7782,7 @@ "/hotels/{hotelId}/fiscalSupportingDocuments": { "get": { "summary": "Get supporting documents details.", - "description": "This API is used to get the list of supporting documents for the reservations.OperationId:getSupportingDocuments
", + "description": "This API is used to get the list of supporting documents for the reservations.OperationId:getSupportingDocuments
The maximum allowable limit for this API is 20.
", "operationId": "getFiscalSupportingDocuments", "parameters": [ { @@ -11268,7 +11268,7 @@ "/hotels/{hotelId}/receiptHistory": { "get": { "summary": "Get Receipt History", - "description": "You can use this API to get Receipt History.OperationId:getReceiptHistory
", + "description": "You can use this API to get Receipt History.OperationId:getReceiptHistory
This API allows a time span of 30 days.
", "operationId": "getReceiptHistory", "parameters": [ { @@ -17394,7 +17394,7 @@ "/hotels/{hotelId}/reservations/{reservationId}/folios": { "get": { "summary": "Get folios", - "description": "This API is used to fetch the folios for a given reservation. A guest reservation could have 1 or more folios per reservation. Folios will only exist for a reservation once the guest has checked into the hotel.OperationId:getFolio
", + "description": "This API is used to fetch the folios for a given reservation. A guest reservation could have 1 or more folios per reservation. Folios will only exist for a reservation once the guest has checked into the hotel.OperationId:getFolio
This API allows a time span of 30 days.
", "operationId": "getFolio", "parameters": [ { @@ -19632,6 +19632,126 @@ ] } }, + "/hotels/{hotelId}/reservations/{reservationId}/proformaFolio": { + "post": { + "summary": "Create proforma", + "description": "API to create Pro-Forma for a specific reservation for external partners.OperationId:postProformaFolio
OperationId:postProformaFolio
", + "operationId": "postProformaFolio", + "parameters": [ + { + "name": "reservationId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the reservation" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel" + }, + { + "name": "reservationFolio", + "in": "body", + "required": true, + "description": "Request to create a Pro-Forma(folio) transactions for a reservation for external partners via OHIP domain. The request generates the internal transactions required to create a Pro-Forma folio, pass it into the response and finally remove/cleanup these transactions", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/proformaReservationFolio" + } + ] + } + }, + { + "$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": "Response for the Create Proforma WS.", + "schema": { + "$ref": "#/definitions/proformaFolio" + } + }, + "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": [ + "Cashiering" + ] + } + }, "/hotels/{hotelId}/reservations/{reservationId}/revenueBuckets": { "get": { "summary": "Get Reservations Revenue Bucket Totals", @@ -19889,7 +20009,7 @@ "/hotels/{hotelId}/reservations/{reservationId}/routingInstructions": { "get": { "summary": "Get routing instructions", - "description": "You can use this API to retrieve routing instructions for a specified reservation.OperationId:getRoutingInstructions
", + "description": "You can use this API to retrieve routing instructions for a specified reservation.OperationId:getRoutingInstructions
The maximum allowable limit for this API is 20.
", "operationId": "getRoutingInstructions", "parameters": [ { @@ -24272,7 +24392,7 @@ "/hotels/{hotelId}/transactions": { "get": { "summary": "Get Guests Transactions", - "description": "You can use this API to get Guests Transactions.OperationId:getGuestsTransactions
", + "description": "You can use this API to get Guests Transactions.OperationId:getGuestsTransactions
This API allows a time span of 30 days.
", "operationId": "getGuestsTransactions", "parameters": [ { @@ -25738,7 +25858,7 @@ "/hotels/{hotelId}/transactions/{transactionId}/payments": { "put": { "summary": "Change Billing Payment", - "description": "You can use this API to change Billing Payment.OperationId:changeBillingPayment
", + "description": "This API can be used to update a posted payment with additional reference, supplement, covers, and checknumber values.OperationId:changeBillingPayment
", "operationId": "changeBillingPayment", "parameters": [ { @@ -28331,6 +28451,12 @@ "type": "string", "minLength": 0, "maxLength": 10 + }, + "proformaFlag": { + "description": "This flag indicates if it is a proforma posted transaction.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, @@ -28810,6 +28936,10 @@ "type": "string", "minLength": 0, "maxLength": 40 + }, + "payeeInternalFolio": { + "description": "Flag considered during folio settlement, to select the corresponding Folio Type when the value is true. Only used in Poland country mode.", + "type": "boolean" } } }, @@ -29060,6 +29190,12 @@ "$ref": "#/definitions/articleInfoType" } }, + "otaTaxType": { + "description": "Open Travel Alliance(OTA) tax type for the given transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, "trxServiceType": { "description": "Contains service type for transaction code.", "type": "string", @@ -30678,6 +30814,18 @@ }, "cashierId": { "$ref": "#/definitions/cashierId" + }, + "originalInvoice": { + "description": "User-defined original invoice number.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "invoiceType": { + "description": "Type of invoice specified in the originalInvoice field.", + "type": "string", + "minLength": 0, + "maxLength": 10 } } }, @@ -33327,6 +33475,10 @@ "description": "The Original Time Span covers the Room Stay dates of the original reservation.", "$ref": "#/definitions/timeSpanType" }, + "bookingTimeSpan": { + "description": "The booking time span of the reservation, only applicable when time increments are being used.", + "$ref": "#/definitions/bookingTimeSpanType" + }, "expectedTimes": { "description": "The expected arrival, return and departure times of the guest.", "$ref": "#/definitions/resExpectedTimesType" @@ -33488,6 +33640,16 @@ "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" + }, + "backToBack": { + "description": "This attribute indicates if the linked reservation is marked as Back to Back or not.", + "type": "boolean" + }, + "backToBackGroupId": { + "description": "This attribute represents a common identifier for a subgroup of linked reservations marked as Back to Back in a group of linked reservations.", + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, @@ -36637,7 +36799,8 @@ "CurrencyExchangeCash", "DepositRequest", "DepositRefundReceipt", - "Acknowledgement" + "Acknowledgement", + "ARPayment" ] }, "projectedRevenueType": { @@ -42834,6 +42997,18 @@ "fiscalTerminalId": { "description": "Applicable for Fiscal Terminal. The ID of the terminal where the fiscal device is connected.", "type": "string" + }, + "originalInvoice": { + "description": "User-defined original invoice number.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "invoiceType": { + "description": "Type of invoice specified in the originalInvoice field.", + "type": "string", + "minLength": 0, + "maxLength": 10 } } }, @@ -46685,6 +46860,76 @@ "type": "integer" } } + }, + "bookingTimeSpanType": { + "type": "object", + "description": "The booking time span of the reservation, only applicable when time increments are being used.", + "properties": { + "startDateTime": { + "type": "string", + "description": "The start time of the reservation booking", + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "description": "The end time of the reservation booking", + "format": "date-time" + } + } + }, + "createProformaFolioCriteriaType": { + "type": "object", + "description": "Criteria for creating Pro-Forma transactions for a reservation. These transactions will be used by the Opera Proforma Report.", + "properties": { + "proformaResponseInstruction": { + "description": "Response instructions for the Pro-Forma transactions creation. Possible values are None or Folio Summary. A Summary of the Proforma Folio can be returned, if requested.", + "$ref": "#/definitions/proformaFolioResponseInstructionType" + } + } + }, + "proformaFolioResponseInstructionType": { + "type": "string", + "description": "Response instructions for Proforma Folio Creation.", + "enum": [ + "Summary", + "Details" + ] + }, + "proformaReservationFolio": { + "type": "object", + "description": "Request to create a Pro-Forma(folio) transactions for a reservation. The request generates the internal transactions required to create a Pro-Forma folio, pass it into the response and finally remove/cleanup these transactions.", + "properties": { + "criteria": { + "description": "Criteria to create a Proforma for a reservation.", + "$ref": "#/definitions/createProformaFolioCriteriaType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "proformaFolio": { + "type": "object", + "description": "Response for the Create Proforma WS. The proforma is created by this request, passed into the response and finally the proforma transactions are removed.", + "properties": { + "reservationFolioInformation": { + "description": "This type will return a detailed Proforma Folio information in the response.", + "$ref": "#/definitions/reservationFolioInfoType" + }, + "trxCodesInfo": { + "description": "Transaction codes information which are in response postings.", + "$ref": "#/definitions/trxCodesInfoType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/dvm.json b/rest-api-specs/property/dvm.json index 05fdaeb..11c5dbd 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 operaThis 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", + "description": "APIs which offer external systems to config and use values different than what are configured in operaThis 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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -596,6 +596,94 @@ "DataValueMapping" ] } + }, + "/services/datavaluemapping/status": { + "get": { + "summary": "ping Data Value Mapping Service", + "description": "ping Data Value Mapping ServiceOperationId:pingDataValueMappingService
", + "operationId": "pingDataValueMappingService", + "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" + } + }, + "description": "Response for Ping operation.", + "schema": { + "$ref": "#/definitions/operaVersion" + } + }, + "204": { + "description": "pingDataValueMappingService 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": [ + "DataValueMapping" + ] + } } }, "parameters": { @@ -1242,6 +1330,22 @@ "$ref": "#/definitions/links" } } + }, + "operaVersion": { + "type": "object", + "description": "Response for Ping operation.", + "properties": { + "operaVersion": { + "description": "Current Opera Version Number", + "type": "string" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/entcfg.json b/rest-api-specs/property/entcfg.json index 92d4a76..b7a7b28 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.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", + "description": "APIs to cater for Enterprise Configuration functionality in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -2948,7 +2948,7 @@ "/configurations/activityLogs": { "get": { "summary": "Get Configuration Activity Logs", - "description": "Use this API to Fetch Configuration Activity logs from Activity Group or Type.OperationId:getConfigActivityLog
", + "description": "Use this API to Fetch Configuration Activity logs from Activity Group or Type.OperationId:getConfigActivityLog
The maximum allowable limit for this API is 20.
This API allows a time span of 4 days.
", "operationId": "getConfigActivityLog", "parameters": [ { @@ -7648,7 +7648,7 @@ "/flexFields": { "get": { "summary": "Operation to fetch flex fields.", - "description": "API to fetch flex fields.OperationId:getFlexFields
", + "description": "API to fetch flex fields.OperationId:getFlexFields
The maximum allowable limit for this API is 50.
", "operationId": "getFlexFields", "parameters": [ { @@ -15327,7 +15327,7 @@ "/hotels/{hotelId}/countries": { "get": { "summary": "Get Countries", - "description": "Use this API to get Countries.OperationId:getCountries
", + "description": "Use this API to get Countries.OperationId:getCountries
The maximum allowable limit for this API is 20.
", "operationId": "getCountries", "parameters": [ { @@ -21478,7 +21478,7 @@ "/hotels/{hotelId}/marketingCities": { "get": { "summary": "Get resort marketing cities", - "description": "Use this API to get resort marketing cities.OperationId:getMarketingCities
", + "description": "Use this API to get resort marketing cities.OperationId:getMarketingCities
The maximum allowable limit for this API is 20.
", "operationId": "getMarketingCities", "parameters": [ { @@ -33283,6 +33283,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -33717,6 +33720,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -34056,6 +34062,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -34285,6 +34294,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -34361,6 +34373,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -34437,6 +34452,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -34513,6 +34531,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -34641,6 +34662,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -34701,6 +34725,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -34793,6 +34820,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -35185,6 +35215,9 @@ "type": "string", "minLength": 0, "maxLength": 2000 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -35277,6 +35310,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -45218,6 +45254,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -45284,6 +45323,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -47645,6 +47687,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -47994,6 +48039,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -48293,6 +48341,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -48369,6 +48420,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -48445,6 +48499,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -48521,6 +48578,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -48839,6 +48899,9 @@ "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -49559,6 +49622,16 @@ "maxLength": 2000 } } + }, + "managedByOptions": { + "description": "Describes of the Configuration is Managed by Enterprise or Property.", + "type": "string", + "enum": [ + "EnterpriseManaged", + "PropertyManaged", + "EnterpriseEnforced", + "PropertyOverridden" + ] } }, "tags": [ diff --git a/rest-api-specs/property/evm.json b/rest-api-specs/property/evm.json index 0e99d8c..2a4b811 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.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", + "description": "APIs to cater for Event Management functionality in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -891,7 +891,7 @@ }, "get": { "summary": "Get Catering packages ", - "description": "Retrieve the cateringPackages on the blockOperationId:getCateringPackages
", + "description": "Retrieve the cateringPackages on the blockOperationId:getCateringPackages
The maximum allowable limit for this API is 25.
", "operationId": "getCateringPackages", "parameters": [ { @@ -7114,7 +7114,7 @@ "/eventcalendar": { "get": { "summary": "Get the event calendar for Multiple Properties", - "description": "You will be able to retrieve all events on the calendar for a specified property. Narrow the results down by using the available parameters, such as Event Status, Event eventStartDate date, Location, Number of Attendees and so on.OperationId:getEventCalendarMultipleHotelIds
", + "description": "You will be able to retrieve all events on the calendar for a specified property. Narrow the results down by using the available parameters, such as Event Status, Event eventStartDate date, Location, Number of Attendees and so on.OperationId:getEventCalendarMultipleHotelIds
This API allows a time span of 21 days.
", "operationId": "getEventCalendarMultipleHotelIds", "parameters": [ { @@ -8986,7 +8986,7 @@ "/events/{eventId}/splitQuantity": { "get": { "summary": "Get Event item split quantity", - "description": "Retrieve the event item split quantity for an event.OperationId:getEventItemSplitQuantity
", + "description": "Retrieve the event item split quantity for an event.OperationId:getEventItemSplitQuantity
This API allows a time span of 1 days.
", "operationId": "getEventItemSplitQuantity", "parameters": [ { @@ -10689,7 +10689,7 @@ "/hotels/{hotelId}/cateringEventChanges": { "get": { "summary": "Get Catering Event changes", - "description": "Retrieve the catering event changes on an event.OperationId:getCateringEventChanges
", + "description": "Retrieve the catering event changes on an event.OperationId:getCateringEventChanges
The maximum allowable limit for this API is 20.
This API allows a time span of 90 days.
", "operationId": "getCateringEventChanges", "parameters": [ { @@ -10997,7 +10997,7 @@ "/hotels/{hotelId}/eventcalendar": { "get": { "summary": "Get the event calendar", - "description": "You will be able to retrieve all events on the calendar for a specified property. Narrow the results down by using the available parameters, such as Event Status, Event eventStartDate date, Location, Number of Attendees and so on.OperationId:getEventCalendar
", + "description": "You will be able to retrieve all events on the calendar for a specified property. Narrow the results down by using the available parameters, such as Event Status, Event eventStartDate date, Location, Number of Attendees and so on.OperationId:getEventCalendar
This API allows a time span of 21 days.
", "operationId": "getEventCalendar", "parameters": [ { @@ -14607,7 +14607,7 @@ "/hotels/{hotelId}/functionalSpace": { "get": { "summary": "Get hotel's function space availability", - "description": "Find the availability of a properties function space.OperationId:getFunctionSpaceAvailability
", + "description": "Find the availability of a properties function space.OperationId:getFunctionSpaceAvailability
This API allows a time span of 21 days.
", "operationId": "getFunctionSpaceAvailability", "parameters": [ { @@ -14957,7 +14957,7 @@ "/hotels/{hotelId}/functionalSpaceEvents": { "get": { "summary": "Get shared function space events", - "description": "This API will allow you to see if events are booked into the same space at the same or overlapping time.OperationId:getSharedFunctionSpaceEvents
", + "description": "This API will allow you to see if events are booked into the same space at the same or overlapping time.OperationId:getSharedFunctionSpaceEvents
This API allows a time span of 21 days.
", "operationId": "getSharedFunctionSpaceEvents", "parameters": [ { @@ -15075,7 +15075,7 @@ "/hotels/{hotelId}/waitListedEvents": { "get": { "summary": "Retreve Waitlisted Events ", - "description": "Search for waitlisted events for a specified property. You can narrow down the results by using filters in the request.OperationId:getWaitlistedEvents
", + "description": "Search for waitlisted events for a specified property. You can narrow down the results by using filters in the request.OperationId:getWaitlistedEvents
This API allows a time span of 21 days.
", "operationId": "getWaitlistedEvents", "parameters": [ { @@ -19467,39 +19467,48 @@ "properties": { "expected": { "description": "Number of expected attendees for the catering event.", - "type": "integer" + "type": "integer", + "minimum": 0 }, "guaranteed": { "description": "Number of guaranteed attendees for the catering event.", - "type": "integer" + "type": "integer", + "minimum": 0 }, "actual": { "description": "Number of actual attendees attending to the catering event.", - "type": "integer" + "type": "integer", + "minimum": 0 }, "set": { "description": "Setup for number of event attendees for resources (i.e. water, pads, tables, etc.).", - "type": "integer" + "type": "integer", + "minimum": 0 }, "billed": { "description": "This defines the count of billed attendees with respect to the menu.", - "type": "integer" + "type": "integer", + "minimum": 0 }, "packageExpected": { "description": "Number of package expected attendees for the catering event.", - "type": "integer" + "type": "integer", + "minimum": 0 }, "packageGuaranteed": { "description": "Number of package guaranteed attendees for the catering event.", - "type": "integer" + "type": "integer", + "minimum": 0 }, "packageActual": { "description": "Number of actual package attendees attending the catering event.", - "type": "integer" + "type": "integer", + "minimum": 0 }, "packageBilled": { "description": "This defines the count of package billed attendees with respect to the menu.", - "type": "integer" + "type": "integer", + "minimum": 0 } } }, @@ -36854,6 +36863,210 @@ "maxLength": 50 } } + }, + "resourceEvents": { + "type": "object", + "description": "Response object for fetching events.", + "properties": { + "resourceEventsSummaries": { + "description": "Events matching the search criteria.", + "$ref": "#/definitions/resourceEventsSummariesInfoType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "resourceEventsSummariesInfoType": { + "type": "object", + "description": "Collection of events.", + "properties": { + "resourceEventSummary": { + "description": "Contains resource events summary information", + "type": "array", + "maxItems": 200, + "items": { + "$ref": "#/definitions/resourceEventSummaryInfoType" + } + }, + "blockId": { + "description": "Block ID for which the details are requested", + "$ref": "#/definitions/uniqueID_Type" + } + } + }, + "resourceEventSummaryInfoType": { + "type": "object", + "description": "Contains information about an event.", + "properties": { + "eventId": { + "description": "Unique identifier of the event.", + "$ref": "#/definitions/eventId" + }, + "eventName": { + "description": "Name of event.", + "$ref": "#/definitions/translationTextType60" + }, + "eventType": { + "description": "Type of event.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "eventTimeSpan": { + "description": "Pertain event duration from eventStartDate and eventEndDate date and time.", + "$ref": "#/definitions/dateTimeSpanType" + }, + "eventStatus": { + "description": "Status details of the Event.", + "$ref": "#/definitions/bookingStatusType" + }, + "packageId": { + "description": "Package Id of the Event.", + "type": "number" + }, + "masterEvent": { + "description": "Indicates whether event is master event.", + "type": "boolean" + }, + "subEvent": { + "description": "Flag to indicate if the event is a sub event.", + "type": "boolean" + }, + "alternateEvent": { + "description": "Flag to indicate if the event is an alternate event.", + "type": "boolean" + }, + "room": { + "description": "Room code of the function space.", + "type": "string" + } + } + }, + "transactionActionEnumType": { + "type": "string", + "enum": [ + "CREATE", + "UPDATE", + "DELETE" + ] + }, + "rESTPaginationGroup": { + "type": "object", + "description": "Provides Pagination Information for the REST API.", + "properties": { + "offset": { + "description": "Indicates the index of the next applicable set(page).", + "type": "integer" + }, + "limit": { + "description": "Indicates number of records the API can return as per the API request limit sent. A maximum of 200 records can be only returned at a time.", + "type": "integer" + }, + "count": { + "description": "Indicates number of records the API has returned actually as per the API request criteria.", + "type": "integer" + }, + "hasMore": { + "description": "Indicates whether there are more records available to be returned as per the API request criteria or not.", + "type": "boolean" + }, + "totalResults": { + "description": "Indicates total number of records available that can be returned as per the API request criteria.", + "type": "integer" + } + } + }, + "eventChangesByDateTimeSummaryType": { + "description": "Event information for changed events by date time", + "type": "object", + "properties": { + "hotelId": { + "description": "The hotel code for changed event by date time.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "blockId": { + "description": "Specifies the Block ID for the changed event by date time.", + "$ref": "#/definitions/blockId" + }, + "eventId": { + "description": "Unique identifier of the changed event by date time.", + "$ref": "#/definitions/eventId" + }, + "startDate": { + "description": "The start date for changed event by date time.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "endDate": { + "description": "The end date for changed event by date time.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "eventStatus": { + "description": "Status of the event.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "lastChangeDateTime": { + "description": "Last change date and time for this event.", + "type": "string", + "format": "date-time" + }, + "actionType": { + "type": "string", + "description": "Action performed on the Catering Event - CREATE, UPDATE, DELETE. When event is created/updated/deleted, then CREATE/UPDATE/DELETE will be set to actionType.", + "$ref": "#/definitions/transactionActionEnumType" + } + } + }, + "eventChangesByDateTimeSummary": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/rESTPaginationGroup" + } + ], + "properties": { + "eventList": { + "description": "Collection of Catering Event changes by date and time.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/eventChangesByDateTimeSummaryType" + } + } + } + }, + "operaVersionNumberType": { + "type": "string", + "description": "Current Opera Version Number", + "minLength": 0, + "maxLength": 40 + }, + "pingDetail": { + "type": "object", + "description": "Response for Ping operation.", + "properties": { + "operaVersion": { + "description": "Opera version number.", + "$ref": "#/definitions/operaVersionNumberType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/evmcfg.json b/rest-api-specs/property/evmcfg.json index de0a7b6..64726a8 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.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", + "description": "This API caters for Event Configuration in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -2313,7 +2313,7 @@ "/cateringPackages": { "get": { "summary": "Fetch catering packages", - "description": "Fetch existing Catering Packages.OperationId:getCateringPackagesMultiProperties
", + "description": "Fetch existing Catering Packages.OperationId:getCateringPackagesMultiProperties
The maximum allowable limit for this API is 25.
This API allows a time span of 90 days.
", "operationId": "getCateringPackagesMultiProperties", "parameters": [ { @@ -5450,7 +5450,7 @@ "/functionspaces/{functionSpaceCode}": { "get": { "summary": "Get Function space ", - "description": "Retrieve detailed information on function spaces, for example Meeting Room.OperationId:getFunctionSpace
", + "description": "Retrieve detailed information on function spaces, for example Meeting Room.OperationId:getFunctionSpace
The maximum allowable limit for this API is 25.
", "operationId": "getFunctionSpace", "parameters": [ { @@ -5604,7 +5604,7 @@ "/hotels/{hotelId}/cateringMenuClasses": { "get": { "summary": "Get menu classes", - "description": "Get menu classes for a property.OperationId:getCateringMenuClasses
", + "description": "Get menu classes for a property.OperationId:getCateringMenuClasses
The maximum allowable limit for this API is 25.
", "operationId": "getCateringMenuClasses", "parameters": [ { @@ -5744,7 +5744,7 @@ "/hotels/{hotelId}/cateringMenuItemClasses": { "get": { "summary": "Get menu item classes", - "description": "Get menu item classes for a property.OperationId:getCateringMenuItemClasses
", + "description": "Get menu item classes for a property.OperationId:getCateringMenuItemClasses
The maximum allowable limit for this API is 25.
", "operationId": "getCateringMenuItemClasses", "parameters": [ { @@ -5901,7 +5901,7 @@ "/hotels/{hotelId}/cateringMenuItems": { "get": { "summary": "Get Menu items", - "description": "Get Menu items for a property.OperationId:getCateringMenuItems
", + "description": "Get Menu items for a property.OperationId:getCateringMenuItems
The maximum allowable limit for this API is 200.
", "operationId": "getCateringMenuItems", "parameters": [ { @@ -6529,7 +6529,7 @@ "/hotels/{hotelId}/cateringMenus": { "get": { "summary": "Get menus", - "description": "Retrieve a list of menus for a property.OperationId:getCateringMenus
", + "description": "Retrieve a list of menus for a property.OperationId:getCateringMenus
The maximum allowable limit for this API is 200.
This API allows a time span of 90 days.
", "operationId": "getCateringMenus", "parameters": [ { @@ -7361,7 +7361,7 @@ "/hotels/{hotelId}/cateringPackages": { "get": { "summary": "Fetch catering packages for a property.", - "description": "Fetch existing Catering Packages for a property.OperationId:getCateringPackages
", + "description": "Fetch existing Catering Packages for a property.OperationId:getCateringPackages
The maximum allowable limit for this API is 25.
", "operationId": "getCateringPackages", "parameters": [ { @@ -8072,6 +8072,255 @@ ] } }, + "/hotels/{hotelId}/cateringPackages/{cateringPackageId}/copy": { + "post": { + "summary": "Operation to copy catering package or template.", + "description": "Use this API to copy catering package or template.OperationId:copyCateringPackage
", + "operationId": "copyCateringPackage", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Unique OPERA Hotel code." + }, + { + "name": "cateringPackageId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 38, + "description": "Unique Catering Package or Template ID." + }, + { + "name": "copyCateringPackageType", + "in": "body", + "required": true, + "description": "Request object for Copying Catering Package/Template.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/copyCateringPackageType" + } + ] + } + }, + { + "$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": "Response object of newly copied resource or configuration code.", + "schema": { + "$ref": "#/definitions/resourceCodeInfo" + } + }, + "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": [ + "ResourceConfig" + ] + } + }, + "/hotels/{hotelId}/cateringPackages/{cateringPackageId}/prices/{pricesId}/copy": { + "post": { + "summary": "Operation to copy catering package price.", + "description": "Use this API to copy catering package price.OperationId:copyCateringPackagePrice
", + "operationId": "copyCateringPackagePrice", + "parameters": [ + { + "name": "pricesId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 38, + "description": "Unique Catering Package Prices ID" + }, + { + "name": "cateringPackageId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 38, + "description": "Unique Catering Package ID." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Unique OPERA Hotel ID" + }, + { + "name": "copyCateringPackagePriceType", + "in": "body", + "required": true, + "description": "Request object for Copying Catering Package Price.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/copyCateringPackagePriceType" + } + ] + } + }, + { + "$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": "Response object of newly copied resource or configuration code.", + "schema": { + "$ref": "#/definitions/resourceCodeInfo" + } + }, + "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": [ + "ResourceConfig" + ] + } + }, "/hotels/{hotelId}/courses/{coursesId}/menuMultiCourses": { "delete": { "summary": "Remove menu multi courses", @@ -8215,7 +8464,7 @@ "/hotels/{hotelId}/dailyInventoryItems": { "get": { "summary": "Get Daily Item Inventory", - "description": "Retrieve a list of Daily Item Inventories that exist for a property. Examples of Item Inventory in a property could be Crib, Roll Away beds, Microwave etc. API will fetch daily quantity configured for the particular item.OperationId:getDailyInventoryItems
", + "description": "Retrieve a list of Daily Item Inventories that exist for a property. Examples of Item Inventory in a property could be Crib, Roll Away beds, Microwave etc. API will fetch daily quantity configured for the particular item.OperationId:getDailyInventoryItems
This API allows a time span of 7 days.
", "operationId": "getDailyInventoryItems", "parameters": [ { @@ -8945,7 +9194,7 @@ "/hotels/{hotelId}/eventForecasts": { "get": { "summary": "Get Event Forecasts", - "description": "This API will allow you to retrieve all Event Forecast for a property.OperationId:getEventForecasts
", + "description": "This API will allow you to retrieve all Event Forecast for a property.OperationId:getEventForecasts
The maximum allowable limit for this API is 200.
", "operationId": "getEventForecasts", "parameters": [ { @@ -9939,7 +10188,7 @@ "/hotels/{hotelId}/inventoryItems": { "get": { "summary": "Get Item Inventory", - "description": "Retrieve a list of Item Inventories that exist for a property. Examples of Item Inventory in a property could be Crib, Roll Away beds, Microwave etc. There is typically a quantity configured for each item, such as 5 Roll Away beds.OperationId:getInventoryItems
", + "description": "Retrieve a list of Item Inventories that exist for a property. Examples of Item Inventory in a property could be Crib, Roll Away beds, Microwave etc. There is typically a quantity configured for each item, such as 5 Roll Away beds.OperationId:getInventoryItems
The maximum allowable limit for this API is 200.
This API allows a time span of 7 days.
", "operationId": "getInventoryItems", "parameters": [ { @@ -11226,7 +11475,7 @@ "/hotels/{hotelId}/roomPools": { "get": { "summary": "Fetch Room Type Pool", - "description": "This API allows you to Use this API to get Room Type Pool and the associated Room Types.OperationId:getRoomTypePool
", + "description": "This API allows you to Use this API to get Room Type Pool and the associated Room Types.OperationId:getRoomTypePool
The maximum allowable limit for this API is 25.
", "operationId": "getRoomTypePool", "parameters": [ { @@ -17401,6 +17650,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -20115,6 +20367,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -20325,6 +20580,72 @@ "$ref": "#/definitions/warningsType" } } + }, + "managedByOptions": { + "description": "Describes of the Configuration is Managed by Enterprise or Property.", + "type": "string", + "enum": [ + "EnterpriseManaged", + "PropertyManaged", + "EnterpriseEnforced", + "PropertyOverriden" + ] + }, + "resourceCodeInfo": { + "type": "object", + "description": "Response object of newly copied resource or configuration code.", + "properties": { + "resourceCode": { + "description": "Newly copied resource or configuration code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "copyCateringPackageType": { + "type": "object", + "description": "Request object for Copying Catering Package/Template.", + "properties": { + "code": { + "description": "Code associated with the newly copied Catering Package/template.", + "type": "string", + "minLength": 0, + "maxLength": 10 + }, + "translatableDescription": { + "description": "Description of the the newly copied Catering Package/template.", + "$ref": "#/definitions/translationTextType200" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "copyCateringPackagePriceType": { + "type": "object", + "description": "Request object for Copying Catering Package Price.", + "properties": { + "code": { + "description": "Code associated with the newly copied Catering Package Price.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "translatableDescription": { + "description": "Description of the newly copied Catering Package Price.", + "$ref": "#/definitions/translationTextType200" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/expcfg.json b/rest-api-specs/property/expcfg.json index 2ab264d..4ce8278 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.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", + "description": "APIs catering to the managing export master data configuration.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -1234,7 +1234,7 @@ "/hotels/{hotelId}/exportActivityLog": { "get": { "summary": "Operation to fetch activity logs for Export Data.", - "description": "Use this API to return activity logs for export data for a specific property based on search criteria such as hotelId, activityType, fromDate, toDate, limit, offset, module, parameterName, parameterValue, activityGroup, searchText, userByIds, userForIds.OperationId:getExportActivityLog
", + "description": "Use this API to return activity logs for export data for a specific property based on search criteria such as hotelId, activityType, fromDate, toDate, limit, offset, module, parameterName, parameterValue, activityGroup, searchText, userByIds, userForIds.OperationId:getExportActivityLog
The maximum allowable limit for this API is 25.
", "operationId": "getExportActivityLog", "parameters": [ { @@ -2593,7 +2593,7 @@ "/{exportFileId}/generatedExports": { "get": { "summary": "Operation to fetch exports generated.", - "description": "OperationId:getExportsGenerated
", + "description": "OperationId:getExportsGenerated
The maximum allowable limit for this API is 25.
", "operationId": "getExportsGenerated", "parameters": [ { diff --git a/rest-api-specs/property/fof.json b/rest-api-specs/property/fof.json index d031cf8..83d6e24 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.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", + "description": "APIs to cater for Front Desk Operations and Front Desk Statistic functionality in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -300,7 +300,7 @@ "/hotels/{hotelId}/bankAccounts/{bankAccountId}/agents/{agentId}/reservationsForCommissions": { "get": { "summary": "Operation to fetch Reservations for Commissions associated to a Travel Agent", - "description": "OperationId:getReservationsForCommissions
", + "description": "OperationId:getReservationsForCommissions
The maximum allowable limit for this API is 50.
", "operationId": "getReservationsForCommissions", "parameters": [ { @@ -1258,7 +1258,7 @@ "/hotels/{hotelId}/billingReservations": { "get": { "summary": "Get Reservations for billing", - "description": "You can use this API to fetch the reservations for billing.OperationId:getReservationsForBilling
", + "description": "You can use this API to fetch the reservations for billing.OperationId:getReservationsForBilling
This API allows a time span of 50 days.
", "operationId": "getReservationsForBilling", "parameters": [ { @@ -5356,7 +5356,8 @@ "RoomStatus", "Turndown", "VIPGuests", - "CompRouting" + "CompRouting", + "RoomMoveStatistics" ] }, { @@ -5538,7 +5539,17 @@ "StagedCompPostings", "DeclinedCompPostings", "CompRoutingInstructionsRequests", - "WalkInVIP" + "WalkInVIP", + "CompletedRoomMoves", + "PendingRoomMoves", + "AdultsArrivals", + "ChildrenArrivals", + "Children1Arrivals", + "Children2Arrivals", + "Children3Arrivals", + "Children1InHouse", + "Children2InHouse", + "Children3InHouse" ] }, "required": false @@ -5694,7 +5705,7 @@ "/hotels/{hotelId}/frontOfficeStatisticsRange/{statisticsCode}": { "get": { "summary": "Get front office Statistics", - "description": "This API is useful to retrieve statistics regarding front office operationsOperationId:getFrontOfficeStatisticsWithDateRange
", + "description": "This API is useful to retrieve statistics regarding front office operationsOperationId:getFrontOfficeStatisticsWithDateRange
This API allows a time span of 7 days.
", "operationId": "getFrontOfficeStatisticsWithDateRange", "parameters": [ { @@ -5704,7 +5715,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Below are the Statistics Code mapping for valid metric code.ReservationActivityDaily:
AdultsInHouse,ChildrenInHouse,ArrivalsTotal,TurndownRequired,DeparturesTotal,MaxOccupancyPercentage,Stayover,TotalRoomsReserved;", + "description": "Below are the Statistics Code mapping for valid metric code.ReservationActivityDaily:
AdultsInHouse,ChildrenInHouse,ArrivalsTotal,TurndownRequired,DeparturesTotal,MaxOccupancyPercentage,Stayover,TotalRoomsReserved,PendingRoomMoves;", "enum": [ "ReservationActivityDaily" ] @@ -5896,7 +5907,8 @@ "StagedCompPostings", "DeclinedCompPostings", "CompRoutingInstructionsRequests", - "WalkInVIP" + "WalkInVIP", + "PendingRoomMoves" ] }, "required": false @@ -6020,7 +6032,7 @@ "/hotels/{hotelId}/fulfillmentActivityLogs": { "get": { "summary": "Get the fullfillment activity log", - "description": "You can use this API to get the fullfillment activity log.OperationId:getFulfillmentActivityLog
", + "description": "You can use this API to get the fullfillment activity log.OperationId:getFulfillmentActivityLog
This API allows a time span of 180 days.
", "operationId": "getFulfillmentActivityLog", "parameters": [ { @@ -6350,7 +6362,7 @@ "/hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses": { "get": { "summary": "Get room interface status", - "description": "This Api will getch the room interface status.OperationId:getRoomInterfaceStatus
", + "description": "This Api will getch the room interface status.OperationId:getRoomInterfaceStatus
This API allows a time span of 90 days.
", "operationId": "getRoomInterfaceStatus", "parameters": [ { @@ -9992,6 +10004,43 @@ }, "required": false }, + { + "name": "keyword", + "in": "query", + "required": false, + "description": "Wildcard search value to lookup reservation summaries with RoomId or First Name or Last Name. If both keyword and roomId/firstName/lastName is specified, keyword will take precedence.", + "type": "string" + }, + { + "name": "fetchInstructions", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Simple type for reservation instructions that can be used in requests to fetch necessary reservation summary details.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "ShortReservationSummaries" + ] + }, + "required": false + }, + { + "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" + }, { "$ref": "#/parameters/authKey" }, @@ -12004,6 +12053,18 @@ "description": "This option is used when all reservation check-in is reversed and the user wants to choose if the room is to be blocked. If all check-ins are not reversed, this is ignored and a default value false is used.", "type": "boolean" }, + { + "name": "sharersList", + "in": "query", + "type": "array", + "description": "List of sharers IDs linked to the reservation selected to be reverse check in.", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 40 + }, + "required": false + }, { "$ref": "#/parameters/authKey" }, @@ -14156,7 +14217,7 @@ "/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls": { "get": { "summary": "Get Wake Up Call", - "description": "Use thisAPI to get existing wake up call on an in-house reservation.OperationId:getWakeUpCall
", + "description": "Use thisAPI to get existing wake up call on an in-house reservation.OperationId:getWakeUpCall
This API allows a time span of 90 days.
", "operationId": "getWakeUpCall", "parameters": [ { @@ -14762,6 +14823,129 @@ ] } }, + "/hotels/{hotelId}/reservationsKeyOptions": { + "get": { + "summary": "Fetch keysOptions for the reservation and the guest profile", + "description": "This API is used to retrieve the key options attached to the room, reservation and profile for all the reservations in reservationIdList. These key options are preferences that correspond to the Door Lock System in use that control the access to areas with the room key. Key option preferences can be configured and saved on profiles, rooms, and reservations to be included when requesting a room key.OperationId:getKeyOptions
", + "operationId": "getReservationsKeyOptions", + "parameters": [ + { + "name": "reservationIdList", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "A list of reservation ids to fetch key options for.", + "items": { + "type": "string" + }, + "required": true + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Name of the resort." + }, + { + "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" + }, + { + "$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 of fetch keyOptions operation.", + "schema": { + "$ref": "#/definitions/keyOptionsInfoListType" + } + }, + "204": { + "description": "keyOptions 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": [ + "FrontDeskOperations" + ] + } + }, "/hotels/{hotelId}/roomKeysDetails": { "get": { "summary": "Read room key", @@ -16255,7 +16439,7 @@ "/hotels/{hotelId}/serviceRequests": { "get": { "summary": "Get Service Requests", - "description": "Use this API to retrieve any service requests that exist on a reservation.OperationId:getServiceRequests
", + "description": "Use this API to retrieve any service requests that exist on a reservation.OperationId:getServiceRequests
This API allows a time span of 30 days.
", "operationId": "getServiceRequests", "parameters": [ { @@ -16850,6 +17034,13 @@ "maxLength": 2000, "description": "" }, + { + "name": "overrideBackToBackRoomSkip", + "in": "query", + "required": false, + "description": "Specifies if the Swap/Shift action should continue regardless of the reservation having a Back to Back Linked Reservation assigned to the same room. Swap/Shift functionality is available when the Swap/Shift Rooms OPERA Control is active. Back to Back Reservation handling is available when the Back to Back Handling for Linked Reservations OPERA Control is active.", + "type": "boolean" + }, { "name": "shiftRooms", "in": "body", @@ -16979,6 +17170,13 @@ "maxLength": 2000, "description": "" }, + { + "name": "overrideBackToBackRoomSkip", + "in": "query", + "required": false, + "description": "Specifies if the Swap/Shift action should continue regardless of the reservation having a Back to Back Linked Reservation assigned to the same room. Swap/Shift functionality is available when the Swap/Shift Rooms OPERA Control is active. Back to Back Reservation handling is available when the Back to Back Handling for Linked Reservations OPERA Control is active.", + "type": "boolean" + }, { "name": "swapRooms", "in": "body", @@ -19027,6 +19225,10 @@ "optedForCommunication": { "description": "Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.", "type": "boolean" + }, + "backToBack": { + "description": "Back to Back functionality is available when the Back to Back Handling of Linked Reservations OPERA Control is active.", + "type": "boolean" } } }, @@ -23654,6 +23856,15 @@ "profileId": { "description": "ProfileId of the guest.", "$ref": "#/definitions/uniqueID_Type" + }, + "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": "This time indicates when the reservation is scheduled to move out of the room.", + "type": "string", + "format": "date-time" } } }, @@ -23761,7 +23972,8 @@ "BlockArrivals", "ReservationsCancellationsToday", "AIRoomAssignment", - "CompRouting" + "CompRouting", + "RoomMoveStatistics" ] }, "hSKStatType": { @@ -23945,7 +24157,17 @@ "ArrivalAIUpgResvs", "ArrivalAIAssgnVIPResvs", "ArrivalAIAssgnMemberResvs", - "ArrivalAIAssgnOverridden" + "ArrivalAIAssgnOverridden", + "CompletedRoomMoves", + "PendingRoomMoves", + "AdultsArrivals", + "ChildrenArrivals", + "Children1Arrivals", + "Children2Arrivals", + "Children3Arrivals", + "Children1InHouse", + "Children2InHouse", + "Children3InHouse" ] }, "activityLog": { @@ -24978,6 +25200,30 @@ "description": "Collection of Reservations summary and their information.", "$ref": "#/definitions/reservationsSummaryType" }, + "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" }, @@ -25270,6 +25516,10 @@ "useETDandETA": { "description": "Indicates if the Estimated Time of Departure of the departing reservation and the Estimated Time of Arrival of the arriving reservation should be considered during the Auto Assign process. If true, rooms that would cause an overlap of the ETD/ETAs will not be assigned. An additional buffer (in Minutes) will also be considered if the value in the Auto Assign ETD - ETA Buffer OPERA Control is not blank. The default value is false, which will not consider the ETD/ETA when assigning rooms.", "type": "boolean" + }, + "excludeBackToBackReservations": { + "description": "When this flag is set to true, it will exclude the linked reservations which are marked as Back to Back in the result.Marking reservations as Back to Back is available when the Back to Back Handling for Linked Reservations OPERA control is active.", + "type": "boolean" } } }, @@ -26097,6 +26347,20 @@ "items": { "$ref": "#/definitions/scheduledRoomMoveType" } + }, + "backToBack": { + "description": "This attribute indicates if the linked reservation is marked as Back to Back or not. Back to Back functionality is available when the Back to Back Handling of Linked Reservations OPERA Control is active.", + "type": "boolean" + }, + "backToBackSequence": { + "description": "This attribute represents Back To Back Sequence of Linked Reservations(e.g. '1,2' i.e, 1 indicates Sequence Position and 2 indicates total count of linked Back to Back reservations with consecutive Stay Dates). This is applicable when OPERA control Back to Back Handling for Linked Reservations is active.", + "$ref": "#/definitions/backToBackResSequenceType" + }, + "backToBackGroupId": { + "description": "This attribute represents a common identifier for a subgroup of linked reservations marked as Back to Back in a group of linked reservations.", + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, @@ -26144,7 +26408,8 @@ }, "estimatedMoveTime": { "type": "string", - "description": "Estimated Move Time in 24Hour Format" + "description": "Estimated Move Time.", + "format": "date-time" }, "moveOutRoomId": { "type": "string", @@ -26255,6 +26520,10 @@ "type": "string", "format": "date" }, + "bookingTimeSpan": { + "description": "The booking time span of the reservation, only applicable when time increments are being used.", + "$ref": "#/definitions/bookingTimeSpanType" + }, "expectedTimes": { "description": "The Expected Arrival and Departure Times.", "$ref": "#/definitions/resExpectedTimesType" @@ -36748,6 +37017,14 @@ "description": "If this element is present, override flags will be set when configuring the room to the reservation.", "$ref": "#/definitions/reservationRoomSelectionOverrideType" }, + "includedBackToBack": { + "description": "This list contains the Reservation IDs of the Back to Back Reservations that will be assigned to the same room. Back to Back Reservation functionality is available when the Back to Back Handling of Linked Reservations OPERA Control is active.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationIdList" + } + }, "includedSharers": { "description": "Valid share reservation identifier.", "type": "array", @@ -36775,6 +37052,16 @@ "scheduledRoomSegmentNumber": { "description": "Indicates the Room Segment number the room is assigned to.", "type": "number" + }, + "roomSegmentBeginDate": { + "type": "string", + "description": "Defines the start date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.", + "format": "date" + }, + "roomSegmentEndDate": { + "type": "string", + "description": "Defines the end date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.", + "format": "date" } } }, @@ -37207,6 +37494,10 @@ "guestInfo": { "description": "Guest information on the key. This information is available when multiple_guest_key is active.", "$ref": "#/definitions/roomKeyGuest" + }, + "backToBackKey": { + "description": "Flag indicates whether the key is back to back.", + "type": "boolean" } } }, @@ -37443,6 +37734,16 @@ "description": "Override the room ownership indicator in the reservation when removing rooms. This is applicable when Room Rotation OPERA Control is active.", "type": "boolean" }, + "roomSegmentBeginDate": { + "type": "string", + "description": "Defines the start date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.", + "format": "date" + }, + "roomSegmentEndDate": { + "type": "string", + "description": "Defines the end date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.", + "format": "date" + }, "links": { "$ref": "#/definitions/links" }, @@ -37523,6 +37824,16 @@ "orderBy": { "description": "When Forecast Rotation is checked, future reservation's point calculation will be considered while determing the room order for the assignment.", "$ref": "#/definitions/hotelRoomsOrderBy" + }, + "roomSegmentBeginDate": { + "type": "string", + "description": "Defines the start date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.", + "format": "date" + }, + "roomSegmentEndDate": { + "type": "string", + "description": "Defines the end date of the room segment of the reservation.Room segments/scheduled room move functionality is available when the Advanced Daily Details OPERA Control is active.", + "format": "date" } } }, @@ -39160,6 +39471,106 @@ "keyValidityEnd", "keyCreationTime" ] + }, + "bookingTimeSpanType": { + "type": "object", + "description": "The booking time span of the reservation, only applicable when time increments are being used.", + "properties": { + "startDateTime": { + "type": "string", + "description": "The start time of the reservation booking", + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "description": "The end time of the reservation booking", + "format": "date-time" + } + } + }, + "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" + } + } + }, + "keyOptionsInfoListType": { + "type": "object", + "properties": { + "keyOptions": { + "description": "List of reservation key options.", + "type": "array", + "items": { + "$ref": "#/definitions/keyOptionsInfoType" + } + }, + "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" + } + } + }, + "keyOptionsInfoType": { + "type": "object", + "description": "Response of fetch keyOptions operation.", + "properties": { + "reservationId": { + "$ref": "#/definitions/reservationId" + }, + "profileKeyOptions": { + "type": "array", + "description": "Key option preferences currently attached to a profile associated with the reservation.", + "items": { + "$ref": "#/definitions/profileKeyOptionsType" + } + }, + "reservationKeyOptions": { + "type": "string", + "description": "Key option preferences currently attached to the reservation.", + "minLength": 0, + "maxLength": 200 + }, + "roomKeyOptions": { + "type": "string", + "description": "Key option preferences currently attached to the room assigned to the reservation.", + "minLength": 0, + "maxLength": 200 + } + } } }, "tags": [ diff --git a/rest-api-specs/property/fofcfg.json b/rest-api-specs/property/fofcfg.json index fed6286..8ecb704 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -8235,7 +8235,7 @@ "/defaultPaymentMethodRules": { "get": { "summary": "Operation to fetch DefaultPaymentMethodRule.", - "description": "Operation to fetch payment method rule.OperationId:getDefaultPaymentMethodRule
", + "description": "Operation to fetch payment method rule.OperationId:getDefaultPaymentMethodRule
The maximum allowable limit for this API is 50.
", "operationId": "getDefaultPaymentMethodRule", "parameters": [ { @@ -20310,7 +20310,7 @@ "/hotels/{hotelId}/exchangeRates/{currencyCode}": { "get": { "summary": "Operation to fetch FuturePastExchangeRates.", - "description": "Operation to Fetch Future Past Exchange Rates.OperationId:getFuturePastExchangeRates
", + "description": "Operation to Fetch Future Past Exchange Rates.OperationId:getFuturePastExchangeRates
This API allows a time span of 30 days.
", "operationId": "getFuturePastExchangeRates", "parameters": [ { @@ -24998,6 +24998,7 @@ "summary": "Operation to copy FiscalFolioParameters.", "description": "Operation to copy Fiscal Folio Parameters.OperationId:copyFiscalFolioParameters
", "operationId": "copyFiscalFolioParameters", + "deprecated": true, "parameters": [ { "name": "sourceHotelId", @@ -26259,7 +26260,8 @@ "enum": [ "BillFolioTypes", "ArInvoice", - "SequenceNumbers" + "SequenceNumbers", + "ARPayment" ] }, "required": false @@ -29178,6 +29180,433 @@ ] } }, + "/roomTypeBasedChargeRanges": { + "put": { + "summary": "Operation to change Room Type Based Charge Ranges.", + "description": "Operation to change Room Type Based Charge Ranges.OperationId:putRoomTypeBasedChargeRanges
", + "operationId": "putRoomTypeBasedChargeRanges", + "parameters": [ + { + "name": "roomTypeBasedChargeRanges", + "in": "body", + "required": true, + "description": "Request to change Room Type Based Charge Ranges.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/roomTypeBasedChargeRngs" + } + ] + } + }, + { + "$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": [ + "CashieringConfig" + ] + }, + "post": { + "summary": "Operation to create Room Type Based Charge Ranges.", + "description": "Operation to create Room Type Based Charge Ranges.OperationId:postRoomTypeBasedChargeRanges
", + "operationId": "postRoomTypeBasedChargeRanges", + "parameters": [ + { + "name": "roomTypeBasedChargeRanges", + "in": "body", + "required": true, + "description": "Request to create Room Type Based Charge Ranges.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/roomTypeBasedChargeRngs" + } + ] + } + }, + { + "$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": [ + "CashieringConfig" + ] + }, + "get": { + "summary": "Operation to fetch Room Type Based Charge Ranges.", + "description": "Use this API to return Room Type Based Charge Ranges for a hotels based on search criteria such as hotelId, transactionCode, generateTrxCode, RoomTypeGroup.OperationId:getRoomTypeBasedChargeRanges
", + "operationId": "getRoomTypeBasedChargeRanges", + "parameters": [ + { + "name": "hotelId", + "in": "query", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the source hotel in OPERA" + }, + { + "name": "transactionCode", + "in": "query", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Transaction code" + }, + { + "name": "generateTrxCode", + "in": "query", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Generate of the Main Transaction code" + }, + { + "name": "roomTypeGroup", + "in": "query", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Room Type Group Code" + }, + { + "$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 fetching Room Type Based Charge Ranges.", + "schema": { + "$ref": "#/definitions/roomTypeBasedChargeRngs" + } + }, + "204": { + "description": "Room Type Based Charge Ranges 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": [ + "CashieringConfig" + ] + }, + "delete": { + "summary": "Operation to delete Room Type Based Charge Ranges.", + "description": "Operation to remove Room Type Based Charge Ranges.OperationId:deleteRoomTypebasedchargeranges
", + "operationId": "deleteRoomTypebasedchargeranges", + "parameters": [ + { + "name": "hotelId", + "in": "query", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the source hotel in OPERA." + }, + { + "name": "transactionNo", + "in": "query", + "required": true, + "type": "number", + "description": "Transaction number, Unique Identifier of the record." + }, + { + "$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": [ + "CashieringConfig" + ] + } + }, "/routingInstructions": { "put": { "summary": "Operation to change RoutingInstructions.", @@ -33877,6 +34306,14 @@ "description": "Inactive flag used to include/exclude inactive transaction codes from the search result", "type": "boolean" }, + { + "name": "earnMembershipPoints", + "in": "query", + "x-example": "false", + "required": false, + "description": "This flag indicates that the transaction is eligible to earn points (guest can earn points on the revenue posted to this transaction code)", + "type": "boolean" + }, { "name": "transactionGroupCodes", "in": "query", @@ -37180,6 +37617,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -38684,6 +39124,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -38913,6 +39356,9 @@ }, "default": { "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -38989,6 +39435,9 @@ "taxPercentage": { "description": "Commission paid Tax details.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -43774,6 +44223,9 @@ "type": "string", "minLength": 0, "maxLength": 100 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -44235,6 +44687,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -44740,6 +45195,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -45018,6 +45476,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -46403,6 +46864,9 @@ "amountOrPercentageFlag": { "description": "Adjustment Code Calculation Type, valid values are Amount and Percentage.", "$ref": "#/definitions/amountOrPercentage" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -46879,6 +47343,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -49520,6 +49987,12 @@ "minLength": 0, "maxLength": 20 }, + "otaTaxType": { + "description": "Open Travel Alliance(OTA) tax type for the given transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, "transactionAdjustments": { "description": "Combination of Adjustment Reason Code and Transaction Adjustment Code.", "type": "array", @@ -49590,6 +50063,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -50143,6 +50619,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -50216,6 +50695,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -50680,7 +51162,8 @@ "SupportingDocument", "TaxRegNo", "InternalPOSAccount", - "InternalPOSAccountCredit" + "InternalPOSAccountCredit", + "ARPayment" ] }, "packageArrangementCodes": { @@ -51962,6 +52445,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -52038,6 +52524,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -52122,6 +52611,12 @@ "minLength": 0, "maxLength": 20 }, + "otaTaxType": { + "description": "Open Travel Alliance(OTA) tax type for the given transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, "transactionAdjustments": { "description": "Combination of Adjustment Reason Code and Transaction Adjustment Code.", "type": "array", @@ -52183,6 +52678,9 @@ "compTransaction": { "description": "If true indicates this transaction codes is for Comp Accounting.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -52232,6 +52730,9 @@ "type": { "description": "Transaction type to which the corresponding transaction group belongs.", "$ref": "#/definitions/cashieringTransactionTypeType" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -52299,6 +52800,9 @@ "type": { "description": "Transaction type to which the corresponding transaction group belongs. This is an information only attribute.", "$ref": "#/definitions/cashieringTransactionTypeType" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -53179,6 +53683,84 @@ "maxLength": 2000 } } + }, + "managedByOptions": { + "description": "Describes of the Configuration is Managed by Enterprise or Property.", + "type": "string", + "enum": [ + "EnterpriseManaged", + "PropertyManaged", + "EnterpriseEnforced", + "PropertyOverridden" + ] + }, + "roomTypeBasedChargeRngs": { + "type": "object", + "description": "Defines Room Type Based Charge Range response type.", + "properties": { + "roomTypeBasedChrgRanges": { + "type": "array", + "description": "The result element containing the requested list of Room Type Based Charge Range configuration.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/roomTypeBasedChargeRangesType" + } + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "roomTypeBasedChargeRangesType": { + "type": "object", + "description": "Provides information about Room Type Based Charge Ranges.", + "properties": { + "hotelId": { + "description": "Code of the Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "transactionNo": { + "description": "Transaction number, Unique Identifier of the record.", + "type": "number" + }, + "transactionCode": { + "description": "Transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "generateTrxCode": { + "description": "Generate of the Main Transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomTypeGroup": { + "description": "Room Type Group Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "startDate": { + "description": "Start Date for Room Type Based Charge Range.", + "type": "string", + "format": "date" + }, + "endDate": { + "description": "End Date for Room Type Based Charge Range.", + "type": "string", + "format": "date" + }, + "amount": { + "description": "Amount of the Room Type Group Based Range.", + "type": "number" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/hsk.json b/rest-api-specs/property/hsk.json index 3ea9b40..9f3a2b2 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.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", + "description": "APIs to cater for Housekeeping functionality in OPERA Cloud.This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020,2023 Oracle and/or its affiliates.
This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.
", + "version": "24.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -24,7 +24,7 @@ "/hotels/{hotelId}/attendants/houseKeepingTasks": { "get": { "summary": "Get the housekeeping attendants schedule", - "description": "This API will allow you to get the housekeeping attendants schedule.OperationId:getHousekeepingAttendantsSchedule
", + "description": "This API will allow you to get the housekeeping attendants schedule.OperationId:getHousekeepingAttendantsSchedule
This API allows a time span of 30 days.
", "operationId": "getHousekeepingAttendantsSchedule", "parameters": [ { @@ -768,7 +768,7 @@ "/hotels/{hotelId}/forecastTaskSchedules": { "get": { "summary": "Get facility forecast", - "description": "This API will allow you to get facility forecast for Housekeeping attendants and tasks for a current or future start date .OperationId:getFacilityForecast
", + "description": "This API will allow you to get facility forecast for Housekeeping attendants and tasks for a current or future start date .OperationId:getFacilityForecast
This API allows a time span of 30 days.
", "operationId": "getFacilityForecast", "parameters": [ { @@ -1065,6 +1065,13 @@ "description": "This will include room details for the Task Sheets. If summary information is only required, then this could be set to false. If a Task Sheet Number is included in the Search and this flag is set to true, then the details for that particular Task Sheet will be returned. For all other task sheets, the IncludeTaskSheetsSummary will determine if Summary details are required or not.", "type": "boolean" }, + { + "name": "includeScheduledRoomDetails", + "in": "query", + "required": false, + "description": "Set this to true to include reservation information associated with any scheduled room moves. Available when the Advanced Daily Details OPERA Control is active. Note: IncludeReservationInfo must also be set to true to fetch reservation details.", + "type": "boolean" + }, { "name": "includeTaskSheetsSummary", "in": "query", @@ -5619,7 +5626,7 @@ "/hotels/{hotelId}/rooms/maintenances": { "get": { "summary": "Get the maintenance rooms", - "description": "Use this API to get a list of rooms with maintenances.OperationId:getRoomMaintenance
", + "description": "Use this API to get a list of rooms with maintenances.OperationId:getRoomMaintenance
This API allows a time span of 90 days.
", "operationId": "getRoomMaintenance", "parameters": [ { @@ -5853,7 +5860,7 @@ "/hotels/{hotelId}/rooms/outOfOrderRooms": { "get": { "summary": "Get Out of Order Rooms", - "description": "Use this API to get a list of rooms for a hotel that are Out of Order. You can narrow down your results with search criteria such as Room class, Room Type, date range.OperationId:getOutOfOrderRooms
", + "description": "Use this API to get a list of rooms for a hotel that are Out of Order. You can narrow down your results with search criteria such as Room class, Room Type, date range.OperationId:getOutOfOrderRooms
This API allows a time span of 90 days.
", "operationId": "getOutOfOrderRooms", "parameters": [ { @@ -6549,7 +6556,7 @@ }, "get": { "summary": "Get Out of Service Rooms", - "description": "Use this API to get a list of rooms for a hotel that are Out of Service. You can narrow down your results with search criteria such as Room class, Room Type, date range.OperationId:getOutOfServiceRooms
", + "description": "Use this API to get a list of rooms for a hotel that are Out of Service. You can narrow down your results with search criteria such as Room class, Room Type, date range.OperationId:getOutOfServiceRooms
This API allows a time span of 90 days.
", "operationId": "getOutOfServiceRooms", "parameters": [ { @@ -8140,6 +8147,13 @@ }, "required": false }, + { + "name": "includeScheduledRoomDetails", + "in": "query", + "required": false, + "description": "Set this to true to include reservation information associated with any scheduled room moves. Available when the Advanced Daily Details OPERA Control is active.", + "type": "boolean" + }, { "$ref": "#/parameters/authKey" }, diff --git a/rest-api-specs/property/int.json b/rest-api-specs/property/int.json index 3b6b6ae..b4ad97c 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.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", + "description": "APIs to get Business Events generated in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -24,7 +24,7 @@ "/externalSystem/{extSystemCode}/businessEvents": { "get": { "summary": "Get Business Events by External System", - "description": "Business Event messages are placed in a queue. Use this API to dequeue/fetch the Business Event messages based on the external system for all hotels within the same chain. In order to get events, you must have a unique consumer code for the External System and hotels.OperationId:getBusinessEventsByExternalSystem
", + "description": "Business Event messages are placed in a queue. Use this API to dequeue/fetch the Business Event messages based on the external system for all hotels within the same chain. In order to get events, you must have a unique consumer code for the External System and hotels.OperationId:getBusinessEventsByExternalSystem
The maximum allowable limit for this API is 20.
", "operationId": "getBusinessEventsByExternalSystem", "parameters": [ { @@ -202,7 +202,7 @@ "/externalSystem/{extSystemCode}/hotels/{hotelId}/businessEvents": { "get": { "summary": "Get Business Events by External System and Hotel ID", - "description": "Business Event messages are placed in a queue. Use this API to fetch(dequeue) the Business Event messages based on the External System and Hotel ID. In order to get property specific business event messages, you must have a unique consumer code (OPERA Cloud UI > Toolbox > External Database) for the External System and the Hotel ID.OperationId:getBusinessEvents
", + "description": "Business Event messages are placed in a queue. Use this API to fetch(dequeue) the Business Event messages based on the External System and Hotel ID. In order to get property specific business event messages, you must have a unique consumer code (OPERA Cloud UI > Toolbox > External Database) for the External System and the Hotel ID.OperationId:getBusinessEvents
The maximum allowable limit for this API is 20.
", "operationId": "getBusinessEvents", "parameters": [ { diff --git a/rest-api-specs/property/intcfg.json b/rest-api-specs/property/intcfg.json index aeb715e..28b2300 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -6770,6 +6770,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -9992,6 +9995,16 @@ "$ref": "#/definitions/emailDeliveryConfigurationType" } } + }, + "managedByOptions": { + "description": "Describes of the Configuration is Managed by Enterprise or Property.", + "type": "string", + "enum": [ + "EnterpriseManaged", + "PropertyManaged", + "EnterpriseEnforced", + "PropertyOverridden" + ] } }, "tags": [ diff --git a/rest-api-specs/property/inv.json b/rest-api-specs/property/inv.json index e56f362..5f87da3 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.).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", + "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.).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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -24,7 +24,7 @@ "/blockInventoryStatistics": { "get": { "summary": "Get block inventory statistics for multiple hotel Ids", - "description": "You can use this API to retrieve Block inventory for multiple hotel codes. Narrow down your results using the query parameters available.OperationId:getBlockInventoryStatisticsMultipleHotelIds
", + "description": "You can use this API to retrieve Block inventory for multiple hotel codes. Narrow down your results using the query parameters available.OperationId:getBlockInventoryStatisticsMultipleHotelIds
The maximum allowable limit for this API is 100.
This API allows a time span of 90 days.
", "operationId": "getBlockInventoryStatisticsMultipleHotelIds", "parameters": [ { @@ -621,7 +621,7 @@ "/hotels/{hotelId}/hotelInventory": { "get": { "summary": "Get hotel inventory", - "description": "You can use this API to retrieve the inventory for a specified hotel. Narrow down your results using the query parameters such as a date range, room type, room class, and/or tentative inventory included.OperationId:getHotelInventory
", + "description": "You can use this API to retrieve the inventory for a specified hotel. Narrow down your results using the query parameters such as a date range, room type, room class, and/or tentative inventory included.OperationId:getHotelInventory
This API allows a time span of 90 days.
", "operationId": "getHotelInventory", "parameters": [ { @@ -834,6 +834,9 @@ "items": { "type": "string", "enum": [ + "HouseScheduledRoomMovesYN", + "RoomScheduledRoomMoveInsYN", + "RoomScheduledRoomMoveOutsYN", "CancelledYN", "Channel", "DeductRoomsYN", @@ -1076,7 +1079,7 @@ "/hotels/{hotelId}/itemInventory": { "get": { "summary": "Get item inventory", - "description": "This will fetch a hotels Item inventory for a specified date range that you can provided in the request.OperationId:getItemInventory
", + "description": "This will fetch a hotels Item inventory for a specified date range that you can provided in the request.OperationId:getItemInventory
This API allows a time span of 90 days.
", "operationId": "getItemInventory", "parameters": [ { diff --git a/rest-api-specs/property/invasync.json b/rest-api-specs/property/invasync.json index dee9109..8317e12 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
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", + "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
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.4", "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 b2f75a7..08cd363 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.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", + "description": "APIs to cater for external Leisure Management functionality integrated with OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -994,7 +994,7 @@ "/activityTypes": { "get": { "summary": "Fetch Activity Types", - "description": "Retrieve Activity Types that are configured for a property. Activity Types are typically used when an EAS (External Activities Scheduler system) interface is connected to OPERA.OperationId:getActivityTypes
", + "description": "Retrieve Activity Types that are configured for a property. Activity Types are typically used when an EAS (External Activities Scheduler system) interface is connected to OPERA.OperationId:getActivityTypes
The maximum allowable limit for this API is 25.
", "operationId": "getActivityTypes", "parameters": [ { @@ -3610,6 +3610,12 @@ "type": "string", "minLength": 0, "maxLength": 40 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, diff --git a/rest-api-specs/property/lov.json b/rest-api-specs/property/lov.json index d0330c7..d371745 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -23,8 +23,8 @@ "paths": { "/listOfValues": { "get": { - "summary": "Fetch Names", - "description": "OperationId:getLOVNames
", + "summary": "Return list of value names", + "description": "Use this API to return list of value names.OperationId:getLOVNames
", "operationId": "getLOVNames", "parameters": [ { @@ -111,8 +111,8 @@ }, "/listOfValues/airlines/{airlines}/loyalty/{loyalty}/membershipClassTypes": { "get": { - "summary": "Fetch List Of Values for Membership Class Types", - "description": "OperationId:getMembershipClassTypesLOV
", + "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
", "operationId": "getMembershipClassTypesLOV", "parameters": [ { @@ -265,8 +265,8 @@ }, "/listOfValues/alertPrinters/{alertPrinters}/printers": { "get": { - "summary": "Fetch List Of Values for Printers", - "description": "OperationId:getPrintersLOV
", + "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
", "operationId": "getPrintersLOV", "parameters": [ { @@ -406,8 +406,8 @@ }, "/listOfValues/blockId/{blockId}/blockBookingStatuses": { "get": { - "summary": "Fetch List Of Values for Block Booking Statuses", - "description": "OperationId:getBlockBookingStatusesLOV
", + "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
", "operationId": "getBlockBookingStatusesLOV", "parameters": [ { @@ -543,8 +543,8 @@ }, "/listOfValues/blockId/{blockId}/blockCurrentStatuses": { "get": { - "summary": "Fetch List Of Values for Block Current Statuses", - "description": "OperationId:getBlockCurrentStatusesLOV
", + "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
", "operationId": "getBlockCurrentStatusesLOV", "parameters": [ { @@ -680,8 +680,8 @@ }, "/listOfValues/bookingChannels/{bookingChannelCodes}/gdsRoomCategoryTemplates": { "get": { - "summary": "Fetch List Of Values for Gds Room Category Templates", - "description": "OperationId:getGdsRoomCategoryTemplatesLOV
", + "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
", "operationId": "getGdsRoomCategoryTemplatesLOV", "parameters": [ { @@ -817,8 +817,8 @@ }, "/listOfValues/bookingChannels/{bookingChannelCode}/gdsGuaranteeCodes": { "get": { - "summary": "Fetch List Of Values for Gds Guarantee Codes", - "description": "OperationId:getGdsGuaranteeCodesLOV
", + "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
", "operationId": "getGdsGuaranteeCodesLOV", "parameters": [ { @@ -954,8 +954,8 @@ }, "/listOfValues/bookingChannels/{bookingChannelCode}/gdsRateCategories": { "get": { - "summary": "Fetch List Of Values for Gds Rate Categories", - "description": "OperationId:getGdsRateCategoriesLOV
", + "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
", "operationId": "getGdsRateCategoriesLOV", "parameters": [ { @@ -1091,8 +1091,8 @@ }, "/listOfValues/bookingChannels/{bookingChannelCode}/gdsRateLevels": { "get": { - "summary": "Fetch List Of Values for Gds Rate Levels", - "description": "OperationId:getGdsRateLevelsLOV
", + "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
", "operationId": "getGdsRateLevelsLOV", "parameters": [ { @@ -1228,8 +1228,8 @@ }, "/listOfValues/bookingChannels/{bookingChannelCode}/templateBookingChannelRoomTypes": { "get": { - "summary": "Fetch List Of Values for Template Booking Channel Room Types", - "description": "OperationId:getTemplateBookingChannelRoomTypesLOV
", + "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
", "operationId": "getTemplateBookingChannelRoomTypesLOV", "parameters": [ { @@ -1365,8 +1365,8 @@ }, "/listOfValues/bookingStatus/{bookingStatus}/blockNextStatuses": { "get": { - "summary": "Fetch List Of Values for Block Next Statuses", - "description": "OperationId:getBlockNextStatusesLOV
", + "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
", "operationId": "getBlockNextStatusesLOV", "parameters": [ { @@ -1502,8 +1502,8 @@ }, "/listOfValues/bookingStatus/{bookingStatus}/gridTypes": { "get": { - "summary": "Fetch List Of Values for Grid Types", - "description": "OperationId:getGridTypesLOV
", + "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
", "operationId": "getGridTypesLOV", "parameters": [ { @@ -1639,8 +1639,8 @@ }, "/listOfValues/breakOutId/{breakOutId}/taskSheet": { "get": { - "summary": "Fetch List Of Values for Task Sheet", - "description": "OperationId:getTaskSheetLOV
", + "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
", "operationId": "getTaskSheetLOV", "parameters": [ { @@ -1776,8 +1776,8 @@ }, "/listOfValues/cashierId/{cashierId}/cashierHotels": { "get": { - "summary": "Fetch List Of Values for Cashier Hotels", - "description": "OperationId:getCashierHotelsLOV
", + "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
", "operationId": "getCashierHotelsLOV", "parameters": [ { @@ -1911,12 +1911,21 @@ ] } }, - "/listOfValues/catBudgetTypeEventCodesLoad": { + "/listOfValues/catStatus/{catStatus}/blockCatNextStatuses": { "get": { - "summary": "Fetch List Of Values for Cat Budget Type Event Codes", - "description": "OperationId:getCatBudgetTypeEventCodesLoadLOV
", - "operationId": "getCatBudgetTypeEventCodesLoadLOV", + "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", "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", @@ -1963,6 +1972,9 @@ { "$ref": "#/parameters/x-app-key" }, + { + "$ref": "#/parameters/x-hotelid" + }, { "$ref": "#/parameters/x-externalsystem" }, @@ -1986,7 +1998,7 @@ } }, "204": { - "description": "CatBudTypeEventCodesLoadLOV not found." + "description": "BlockCatNextStatusesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2036,12 +2048,21 @@ ] } }, - "/listOfValues/catBudgetTypeMealCodesLoad": { + "/listOfValues/category/{category}/userDbFunctions": { "get": { - "summary": "Fetch List Of Values for Cat Budget Type Meal Codes", - "description": "OperationId:getCatBudgetTypeMealCodesLoadLOV
", - "operationId": "getCatBudgetTypeMealCodesLoadLOV", + "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", "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", @@ -2088,6 +2109,9 @@ { "$ref": "#/parameters/x-app-key" }, + { + "$ref": "#/parameters/x-hotelid" + }, { "$ref": "#/parameters/x-externalsystem" }, @@ -2111,7 +2135,7 @@ } }, "204": { - "description": "CatBudTypeMealCodesLoadLOV not found." + "description": "UserDbFunctionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2161,20 +2185,37 @@ ] } }, - "/listOfValues/catStatus/{catStatus}/blockCatNextStatuses": { + "/listOfValues/catering/{catering}/active/{active}/cateringBudgetTypes": { "get": { - "summary": "Fetch List Of Values for Block Cat Next Statuses", - "description": "OperationId:getBlockCatNextStatusesLOV
", - "operationId": "getBlockCatNextStatusesLOV", + "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", "parameters": [ { - "name": "catStatus", + "name": "active", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'catStatus' which is required to fetch BlockCatNextStatuses 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", @@ -2248,7 +2289,7 @@ } }, "204": { - "description": "BlockCatNextStatusesLOV not found." + "description": "CateringBudTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2298,20 +2339,20 @@ ] } }, - "/listOfValues/category/{category}/userDbFunctions": { + "/listOfValues/cateringEvents/{cateringEvents}/hotelsForSnC": { "get": { - "summary": "Fetch List Of Values for User Db Functions", - "description": "OperationId:getUserDbFunctionsLOV
", - "operationId": "getUserDbFunctionsLOV", + "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", "parameters": [ { - "name": "category", + "name": "cateringEvents", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'category' which is required to fetch UserDbFunctions LOV" + "description": "Value of the parameter 'cateringEvents' which is required to fetch HotelsForSnC LOV" }, { "name": "includeInactiveFlag", @@ -2385,7 +2426,7 @@ } }, "204": { - "description": "UserDbFunctionsLOV not found." + "description": "HotelsForSnCLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2435,37 +2476,20 @@ ] } }, - "/listOfValues/catering/{catering}/active/{active}/cateringBudgetTypes": { + "/listOfValues/chainCode/{chainCode}/chainLanguages": { "get": { - "summary": "Fetch List Of Values for Catering Budget Types", - "description": "OperationId:getCateringBudgetTypesLOV
", - "operationId": "getCateringBudgetTypesLOV", + "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", "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": "chainCode", "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 'chainCode' which is required to fetch ChainLanguages LOV" }, { "name": "includeInactiveFlag", @@ -2539,7 +2563,7 @@ } }, "204": { - "description": "CateringBudTypesLOV not found." + "description": "ChainLanguagesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2589,20 +2613,29 @@ ] } }, - "/listOfValues/cateringEvents/{cateringEvents}/hotelsForSnC": { + "/listOfValues/chainCode/{chainCode}/preferenceGroup/{preferenceGroup}/preferenceSubgroups": { "get": { - "summary": "Fetch List Of Values for Hotels For Sn C", - "description": "OperationId:getHotelsForSnCLOV
", - "operationId": "getHotelsForSnCLOV", + "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", "parameters": [ { - "name": "cateringEvents", + "name": "preferenceGroup", "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 'preferenceGroup' which is required to fetch PreferenceSubgroups LOV" + }, + { + "name": "chainCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'chainCode' which is required to fetch PreferenceSubgroups LOV" }, { "name": "includeInactiveFlag", @@ -2676,7 +2709,7 @@ } }, "204": { - "description": "HotelsForSnCLOV not found." + "description": "PreferenceSubgroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2726,12 +2759,21 @@ ] } }, - "/listOfValues/chainCode/{chainCode}/chainLanguages": { + "/listOfValues/chainCode/{chainCode}/screenCode/{screenCode}/screenStyleCodes": { "get": { - "summary": "Fetch List Of Values for Chain Languages", - "description": "OperationId:getChainLanguagesLOV
", - "operationId": "getChainLanguagesLOV", + "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", "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", @@ -2739,7 +2781,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'chainCode' which is required to fetch ChainLanguages LOV" + "description": "Value of the parameter 'chainCode' which is required to fetch ScreenStyleCodes LOV" }, { "name": "includeInactiveFlag", @@ -2813,7 +2855,7 @@ } }, "204": { - "description": "ChainLanguagesLOV not found." + "description": "ScreenStyleCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -2863,20 +2905,29 @@ ] } }, - "/listOfValues/chainCode/{chainCode}/preferenceGroup/{preferenceGroup}/preferenceSubgroups": { + "/listOfValues/chainCode/{chainCode}/screenType/{screenType}/screenArea/{screenArea}/screenCodes": { "get": { - "summary": "Fetch List Of Values for Preference Subgroups", - "description": "OperationId:getPreferenceSubgroupsLOV
", - "operationId": "getPreferenceSubgroupsLOV", + "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", "parameters": [ { - "name": "preferenceGroup", + "name": "screenArea", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'preferenceGroup' which is required to fetch PreferenceSubgroups 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", @@ -2885,7 +2936,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'chainCode' which is required to fetch PreferenceSubgroups LOV" + "description": "Value of the parameter 'chainCode' which is required to fetch ScreenCodes LOV" }, { "name": "includeInactiveFlag", @@ -2959,7 +3010,7 @@ } }, "204": { - "description": "PreferenceSubgroupsLOV not found." + "description": "ScreenCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3009,29 +3060,20 @@ ] } }, - "/listOfValues/chainCode/{chainCode}/screenCode/{screenCode}/screenStyleCodes": { + "/listOfValues/changeSource/{changeSource}/fieldName": { "get": { - "summary": "Fetch List Of Values for Screen Style Codes", - "description": "OperationId:getScreenStyleCodesLOV
", - "operationId": "getScreenStyleCodesLOV", + "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", "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", + "name": "changeSource", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'chainCode' which is required to fetch ScreenStyleCodes LOV" + "description": "Value of the parameter 'changeSource' which is required to fetch FieldName LOV" }, { "name": "includeInactiveFlag", @@ -3105,7 +3147,7 @@ } }, "204": { - "description": "ScreenStyleCodesLOV not found." + "description": "FieldNameLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3155,38 +3197,20 @@ ] } }, - "/listOfValues/chainCode/{chainCode}/screenType/{screenType}/screenArea/{screenArea}/screenCodes": { + "/listOfValues/channel/{channel}/bookingChannelRoomTypes": { "get": { - "summary": "Fetch List Of Values for Screen Codes", - "description": "OperationId:getScreenCodesLOV
", - "operationId": "getScreenCodesLOV", + "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", "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", - "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", + "name": "channel", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'chainCode' which is required to fetch ScreenCodes LOV" + "description": "Value of the parameter 'channel' which is required to fetch BookingChannelRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -3260,7 +3284,7 @@ } }, "204": { - "description": "ScreenCodesLOV not found." + "description": "BookingChannelRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3310,20 +3334,20 @@ ] } }, - "/listOfValues/changeSource/{changeSource}/fieldName": { + "/listOfValues/channelType/{channelType}/gdsHotels": { "get": { - "summary": "Fetch List Of Values for Field Name", - "description": "OperationId:getFieldNameLOV
", - "operationId": "getFieldNameLOV", + "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", "parameters": [ { - "name": "changeSource", + "name": "channelType", "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 'channelType' which is required to fetch GdsHotels LOV" }, { "name": "includeInactiveFlag", @@ -3397,7 +3421,7 @@ } }, "204": { - "description": "FieldNameLOV not found." + "description": "GdsHotelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3447,20 +3471,20 @@ ] } }, - "/listOfValues/channel/{channel}/bookingChannelRoomTypes": { + "/listOfValues/codeType/{codeType}/cateringCodes": { "get": { - "summary": "Fetch List Of Values for Booking Channel Room Types", - "description": "OperationId:getBookingChannelRoomTypesLOV
", - "operationId": "getBookingChannelRoomTypesLOV", + "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", "parameters": [ { - "name": "channel", + "name": "codeType", "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 'codeType' which is required to fetch CateringCodes LOV" }, { "name": "includeInactiveFlag", @@ -3534,7 +3558,7 @@ } }, "204": { - "description": "BookingChannelRoomTypesLOV not found." + "description": "CateringCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3584,20 +3608,20 @@ ] } }, - "/listOfValues/channelType/{channelType}/gdsHotels": { + "/listOfValues/country/{country}/postalCodes": { "get": { - "summary": "Fetch List Of Values for Gds Hotels", - "description": "OperationId:getGdsHotelsLOV
", - "operationId": "getGdsHotelsLOV", + "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", "parameters": [ { - "name": "channelType", + "name": "country", "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 'country' which is required to fetch PostalCodes LOV" }, { "name": "includeInactiveFlag", @@ -3671,7 +3695,7 @@ } }, "204": { - "description": "GdsHotelsLOV not found." + "description": "PostalCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3721,20 +3745,20 @@ ] } }, - "/listOfValues/codeType/{codeType}/cateringCodes": { + "/listOfValues/country/{country}/toPostalCodes": { "get": { - "summary": "Fetch List Of Values for Catering Codes", - "description": "OperationId:getCateringCodesLOV
", - "operationId": "getCateringCodesLOV", + "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", "parameters": [ { - "name": "codeType", + "name": "country", "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 'country' which is required to fetch ToPostalCodes LOV" }, { "name": "includeInactiveFlag", @@ -3808,7 +3832,7 @@ } }, "204": { - "description": "CateringCodesLOV not found." + "description": "ToPostalCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3858,20 +3882,20 @@ ] } }, - "/listOfValues/country/{country}/postalCodes": { + "/listOfValues/currencyCode/{currencyCode}/exchangeTypes": { "get": { - "summary": "Fetch List Of Values for Postal Codes", - "description": "OperationId:getPostalCodesLOV
", - "operationId": "getPostalCodesLOV", + "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", "parameters": [ { - "name": "country", + "name": "currencyCode", "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 'currencyCode' which is required to fetch ExchangeTypes LOV" }, { "name": "includeInactiveFlag", @@ -3945,7 +3969,7 @@ } }, "204": { - "description": "PostalCodesLOV not found." + "description": "ExchangeTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -3995,20 +4019,20 @@ ] } }, - "/listOfValues/country/{country}/toPostalCodes": { + "/listOfValues/decimal/{decimal}/currencyFormats": { "get": { - "summary": "Fetch List Of Values for To Postal Codes", - "description": "OperationId:getToPostalCodesLOV
", - "operationId": "getToPostalCodesLOV", + "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", "parameters": [ { - "name": "country", + "name": "decimal", "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 'decimal' which is required to fetch CurrencyFormats LOV" }, { "name": "includeInactiveFlag", @@ -4082,7 +4106,7 @@ } }, "204": { - "description": "ToPostalCodesLOV not found." + "description": "CurrencyFormatsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4132,20 +4156,20 @@ ] } }, - "/listOfValues/currencyCode/{currencyCode}/exchangeTypes": { + "/listOfValues/departments/{departmentType}/noteTypes": { "get": { - "summary": "Fetch List Of Values for Exchange Types", - "description": "OperationId:getExchangeTypesLOV
", - "operationId": "getExchangeTypesLOV", + "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", "parameters": [ { - "name": "currencyCode", + "name": "departmentType", "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 'departmentType' which is required to fetch NoteTypes LOV" }, { "name": "includeInactiveFlag", @@ -4219,7 +4243,7 @@ } }, "204": { - "description": "ExchangeTypesLOV not found." + "description": "NoteTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4269,20 +4293,47 @@ ] } }, - "/listOfValues/decimal/{decimal}/currencyFormats": { + "/listOfValues/deviceType/{deviceType}/deviceCode/{deviceCode}/codeType/{codeType}/externalCode/{externalCode}/deviceCodeMappingValues": { "get": { - "summary": "Fetch List Of Values for Currency Formats", - "description": "OperationId:getCurrencyFormatsLOV
", - "operationId": "getCurrencyFormatsLOV", + "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", "parameters": [ { - "name": "decimal", + "name": "externalCode", "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 '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", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'deviceType' which is required to fetch DeviceCodeMappingValues LOV" }, { "name": "includeInactiveFlag", @@ -4356,7 +4407,7 @@ } }, "204": { - "description": "CurrencyFormatsLOV not found." + "description": "DeviceCodeMappingValuesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4406,20 +4457,20 @@ ] } }, - "/listOfValues/departments/{departmentType}/noteTypes": { + "/listOfValues/entityName/{entityName}/eCertificateGroupEntity": { "get": { - "summary": "Fetch List Of Values for Note Types", - "description": "OperationId:getNoteTypesLOV
", - "operationId": "getNoteTypesLOV", + "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", "parameters": [ { - "name": "departmentType", + "name": "entityName", "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 'entityName' which is required to fetch ECertificateGroupEntity LOV" }, { "name": "includeInactiveFlag", @@ -4493,7 +4544,7 @@ } }, "204": { - "description": "NoteTypesLOV not found." + "description": "ECertificateGroupEntityLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4543,47 +4594,157 @@ ] } }, - "/listOfValues/deviceType/{deviceType}/deviceCode/{deviceCode}/codeType/{codeType}/externalCode/{externalCode}/deviceCodeMappingValues": { + "/listOfValues/errorType/{errorType}/adsEchoToken": { "get": { - "summary": "Fetch List Of Values for Device Code Mapping Values", - "description": "OperationId:getDeviceCodeMappingValuesLOV
", - "operationId": "getDeviceCodeMappingValuesLOV", + "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", "parameters": [ { - "name": "externalCode", + "name": "errorType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'externalCode' which is required to fetch DeviceCodeMappingValues LOV" + "description": "Value of the parameter 'errorType' which is required to fetch ADSEchoToken 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": "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": "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": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false }, { - "name": "deviceType", + "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": "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" + }, + "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", "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 'errorType' which is required to fetch ADSStatus LOV" }, { "name": "includeInactiveFlag", @@ -4657,7 +4818,7 @@ } }, "204": { - "description": "DeviceCodeMappingValuesLOV not found." + "description": "ADSStatusLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4707,20 +4868,20 @@ ] } }, - "/listOfValues/entityName/{entityName}/eCertificateGroupEntity": { + "/listOfValues/exclusionList/{exclusionList}/cateringStatusCodes": { "get": { - "summary": "Fetch List Of Values for ECertificate Group Entity", - "description": "OperationId:getECertificateGroupEntityLOV
", - "operationId": "getECertificateGroupEntityLOV", + "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", "parameters": [ { - "name": "entityName", + "name": "exclusionList", "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 'exclusionList' which is required to fetch CateringStatusCodes LOV" }, { "name": "includeInactiveFlag", @@ -4794,7 +4955,7 @@ } }, "204": { - "description": "ECertificateGroupEntityLOV not found." + "description": "CateringStatusCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4844,20 +5005,20 @@ ] } }, - "/listOfValues/errorType/{errorType}/adsEchoToken": { + "/listOfValues/exclusionList/{exclusionList}/eventStatusCodes": { "get": { - "summary": "Fetch List Of Values for ADSEcho Token", - "description": "OperationId:getADSEchoTokenLOV
", - "operationId": "getADSEchoTokenLOV", + "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", "parameters": [ { - "name": "errorType", + "name": "exclusionList", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'errorType' which is required to fetch ADSEchoToken LOV" + "description": "Value of the parameter 'exclusionList' which is required to fetch EventStatusCodes LOV" }, { "name": "includeInactiveFlag", @@ -4931,7 +5092,7 @@ } }, "204": { - "description": "ADSEchoTokenLOV not found." + "description": "EventStatusCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -4981,20 +5142,29 @@ ] } }, - "/listOfValues/errorType/{errorType}/adsStatus": { + "/listOfValues/featureType/{featureType}/bookingChannels/{bookingChannelCodes}/gdsConvAmenityCodes": { "get": { - "summary": "Fetch List Of Values for ADSStatus", - "description": "OperationId:getADSStatusLOV
", - "operationId": "getADSStatusLOV", + "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", "parameters": [ { - "name": "errorType", + "name": "bookingChannelCodes", "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 'bookingChannelCodes' which is required to fetch GdsConvAmenityCodes LOV" + }, + { + "name": "featureType", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'featureType' which is required to fetch GdsConvAmenityCodes LOV" }, { "name": "includeInactiveFlag", @@ -5068,7 +5238,7 @@ } }, "204": { - "description": "ADSStatusLOV not found." + "description": "GdsConvAmenityCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5118,20 +5288,24 @@ ] } }, - "/listOfValues/exclusionList/{exclusionList}/cateringStatusCodes": { + "/listOfValues/fetchOnlyUniqueValues/{fetchOnlyUniqueValues}/templateTransactionSubgroups": { "get": { - "summary": "Fetch List Of Values for Catering Status Codes", - "description": "OperationId:getCateringStatusCodesLOV
", - "operationId": "getCateringStatusCodesLOV", + "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", "parameters": [ { - "name": "exclusionList", + "name": "fetchOnlyUniqueValues", "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 'fetchOnlyUniqueValues' which is required to fetch TemplateTransactionSubgroups LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -5205,7 +5379,7 @@ } }, "204": { - "description": "CateringStatusCodesLOV not found." + "description": "TemplateTransactionSubgroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5255,20 +5429,20 @@ ] } }, - "/listOfValues/exclusionList/{exclusionList}/eventStatusCodes": { + "/listOfValues/fieldType/{fieldType}/globalAlertFunction": { "get": { - "summary": "Fetch List Of Values for Event Status Codes", - "description": "OperationId:getEventStatusCodesLOV
", - "operationId": "getEventStatusCodesLOV", + "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", "parameters": [ { - "name": "exclusionList", + "name": "fieldType", "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 'fieldType' which is required to fetch GlobalAlertFunction LOV" }, { "name": "includeInactiveFlag", @@ -5342,7 +5516,7 @@ } }, "204": { - "description": "EventStatusCodesLOV not found." + "description": "GlobalAlertFunctionLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5392,29 +5566,29 @@ ] } }, - "/listOfValues/featureType/{featureType}/bookingChannels/{bookingChannelCodes}/gdsConvAmenityCodes": { + "/listOfValues/functionName/{functionName}/category/{category}/userDbFunctionArgs": { "get": { - "summary": "Fetch List Of Values for Gds Conv Amenity Codes", - "description": "OperationId:getGdsConvAmenityCodesLOV
", - "operationId": "getGdsConvAmenityCodesLOV", + "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", "parameters": [ { - "name": "bookingChannelCodes", + "name": "category", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'bookingChannelCodes' which is required to fetch GdsConvAmenityCodes LOV" + "description": "Value of the parameter 'category' which is required to fetch UserDbFunctionArgs LOV" }, { - "name": "featureType", + "name": "functionName", "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 'functionName' which is required to fetch UserDbFunctionArgs LOV" }, { "name": "includeInactiveFlag", @@ -5488,7 +5662,7 @@ } }, "204": { - "description": "GdsConvAmenityCodesLOV not found." + "description": "UserDbFunctionArgsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5538,24 +5712,29 @@ ] } }, - "/listOfValues/fetchOnlyUniqueValues/{fetchOnlyUniqueValues}/templateTransactionSubgroups": { + "/listOfValues/gdsHost/{gdsHost}/cardType/{cardType}/channelCardTypeMappingChannelCardType": { "get": { - "summary": "Fetch List Of Values for Template Transaction Subgroups", - "description": "OperationId:getTemplateTransactionSubgroupsLOV
", - "operationId": "getTemplateTransactionSubgroupsLOV", + "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", "parameters": [ { - "name": "fetchOnlyUniqueValues", + "name": "cardType", "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 'cardType' which is required to fetch ChannelCardTypeMappingChannelCardType LOV" + }, + { + "name": "gdsHost", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'gdsHost' which is required to fetch ChannelCardTypeMappingChannelCardType LOV" }, { "name": "includeInactiveFlag", @@ -5629,7 +5808,7 @@ } }, "204": { - "description": "TemplateTransactionSubgroupsLOV not found." + "description": "ChannelCardTypeMappingChannelCardTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5679,20 +5858,20 @@ ] } }, - "/listOfValues/fieldType/{fieldType}/globalAlertFunction": { + "/listOfValues/groupName/{groupName}/repGroupReports": { "get": { - "summary": "Fetch List Of Values for Global Alert Function", - "description": "OperationId:getGlobalAlertFunctionLOV
", - "operationId": "getGlobalAlertFunctionLOV", + "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", "parameters": [ { - "name": "fieldType", + "name": "groupName", "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 'groupName' which is required to fetch RepGroupReports LOV" }, { "name": "includeInactiveFlag", @@ -5766,7 +5945,7 @@ } }, "204": { - "description": "GlobalAlertFunctionLOV not found." + "description": "RepGroupReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5816,29 +5995,29 @@ ] } }, - "/listOfValues/functionName/{functionName}/category/{category}/userDbFunctionArgs": { + "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequency": { "get": { - "summary": "Fetch List Of Values for User Db Function Args", - "description": "OperationId:getUserDbFunctionArgsLOV
", - "operationId": "getUserDbFunctionArgsLOV", + "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", "parameters": [ { - "name": "category", + "name": "defaultDepartureTask", "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 'defaultDepartureTask' which is required to fetch Frequency LOV" }, { - "name": "functionName", + "name": "guestRequested", "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 'guestRequested' which is required to fetch Frequency LOV" }, { "name": "includeInactiveFlag", @@ -5912,7 +6091,7 @@ } }, "204": { - "description": "UserDbFunctionArgsLOV not found." + "description": "FrequencyLOV not found." }, "400": { "$ref": "#/responses/400" @@ -5962,29 +6141,29 @@ ] } }, - "/listOfValues/gdsHost/{gdsHost}/cardType/{cardType}/channelCardTypeMappingChannelCardType": { + "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequencyType": { "get": { - "summary": "Fetch List Of Values for Channel Card Type Mapping Channel Card Type", - "description": "OperationId:getChannelCardTypeMappingChannelCardTypeLOV
", - "operationId": "getChannelCardTypeMappingChannelCardTypeLOV", + "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", "parameters": [ { - "name": "cardType", + "name": "defaultDepartureTask", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'cardType' which is required to fetch ChannelCardTypeMappingChannelCardType LOV" + "description": "Value of the parameter 'defaultDepartureTask' which is required to fetch FrequencyType LOV" }, { - "name": "gdsHost", + "name": "guestRequested", "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 'guestRequested' which is required to fetch FrequencyType LOV" }, { "name": "includeInactiveFlag", @@ -6058,7 +6237,7 @@ } }, "204": { - "description": "ChannelCardTypeMappingChannelCardTypeLOV not found." + "description": "FrequencyTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6108,20 +6287,20 @@ ] } }, - "/listOfValues/groupName/{groupName}/repGroupReports": { + "/listOfValues/hotelCodeList/{hotelCodeList}/queueName": { "get": { - "summary": "Fetch List Of Values for Rep Group Reports", - "description": "OperationId:getRepGroupReportsLOV
", - "operationId": "getRepGroupReportsLOV", + "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", "parameters": [ { - "name": "groupName", + "name": "hotelCodeList", "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 'hotelCodeList' which is required to fetch QueueName LOV" }, { "name": "includeInactiveFlag", @@ -6195,7 +6374,7 @@ } }, "204": { - "description": "RepGroupReportsLOV not found." + "description": "QueueNameLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6245,29 +6424,20 @@ ] } }, - "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequency": { + "/listOfValues/hotelCodeList/{hotelCodeList}/repRoomTypeMultiHotel": { "get": { - "summary": "Fetch List Of Values for Frequency", - "description": "OperationId:getFrequencyLOV
", - "operationId": "getFrequencyLOV", + "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", "parameters": [ { - "name": "defaultDepartureTask", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'defaultDepartureTask' which is required to fetch Frequency LOV" - }, - { - "name": "guestRequested", + "name": "hotelCodeList", "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 'hotelCodeList' which is required to fetch RepRoomTypeMultiHotel LOV" }, { "name": "includeInactiveFlag", @@ -6341,7 +6511,7 @@ } }, "204": { - "description": "FrequencyLOV not found." + "description": "RepRoomTypeMultiHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6391,29 +6561,20 @@ ] } }, - "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequencyType": { + "/listOfValues/hotelCodeList/{hotelCodeList}/roomClassMultiProperty": { "get": { - "summary": "Fetch List Of Values for Frequency Type", - "description": "OperationId:getFrequencyTypeLOV
", - "operationId": "getFrequencyTypeLOV", + "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", "parameters": [ { - "name": "defaultDepartureTask", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'defaultDepartureTask' which is required to fetch FrequencyType LOV" - }, - { - "name": "guestRequested", + "name": "hotelCodeList", "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 'hotelCodeList' which is required to fetch RoomClassMultiProperty LOV" }, { "name": "includeInactiveFlag", @@ -6487,7 +6648,7 @@ } }, "204": { - "description": "FrequencyTypeLOV not found." + "description": "RoomClassMultiPropertyLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6537,20 +6698,20 @@ ] } }, - "/listOfValues/hotelCodeList/{hotelCodeList}/queueName": { + "/listOfValues/hotelCodesList/{hotelCodesList}/repOwnerCodes": { "get": { - "summary": "Fetch List Of Values for Queue Name", - "description": "OperationId:getQueueNameLOV
", - "operationId": "getQueueNameLOV", + "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", "parameters": [ { - "name": "hotelCodeList", + "name": "hotelCodesList", "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 'hotelCodesList' which is required to fetch RepOwnerCodes LOV" }, { "name": "includeInactiveFlag", @@ -6624,7 +6785,7 @@ } }, "204": { - "description": "QueueNameLOV not found." + "description": "RepOwnerCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6674,20 +6835,20 @@ ] } }, - "/listOfValues/hotelCodeList/{hotelCodeList}/repRoomTypeMultiHotel": { + "/listOfValues/hotels/{hotelId}/activities": { "get": { - "summary": "Fetch List Of Values for Rep Room Type Multi Hotel", - "description": "OperationId:getRepRoomTypeMultiHotelLOV
", - "operationId": "getRepRoomTypeMultiHotelLOV", + "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", "parameters": [ { - "name": "hotelCodeList", + "name": "hotelId", "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 'hotelId' which is required to fetch Activities LOV" }, { "name": "includeInactiveFlag", @@ -6761,7 +6922,7 @@ } }, "204": { - "description": "RepRoomTypeMultiHotelLOV not found." + "description": "ActivitiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6811,20 +6972,20 @@ ] } }, - "/listOfValues/hotelCodeList/{hotelCodeList}/roomClassMultiProperty": { + "/listOfValues/hotels/{hotelId}/activityConfigTypes": { "get": { - "summary": "Fetch List Of Values for Room Class Multi Property", - "description": "OperationId:getRoomClassMultiPropertyLOV
", - "operationId": "getRoomClassMultiPropertyLOV", + "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", "parameters": [ { - "name": "hotelCodeList", + "name": "hotelId", "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 'hotelId' which is required to fetch ActivityConfigTypes LOV" }, { "name": "includeInactiveFlag", @@ -6898,7 +7059,7 @@ } }, "204": { - "description": "RoomClassMultiPropertyLOV not found." + "description": "ActivityConfigTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -6948,20 +7109,29 @@ ] } }, - "/listOfValues/hotelCodesList/{hotelCodesList}/repOwnerCodes": { + "/listOfValues/hotels/{hotelId}/activityGroup/{activityGroup}/userLogActivityTypes": { "get": { - "summary": "Fetch List Of Values for Rep Owner Codes", - "description": "OperationId:getRepOwnerCodesLOV
", - "operationId": "getRepOwnerCodesLOV", + "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", "parameters": [ { - "name": "hotelCodesList", + "name": "activityGroup", "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 'activityGroup' which is required to fetch UserLogActivityTypes LOV" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch UserLogActivityTypes LOV" }, { "name": "includeInactiveFlag", @@ -7035,7 +7205,7 @@ } }, "204": { - "description": "RepOwnerCodesLOV not found." + "description": "UserLogActivityTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7085,11 +7255,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activities": { + "/listOfValues/hotels/{hotelId}/activityLocations": { "get": { - "summary": "Fetch List Of Values for Activities", - "description": "OperationId:getActivitiesLOV
", - "operationId": "getActivitiesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -7098,7 +7268,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Activities LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ActivityLocations LOV" }, { "name": "includeInactiveFlag", @@ -7172,7 +7342,7 @@ } }, "204": { - "description": "ActivitiesLOV not found." + "description": "ActivityLocationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7222,11 +7392,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activityConfigTypes": { + "/listOfValues/hotels/{hotelId}/activityStatus": { "get": { - "summary": "Fetch List Of Values for Activity Config Types", - "description": "OperationId:getActivityConfigTypesLOV
", - "operationId": "getActivityConfigTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -7235,7 +7405,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ActivityConfigTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ActivityStatus LOV" }, { "name": "includeInactiveFlag", @@ -7309,7 +7479,7 @@ } }, "204": { - "description": "ActivityConfigTypesLOV not found." + "description": "ActivityStatusLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7359,21 +7529,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activityGroup/{activityGroup}/userLogActivityTypes": { + "/listOfValues/hotels/{hotelId}/activityTypes": { "get": { - "summary": "Fetch List Of Values for User Log Activity Types", - "description": "OperationId:getUserLogActivityTypesLOV
", - "operationId": "getUserLogActivityTypesLOV", + "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", "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", @@ -7381,7 +7542,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UserLogActivityTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ActivityTypes LOV" }, { "name": "includeInactiveFlag", @@ -7455,7 +7616,7 @@ } }, "204": { - "description": "UserLogActivityTypesLOV not found." + "description": "ActivityTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7505,12 +7666,48 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activityLocations": { + "/listOfValues/hotels/{hotelId}/adults/{adults}/children/{children}/arrival/{arrival}/departure/{departure}/reservationPackages": { "get": { - "summary": "Fetch List Of Values for Activity Locations", - "description": "OperationId:getActivityLocationsLOV
", - "operationId": "getActivityLocationsLOV", + "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", "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", @@ -7518,7 +7715,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 ReservationPackages LOV" }, { "name": "includeInactiveFlag", @@ -7592,7 +7789,7 @@ } }, "204": { - "description": "ActivityLocationsLOV not found." + "description": "ReservationPackagesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7642,12 +7839,48 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activityStatus": { + "/listOfValues/hotels/{hotelId}/adults/{adults}/children/{children}/arrival/{arrival}/group/{group}/reservationPackagesGroupItems": { "get": { - "summary": "Fetch List Of Values for Activity Status", - "description": "OperationId:getActivityStatusLOV
", - "operationId": "getActivityStatusLOV", + "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", "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", @@ -7655,7 +7888,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 ReservationPackagesGroupItems LOV" }, { "name": "includeInactiveFlag", @@ -7729,7 +7962,7 @@ } }, "204": { - "description": "ActivityStatusLOV not found." + "description": "ReservationPackagesGroupItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7779,11 +8012,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activityTypes": { + "/listOfValues/hotels/{hotelId}/agentAccounts": { "get": { - "summary": "Fetch List Of Values for Activity Types", - "description": "OperationId:getActivityTypesLOV
", - "operationId": "getActivityTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -7792,7 +8025,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 AgentAccounts LOV" }, { "name": "includeInactiveFlag", @@ -7866,7 +8099,7 @@ } }, "204": { - "description": "ActivityTypesLOV not found." + "description": "AgentAccountsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -7916,48 +8149,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/adults/{adults}/children/{children}/arrival/{arrival}/departure/{departure}/reservationPackages": { + "/listOfValues/hotels/{hotelId}/agentSourceCities": { "get": { - "summary": "Fetch List Of Values for Reservation Packages", - "description": "OperationId:getReservationPackagesLOV
", - "operationId": "getReservationPackagesLOV", + "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", "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", @@ -7965,7 +8162,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 AgentSourceCities LOV" }, { "name": "includeInactiveFlag", @@ -8039,7 +8236,7 @@ } }, "204": { - "description": "ReservationPackagesLOV not found." + "description": "AgentSourceCitiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8089,48 +8286,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/adults/{adults}/children/{children}/arrival/{arrival}/group/{group}/reservationPackagesGroupItems": { + "/listOfValues/hotels/{hotelId}/agentSourceResvCities": { "get": { - "summary": "Fetch List Of Values for Reservation Packages Group Items", - "description": "OperationId:getReservationPackagesGroupItemsLOV
", - "operationId": "getReservationPackagesGroupItemsLOV", + "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": "group", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'group' which is required to fetch ReservationPackagesGroupItems LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch AgentSourceResvCities 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": "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": "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": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false }, { - "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": "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": "AgentSourceResvCitiesLOV 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}/alertCodes": { + "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", + "parameters": [ { "name": "hotelId", "in": "path", @@ -8138,7 +8436,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 AlertCodes LOV" }, { "name": "includeInactiveFlag", @@ -8212,7 +8510,7 @@ } }, "204": { - "description": "ReservationPackagesGroupItemsLOV not found." + "description": "AlertCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8262,11 +8560,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/agentAccounts": { + "/listOfValues/hotels/{hotelId}/alternateHotelCodes": { "get": { - "summary": "Fetch List Of Values for Agent Accounts", - "description": "OperationId:getAgentAccountsLOV
", - "operationId": "getAgentAccountsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -8275,7 +8573,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 AlternateHotelCodes LOV" }, { "name": "includeInactiveFlag", @@ -8349,7 +8647,7 @@ } }, "204": { - "description": "AgentAccountsLOV not found." + "description": "AlternateHotelCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8399,11 +8697,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/agentSourceCities": { + "/listOfValues/hotels/{hotelId}/amenities": { "get": { - "summary": "Fetch List Of Values for Agent Source Cities", - "description": "OperationId:getAgentSourceCitiesLOV
", - "operationId": "getAgentSourceCitiesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -8412,7 +8710,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AgentSourceCities LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Amenities LOV" }, { "name": "includeInactiveFlag", @@ -8486,7 +8784,7 @@ } }, "204": { - "description": "AgentSourceCitiesLOV not found." + "description": "AmenitiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8536,11 +8834,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/agentSourceResvCities": { + "/listOfValues/hotels/{hotelId}/arAccountTypes": { "get": { - "summary": "Fetch List Of Values for Agent Source Resv Cities", - "description": "OperationId:getAgentSourceResvCitiesLOV
", - "operationId": "getAgentSourceResvCitiesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -8549,7 +8847,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 ARAccountTypes LOV" }, { "name": "includeInactiveFlag", @@ -8623,7 +8921,7 @@ } }, "204": { - "description": "AgentSourceResvCitiesLOV not found." + "description": "ARAccountTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8673,11 +8971,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/alertCodes": { + "/listOfValues/hotels/{hotelId}/arCreditCards": { "get": { - "summary": "Fetch List Of Values for Alert Codes", - "description": "OperationId:getAlertCodesLOV
", - "operationId": "getAlertCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -8686,7 +8984,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 ARCreditCards LOV" }, { "name": "includeInactiveFlag", @@ -8760,7 +9058,7 @@ } }, "204": { - "description": "AlertCodesLOV not found." + "description": "ARCreditCardsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8810,11 +9108,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/alternateHotelCodes": { + "/listOfValues/hotels/{hotelId}/arrangementCode": { "get": { - "summary": "Fetch List Of Values for Alternate Hotel Codes", - "description": "OperationId:getAlternateHotelCodesLOV
", - "operationId": "getAlternateHotelCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -8823,7 +9121,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 ArrangementCode LOV" }, { "name": "includeInactiveFlag", @@ -8897,7 +9195,7 @@ } }, "204": { - "description": "AlternateHotelCodesLOV not found." + "description": "ArrangementCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -8947,12 +9245,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/amenities": { + "/listOfValues/hotels/{hotelId}/arrangementCode/{arrangementCode}/packageArrangementAssociation": { "get": { - "summary": "Fetch List Of Values for Amenities", - "description": "OperationId:getAmenitiesLOV
", - "operationId": "getAmenitiesLOV", + "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", "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", @@ -8960,7 +9267,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 PackageArrangementAssociation LOV" }, { "name": "includeInactiveFlag", @@ -9034,7 +9341,7 @@ } }, "204": { - "description": "AmenitiesLOV not found." + "description": "PackageArrangementAssociationLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9084,12 +9391,39 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arAccountTypes": { + "/listOfValues/hotels/{hotelId}/arrival/{arrival}/departure/{departure}/blockId/{blockId}/blockRates": { "get": { - "summary": "Fetch List Of Values for ARAccount Types", - "description": "OperationId:getARAccountTypesLOV
", - "operationId": "getARAccountTypesLOV", + "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", "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", @@ -9097,7 +9431,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 BlockRates LOV" }, { "name": "includeInactiveFlag", @@ -9171,7 +9505,7 @@ } }, "204": { - "description": "ARAccountTypesLOV not found." + "description": "BlockRatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9221,12 +9555,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arCreditCards": { + "/listOfValues/hotels/{hotelId}/arrival/{arrival}/departure/{departure}/reservationTicketsCodes": { "get": { - "summary": "Fetch List Of Values for ARCredit Cards", - "description": "OperationId:getARCreditCardsLOV
", - "operationId": "getARCreditCardsLOV", + "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", "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", @@ -9234,7 +9586,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 ReservationTicketsCodes LOV" }, { "name": "includeInactiveFlag", @@ -9308,7 +9660,7 @@ } }, "204": { - "description": "ARCreditCardsLOV not found." + "description": "ReservationTicketsCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9358,12 +9710,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arrangementCode": { + "/listOfValues/hotels/{hotelId}/arrivalDate/{arrivalDate}/blockCodesByArrivalDate": { "get": { - "summary": "Fetch List Of Values for Arrangement Code", - "description": "OperationId:getArrangementCodeLOV
", - "operationId": "getArrangementCodeLOV", + "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", "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", @@ -9371,7 +9732,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 BlockCodesByArrivalDate LOV" }, { "name": "includeInactiveFlag", @@ -9445,7 +9806,7 @@ } }, "204": { - "description": "ArrangementCodeLOV not found." + "description": "BlockCodesByArrivalDateLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9495,21 +9856,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arrangementCode/{arrangementCode}/packageArrangementAssociation": { + "/listOfValues/hotels/{hotelId}/articleCodes": { "get": { - "summary": "Fetch List Of Values for Package Arrangement Association", - "description": "OperationId:getPackageArrangementAssociationLOV
", - "operationId": "getPackageArrangementAssociationLOV", + "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", "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", @@ -9517,7 +9869,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 ArticleCodes LOV" }, { "name": "includeInactiveFlag", @@ -9591,7 +9943,7 @@ } }, "204": { - "description": "PackageArrangementAssociationLOV not found." + "description": "ArticleCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9641,39 +9993,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arrival/{arrival}/departure/{departure}/blockId/{blockId}/blockRates": { + "/listOfValues/hotels/{hotelId}/attractions": { "get": { - "summary": "Fetch List Of Values for Block Rates", - "description": "OperationId:getBlockRatesLOV
", - "operationId": "getBlockRatesLOV", + "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", "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", @@ -9681,7 +10006,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 Attractions LOV" }, { "name": "includeInactiveFlag", @@ -9755,7 +10080,7 @@ } }, "204": { - "description": "BlockRatesLOV not found." + "description": "AttractionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9805,30 +10130,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arrival/{arrival}/departure/{departure}/reservationTicketsCodes": { + "/listOfValues/hotels/{hotelId}/authorizer": { "get": { - "summary": "Fetch List Of Values for Reservation Tickets Codes", - "description": "OperationId:getReservationTicketsCodesLOV
", - "operationId": "getReservationTicketsCodesLOV", + "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", "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", @@ -9836,7 +10143,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 Authorizer LOV" }, { "name": "includeInactiveFlag", @@ -9910,7 +10217,7 @@ } }, "204": { - "description": "ReservationTicketsCodesLOV not found." + "description": "AuthorizerLOV not found." }, "400": { "$ref": "#/responses/400" @@ -9960,21 +10267,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/arrivalDate/{arrivalDate}/blockCodesByArrivalDate": { + "/listOfValues/hotels/{hotelId}/availableProfileOwnerRooms": { "get": { - "summary": "Fetch List Of Values for Block Codes By Arrival Date", - "description": "OperationId:getBlockCodesByArrivalDateLOV
", - "operationId": "getBlockCodesByArrivalDateLOV", + "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", "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", @@ -9982,7 +10280,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 AvailableProfileOwnerRooms LOV" }, { "name": "includeInactiveFlag", @@ -10056,7 +10354,7 @@ } }, "204": { - "description": "BlockCodesByArrivalDateLOV not found." + "description": "AvailableProfileOwnerRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10106,11 +10404,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/articleCodes": { + "/listOfValues/hotels/{hotelId}/availableScriptLanguages": { "get": { - "summary": "Fetch List Of Values for Article Codes", - "description": "OperationId:getArticleCodesLOV
", - "operationId": "getArticleCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -10119,7 +10417,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 AvailableScriptLanguages LOV" }, { "name": "includeInactiveFlag", @@ -10193,7 +10491,7 @@ } }, "204": { - "description": "ArticleCodesLOV not found." + "description": "AvailableScriptLanguagesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10243,11 +10541,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/attractions": { + "/listOfValues/hotels/{hotelId}/awardCodes": { "get": { - "summary": "Fetch List Of Values for Attractions", - "description": "OperationId:getAttractionsLOV
", - "operationId": "getAttractionsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -10256,7 +10554,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 AwardCodes LOV" }, { "name": "includeInactiveFlag", @@ -10330,7 +10628,7 @@ } }, "204": { - "description": "AttractionsLOV not found." + "description": "AwardCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10380,11 +10678,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/authorizer": { + "/listOfValues/hotels/{hotelId}/awardCodesMultiHotel": { "get": { - "summary": "Fetch List Of Values for Authorizer", - "description": "OperationId:getAuthorizerLOV
", - "operationId": "getAuthorizerLOV", + "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", "parameters": [ { "name": "hotelId", @@ -10393,7 +10691,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 AwardCodesMultiHotel LOV" }, { "name": "includeInactiveFlag", @@ -10467,7 +10765,7 @@ } }, "204": { - "description": "AuthorizerLOV not found." + "description": "AwardCodesMultiHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10517,11 +10815,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/availableProfileOwnerRooms": { + "/listOfValues/hotels/{hotelId}/awardMktgCodes": { "get": { - "summary": "Fetch List Of Values for Available Profile Owner Rooms", - "description": "OperationId:getAvailableProfileOwnerRoomsLOV
", - "operationId": "getAvailableProfileOwnerRoomsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -10530,7 +10828,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 AwardMktgCodes LOV" }, { "name": "includeInactiveFlag", @@ -10604,7 +10902,7 @@ } }, "204": { - "description": "AvailableProfileOwnerRoomsLOV not found." + "description": "AwardMktgCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10654,11 +10952,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/availableScriptLanguages": { + "/listOfValues/hotels/{hotelId}/bankAccounts": { "get": { - "summary": "Fetch List Of Values for Available Script Languages", - "description": "OperationId:getAvailableScriptLanguagesLOV
", - "operationId": "getAvailableScriptLanguagesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -10667,7 +10965,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 BankAccounts LOV" }, { "name": "includeInactiveFlag", @@ -10741,7 +11039,7 @@ } }, "204": { - "description": "AvailableScriptLanguagesLOV not found." + "description": "BankAccountsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10791,11 +11089,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/awardCodes": { + "/listOfValues/hotels/{hotelId}/bankAccountsForReports": { "get": { - "summary": "Fetch List Of Values for Award Codes", - "description": "OperationId:getAwardCodesLOV
", - "operationId": "getAwardCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -10804,7 +11102,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 BankAccountsForReports LOV" }, { "name": "includeInactiveFlag", @@ -10878,7 +11176,7 @@ } }, "204": { - "description": "AwardCodesLOV not found." + "description": "BankAccountsForReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -10928,11 +11226,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/awardCodesMultiHotel": { + "/listOfValues/hotels/{hotelId}/banquetPrintingMethod": { "get": { - "summary": "Fetch List Of Values for Award Codes Multi Hotel", - "description": "OperationId:getAwardCodesMultiHotelLOV
", - "operationId": "getAwardCodesMultiHotelLOV", + "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", "parameters": [ { "name": "hotelId", @@ -10941,7 +11239,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 BanquetPrintingMethod LOV" }, { "name": "includeInactiveFlag", @@ -11015,7 +11313,7 @@ } }, "204": { - "description": "AwardCodesMultiHotelLOV not found." + "description": "BanquetPrintingMethodLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11065,12 +11363,25 @@ ] } }, - "/listOfValues/hotels/{hotelId}/awardMktgCodes": { + "/listOfValues/hotels/{hotelId}/beforeIncomeAudit/{beforeIncomeAudit}/endOfDayReports": { "get": { - "summary": "Fetch List Of Values for Award Mktg Codes", - "description": "OperationId:getAwardMktgCodesLOV
", - "operationId": "getAwardMktgCodesLOV", + "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", "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", @@ -11078,7 +11389,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 EndOfDayReports LOV" }, { "name": "includeInactiveFlag", @@ -11152,7 +11463,7 @@ } }, "204": { - "description": "AwardMktgCodesLOV not found." + "description": "EndOfDayReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11202,12 +11513,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bankAccounts": { + "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/blockCodes": { "get": { - "summary": "Fetch List Of Values for Bank Accounts", - "description": "OperationId:getBankAccountsLOV
", - "operationId": "getBankAccountsLOV", + "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", "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", @@ -11215,7 +11544,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 BlockCodes LOV" }, { "name": "includeInactiveFlag", @@ -11289,7 +11618,7 @@ } }, "204": { - "description": "BankAccountsLOV not found." + "description": "BlockCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11339,12 +11668,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bankAccountsForReports": { + "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/blockIds": { "get": { - "summary": "Fetch List Of Values for Bank Accounts For Reports", - "description": "OperationId:getBankAccountsForReportsLOV
", - "operationId": "getBankAccountsForReportsLOV", + "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", "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", @@ -11352,7 +11699,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 BlockIds LOV" }, { "name": "includeInactiveFlag", @@ -11426,7 +11773,7 @@ } }, "204": { - "description": "BankAccountsForReportsLOV not found." + "description": "BlockIdsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11476,12 +11823,43 @@ ] } }, - "/listOfValues/hotels/{hotelId}/banquetPrintingMethod": { + "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/negotiatedOnly/{negotiatedOnly}/blockRateCodes": { "get": { - "summary": "Fetch List Of Values for Banquet Printing Method", - "description": "OperationId:getBanquetPrintingMethodLOV
", - "operationId": "getBanquetPrintingMethodLOV", + "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", "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", @@ -11489,7 +11867,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 BlockRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -11563,7 +11941,7 @@ } }, "204": { - "description": "BanquetPrintingMethodLOV not found." + "description": "BlockRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11613,24 +11991,29 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beforeIncomeAudit/{beforeIncomeAudit}/endOfDayReports": { + "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/resStatReportRateCode": { "get": { - "summary": "Fetch List Of Values for End Of Day Reports", - "description": "OperationId:getEndOfDayReportsLOV
", - "operationId": "getEndOfDayReportsLOV", + "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", "parameters": [ { - "name": "beforeIncomeAudit", + "name": "endDate", "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" - ] + "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", @@ -11639,7 +12022,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 ResStatReportRateCode LOV" }, { "name": "includeInactiveFlag", @@ -11713,7 +12096,7 @@ } }, "204": { - "description": "EndOfDayReportsLOV not found." + "description": "ResStatReportRateCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11763,20 +12146,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/blockCodes": { + "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/membershipId/{membershipId}/membershipPromotions": { "get": { - "summary": "Fetch List Of Values for Block Codes", - "description": "OperationId:getBlockCodesLOV
", - "operationId": "getBlockCodesLOV", + "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", "parameters": [ { - "name": "endDate", + "name": "membershipId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'endDate' which is required to fetch BlockCodes LOV" + "description": "Value of the parameter 'membershipId' which is required to fetch MembershipPromotions LOV" }, { "name": "beginDate", @@ -11785,7 +12168,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'beginDate' which is required to fetch BlockCodes LOV" + "description": "Value of the parameter 'beginDate' which is required to fetch MembershipPromotions LOV" }, { "name": "hotelId", @@ -11794,7 +12177,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 MembershipPromotions LOV" }, { "name": "includeInactiveFlag", @@ -11868,7 +12251,7 @@ } }, "204": { - "description": "BlockCodesLOV not found." + "description": "MembershipPromotionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -11918,30 +12301,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/blockIds": { + "/listOfValues/hotels/{hotelId}/billingInstructions": { "get": { - "summary": "Fetch List Of Values for Block Ids", - "description": "OperationId:getBlockIdsLOV
", - "operationId": "getBlockIdsLOV", + "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", "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", @@ -11949,7 +12314,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 BillingInstructions LOV" }, { "name": "includeInactiveFlag", @@ -12023,7 +12388,7 @@ } }, "204": { - "description": "BlockIdsLOV not found." + "description": "BillingInstructionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12073,43 +12438,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/negotiatedOnly/{negotiatedOnly}/blockRateCodes": { + "/listOfValues/hotels/{hotelId}/blockCodesFinOperations": { "get": { - "summary": "Fetch List Of Values for Block Rate Codes", - "description": "OperationId:getBlockRateCodesLOV
", - "operationId": "getBlockRateCodesLOV", + "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", "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", @@ -12117,7 +12451,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 BlockCodesFinOperations LOV" }, { "name": "includeInactiveFlag", @@ -12191,7 +12525,7 @@ } }, "204": { - "description": "BlockRateCodesLOV not found." + "description": "BlockCodesFinOperationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12241,30 +12575,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/endDate/{endDate}/resStatReportRateCode": { + "/listOfValues/hotels/{hotelId}/blockEvents": { "get": { - "summary": "Fetch List Of Values for Res Stat Report Rate Code", - "description": "OperationId:getResStatReportRateCodeLOV
", - "operationId": "getResStatReportRateCodeLOV", + "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", "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", @@ -12272,7 +12588,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 BlockEvents LOV" }, { "name": "includeInactiveFlag", @@ -12346,7 +12662,7 @@ } }, "204": { - "description": "ResStatReportRateCodeLOV not found." + "description": "BlockEventsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12396,29 +12712,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/beginDate/{beginDate}/membershipId/{membershipId}/membershipPromotions": { + "/listOfValues/hotels/{hotelId}/blockId/{blockId}/blockEventIds": { "get": { - "summary": "Fetch List Of Values for Membership Promotions", - "description": "OperationId:getMembershipPromotionsLOV
", - "operationId": "getMembershipPromotionsLOV", + "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", "parameters": [ { - "name": "membershipId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'membershipId' which is required to fetch MembershipPromotions LOV" - }, - { - "name": "beginDate", + "name": "blockId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'beginDate' which is required to fetch MembershipPromotions LOV" + "description": "Value of the parameter 'blockId' which is required to fetch BlockEventIds LOV" }, { "name": "hotelId", @@ -12427,7 +12734,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 BlockEventIds LOV" }, { "name": "includeInactiveFlag", @@ -12501,7 +12808,7 @@ } }, "204": { - "description": "MembershipPromotionsLOV not found." + "description": "BlockEventIdsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12551,11 +12858,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/billingInstructions": { + "/listOfValues/hotels/{hotelId}/blockModeLov": { "get": { - "summary": "Fetch List Of Values for Billing Instructions", - "description": "OperationId:getBillingInstructionsLOV
", - "operationId": "getBillingInstructionsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -12564,7 +12871,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 BlockModeLov LOV" }, { "name": "includeInactiveFlag", @@ -12638,7 +12945,7 @@ } }, "204": { - "description": "BillingInstructionsLOV not found." + "description": "BlockModeLovLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12688,11 +12995,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/blockCodesFinOperations": { + "/listOfValues/hotels/{hotelId}/blockPaymentMethods": { "get": { - "summary": "Fetch List Of Values for Block Codes Fin Operations", - "description": "OperationId:getBlockCodesFinOperationsLOV
", - "operationId": "getBlockCodesFinOperationsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -12701,7 +13008,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 BlockPaymentMethods LOV" }, { "name": "includeInactiveFlag", @@ -12775,7 +13082,7 @@ } }, "204": { - "description": "BlockCodesFinOperationsLOV not found." + "description": "BlockPaymentMethodsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12825,12 +13132,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/blockEvents": { + "/listOfValues/hotels/{hotelId}/bookingChannels/{bookingChannelCode}/roomType/{roomType}/channelConfigRateCodes": { "get": { - "summary": "Fetch List Of Values for Block Events", - "description": "OperationId:getBlockEventsLOV
", - "operationId": "getBlockEventsLOV", + "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", "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", @@ -12838,7 +13163,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 ChannelConfigRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -12912,7 +13237,7 @@ } }, "204": { - "description": "BlockEventsLOV not found." + "description": "ChannelConfigRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -12962,20 +13287,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/blockId/{blockId}/blockEventIds": { + "/listOfValues/hotels/{hotelId}/bookingStatus/{bookingStatus}/blockReservationTypes": { "get": { - "summary": "Fetch List Of Values for Block Event Ids", - "description": "OperationId:getBlockEventIdsLOV
", - "operationId": "getBlockEventIdsLOV", + "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", "parameters": [ { - "name": "blockId", + "name": "bookingStatus", "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 'bookingStatus' which is required to fetch BlockReservationTypes LOV" }, { "name": "hotelId", @@ -12984,7 +13309,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 BlockReservationTypes LOV" }, { "name": "includeInactiveFlag", @@ -13058,7 +13383,7 @@ } }, "204": { - "description": "BlockEventIdsLOV not found." + "description": "BlockReservationTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13108,11 +13433,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/blockModeLov": { + "/listOfValues/hotels/{hotelId}/bookingTypesIndividuals": { "get": { - "summary": "Fetch List Of Values for Block Mode Lov", - "description": "OperationId:getBlockModeLovLOV
", - "operationId": "getBlockModeLovLOV", + "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", "parameters": [ { "name": "hotelId", @@ -13121,7 +13446,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 BookingTypesIndividuals LOV" }, { "name": "includeInactiveFlag", @@ -13195,7 +13520,7 @@ } }, "204": { - "description": "BlockModeLovLOV not found." + "description": "BookingTypesIndividualsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13245,12 +13570,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/blockPaymentMethods": { + "/listOfValues/hotels/{hotelId}/breakOutId/{breakOutId}/hkTaskSheetsNo": { "get": { - "summary": "Fetch List Of Values for Block Payment Methods", - "description": "OperationId:getBlockPaymentMethodsLOV
", - "operationId": "getBlockPaymentMethodsLOV", + "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", "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", @@ -13258,7 +13592,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 HKTaskSheetsNo LOV" }, { "name": "includeInactiveFlag", @@ -13332,7 +13666,7 @@ } }, "204": { - "description": "BlockPaymentMethodsLOV not found." + "description": "HKTaskSheetsNoLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13382,29 +13716,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bookingChannels/{bookingChannelCode}/roomType/{roomType}/channelConfigRateCodes": { + "/listOfValues/hotels/{hotelId}/bucketType/{bucketType}/revenueBucketTrxCodes": { "get": { - "summary": "Fetch List Of Values for Channel Config Rate Codes", - "description": "OperationId:getChannelConfigRateCodesLOV
", - "operationId": "getChannelConfigRateCodesLOV", + "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", "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", + "name": "bucketType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'bookingChannelCode' which is required to fetch ChannelConfigRateCodes LOV" + "description": "Value of the parameter 'bucketType' which is required to fetch RevenueBucketTrxCodes LOV" }, { "name": "hotelId", @@ -13413,7 +13738,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 RevenueBucketTrxCodes LOV" }, { "name": "includeInactiveFlag", @@ -13487,7 +13812,7 @@ } }, "204": { - "description": "ChannelConfigRateCodesLOV not found." + "description": "RevenueBucketTrxCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13537,21 +13862,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bookingStatus/{bookingStatus}/blockReservationTypes": { + "/listOfValues/hotels/{hotelId}/budgetForecastCodes": { "get": { - "summary": "Fetch List Of Values for Block Reservation Types", - "description": "OperationId:getBlockReservationTypesLOV
", - "operationId": "getBlockReservationTypesLOV", + "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": "bookingStatus", + "name": "hotelId", "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 'hotelId' which is required to fetch BudgetForecastCodes 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": "BudForecastCodesLOV 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}/budgetRateCodes": { + "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", + "parameters": [ { "name": "hotelId", "in": "path", @@ -13559,7 +14012,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 BudgetRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -13633,7 +14086,7 @@ } }, "204": { - "description": "BlockReservationTypesLOV not found." + "description": "BudRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13683,12 +14136,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bookingTypesIndividuals": { + "/listOfValues/hotels/{hotelId}/businessDate/{businessDate}/hkScheduledAttendants": { "get": { - "summary": "Fetch List Of Values for Booking Types Individuals", - "description": "OperationId:getBookingTypesIndividualsLOV
", - "operationId": "getBookingTypesIndividualsLOV", + "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", "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", @@ -13696,7 +14158,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 HKScheduledAttendants LOV" }, { "name": "includeInactiveFlag", @@ -13770,7 +14232,7 @@ } }, "204": { - "description": "BookingTypesIndividualsLOV not found." + "description": "HKScheduledAttendantsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13820,21 +14282,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/breakOutId/{breakOutId}/hkTaskSheetsNo": { + "/listOfValues/hotels/{hotelId}/campaignActivityTypes": { "get": { - "summary": "Fetch List Of Values for HKTask Sheets No", - "description": "OperationId:getHKTaskSheetsNoLOV
", - "operationId": "getHKTaskSheetsNoLOV", + "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", "parameters": [ { - "name": "breakOutId", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'breakOutId' which is required to fetch HKTaskSheetsNo LOV" + "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" + }, + "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", @@ -13842,7 +14432,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 CashRegisterID LOV" }, { "name": "includeInactiveFlag", @@ -13916,7 +14506,7 @@ } }, "204": { - "description": "HKTaskSheetsNoLOV not found." + "description": "CashRegisterIDLOV not found." }, "400": { "$ref": "#/responses/400" @@ -13966,20 +14556,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/bucketType/{bucketType}/revenueBucketTrxCodes": { + "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeEventCodes": { "get": { - "summary": "Fetch List Of Values for Revenue Bucket Trx Codes", - "description": "OperationId:getRevenueBucketTrxCodesLOV
", - "operationId": "getRevenueBucketTrxCodesLOV", + "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", "parameters": [ { - "name": "bucketType", + "name": "catBudgetType", "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 'catBudgetType' which is required to fetch CatBudgetTypeEventCodes LOV" }, { "name": "hotelId", @@ -13988,7 +14578,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RevenueBucketTrxCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CatBudgetTypeEventCodes LOV" }, { "name": "includeInactiveFlag", @@ -14062,7 +14652,7 @@ } }, "204": { - "description": "RevenueBucketTrxCodesLOV not found." + "description": "CatBudTypeEventCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14112,12 +14702,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/budgetForecastCodes": { + "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeMarketCodes": { "get": { - "summary": "Fetch List Of Values for Budget Forecast Codes", - "description": "OperationId:getBudgetForecastCodesLOV
", - "operationId": "getBudgetForecastCodesLOV", + "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", "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", @@ -14125,7 +14724,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 CatBudgetTypeMarketCodes LOV" }, { "name": "includeInactiveFlag", @@ -14199,7 +14798,7 @@ } }, "204": { - "description": "BudForecastCodesLOV not found." + "description": "CatBudTypeMarketCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14249,12 +14848,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/budgetRateCodes": { + "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeMealCodes": { "get": { - "summary": "Fetch List Of Values for Budget Rate Codes", - "description": "OperationId:getBudgetRateCodesLOV
", - "operationId": "getBudgetRateCodesLOV", + "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", "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", @@ -14262,7 +14870,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 CatBudgetTypeMealCodes LOV" }, { "name": "includeInactiveFlag", @@ -14336,7 +14944,7 @@ } }, "204": { - "description": "BudRateCodesLOV not found." + "description": "CatBudTypeMealCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14386,20 +14994,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/businessDate/{businessDate}/hkScheduledAttendants": { + "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeRevenueCodes": { "get": { - "summary": "Fetch List Of Values for HKScheduled Attendants", - "description": "OperationId:getHKScheduledAttendantsLOV
", - "operationId": "getHKScheduledAttendantsLOV", + "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", "parameters": [ { - "name": "businessDate", + "name": "catBudgetType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'businessDate' which is required to fetch HKScheduledAttendants LOV" + "description": "Value of the parameter 'catBudgetType' which is required to fetch CatBudgetTypeRevenueCodes LOV" }, { "name": "hotelId", @@ -14408,7 +15016,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 CatBudgetTypeRevenueCodes LOV" }, { "name": "includeInactiveFlag", @@ -14482,7 +15090,7 @@ } }, "204": { - "description": "HKScheduledAttendantsLOV not found." + "description": "CatBudTypeRevenueCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14532,11 +15140,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/campaignActivityTypes": { + "/listOfValues/hotels/{hotelId}/cateringPackagePriceCodes": { "get": { - "summary": "Fetch List Of Values for Campaign Activity Types", - "description": "OperationId:getCampaignActivityTypesLOV
", - "operationId": "getCampaignActivityTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -14545,7 +15153,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CampaignActivityTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CateringPackagePriceCodes LOV" }, { "name": "includeInactiveFlag", @@ -14619,7 +15227,7 @@ } }, "204": { - "description": "CampaignActivityTypesLOV not found." + "description": "CateringPackagePriceCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14669,12 +15277,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/cashRegisterId": { + "/listOfValues/hotels/{hotelId}/channel/{channel}/bookingChannelRatePlans": { "get": { - "summary": "Fetch List Of Values for Cash Register ID", - "description": "OperationId:getCashRegisterIDLOV
", - "operationId": "getCashRegisterIDLOV", + "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", "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", @@ -14682,7 +15299,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 BookingChannelRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -14756,7 +15373,7 @@ } }, "204": { - "description": "CashRegisterIDLOV not found." + "description": "BookingChannelRatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14806,21 +15423,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeEventCodes": { + "/listOfValues/hotels/{hotelId}/channelCardTypeMappingCardType": { "get": { - "summary": "Fetch List Of Values for Cat Budget Type Event Codes", - "description": "OperationId:getCatBudgetTypeEventCodesLOV
", - "operationId": "getCatBudgetTypeEventCodesLOV", + "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", "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", @@ -14828,7 +15436,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 ChannelCardTypeMappingCardType LOV" }, { "name": "includeInactiveFlag", @@ -14902,7 +15510,7 @@ } }, "204": { - "description": "CatBudTypeEventCodesLOV not found." + "description": "ChannelCardTypeMappingCardTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -14952,21 +15560,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeMarketCodes": { + "/listOfValues/hotels/{hotelId}/channelCardTypeMappingGdsHost": { "get": { - "summary": "Fetch List Of Values for Cat Budget Type Market Codes", - "description": "OperationId:getCatBudgetTypeMarketCodesLOV
", - "operationId": "getCatBudgetTypeMarketCodesLOV", + "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", "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", @@ -14974,7 +15573,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 ChannelCardTypeMappingGdsHost LOV" }, { "name": "includeInactiveFlag", @@ -15048,7 +15647,7 @@ } }, "204": { - "description": "CatBudTypeMarketCodesLOV not found." + "description": "ChannelCardTypeMappingGdsHostLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15098,21 +15697,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeMealCodes": { + "/listOfValues/hotels/{hotelId}/commissionCode": { "get": { - "summary": "Fetch List Of Values for Cat Budget Type Meal Codes", - "description": "OperationId:getCatBudgetTypeMealCodesLOV
", - "operationId": "getCatBudgetTypeMealCodesLOV", + "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": "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", @@ -15120,7 +15710,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 CommissionCode LOV" }, { "name": "includeInactiveFlag", @@ -15194,7 +15784,7 @@ } }, "204": { - "description": "CatBudTypeMealCodesLOV not found." + "description": "CommissionCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15244,21 +15834,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/catBudgetType/{catBudgetType}/catBudgetTypeRevenueCodes": { + "/listOfValues/hotels/{hotelId}/commissionTxnCodes": { "get": { - "summary": "Fetch List Of Values for Cat Budget Type Revenue Codes", - "description": "OperationId:getCatBudgetTypeRevenueCodesLOV
", - "operationId": "getCatBudgetTypeRevenueCodesLOV", + "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", "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", @@ -15266,7 +15847,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 CommissionTxnCodes LOV" }, { "name": "includeInactiveFlag", @@ -15340,7 +15921,7 @@ } }, "204": { - "description": "CatBudTypeRevenueCodesLOV not found." + "description": "CommissionTxnCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15390,11 +15971,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/catBudgetTypeMarketCodesLoad": { + "/listOfValues/hotels/{hotelId}/compAuthorizers": { "get": { - "summary": "Fetch List Of Values for Cat Budget Type Market Codes", - "description": "OperationId:getCatBudgetTypeMarketCodesLOV
", - "operationId": "getCatBudgetTypeMarketCodesLoadLOV", + "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", "parameters": [ { "name": "hotelId", @@ -15403,7 +15984,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CatBudgetTypeMarketCodesLoad LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch CompAuthorizers LOV" }, { "name": "includeInactiveFlag", @@ -15477,7 +16058,7 @@ } }, "204": { - "description": "CatBudTypeMarketCodesLoadLOV not found." + "description": "CompAuthorizersLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15527,11 +16108,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/cateringPackagePriceCodes": { + "/listOfValues/hotels/{hotelId}/compTypes": { "get": { - "summary": "Fetch List Of Values for Catering Package Price Codes", - "description": "OperationId:getCateringPackagePriceCodesLOV
", - "operationId": "getCateringPackagePriceCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -15540,7 +16121,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 CompTypes LOV" }, { "name": "includeInactiveFlag", @@ -15614,7 +16195,7 @@ } }, "204": { - "description": "CateringPackagePriceCodesLOV not found." + "description": "CompTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15664,21 +16245,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/channel/{channel}/bookingChannelRatePlans": { + "/listOfValues/hotels/{hotelId}/companies": { "get": { - "summary": "Fetch List Of Values for Booking Channel Rate Plans", - "description": "OperationId:getBookingChannelRatePlansLOV
", - "operationId": "getBookingChannelRatePlansLOV", + "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", "parameters": [ { - "name": "channel", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'channel' which is required to fetch BookingChannelRatePlans LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch Companies 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": "CompaniesLOV 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}/confLetterReports": { + "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", + "parameters": [ { "name": "hotelId", "in": "path", @@ -15686,7 +16395,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 ConfLetterReports LOV" }, { "name": "includeInactiveFlag", @@ -15760,7 +16469,7 @@ } }, "204": { - "description": "BookingChannelRatePlansLOV not found." + "description": "ConfLetterReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15810,12 +16519,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/channelCardTypeMappingCardType": { + "/listOfValues/hotels/{hotelId}/configType/{configType}/exportMappingCodesToLink": { "get": { - "summary": "Fetch List Of Values for Channel Card Type Mapping Card Type", - "description": "OperationId:getChannelCardTypeMappingCardTypeLOV
", - "operationId": "getChannelCardTypeMappingCardTypeLOV", + "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", "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", @@ -15823,7 +16541,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 ExportMappingCodesToLink LOV" }, { "name": "includeInactiveFlag", @@ -15897,7 +16615,7 @@ } }, "204": { - "description": "ChannelCardTypeMappingCardTypeLOV not found." + "description": "ExportMappingCodesToLinkLOV not found." }, "400": { "$ref": "#/responses/400" @@ -15947,12 +16665,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/channelCardTypeMappingGdsHost": { + "/listOfValues/hotels/{hotelId}/contactType/{contactType}/hotelContactCommMethod": { "get": { - "summary": "Fetch List Of Values for Channel Card Type Mapping Gds Host", - "description": "OperationId:getChannelCardTypeMappingGdsHostLOV
", - "operationId": "getChannelCardTypeMappingGdsHostLOV", + "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", "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", @@ -15960,7 +16687,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ChannelCardTypeMappingGdsHost LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HotelContactCommMethod LOV" }, { "name": "includeInactiveFlag", @@ -16034,7 +16761,7 @@ } }, "204": { - "description": "ChannelCardTypeMappingGdsHostLOV not found." + "description": "HotelContactCommMethodLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16084,11 +16811,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/commissionCode": { + "/listOfValues/hotels/{hotelId}/creditCardTypes": { "get": { - "summary": "Fetch List Of Values for Commission Code", - "description": "OperationId:getCommissionCodeLOV
", - "operationId": "getCommissionCodeLOV", + "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", "parameters": [ { "name": "hotelId", @@ -16097,7 +16824,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 CreditCardTypes LOV" }, { "name": "includeInactiveFlag", @@ -16171,7 +16898,7 @@ } }, "204": { - "description": "CommissionCodeLOV not found." + "description": "CreditCardTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16221,12 +16948,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/commissionTxnCodes": { + "/listOfValues/hotels/{hotelId}/criteria/{criteria}/stageProfiles": { "get": { - "summary": "Fetch List Of Values for Commission Txn Codes", - "description": "OperationId:getCommissionTxnCodesLOV
", - "operationId": "getCommissionTxnCodesLOV", + "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", "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", @@ -16234,7 +16970,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 StageProfiles LOV" }, { "name": "includeInactiveFlag", @@ -16308,7 +17044,7 @@ } }, "204": { - "description": "CommissionTxnCodesLOV not found." + "description": "StageProfilesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16358,149 +17094,56 @@ ] } }, - "/listOfValues/hotels/{hotelId}/compAuthorizers": { + "/listOfValues/hotels/{hotelId}/currentRateCode/{currentRateCode}/currencyCode/{currencyCode}/daily/{daily}/tiered/{tiered}/configBaseRatePlans": { "get": { - "summary": "Fetch List Of Values for Comp Authorizers", - "description": "OperationId:getCompAuthorizersLOV
", - "operationId": "getCompAuthorizersLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "tiered", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CompAuthorizers 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 'tiered' which is required to fetch ConfigBaseRatePlans LOV", + "enum": [ + "Y", + "N" + ] }, { - "$ref": "#/parameters/x-hotelid" + "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" + ] }, { - "$ref": "#/parameters/x-externalsystem" + "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" }, { - "$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" + "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" }, - "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", @@ -16508,7 +17151,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 ConfigBaseRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -16582,7 +17225,7 @@ } }, "204": { - "description": "CompTypesLOV not found." + "description": "ConfigBaseRatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16632,12 +17275,47 @@ ] } }, - "/listOfValues/hotels/{hotelId}/companies": { + "/listOfValues/hotels/{hotelId}/currentRateCode/{currentRateCode}/tiered/{tiered}/daily/{daily}/configAdvDynamicBaseRatePlans": { "get": { - "summary": "Fetch List Of Values for Companies", - "description": "OperationId:getCompaniesLOV
", - "operationId": "getCompaniesLOV", + "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", "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", @@ -16645,7 +17323,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 ConfigAdvDynamicBaseRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -16719,7 +17397,7 @@ } }, "204": { - "description": "CompaniesLOV not found." + "description": "ConfigAdvDynamicBaseRatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16769,11 +17447,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/confLetterReports": { + "/listOfValues/hotels/{hotelId}/customNumberConfigCodes": { "get": { - "summary": "Fetch List Of Values for Conf Letter Reports", - "description": "OperationId:getConfLetterReportsLOV
", - "operationId": "getConfLetterReportsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -16782,7 +17460,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 CustomNumberConfigCodes LOV" }, { "name": "includeInactiveFlag", @@ -16856,7 +17534,7 @@ } }, "204": { - "description": "ConfLetterReportsLOV not found." + "description": "CustomNumberConfigCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -16906,20 +17584,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/configType/{configType}/exportMappingCodesToLink": { + "/listOfValues/hotels/{hotelId}/dbfLogo/{dbfLogo}/customRoomTranslation": { "get": { - "summary": "Fetch List Of Values for Export Mapping Codes To Link", - "description": "OperationId:getExportMappingCodesToLinkLOV
", - "operationId": "getExportMappingCodesToLinkLOV", + "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", "parameters": [ { - "name": "configType", + "name": "dbfLogo", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'configType' which is required to fetch ExportMappingCodesToLink LOV" + "description": "Value of the parameter 'dbfLogo' which is required to fetch CustomRoomTranslation LOV" }, { "name": "hotelId", @@ -16928,7 +17606,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 CustomRoomTranslation LOV" }, { "name": "includeInactiveFlag", @@ -17002,7 +17680,7 @@ } }, "204": { - "description": "ExportMappingCodesToLinkLOV not found." + "description": "CustomRoomTranslationLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17052,20 +17730,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/contactType/{contactType}/hotelContactCommMethod": { + "/listOfValues/hotels/{hotelId}/departmentId/{departmentId}/quickTexts": { "get": { - "summary": "Fetch List Of Values for Hotel Contact Comm Method", - "description": "OperationId:getHotelContactCommMethodLOV
", - "operationId": "getHotelContactCommMethodLOV", + "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", "parameters": [ { - "name": "contactType", + "name": "departmentId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'contactType' which is required to fetch HotelContactCommMethod LOV" + "description": "Value of the parameter 'departmentId' which is required to fetch QuickTexts LOV" }, { "name": "hotelId", @@ -17074,7 +17752,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 QuickTexts LOV" }, { "name": "includeInactiveFlag", @@ -17148,7 +17826,7 @@ } }, "204": { - "description": "HotelContactCommMethodLOV not found." + "description": "QuickTextsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17198,11 +17876,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/creditCardTypes": { + "/listOfValues/hotels/{hotelId}/deviceLocations": { "get": { - "summary": "Fetch List Of Values for Credit Card Types", - "description": "OperationId:getCreditCardTypesLOV
", - "operationId": "getCreditCardTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -17211,7 +17889,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 DeviceLocations LOV" }, { "name": "includeInactiveFlag", @@ -17285,7 +17963,7 @@ } }, "204": { - "description": "CreditCardTypesLOV not found." + "description": "DeviceLocationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17335,21 +18013,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/criteria/{criteria}/stageProfiles": { + "/listOfValues/hotels/{hotelId}/dietaryPreferences": { "get": { - "summary": "Fetch List Of Values for Stage Profiles", - "description": "OperationId:getStageProfilesLOV
", - "operationId": "getStageProfilesLOV", + "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", "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", @@ -17357,7 +18026,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 DietaryPreferences LOV" }, { "name": "includeInactiveFlag", @@ -17431,7 +18100,7 @@ } }, "204": { - "description": "StageProfilesLOV not found." + "description": "DietaryPreferencesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17481,56 +18150,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/currentRateCode/{currentRateCode}/currencyCode/{currencyCode}/daily/{daily}/tiered/{tiered}/configBaseRatePlans": { + "/listOfValues/hotels/{hotelId}/eCoupon": { "get": { - "summary": "Fetch List Of Values for Config Base Rate Plans", - "description": "OperationId:getConfigBaseRatePlansLOV
", - "operationId": "getConfigBaseRatePlansLOV", + "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", "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", @@ -17538,7 +18163,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 ECoupon LOV" }, { "name": "includeInactiveFlag", @@ -17612,7 +18237,7 @@ } }, "204": { - "description": "ConfigBaseRatePlansLOV not found." + "description": "ECouponLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17662,47 +18287,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/currentRateCode/{currentRateCode}/tiered/{tiered}/daily/{daily}/configAdvDynamicBaseRatePlans": { + "/listOfValues/hotels/{hotelId}/eCouponRateCodes": { "get": { - "summary": "Fetch List Of Values for Config Adv Dynamic Base Rate Plans", - "description": "OperationId:getConfigAdvDynamicBaseRatePlansLOV
", - "operationId": "getConfigAdvDynamicBaseRatePlansLOV", + "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", "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", @@ -17710,7 +18300,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 ECouponRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -17784,7 +18374,7 @@ } }, "204": { - "description": "ConfigAdvDynamicBaseRatePlansLOV not found." + "description": "ECouponRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17834,11 +18424,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/customNumberConfigCodes": { + "/listOfValues/hotels/{hotelId}/ecouponResvRoom": { "get": { - "summary": "Fetch List Of Values for Custom Number Config Codes", - "description": "OperationId:getCustomNumberConfigCodesLOV
", - "operationId": "getCustomNumberConfigCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -17847,7 +18437,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 EcouponResvRoom LOV" }, { "name": "includeInactiveFlag", @@ -17921,7 +18511,7 @@ } }, "204": { - "description": "CustomNumberConfigCodesLOV not found." + "description": "EcouponResvRoomLOV not found." }, "400": { "$ref": "#/responses/400" @@ -17971,11 +18561,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/cutoffScheduleCodes": { + "/listOfValues/hotels/{hotelId}/eventGroups": { "get": { - "summary": "Fetch List Of Values for Cutoff Schedule Codes.", - "description": "OperationId:getcutoffScheduleCodesLOV
", - "operationId": "getcutoffScheduleCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -17984,7 +18574,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch cutoffScheduleCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch EventGroups LOV" }, { "name": "includeInactiveFlag", @@ -18058,7 +18648,7 @@ } }, "204": { - "description": "cutoffScheduleCodes not found." + "description": "EventGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18108,21 +18698,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/dbfLogo/{dbfLogo}/customRoomTranslation": { + "/listOfValues/hotels/{hotelId}/eventLocations": { "get": { - "summary": "Fetch List Of Values for Custom Room Translation", - "description": "OperationId:getCustomRoomTranslationLOV
", - "operationId": "getCustomRoomTranslationLOV", + "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", "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", @@ -18130,7 +18711,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 EventLocations LOV" }, { "name": "includeInactiveFlag", @@ -18204,7 +18785,7 @@ } }, "204": { - "description": "CustomRoomTranslationLOV not found." + "description": "EventLocationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18254,20 +18835,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/departmentId/{departmentId}/quickTexts": { + "/listOfValues/hotels/{hotelId}/exchangeType/{exchangeType}/currencyExchangeRates": { "get": { - "summary": "Fetch List Of Values for Quick Texts", - "description": "OperationId:getQuickTextsLOV
", - "operationId": "getQuickTextsLOV", + "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", "parameters": [ { - "name": "departmentId", + "name": "exchangeType", "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 'exchangeType' which is required to fetch CurrencyExchangeRates LOV" }, { "name": "hotelId", @@ -18276,7 +18857,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 CurrencyExchangeRates LOV" }, { "name": "includeInactiveFlag", @@ -18350,7 +18931,7 @@ } }, "204": { - "description": "QuickTextsLOV not found." + "description": "CurrencyExchangeRatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18400,11 +18981,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/deviceLocations": { + "/listOfValues/hotels/{hotelId}/exportMappingTypeCodes": { "get": { - "summary": "Fetch List Of Values for Device Locations", - "description": "OperationId:getDeviceLocationsLOV
", - "operationId": "getDeviceLocationsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -18413,7 +18994,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 ExportMappingTypeCodes LOV" }, { "name": "includeInactiveFlag", @@ -18487,7 +19068,7 @@ } }, "204": { - "description": "DeviceLocationsLOV not found." + "description": "ExportMappingTypeCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18537,12 +19118,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/dietaryPreferences": { + "/listOfValues/hotels/{hotelId}/extSystem/{extSystem}/module/{module}/businessEventActionType": { "get": { - "summary": "Fetch List Of Values for Dietary Preferences", - "description": "OperationId:getDietaryPreferencesLOV
", - "operationId": "getDietaryPreferencesLOV", + "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", "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", @@ -18550,7 +19149,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 BusinessEventActionType LOV" }, { "name": "includeInactiveFlag", @@ -18624,7 +19223,7 @@ } }, "204": { - "description": "DietaryPreferencesLOV not found." + "description": "BusinessEventActionTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18674,11 +19273,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/eCoupon": { + "/listOfValues/hotels/{hotelId}/externalReferenceTypes": { "get": { - "summary": "Fetch List Of Values for ECoupon", - "description": "OperationId:getECouponLOV
", - "operationId": "getECouponLOV", + "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", "parameters": [ { "name": "hotelId", @@ -18687,7 +19286,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 ExternalReferenceTypes LOV" }, { "name": "includeInactiveFlag", @@ -18761,7 +19360,7 @@ } }, "204": { - "description": "ECouponLOV not found." + "description": "ExternalReferenceTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18811,11 +19410,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/eCouponRateCodes": { + "/listOfValues/hotels/{hotelId}/facilityCodes": { "get": { - "summary": "Fetch List Of Values for ECoupon Rate Codes", - "description": "OperationId:getECouponRateCodesLOV
", - "operationId": "getECouponRateCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -18824,7 +19423,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 FacilityCodes LOV" }, { "name": "includeInactiveFlag", @@ -18898,7 +19497,7 @@ } }, "204": { - "description": "ECouponRateCodesLOV not found." + "description": "FacilityCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -18948,12 +19547,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/ecouponResvRoom": { + "/listOfValues/hotels/{hotelId}/facilityTask/{facilityTask}/facilityCodesReservation": { "get": { - "summary": "Fetch List Of Values for Ecoupon Resv Room", - "description": "OperationId:getEcouponResvRoomLOV
", - "operationId": "getEcouponResvRoomLOV", + "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", "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", @@ -18961,7 +19569,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 FacilityCodesReservation LOV" }, { "name": "includeInactiveFlag", @@ -19035,7 +19643,7 @@ } }, "204": { - "description": "EcouponResvRoomLOV not found." + "description": "FacilityCodesReservationLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19085,11 +19693,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/eventGroups": { + "/listOfValues/hotels/{hotelId}/facilityTasks": { "get": { - "summary": "Fetch List Of Values for Event Groups", - "description": "OperationId:getEventGroupsLOV
", - "operationId": "getEventGroupsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -19098,7 +19706,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 FacilityTasks LOV" }, { "name": "includeInactiveFlag", @@ -19172,7 +19780,7 @@ } }, "204": { - "description": "EventGroupsLOV not found." + "description": "FacilityTasksLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19222,12 +19830,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/eventLocations": { + "/listOfValues/hotels/{hotelId}/fileGroup/{fileGroup}/availableExportTemplates": { "get": { - "summary": "Fetch List Of Values for Event Locations", - "description": "OperationId:getEventLocationsLOV
", - "operationId": "getEventLocationsLOV", + "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", "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", @@ -19235,7 +19852,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 AvailableExportTemplates LOV" }, { "name": "includeInactiveFlag", @@ -19309,7 +19926,7 @@ } }, "204": { - "description": "EventLocationsLOV not found." + "description": "AvailableExportTemplatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19359,21 +19976,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/exchangeType/{exchangeType}/currencyExchangeRates": { + "/listOfValues/hotels/{hotelId}/fiscalPaymentMethods": { "get": { - "summary": "Fetch List Of Values for Currency Exchange Rates", - "description": "OperationId:getCurrencyExchangeRatesLOV
", - "operationId": "getCurrencyExchangeRatesLOV", + "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", "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", @@ -19381,7 +19989,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 FiscalPaymentMethods LOV" }, { "name": "includeInactiveFlag", @@ -19455,7 +20063,7 @@ } }, "204": { - "description": "CurrencyExchangeRatesLOV not found." + "description": "FiscalPaymentMethodsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19505,12 +20113,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/exportMappingTypeCodes": { + "/listOfValues/hotels/{hotelId}/fiscalYearId/{fiscalYearId}/repFiscalMonths": { "get": { - "summary": "Fetch List Of Values for Export Mapping Type Codes", - "description": "OperationId:getExportMappingTypeCodesLOV
", - "operationId": "getExportMappingTypeCodesLOV", + "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", "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", @@ -19518,7 +20135,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 RepFiscalMonths LOV" }, { "name": "includeInactiveFlag", @@ -19592,7 +20209,7 @@ } }, "204": { - "description": "ExportMappingTypeCodesLOV not found." + "description": "RepFiscalMonthsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19642,29 +20259,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/extSystem/{extSystem}/module/{module}/businessEventActionType": { + "/listOfValues/hotels/{hotelId}/fiscalYearId/{fiscalYearId}/repFiscalWeeks": { "get": { - "summary": "Fetch List Of Values for Business Event Action Type", - "description": "OperationId:getBusinessEventActionTypeLOV
", - "operationId": "getBusinessEventActionTypeLOV", + "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", "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", + "name": "fiscalYearId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'extSystem' which is required to fetch BusinessEventActionType LOV" + "description": "Value of the parameter 'fiscalYearId' which is required to fetch RepFiscalWeeks LOV" }, { "name": "hotelId", @@ -19673,7 +20281,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 RepFiscalWeeks LOV" }, { "name": "includeInactiveFlag", @@ -19747,7 +20355,7 @@ } }, "204": { - "description": "BusinessEventActionTypeLOV not found." + "description": "RepFiscalWeeksLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19797,11 +20405,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/externalReferenceTypes": { + "/listOfValues/hotels/{hotelId}/fixedChargesTransactionCodes": { "get": { - "summary": "Fetch List Of Values for External Reference Types", - "description": "OperationId:getExternalReferenceTypesLOV
", - "operationId": "getExternalReferenceTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -19810,7 +20418,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 FixedChargesTransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -19884,7 +20492,7 @@ } }, "204": { - "description": "ExternalReferenceTypesLOV not found." + "description": "FixedChargesTransactionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -19934,11 +20542,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/facilityCodes": { + "/listOfValues/hotels/{hotelId}/floors": { "get": { - "summary": "Fetch List Of Values for Facility Codes", - "description": "OperationId:getFacilityCodesLOV
", - "operationId": "getFacilityCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -19947,7 +20555,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 Floors LOV" }, { "name": "includeInactiveFlag", @@ -20021,7 +20629,7 @@ } }, "204": { - "description": "FacilityCodesLOV not found." + "description": "FloorsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20071,21 +20679,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/facilityTask/{facilityTask}/facilityCodesReservation": { + "/listOfValues/hotels/{hotelId}/folioStyles": { "get": { - "summary": "Fetch List Of Values for Facility Codes Reservation", - "description": "OperationId:getFacilityCodesReservationLOV
", - "operationId": "getFacilityCodesReservationLOV", + "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", "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", @@ -20093,7 +20692,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 FolioStyles LOV" }, { "name": "includeInactiveFlag", @@ -20167,7 +20766,7 @@ } }, "204": { - "description": "FacilityCodesReservationLOV not found." + "description": "FolioStylesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20217,11 +20816,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/facilityTasks": { + "/listOfValues/hotels/{hotelId}/folioTypes": { "get": { - "summary": "Fetch List Of Values for Facility Tasks", - "description": "OperationId:getFacilityTasksLOV
", - "operationId": "getFacilityTasksLOV", + "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", "parameters": [ { "name": "hotelId", @@ -20230,7 +20829,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 FolioTypes LOV" }, { "name": "includeInactiveFlag", @@ -20304,7 +20903,7 @@ } }, "204": { - "description": "FacilityTasksLOV not found." + "description": "FolioTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20354,21 +20953,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fileGroup/{fileGroup}/availableExportTemplates": { + "/listOfValues/hotels/{hotelId}/forecastGroups": { "get": { - "summary": "Fetch List Of Values for Available Export Templates", - "description": "OperationId:getAvailableExportTemplatesLOV
", - "operationId": "getAvailableExportTemplatesLOV", + "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", "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", @@ -20376,7 +20966,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 ForecastGroups LOV" }, { "name": "includeInactiveFlag", @@ -20450,7 +21040,7 @@ } }, "204": { - "description": "AvailableExportTemplatesLOV not found." + "description": "ForecastGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20500,12 +21090,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fiscalPaymentMethods": { + "/listOfValues/hotels/{hotelId}/fromDate/{fromDate}/taskBreakOut": { "get": { - "summary": "Fetch List Of Values for Fiscal Payment Methods", - "description": "OperationId:getFiscalPaymentMethodsLOV
", - "operationId": "getFiscalPaymentMethodsLOV", + "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", "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", @@ -20513,7 +21112,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 TaskBreakOut LOV" }, { "name": "includeInactiveFlag", @@ -20587,7 +21186,7 @@ } }, "204": { - "description": "FiscalPaymentMethodsLOV not found." + "description": "TaskBreakOutLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20637,20 +21236,29 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fiscalYearId/{fiscalYearId}/repFiscalMonths": { + "/listOfValues/hotels/{hotelId}/fromDate/{fromDate}/toDate/{toDate}/repRoomsStat": { "get": { - "summary": "Fetch List Of Values for Rep Fiscal Months", - "description": "OperationId:getRepFiscalMonthsLOV
", - "operationId": "getRepFiscalMonthsLOV", + "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", "parameters": [ { - "name": "fiscalYearId", + "name": "toDate", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'fiscalYearId' which is required to fetch RepFiscalMonths LOV" + "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", @@ -20659,7 +21267,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 RepRoomsStat LOV" }, { "name": "includeInactiveFlag", @@ -20733,7 +21341,7 @@ } }, "204": { - "description": "RepFiscalMonthsLOV not found." + "description": "RepRoomsStatLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20783,20 +21391,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fiscalYearId/{fiscalYearId}/repFiscalWeeks": { + "/listOfValues/hotels/{hotelId}/fromRoomClass/{fromRoomClass}/upsellToRoomClassEdit": { "get": { - "summary": "Fetch List Of Values for Rep Fiscal Weeks", - "description": "OperationId:getRepFiscalWeeksLOV
", - "operationId": "getRepFiscalWeeksLOV", + "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", "parameters": [ { - "name": "fiscalYearId", + "name": "fromRoomClass", "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 'fromRoomClass' which is required to fetch UpsellToRoomClassEdit LOV" }, { "name": "hotelId", @@ -20805,7 +21413,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 UpsellToRoomClassEdit LOV" }, { "name": "includeInactiveFlag", @@ -20879,7 +21487,7 @@ } }, "204": { - "description": "RepFiscalWeeksLOV not found." + "description": "UpsellToRoomClassEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -20929,11 +21537,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fixedChargesTransactionCodes": { + "/listOfValues/hotels/{hotelId}/fromRoomNumber": { "get": { - "summary": "Fetch List Of Values for Fixed Charges Transaction Codes", - "description": "OperationId:getFixedChargesTransactionCodesLOV
", - "operationId": "getFixedChargesTransactionCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -20942,7 +21550,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 FromRoomNumber LOV" }, { "name": "includeInactiveFlag", @@ -21016,7 +21624,7 @@ } }, "204": { - "description": "FixedChargesTransactionCodesLOV not found." + "description": "FromRoomNumberLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21066,12 +21674,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/floors": { + "/listOfValues/hotels/{hotelId}/fromRoomTypeLabel/{fromRoomTypeLabel}/upsellToRoomTypeEdit": { "get": { - "summary": "Fetch List Of Values for Floors", - "description": "OperationId:getFloorsLOV
", - "operationId": "getFloorsLOV", + "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", "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", @@ -21079,7 +21696,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 UpsellToRoomTypeEdit LOV" }, { "name": "includeInactiveFlag", @@ -21153,7 +21770,7 @@ } }, "204": { - "description": "FloorsLOV not found." + "description": "UpsellToRoomTypeEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21203,11 +21820,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/folioStyles": { + "/listOfValues/hotels/{hotelId}/gemMenuItems": { "get": { - "summary": "Fetch List Of Values for Folio Styles", - "description": "OperationId:getFolioStylesLOV
", - "operationId": "getFolioStylesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -21216,7 +21833,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 GemMenuItems LOV" }, { "name": "includeInactiveFlag", @@ -21290,7 +21907,7 @@ } }, "204": { - "description": "FolioStylesLOV not found." + "description": "GemMenuItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21340,11 +21957,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/folioTypes": { + "/listOfValues/hotels/{hotelId}/genericReports": { "get": { - "summary": "Fetch List Of Values for Folio Types", - "description": "OperationId:getFolioTypesLOV
", - "operationId": "getFolioTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -21353,7 +21970,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 GenericReports LOV" }, { "name": "includeInactiveFlag", @@ -21427,7 +22044,7 @@ } }, "204": { - "description": "FolioTypesLOV not found." + "description": "GenericReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21477,11 +22094,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/forecastGroups": { + "/listOfValues/hotels/{hotelId}/groupArrivals": { "get": { - "summary": "Fetch List Of Values for Forecast Groups", - "description": "OperationId:getForecastGroupsLOV
", - "operationId": "getForecastGroupsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -21490,7 +22107,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 GroupArrivals LOV" }, { "name": "includeInactiveFlag", @@ -21564,7 +22181,7 @@ } }, "204": { - "description": "ForecastGroupsLOV not found." + "description": "GroupArrivalsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21614,21 +22231,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fromDate/{fromDate}/taskBreakOut": { + "/listOfValues/hotels/{hotelId}/groups": { "get": { - "summary": "Fetch List Of Values for Task Break Out", - "description": "OperationId:getTaskBreakOutLOV
", - "operationId": "getTaskBreakOutLOV", + "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", "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", @@ -21636,7 +22244,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 Groups LOV" }, { "name": "includeInactiveFlag", @@ -21710,7 +22318,7 @@ } }, "204": { - "description": "TaskBreakOutLOV not found." + "description": "GroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21760,30 +22368,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fromDate/{fromDate}/toDate/{toDate}/repRoomsStat": { + "/listOfValues/hotels/{hotelId}/guestMessagesMultiHotel": { "get": { - "summary": "Fetch List Of Values for Rep Rooms Stat", - "description": "OperationId:getRepRoomsStatLOV
", - "operationId": "getRepRoomsStatLOV", + "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", "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", @@ -21791,7 +22381,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 GuestMessagesMultiHotel LOV" }, { "name": "includeInactiveFlag", @@ -21865,7 +22455,7 @@ } }, "204": { - "description": "RepRoomsStatLOV not found." + "description": "GuestMessagesMultiHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -21915,21 +22505,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fromRoomClass/{fromRoomClass}/upsellToRoomClassEdit": { + "/listOfValues/hotels/{hotelId}/guestMessagesQuickTexts": { "get": { - "summary": "Fetch List Of Values for Upsell To Room Class Edit", - "description": "OperationId:getUpsellToRoomClassEditLOV
", - "operationId": "getUpsellToRoomClassEditLOV", + "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", "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", @@ -21937,7 +22518,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 GuestMessagesQuickTexts LOV" }, { "name": "includeInactiveFlag", @@ -22011,7 +22592,7 @@ } }, "204": { - "description": "UpsellToRoomClassEditLOV not found." + "description": "GuestMessagesQuickTextsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22061,11 +22642,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fromRoomNumber": { + "/listOfValues/hotels/{hotelId}/hkAttendants": { "get": { - "summary": "Fetch List Of Values for From Room Number", - "description": "OperationId:getFromRoomNumberLOV
", - "operationId": "getFromRoomNumberLOV", + "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", "parameters": [ { "name": "hotelId", @@ -22074,7 +22655,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 HKAttendants LOV" }, { "name": "includeInactiveFlag", @@ -22148,7 +22729,7 @@ } }, "204": { - "description": "FromRoomNumberLOV not found." + "description": "HKAttendantsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22198,21 +22779,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/fromRoomTypeLabel/{fromRoomTypeLabel}/upsellToRoomTypeEdit": { + "/listOfValues/hotels/{hotelId}/hkAttendantsMobile": { "get": { - "summary": "Fetch List Of Values for Upsell To Room Type Edit", - "description": "OperationId:getUpsellToRoomTypeEditLOV
", - "operationId": "getUpsellToRoomTypeEditLOV", + "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", "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", @@ -22220,7 +22792,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 HKAttendantsMobile LOV" }, { "name": "includeInactiveFlag", @@ -22294,7 +22866,7 @@ } }, "204": { - "description": "UpsellToRoomTypeEditLOV not found." + "description": "HKAttendantsMobileLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22344,11 +22916,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/gemMenuItems": { + "/listOfValues/hotels/{hotelId}/hkFloors": { "get": { - "summary": "Fetch List Of Values for Gem Menu Items", - "description": "OperationId:getGemMenuItemsLOV
", - "operationId": "getGemMenuItemsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -22357,7 +22929,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 HkFloors LOV" }, { "name": "includeInactiveFlag", @@ -22431,7 +23003,7 @@ } }, "204": { - "description": "GemMenuItemsLOV not found." + "description": "HkFloorsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22481,11 +23053,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/genericReports": { + "/listOfValues/hotels/{hotelId}/hkRoomTypes": { "get": { - "summary": "Fetch List Of Values for Generic Reports", - "description": "OperationId:getGenericReportsLOV
", - "operationId": "getGenericReportsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -22494,7 +23066,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 HkRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -22568,7 +23140,7 @@ } }, "204": { - "description": "GenericReportsLOV not found." + "description": "HkRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22618,11 +23190,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/groupArrivals": { + "/listOfValues/hotels/{hotelId}/hkRooms": { "get": { - "summary": "Fetch List Of Values for Group Arrivals", - "description": "OperationId:getGroupArrivalsLOV
", - "operationId": "getGroupArrivalsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -22631,7 +23203,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 HkRooms LOV" }, { "name": "includeInactiveFlag", @@ -22705,7 +23277,7 @@ } }, "204": { - "description": "GroupArrivalsLOV not found." + "description": "HkRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22755,11 +23327,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/groups": { + "/listOfValues/hotels/{hotelId}/hkTaskBreakOut": { "get": { - "summary": "Fetch List Of Values for Groups", - "description": "OperationId:getGroupsLOV
", - "operationId": "getGroupsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -22768,7 +23340,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 HKTaskBreakOut LOV" }, { "name": "includeInactiveFlag", @@ -22842,7 +23414,7 @@ } }, "204": { - "description": "GroupsLOV not found." + "description": "HKTaskBreakOutLOV not found." }, "400": { "$ref": "#/responses/400" @@ -22892,11 +23464,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/guestMessagesMultiHotel": { + "/listOfValues/hotels/{hotelId}/hkTaskCodes": { "get": { - "summary": "Fetch List Of Values for Guest Messages Multi Hotel", - "description": "OperationId:getGuestMessagesMultiHotelLOV
", - "operationId": "getGuestMessagesMultiHotelLOV", + "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", "parameters": [ { "name": "hotelId", @@ -22905,7 +23477,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 HKTaskCodes LOV" }, { "name": "includeInactiveFlag", @@ -22979,7 +23551,7 @@ } }, "204": { - "description": "GuestMessagesMultiHotelLOV not found." + "description": "HKTaskCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23029,11 +23601,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/guestMessagesQuickTexts": { + "/listOfValues/hotels/{hotelId}/hkTaskTemplates": { "get": { - "summary": "Fetch List Of Values for Guest Messages Quick Texts", - "description": "OperationId:getGuestMessagesQuickTextsLOV
", - "operationId": "getGuestMessagesQuickTextsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -23042,7 +23614,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 HKTaskTemplates LOV" }, { "name": "includeInactiveFlag", @@ -23116,7 +23688,7 @@ } }, "204": { - "description": "GuestMessagesQuickTextsLOV not found." + "description": "HKTaskTemplatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23166,11 +23738,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkAttendants": { + "/listOfValues/hotels/{hotelId}/hotelEventTypes": { "get": { - "summary": "Fetch List Of Values for HKAttendants", - "description": "OperationId:getHKAttendantsLOV
", - "operationId": "getHKAttendantsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -23179,7 +23751,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 HotelEventTypes LOV" }, { "name": "includeInactiveFlag", @@ -23253,7 +23825,7 @@ } }, "204": { - "description": "HKAttendantsLOV not found." + "description": "HotelEventTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23303,11 +23875,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkAttendantsMobile": { + "/listOfValues/hotels/{hotelId}/hotelInterfaceImportRooms": { "get": { - "summary": "Fetch List Of Values for HKAttendants Mobile", - "description": "OperationId:getHKAttendantsMobileLOV
", - "operationId": "getHKAttendantsMobileLOV", + "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", "parameters": [ { "name": "hotelId", @@ -23316,7 +23888,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 HotelInterfaceImportRooms LOV" }, { "name": "includeInactiveFlag", @@ -23390,7 +23962,7 @@ } }, "204": { - "description": "HKAttendantsMobileLOV not found." + "description": "HotelInterfaceImportRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23440,11 +24012,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkFloors": { + "/listOfValues/hotels/{hotelId}/hotelRateTier": { "get": { - "summary": "Fetch List Of Values for Hk Floors", - "description": "OperationId:getHkFloorsLOV
", - "operationId": "getHkFloorsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -23453,7 +24025,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 HotelRateTier LOV" }, { "name": "includeInactiveFlag", @@ -23527,7 +24099,7 @@ } }, "204": { - "description": "HkFloorsLOV not found." + "description": "HotelRateTierLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23577,11 +24149,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkRoomTypes": { + "/listOfValues/hotels/{hotelId}/houseKeepingRooms": { "get": { - "summary": "Fetch List Of Values for Hk Room Types", - "description": "OperationId:getHkRoomTypesLOV
", - "operationId": "getHkRoomTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -23590,7 +24162,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 HouseKeepingRooms LOV" }, { "name": "includeInactiveFlag", @@ -23664,7 +24236,7 @@ } }, "204": { - "description": "HkRoomTypesLOV not found." + "description": "HouseKeepingRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23714,11 +24286,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkRooms": { + "/listOfValues/hotels/{hotelId}/houseKeepingSections": { "get": { - "summary": "Fetch List Of Values for Hk Rooms", - "description": "OperationId:getHkRoomsLOV
", - "operationId": "getHkRoomsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -23727,7 +24299,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 HouseKeepingSections LOV" }, { "name": "includeInactiveFlag", @@ -23801,7 +24373,7 @@ } }, "204": { - "description": "HkRoomsLOV not found." + "description": "HouseKeepingSectionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23851,11 +24423,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkTaskBreakOut": { + "/listOfValues/hotels/{hotelId}/housekeepingCreditRules": { "get": { - "summary": "Fetch List Of Values for HKTask Break Out", - "description": "OperationId:getHKTaskBreakOutLOV
", - "operationId": "getHKTaskBreakOutLOV", + "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", "parameters": [ { "name": "hotelId", @@ -23864,7 +24436,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 HousekeepingCreditRules LOV" }, { "name": "includeInactiveFlag", @@ -23938,7 +24510,7 @@ } }, "204": { - "description": "HKTaskBreakOutLOV not found." + "description": "HousekeepingCreditRulesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -23988,149 +24560,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hkTaskCodes": { + "/listOfValues/hotels/{hotelId}/ifcId/{ifcId}/category/{category}/ifcRightsView": { "get": { - "summary": "Fetch List Of Values for HKTask Codes", - "description": "OperationId:getHKTaskCodesLOV
", - "operationId": "getHKTaskCodesLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "category", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HKTaskCodes 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 'category' which is required to fetch IfcRightsView 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": "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" + "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" }, - "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", @@ -24138,7 +24591,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 IfcRightsView LOV" }, { "name": "includeInactiveFlag", @@ -24212,7 +24665,7 @@ } }, "204": { - "description": "HKTaskTemplatesLOV not found." + "description": "IfcRightsViewLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24262,11 +24715,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hotelEventTypes": { + "/listOfValues/hotels/{hotelId}/imbalanceVerificationTypes": { "get": { - "summary": "Fetch List Of Values for Hotel Event Types", - "description": "OperationId:getHotelEventTypesLOV
", - "operationId": "getHotelEventTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -24275,7 +24728,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 ImbalanceVerificationTypes LOV" }, { "name": "includeInactiveFlag", @@ -24349,7 +24802,7 @@ } }, "204": { - "description": "HotelEventTypesLOV not found." + "description": "ImbalanceVerificationTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24399,12 +24852,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hotelInterfaceImportRooms": { + "/listOfValues/hotels/{hotelId}/includeBlank/{includeBlank}/upsellOccupancyLevels": { "get": { - "summary": "Fetch List Of Values for Hotel Interface Import Rooms", - "description": "OperationId:getHotelInterfaceImportRoomsLOV
", - "operationId": "getHotelInterfaceImportRoomsLOV", + "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", "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", @@ -24412,7 +24874,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 UpsellOccupancyLevels LOV" }, { "name": "includeInactiveFlag", @@ -24486,7 +24948,7 @@ } }, "204": { - "description": "HotelInterfaceImportRoomsLOV not found." + "description": "UpsellOccupancyLevelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24536,12 +24998,25 @@ ] } }, - "/listOfValues/hotels/{hotelId}/hotelRateTier": { + "/listOfValues/hotels/{hotelId}/includeInactive/{includeInactive}/sourceGroups": { "get": { - "summary": "Fetch List Of Values for Hotel Rate Tier", - "description": "OperationId:getHotelRateTierLOV
", - "operationId": "getHotelRateTierLOV", + "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", "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", @@ -24549,7 +25024,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 SourceGroups LOV" }, { "name": "includeInactiveFlag", @@ -24623,7 +25098,7 @@ } }, "204": { - "description": "HotelRateTierLOV not found." + "description": "SourceGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24673,11 +25148,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/houseKeepingRooms": { + "/listOfValues/hotels/{hotelId}/interfaceAutoBalance": { "get": { - "summary": "Fetch List Of Values for House Keeping Rooms", - "description": "OperationId:getHouseKeepingRoomsLOV
", - "operationId": "getHouseKeepingRoomsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -24686,7 +25161,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 InterfaceAutoBalance LOV" }, { "name": "includeInactiveFlag", @@ -24760,7 +25235,7 @@ } }, "204": { - "description": "HouseKeepingRoomsLOV not found." + "description": "InterfaceAutoBalanceLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24810,11 +25285,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/houseKeepingSections": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestMarketCode": { "get": { - "summary": "Fetch List Of Values for House Keeping Sections", - "description": "OperationId:getHouseKeepingSectionsLOV
", - "operationId": "getHouseKeepingSectionsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -24823,7 +25298,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 InterfaceDataRequestMarketCode LOV" }, { "name": "includeInactiveFlag", @@ -24897,7 +25372,7 @@ } }, "204": { - "description": "HouseKeepingSectionsLOV not found." + "description": "InterfaceDataRequestMarketCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -24947,11 +25422,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/housekeepingCreditRules": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestMarketGroup": { "get": { - "summary": "Fetch List Of Values for Housekeeping Credit Rules", - "description": "OperationId:getHousekeepingCreditRulesLOV
", - "operationId": "getHousekeepingCreditRulesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -24960,7 +25435,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 InterfaceDataRequestMarketGroup LOV" }, { "name": "includeInactiveFlag", @@ -25034,7 +25509,7 @@ } }, "204": { - "description": "HousekeepingCreditRulesLOV not found." + "description": "InterfaceDataRequestMarketGroupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25084,30 +25559,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/ifcId/{ifcId}/category/{category}/ifcRightsView": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestRoomClass": { "get": { - "summary": "Fetch List Of Values for Ifc Rights View", - "description": "OperationId:getIfcRightsViewLOV
", - "operationId": "getIfcRightsViewLOV", + "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", "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", @@ -25115,7 +25572,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 InterfaceDataRequestRoomClass LOV" }, { "name": "includeInactiveFlag", @@ -25189,7 +25646,7 @@ } }, "204": { - "description": "IfcRightsViewLOV not found." + "description": "InterfaceDataRequestRoomClassLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25239,11 +25696,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/imbalanceVerificationTypes": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestRoomTypes": { "get": { - "summary": "Fetch List Of Values for Imbalance Verification Types", - "description": "OperationId:getImbalanceVerificationTypesLOV
", - "operationId": "getImbalanceVerificationTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -25252,7 +25709,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 InterfaceDataRequestRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -25326,7 +25783,7 @@ } }, "204": { - "description": "ImbalanceVerificationTypesLOV not found." + "description": "InterfaceDataRequestRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25376,21 +25833,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/includeBlank/{includeBlank}/upsellOccupancyLevels": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestSourceCode": { "get": { - "summary": "Fetch List Of Values for Upsell Occupancy Levels", - "description": "OperationId:getUpsellOccupancyLevelsLOV
", - "operationId": "getUpsellOccupancyLevelsLOV", + "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", "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", @@ -25398,7 +25846,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 InterfaceDataRequestSourceCode LOV" }, { "name": "includeInactiveFlag", @@ -25472,7 +25920,7 @@ } }, "204": { - "description": "UpsellOccupancyLevelsLOV not found." + "description": "InterfaceDataRequestSourceCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25522,25 +25970,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/includeInactive/{includeInactive}/sourceGroups": { + "/listOfValues/hotels/{hotelId}/interfaceDataRequestSourceGroup": { "get": { - "summary": "Fetch List Of Values for Source Groups", - "description": "OperationId:getSourceGroupsLOV
", - "operationId": "getSourceGroupsLOV", + "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", "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", @@ -25548,7 +25983,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 InterfaceDataRequestSourceGroup LOV" }, { "name": "includeInactiveFlag", @@ -25622,7 +26057,7 @@ } }, "204": { - "description": "SourceGroupsLOV not found." + "description": "InterfaceDataRequestSourceGroupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25672,11 +26107,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceAutoBalance": { + "/listOfValues/hotels/{hotelId}/interfacePseudoRoom": { "get": { - "summary": "Fetch List Of Values for Interface Auto Balance", - "description": "OperationId:getInterfaceAutoBalanceLOV
", - "operationId": "getInterfaceAutoBalanceLOV", + "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", "parameters": [ { "name": "hotelId", @@ -25685,7 +26120,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 InterfacePseudoRoom LOV" }, { "name": "includeInactiveFlag", @@ -25759,7 +26194,7 @@ } }, "204": { - "description": "InterfaceAutoBalanceLOV not found." + "description": "InterfacePseudoRoomLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25809,11 +26244,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestMarketCode": { + "/listOfValues/hotels/{hotelId}/interfaceResyncFunctionSpace": { "get": { - "summary": "Fetch List Of Values for Interface Data Request Market Code", - "description": "OperationId:getInterfaceDataRequestMarketCodeLOV
", - "operationId": "getInterfaceDataRequestMarketCodeLOV", + "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", "parameters": [ { "name": "hotelId", @@ -25822,7 +26257,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 InterfaceResyncFunctionSpace LOV" }, { "name": "includeInactiveFlag", @@ -25896,7 +26331,7 @@ } }, "204": { - "description": "InterfaceDataRequestMarketCodeLOV not found." + "description": "InterfaceResyncFunctionSpaceLOV not found." }, "400": { "$ref": "#/responses/400" @@ -25946,11 +26381,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestMarketGroup": { + "/listOfValues/hotels/{hotelId}/interfaceResyncOwnerContract": { "get": { - "summary": "Fetch List Of Values for Interface Data Request Market Group", - "description": "OperationId:getInterfaceDataRequestMarketGroupLOV
", - "operationId": "getInterfaceDataRequestMarketGroupLOV", + "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", "parameters": [ { "name": "hotelId", @@ -25959,7 +26394,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 InterfaceResyncOwnerContract LOV" }, { "name": "includeInactiveFlag", @@ -26033,7 +26468,7 @@ } }, "204": { - "description": "InterfaceDataRequestMarketGroupLOV not found." + "description": "InterfaceResyncOwnerContractLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26083,11 +26518,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestRoomClass": { + "/listOfValues/hotels/{hotelId}/interfaceResyncOwnerContractRoom": { "get": { - "summary": "Fetch List Of Values for Interface Data Request Room Class", - "description": "OperationId:getInterfaceDataRequestRoomClassLOV
", - "operationId": "getInterfaceDataRequestRoomClassLOV", + "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", "parameters": [ { "name": "hotelId", @@ -26096,7 +26531,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 InterfaceResyncOwnerContractRoom LOV" }, { "name": "includeInactiveFlag", @@ -26170,7 +26605,7 @@ } }, "204": { - "description": "InterfaceDataRequestRoomClassLOV not found." + "description": "InterfaceResyncOwnerContractRoomLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26220,11 +26655,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestRoomTypes": { + "/listOfValues/hotels/{hotelId}/interfaceResyncProducts": { "get": { - "summary": "Fetch List Of Values for Interface Data Request Room Types", - "description": "OperationId:getInterfaceDataRequestRoomTypesLOV
", - "operationId": "getInterfaceDataRequestRoomTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -26233,7 +26668,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 InterfaceResyncProducts LOV" }, { "name": "includeInactiveFlag", @@ -26307,7 +26742,7 @@ } }, "204": { - "description": "InterfaceDataRequestRoomTypesLOV not found." + "description": "InterfaceResyncProductsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26357,11 +26792,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestSourceCode": { + "/listOfValues/hotels/{hotelId}/interfaceTrxCodesAllCharges": { "get": { - "summary": "Fetch List Of Values for Interface Data Request Source Code", - "description": "OperationId:getInterfaceDataRequestSourceCodeLOV
", - "operationId": "getInterfaceDataRequestSourceCodeLOV", + "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", "parameters": [ { "name": "hotelId", @@ -26370,7 +26805,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 InterfaceTrxCodesAllCharges LOV" }, { "name": "includeInactiveFlag", @@ -26444,7 +26879,7 @@ } }, "204": { - "description": "InterfaceDataRequestSourceCodeLOV not found." + "description": "InterfaceTrxCodesAllChargesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26494,11 +26929,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceDataRequestSourceGroup": { + "/listOfValues/hotels/{hotelId}/interfaceTrxCodesMinibar": { "get": { - "summary": "Fetch List Of Values for Interface Data Request Source Group", - "description": "OperationId:getInterfaceDataRequestSourceGroupLOV
", - "operationId": "getInterfaceDataRequestSourceGroupLOV", + "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", "parameters": [ { "name": "hotelId", @@ -26507,7 +26942,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 InterfaceTrxCodesMinibar LOV" }, { "name": "includeInactiveFlag", @@ -26581,7 +27016,7 @@ } }, "204": { - "description": "InterfaceDataRequestSourceGroupLOV not found." + "description": "InterfaceTrxCodesMinibarLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26631,12 +27066,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfacePseudoRoom": { + "/listOfValues/hotels/{hotelId}/interfaceType/{interfaceType}/interfaceRowId/{interfaceRowId}/allowedHotelInterfaceRights": { "get": { - "summary": "Fetch List Of Values for Interface Pseudo Room", - "description": "OperationId:getInterfacePseudoRoomLOV
", - "operationId": "getInterfacePseudoRoomLOV", + "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", "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", @@ -26644,7 +27097,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 AllowedHotelInterfaceRights LOV" }, { "name": "includeInactiveFlag", @@ -26718,7 +27171,7 @@ } }, "204": { - "description": "InterfacePseudoRoomLOV not found." + "description": "AllowedHotelInterfaceRightsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26768,11 +27221,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceResyncFunctionSpace": { + "/listOfValues/hotels/{hotelId}/invItemsClasses": { "get": { - "summary": "Fetch List Of Values for Interface Resync Function Space", - "description": "OperationId:getInterfaceResyncFunctionSpaceLOV
", - "operationId": "getInterfaceResyncFunctionSpaceLOV", + "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", "parameters": [ { "name": "hotelId", @@ -26781,7 +27234,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 InvItemsClasses LOV" }, { "name": "includeInactiveFlag", @@ -26855,7 +27308,7 @@ } }, "204": { - "description": "InterfaceResyncFunctionSpaceLOV not found." + "description": "InvItemsClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -26905,11 +27358,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceResyncOwnerContract": { + "/listOfValues/hotels/{hotelId}/invItemsPools": { "get": { - "summary": "Fetch List Of Values for Interface Resync Owner Contract", - "description": "OperationId:getInterfaceResyncOwnerContractLOV
", - "operationId": "getInterfaceResyncOwnerContractLOV", + "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", "parameters": [ { "name": "hotelId", @@ -26918,7 +27371,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 InvItemsPools LOV" }, { "name": "includeInactiveFlag", @@ -26992,7 +27445,7 @@ } }, "204": { - "description": "InterfaceResyncOwnerContractLOV not found." + "description": "InvItemsPoolsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27042,11 +27495,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceResyncOwnerContractRoom": { + "/listOfValues/hotels/{hotelId}/inventoryItemTemplateItems": { "get": { - "summary": "Fetch List Of Values for Interface Resync Owner Contract Room", - "description": "OperationId:getInterfaceResyncOwnerContractRoomLOV
", - "operationId": "getInterfaceResyncOwnerContractRoomLOV", + "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", "parameters": [ { "name": "hotelId", @@ -27055,7 +27508,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 InventoryItemTemplateItems LOV" }, { "name": "includeInactiveFlag", @@ -27129,7 +27582,7 @@ } }, "204": { - "description": "InterfaceResyncOwnerContractRoomLOV not found." + "description": "InventoryItemTemplateItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27179,11 +27632,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceResyncProducts": { + "/listOfValues/hotels/{hotelId}/itemClasses": { "get": { - "summary": "Fetch List Of Values for Interface Resync Products", - "description": "OperationId:getInterfaceResyncProductsLOV
", - "operationId": "getInterfaceResyncProductsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -27192,7 +27645,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 ItemClasses LOV" }, { "name": "includeInactiveFlag", @@ -27266,7 +27719,7 @@ } }, "204": { - "description": "InterfaceResyncProductsLOV not found." + "description": "ItemClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27316,11 +27769,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceTrxCodesAllCharges": { + "/listOfValues/hotels/{hotelId}/itemCodes": { "get": { - "summary": "Fetch List Of Values for Interface Trx Codes All Charges", - "description": "OperationId:getInterfaceTrxCodesAllChargesLOV
", - "operationId": "getInterfaceTrxCodesAllChargesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -27329,7 +27782,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 ItemCodes LOV" }, { "name": "includeInactiveFlag", @@ -27403,7 +27856,7 @@ } }, "204": { - "description": "InterfaceTrxCodesAllChargesLOV not found." + "description": "ItemCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27453,12 +27906,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceTrxCodesMinibar": { + "/listOfValues/hotels/{hotelId}/itemId/{itemId}/inventoryItemAttributes": { "get": { - "summary": "Fetch List Of Values for Interface Trx Codes Minibar", - "description": "OperationId:getInterfaceTrxCodesMinibarLOV
", - "operationId": "getInterfaceTrxCodesMinibarLOV", + "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", "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", @@ -27466,7 +27928,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 InventoryItemAttributes LOV" }, { "name": "includeInactiveFlag", @@ -27540,7 +28002,7 @@ } }, "204": { - "description": "InterfaceTrxCodesMinibarLOV not found." + "description": "InventoryItemAttributesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27590,29 +28052,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/interfaceType/{interfaceType}/interfaceRowId/{interfaceRowId}/allowedHotelInterfaceRights": { + "/listOfValues/hotels/{hotelId}/itemId/{itemId}/inventoryItemRates": { "get": { - "summary": "Fetch List Of Values for Allowed Hotel Interface Rights", - "description": "OperationId:getAllowedHotelInterfaceRightsLOV
", - "operationId": "getAllowedHotelInterfaceRightsLOV", + "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", "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", + "name": "itemId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'interfaceType' which is required to fetch AllowedHotelInterfaceRights LOV" + "description": "Value of the parameter 'itemId' which is required to fetch InventoryItemRates LOV" }, { "name": "hotelId", @@ -27621,7 +28074,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 InventoryItemRates LOV" }, { "name": "includeInactiveFlag", @@ -27695,7 +28148,7 @@ } }, "204": { - "description": "AllowedHotelInterfaceRightsLOV not found." + "description": "InventoryItemRatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27745,12 +28198,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/invItemsClasses": { + "/listOfValues/hotels/{hotelId}/itemId/{itemId}/itemPriceCode": { "get": { - "summary": "Fetch List Of Values for Inv Items Classes", - "description": "OperationId:getInvItemsClassesLOV
", - "operationId": "getInvItemsClassesLOV", + "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", + "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", @@ -27758,7 +28220,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 ItemPriceCode LOV" }, { "name": "includeInactiveFlag", @@ -27832,7 +28294,7 @@ } }, "204": { - "description": "InvItemsClassesLOV not found." + "description": "ItemPriceCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -27882,12 +28344,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/invItemsPools": { + "/listOfValues/hotels/{hotelId}/itemId/{itemId}/itemVendor": { "get": { - "summary": "Fetch List Of Values for Inv Items Pools", - "description": "OperationId:getInvItemsPoolsLOV
", - "operationId": "getInvItemsPoolsLOV", + "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", "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", @@ -27895,7 +28366,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 ItemVendor LOV" }, { "name": "includeInactiveFlag", @@ -27969,7 +28440,7 @@ } }, "204": { - "description": "InvItemsPoolsLOV not found." + "description": "ItemVendorLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28019,11 +28490,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/inventoryItemTemplateItems": { + "/listOfValues/hotels/{hotelId}/jobTitles": { "get": { - "summary": "Fetch List Of Values for Inventory Item Template Items", - "description": "OperationId:getInventoryItemTemplateItemsLOV
", - "operationId": "getInventoryItemTemplateItemsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -28032,7 +28503,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 JobTitles LOV" }, { "name": "includeInactiveFlag", @@ -28106,7 +28577,7 @@ } }, "204": { - "description": "InventoryItemTemplateItemsLOV not found." + "description": "JobTitlesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28156,11 +28627,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/itemClasses": { + "/listOfValues/hotels/{hotelId}/keyOptions": { "get": { - "summary": "Fetch List Of Values for Item Classes", - "description": "OperationId:getItemClassesLOV
", - "operationId": "getItemClassesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -28169,7 +28640,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 KeyOptions LOV" }, { "name": "includeInactiveFlag", @@ -28243,7 +28714,7 @@ } }, "204": { - "description": "ItemClassesLOV not found." + "description": "KeyOptionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28293,11 +28764,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/itemCodes": { + "/listOfValues/hotels/{hotelId}/licenses": { "get": { - "summary": "Fetch List Of Values for Item Codes", - "description": "OperationId:getItemCodesLOV
", - "operationId": "getItemCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -28306,7 +28777,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 Licenses LOV" }, { "name": "includeInactiveFlag", @@ -28380,7 +28851,7 @@ } }, "204": { - "description": "ItemCodesLOV not found." + "description": "LicensesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28430,21 +28901,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/itemId/{itemId}/inventoryItemAttributes": { + "/listOfValues/hotels/{hotelId}/locatorQuickTexts": { "get": { - "summary": "Fetch List Of Values for Inventory Item Attributes", - "description": "OperationId:getInventoryItemAttributesLOV
", - "operationId": "getInventoryItemAttributesLOV", + "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", "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", @@ -28452,7 +28914,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 LocatorQuickTexts LOV" }, { "name": "includeInactiveFlag", @@ -28526,7 +28988,7 @@ } }, "204": { - "description": "InventoryItemAttributesLOV not found." + "description": "LocatorQuickTextsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28576,20 +29038,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/itemId/{itemId}/inventoryItemRates": { + "/listOfValues/hotels/{hotelId}/logo/{logo}/hotelInterfaceDataLineTypes": { "get": { - "summary": "Fetch List Of Values for Inventory Item Rates", - "description": "OperationId:getInventoryItemRatesLOV
", - "operationId": "getInventoryItemRatesLOV", + "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", "parameters": [ { - "name": "itemId", + "name": "logo", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'itemId' which is required to fetch InventoryItemRates LOV" + "description": "Value of the parameter 'logo' which is required to fetch HotelInterfaceDataLineTypes LOV" }, { "name": "hotelId", @@ -28598,7 +29060,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch InventoryItemRates LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch HotelInterfaceDataLineTypes LOV" }, { "name": "includeInactiveFlag", @@ -28672,7 +29134,7 @@ } }, "204": { - "description": "InventoryItemRatesLOV not found." + "description": "HotelInterfaceDataLineTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28722,20 +29184,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/itemId/{itemId}/itemPriceCode": { + "/listOfValues/hotels/{hotelId}/logo/{logo}/interfaceRevenueCode": { "get": { - "summary": "Fetch List Of Values for Item Price Code", - "description": "OperationId:getItemPriceCodeLOV
", - "operationId": "getItemPriceCodeLOV", + "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", "parameters": [ { - "name": "itemId", + "name": "logo", "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 'logo' which is required to fetch InterfaceRevenueCode LOV" }, { "name": "hotelId", @@ -28744,7 +29206,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 InterfaceRevenueCode LOV" }, { "name": "includeInactiveFlag", @@ -28818,7 +29280,7 @@ } }, "204": { - "description": "ItemPriceCodeLOV not found." + "description": "InterfaceRevenueCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -28868,21 +29330,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/itemId/{itemId}/itemVendor": { + "/listOfValues/hotels/{hotelId}/managerReportDetails": { "get": { - "summary": "Fetch List Of Values for Item Vendor", - "description": "OperationId:getItemVendorLOV
", - "operationId": "getItemVendorLOV", + "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", "parameters": [ { - "name": "itemId", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'itemId' which is required to fetch ItemVendor LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ManagerReportDetails 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": "ManagerReportDetailsLOV 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}/managersReports": { + "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", + "parameters": [ { "name": "hotelId", "in": "path", @@ -28890,7 +29480,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 ManagersReports LOV" }, { "name": "includeInactiveFlag", @@ -28964,7 +29554,7 @@ } }, "204": { - "description": "ItemVendorLOV not found." + "description": "ManagersReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29014,11 +29604,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/jobTitles": { + "/listOfValues/hotels/{hotelId}/marketGroups": { "get": { - "summary": "Fetch List Of Values for Job Titles", - "description": "OperationId:getJobTitlesLOV
", - "operationId": "getJobTitlesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -29027,7 +29617,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 MarketGroups LOV" }, { "name": "includeInactiveFlag", @@ -29101,7 +29691,7 @@ } }, "204": { - "description": "JobTitlesLOV not found." + "description": "MarketGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29151,11 +29741,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/keyOptions": { + "/listOfValues/hotels/{hotelId}/marketSegment": { "get": { - "summary": "Fetch List Of Values for Key Options", - "description": "OperationId:getKeyOptionsLOV
", - "operationId": "getKeyOptionsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -29164,7 +29754,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 MarketSegment LOV" }, { "name": "includeInactiveFlag", @@ -29238,7 +29828,7 @@ } }, "204": { - "description": "KeyOptionsLOV not found." + "description": "MarketSegmentLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29288,11 +29878,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/licenses": { + "/listOfValues/hotels/{hotelId}/masterBlock": { "get": { - "summary": "Fetch List Of Values for Licenses", - "description": "OperationId:getLicensesLOV
", - "operationId": "getLicensesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -29301,7 +29891,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 MasterBlock LOV" }, { "name": "includeInactiveFlag", @@ -29375,7 +29965,7 @@ } }, "204": { - "description": "LicensesLOV not found." + "description": "MasterBlockLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29425,11 +30015,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/locatorQuickTexts": { + "/listOfValues/hotels/{hotelId}/membershipAwardFinTrx": { "get": { - "summary": "Fetch List Of Values for Locator Quick Texts", - "description": "OperationId:getLocatorQuickTextsLOV
", - "operationId": "getLocatorQuickTextsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -29438,7 +30028,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 MembershipAwardFinTrx LOV" }, { "name": "includeInactiveFlag", @@ -29512,7 +30102,7 @@ } }, "204": { - "description": "LocatorQuickTextsLOV not found." + "description": "MembershipAwardFinTrxLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29562,21 +30152,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/logo/{logo}/hotelInterfaceDataLineTypes": { + "/listOfValues/hotels/{hotelId}/membershipAwardProducts": { "get": { - "summary": "Fetch List Of Values for Hotel Interface Data Line Types", - "description": "OperationId:getHotelInterfaceDataLineTypesLOV
", - "operationId": "getHotelInterfaceDataLineTypesLOV", + "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", "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", @@ -29584,7 +30165,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 MembershipAwardProducts LOV" }, { "name": "includeInactiveFlag", @@ -29658,7 +30239,7 @@ } }, "204": { - "description": "HotelInterfaceDataLineTypesLOV not found." + "description": "MembershipAwardProductsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29708,21 +30289,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/logo/{logo}/hotelInterfaceIfcRooms": { + "/listOfValues/hotels/{hotelId}/membershipAwardRateCodes": { "get": { - "summary": "Fetch List Of Values for Hotel Interface Data Line Types", - "description": "OperationId:getHotelInterfaceIfcRoomsLOV
", - "operationId": "getHotelInterfaceIfcRoomsLOV", + "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", "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", @@ -29730,7 +30302,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HotelInterfaceIfcRooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch MembershipAwardRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -29804,7 +30376,7 @@ } }, "204": { - "description": "HotelInterfaceIfcRoomsLOV not found." + "description": "MembershipAwardRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -29854,21 +30426,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/logo/{logo}/interfaceRevenueCode": { + "/listOfValues/hotels/{hotelId}/membershipAwardUpgradeRoom": { "get": { - "summary": "Fetch List Of Values for Interface Revenue Code", - "description": "OperationId:getInterfaceRevenueCodeLOV
", - "operationId": "getInterfaceRevenueCodeLOV", + "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", "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", @@ -29876,7 +30439,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 MembershipAwardUpgradeRoom LOV" }, { "name": "includeInactiveFlag", @@ -29950,7 +30513,7 @@ } }, "204": { - "description": "InterfaceRevenueCodeLOV not found." + "description": "MembershipAwardUpgradeRoomLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30000,11 +30563,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/managerReportDetails": { + "/listOfValues/hotels/{hotelId}/membershipAwardUpgradeRoomGroup": { "get": { - "summary": "Fetch List Of Values for Manager Report Details", - "description": "OperationId:getManagerReportDetailsLOV
", - "operationId": "getManagerReportDetailsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -30013,7 +30576,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 MembershipAwardUpgradeRoomGroup LOV" }, { "name": "includeInactiveFlag", @@ -30087,7 +30650,7 @@ } }, "204": { - "description": "ManagerReportDetailsLOV not found." + "description": "MembershipAwardUpgradeRoomGroupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30137,12 +30700,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/managersReports": { + "/listOfValues/hotels/{hotelId}/membershipType/{membershipType}/awardPayment": { "get": { - "summary": "Fetch List Of Values for Managers Reports", - "description": "OperationId:getManagersReportsLOV
", - "operationId": "getManagersReportsLOV", + "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", "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", @@ -30150,7 +30722,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 AwardPayment LOV" }, { "name": "includeInactiveFlag", @@ -30224,7 +30796,7 @@ } }, "204": { - "description": "ManagersReportsLOV not found." + "description": "AwardPaymentLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30274,11 +30846,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/marketGroups": { + "/listOfValues/hotels/{hotelId}/menuClasses": { "get": { - "summary": "Fetch List Of Values for Market Groups", - "description": "OperationId:getMarketGroupsLOV
", - "operationId": "getMarketGroupsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -30287,7 +30859,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 MenuClasses LOV" }, { "name": "includeInactiveFlag", @@ -30361,7 +30933,7 @@ } }, "204": { - "description": "MarketGroupsLOV not found." + "description": "MenuClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30411,11 +30983,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/marketSegment": { + "/listOfValues/hotels/{hotelId}/menuItems": { "get": { - "summary": "Fetch List Of Values for Market Segment", - "description": "OperationId:getMarketSegmentLOV
", - "operationId": "getMarketSegmentLOV", + "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", "parameters": [ { "name": "hotelId", @@ -30424,7 +30996,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 MenuItems LOV" }, { "name": "includeInactiveFlag", @@ -30498,7 +31070,7 @@ } }, "204": { - "description": "MarketSegmentLOV not found." + "description": "MenuItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30548,12 +31120,39 @@ ] } }, - "/listOfValues/hotels/{hotelId}/masterBlock": { + "/listOfValues/hotels/{hotelId}/module/{module}/extSystem/{extSystem}/databaseId/{databaseId}/businessEventActionTypeExtDB": { "get": { - "summary": "Fetch List Of Values for Master Block", - "description": "OperationId:getMasterBlockLOV
", - "operationId": "getMasterBlockLOV", + "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", "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", @@ -30561,7 +31160,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 BusinessEventActionTypeExtDB LOV" }, { "name": "includeInactiveFlag", @@ -30635,7 +31234,7 @@ } }, "204": { - "description": "MasterBlockLOV not found." + "description": "BusinessEventActionTypeExtDBLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30685,12 +31284,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipAwardFinTrx": { + "/listOfValues/hotels/{hotelId}/moduleName/{moduleName}/method/{method}/format": { "get": { - "summary": "Fetch List Of Values for Membership Award Fin Trx", - "description": "OperationId:getMembershipAwardFinTrxLOV
", - "operationId": "getMembershipAwardFinTrxLOV", + "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", "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", @@ -30698,7 +31315,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 Format LOV" }, { "name": "includeInactiveFlag", @@ -30772,7 +31389,7 @@ } }, "204": { - "description": "MembershipAwardFinTrxLOV not found." + "description": "FormatLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30822,12 +31439,39 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipAwardProducts": { + "/listOfValues/hotels/{hotelId}/nights/{nights}/arrivalDate/{arrivalDate}/roomCategory/{roomCategory}/testUpsellRulesRateCode": { "get": { - "summary": "Fetch List Of Values for Membership Award Products", - "description": "OperationId:getMembershipAwardProductsLOV
", - "operationId": "getMembershipAwardProductsLOV", + "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", "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", @@ -30835,7 +31479,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 TestUpsellRulesRateCode LOV" }, { "name": "includeInactiveFlag", @@ -30909,7 +31553,7 @@ } }, "204": { - "description": "MembershipAwardProductsLOV not found." + "description": "TestUpsellRulesRateCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -30959,11 +31603,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipAwardRateCodes": { + "/listOfValues/hotels/{hotelId}/osaActivityTypes": { "get": { - "summary": "Fetch List Of Values for Membership Award Rate Codes", - "description": "OperationId:getMembershipAwardRateCodesLOV
", - "operationId": "getMembershipAwardRateCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -30972,7 +31616,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 OSAActivityTypes LOV" }, { "name": "includeInactiveFlag", @@ -31046,7 +31690,7 @@ } }, "204": { - "description": "MembershipAwardRateCodesLOV not found." + "description": "OSAActivityTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31096,11 +31740,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipAwardUpgradeRoom": { + "/listOfValues/hotels/{hotelId}/oxiInterfaceReferences": { "get": { - "summary": "Fetch List Of Values for Membership Award Upgrade Room", - "description": "OperationId:getMembershipAwardUpgradeRoomLOV
", - "operationId": "getMembershipAwardUpgradeRoomLOV", + "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", "parameters": [ { "name": "hotelId", @@ -31109,7 +31753,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 OXIInterfaceReferences LOV" }, { "name": "includeInactiveFlag", @@ -31183,7 +31827,7 @@ } }, "204": { - "description": "MembershipAwardUpgradeRoomLOV not found." + "description": "OXIInterfaceReferencesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31233,11 +31877,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipAwardUpgradeRoomGroup": { + "/listOfValues/hotels/{hotelId}/oxiInterfaceResorts": { "get": { - "summary": "Fetch List Of Values for Membership Award Upgrade Room Group", - "description": "OperationId:getMembershipAwardUpgradeRoomGroupLOV
", - "operationId": "getMembershipAwardUpgradeRoomGroupLOV", + "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", "parameters": [ { "name": "hotelId", @@ -31246,7 +31890,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 OXIInterfaceResorts LOV" }, { "name": "includeInactiveFlag", @@ -31320,7 +31964,7 @@ } }, "204": { - "description": "MembershipAwardUpgradeRoomGroupLOV not found." + "description": "OXIInterfaceResortsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31370,21 +32014,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/membershipType/{membershipType}/awardPayment": { + "/listOfValues/hotels/{hotelId}/oxiInterfaces": { "get": { - "summary": "Fetch List Of Values for Award Payment", - "description": "OperationId:getAwardPaymentLOV
", - "operationId": "getAwardPaymentLOV", + "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", "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", @@ -31392,7 +32027,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 OXIInterfaces LOV" }, { "name": "includeInactiveFlag", @@ -31466,7 +32101,7 @@ } }, "204": { - "description": "AwardPaymentLOV not found." + "description": "OXIInterfacesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31516,11 +32151,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/menuClasses": { + "/listOfValues/hotels/{hotelId}/packForecastGroupCode": { "get": { - "summary": "Fetch List Of Values for Menu Classes", - "description": "OperationId:getMenuClassesLOV
", - "operationId": "getMenuClassesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -31529,7 +32164,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 PackForecastGroupCode LOV" }, { "name": "includeInactiveFlag", @@ -31603,7 +32238,7 @@ } }, "204": { - "description": "MenuClassesLOV not found." + "description": "PackForecastGroupCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31653,11 +32288,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/menuItems": { + "/listOfValues/hotels/{hotelId}/paymentMethods": { "get": { - "summary": "Fetch List Of Values for Menu Items", - "description": "OperationId:getMenuItemsLOV
", - "operationId": "getMenuItemsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -31666,7 +32301,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 PaymentMethods LOV" }, { "name": "includeInactiveFlag", @@ -31740,7 +32375,7 @@ } }, "204": { - "description": "MenuItemsLOV not found." + "description": "PaymentMethodsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31790,39 +32425,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/module/{module}/extSystem/{extSystem}/databaseId/{databaseId}/businessEventActionTypeExtDB": { + "/listOfValues/hotels/{hotelId}/paymentTypes": { "get": { - "summary": "Fetch List Of Values for Business Event Action Type Ext DB", - "description": "OperationId:getBusinessEventActionTypeExtDBLOV
", - "operationId": "getBusinessEventActionTypeExtDBLOV", + "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", "parameters": [ { - "name": "databaseId", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'databaseId' which is required to fetch BusinessEventActionTypeExtDB LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PaymentTypes 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": "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": "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": "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": "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" + }, + "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", @@ -31830,7 +32575,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 PeriodSetup LOV" }, { "name": "includeInactiveFlag", @@ -31904,7 +32649,7 @@ } }, "204": { - "description": "BusinessEventActionTypeExtDBLOV not found." + "description": "PeriodSetupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -31954,30 +32699,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/moduleName/{moduleName}/method/{method}/format": { + "/listOfValues/hotels/{hotelId}/periodsSetup": { "get": { - "summary": "Fetch List Of Values for Format", - "description": "OperationId:getFormatLOV
", - "operationId": "getFormatLOV", + "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", "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", @@ -31985,7 +32712,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 PeriodsSetup LOV" }, { "name": "includeInactiveFlag", @@ -32059,7 +32786,7 @@ } }, "204": { - "description": "FormatLOV not found." + "description": "PeriodsSetupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32109,38 +32836,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/nights/{nights}/arrivalDate/{arrivalDate}/roomCategory/{roomCategory}/testUpsellRulesRateCode": { + "/listOfValues/hotels/{hotelId}/policyType/{policyType}/depositCancelRules": { "get": { - "summary": "Fetch List Of Values for Test Upsell Rules Rate Code", - "description": "OperationId:getTestUpsellRulesRateCodeLOV
", - "operationId": "getTestUpsellRulesRateCodeLOV", + "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", "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", + "name": "policyType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'nights' which is required to fetch TestUpsellRulesRateCode LOV" + "description": "Value of the parameter 'policyType' which is required to fetch DepositCancelRules LOV" }, { "name": "hotelId", @@ -32149,7 +32858,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 DepositCancelRules LOV" }, { "name": "includeInactiveFlag", @@ -32223,7 +32932,7 @@ } }, "204": { - "description": "TestUpsellRulesRateCodeLOV not found." + "description": "DepositCancelRulesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32273,25 +32982,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/operaLDAPUsersOnly/{operaLDAPUsersOnly}/applicationUserNames": { + "/listOfValues/hotels/{hotelId}/postingRoom": { "get": { - "summary": "Fetch List Of Values for Application User Names", - "description": "OperationId:getApplicationUserNamesLOV
", - "operationId": "getApplicationUserNamesLOV", + "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", "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", @@ -32299,7 +32995,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ApplicationUserNames LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PostingRoom LOV" }, { "name": "includeInactiveFlag", @@ -32373,7 +33069,7 @@ } }, "204": { - "description": "ApplicationUserNamesLOV not found." + "description": "PostingRoomLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32423,25 +33119,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/operaLDAPUsersOnly/{operaLDAPUsersOnly}/applicationUsers": { + "/listOfValues/hotels/{hotelId}/postingTransactionCodes": { "get": { - "summary": "Fetch List Of Values for Application Users", - "description": "OperationId:getApplicationUsersLOV
", - "operationId": "getApplicationUsersLOV", + "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", "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", @@ -32449,7 +33132,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ApplicationUsers LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch PostingTransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -32523,7 +33206,7 @@ } }, "204": { - "description": "ApplicationUsersLOV not found." + "description": "PostingTransactionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32573,11 +33256,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/osaActivityTypes": { + "/listOfValues/hotels/{hotelId}/prepaidCardInterfaces": { "get": { - "summary": "Fetch List Of Values for OSAActivity Types", - "description": "OperationId:getOSAActivityTypesLOV
", - "operationId": "getOSAActivityTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -32586,7 +33269,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 PrepaidCardInterfaces LOV" }, { "name": "includeInactiveFlag", @@ -32660,7 +33343,7 @@ } }, "204": { - "description": "OSAActivityTypesLOV not found." + "description": "PrepaidCardInterfacesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32710,11 +33393,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/oxiInterfaceReferences": { + "/listOfValues/hotels/{hotelId}/priorities": { "get": { - "summary": "Fetch List Of Values for OXIInterface References", - "description": "OperationId:getOXIInterfaceReferencesLOV
", - "operationId": "getOXIInterfaceReferencesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -32723,7 +33406,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 Priorities LOV" }, { "name": "includeInactiveFlag", @@ -32797,7 +33480,7 @@ } }, "204": { - "description": "OXIInterfaceReferencesLOV not found." + "description": "PrioritiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32847,12 +33530,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/oxiInterfaceResorts": { + "/listOfValues/hotels/{hotelId}/profiles/{profileId}/profileIdentifications": { "get": { - "summary": "Fetch List Of Values for OXIInterface Resorts", - "description": "OperationId:getOXIInterfaceResortsLOV
", - "operationId": "getOXIInterfaceResortsLOV", + "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", "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", @@ -32860,7 +33552,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 ProfileIdentifications LOV" }, { "name": "includeInactiveFlag", @@ -32934,7 +33626,7 @@ } }, "204": { - "description": "OXIInterfaceResortsLOV not found." + "description": "ProfileIdentificationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -32984,12 +33676,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/oxiInterfaces": { + "/listOfValues/hotels/{hotelId}/promoCode/{promoCode}/promoRates": { "get": { - "summary": "Fetch List Of Values for OXIInterfaces", - "description": "OperationId:getOXIInterfacesLOV
", - "operationId": "getOXIInterfacesLOV", + "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", "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", @@ -32997,7 +33698,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 PromoRates LOV" }, { "name": "includeInactiveFlag", @@ -33071,7 +33772,7 @@ } }, "204": { - "description": "OXIInterfacesLOV not found." + "description": "PromoRatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33121,11 +33822,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/packForecastGroupCode": { + "/listOfValues/hotels/{hotelId}/promoGroups": { "get": { - "summary": "Fetch List Of Values for Pack Forecast Group Code", - "description": "OperationId:getPackForecastGroupCodeLOV
", - "operationId": "getPackForecastGroupCodeLOV", + "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", "parameters": [ { "name": "hotelId", @@ -33134,7 +33835,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 PromoGroups LOV" }, { "name": "includeInactiveFlag", @@ -33208,7 +33909,7 @@ } }, "204": { - "description": "PackForecastGroupCodeLOV not found." + "description": "PromoGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33258,11 +33959,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/paymentMethods": { + "/listOfValues/hotels/{hotelId}/propertyAmenities": { "get": { - "summary": "Fetch List Of Values for Payment Methods", - "description": "OperationId:getPaymentMethodsLOV
", - "operationId": "getPaymentMethodsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -33271,7 +33972,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 PropertyAmenities LOV" }, { "name": "includeInactiveFlag", @@ -33345,7 +34046,7 @@ } }, "204": { - "description": "PaymentMethodsLOV not found." + "description": "PropertyAmenitiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33395,11 +34096,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/paymentTypes": { + "/listOfValues/hotels/{hotelId}/rateCategories": { "get": { - "summary": "Fetch List Of Values for Payment Types", - "description": "OperationId:getPaymentTypesLOV
", - "operationId": "getPaymentTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -33408,7 +34109,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PaymentTypes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RateCategories LOV" }, { "name": "includeInactiveFlag", @@ -33482,7 +34183,7 @@ } }, "204": { - "description": "PaymentTypesLOV not found." + "description": "RateCategoriesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33532,12 +34233,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/periodSetup": { + "/listOfValues/hotels/{hotelId}/rateCode/{rateCode}/ratePlansForYieldAsConfig": { "get": { - "summary": "Fetch List Of Values for Period Setup", - "description": "OperationId:getPeriodSetupLOV
", - "operationId": "getPeriodSetupLOV", + "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", "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", @@ -33545,7 +34255,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 RatePlansForYieldAsConfig LOV" }, { "name": "includeInactiveFlag", @@ -33619,7 +34329,7 @@ } }, "204": { - "description": "PeriodSetupLOV not found." + "description": "RatePlansForYieldAsConfigLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33669,11 +34379,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/periodsSetup": { + "/listOfValues/hotels/{hotelId}/rateCodeGlobalDescEdit": { "get": { - "summary": "Fetch List Of Values for Periods Setup", - "description": "OperationId:getPeriodsSetupLOV
", - "operationId": "getPeriodsSetupLOV", + "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", "parameters": [ { "name": "hotelId", @@ -33682,7 +34392,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 RateCodeGlobalDescEdit LOV" }, { "name": "includeInactiveFlag", @@ -33756,7 +34466,7 @@ } }, "204": { - "description": "PeriodsSetupLOV not found." + "description": "RateCodeGlobalDescEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33806,20 +34516,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/policyType/{policyType}/depositCancelRules": { + "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/rateCodesByType": { "get": { - "summary": "Fetch List Of Values for Deposit Cancel Rules", - "description": "OperationId:getDepositCancelRulesLOV
", - "operationId": "getDepositCancelRulesLOV", + "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", "parameters": [ { - "name": "policyType", + "name": "rateCodeType", "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 'rateCodeType' which is required to fetch RateCodesByType LOV" }, { "name": "hotelId", @@ -33828,7 +34538,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 RateCodesByType LOV" }, { "name": "includeInactiveFlag", @@ -33902,7 +34612,7 @@ } }, "204": { - "description": "DepositCancelRulesLOV not found." + "description": "RateCodesByTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -33952,12 +34662,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/postingRoom": { + "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/ratePlanForMassRate": { "get": { - "summary": "Fetch List Of Values for Posting Room", - "description": "OperationId:getPostingRoomLOV
", - "operationId": "getPostingRoomLOV", + "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", "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", @@ -33965,7 +34684,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 RatePlanForMassRate LOV" }, { "name": "includeInactiveFlag", @@ -34039,7 +34758,7 @@ } }, "204": { - "description": "PostingRoomLOV not found." + "description": "RatePlanForMassRateLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34089,11 +34808,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/postingTransactionCodes": { + "/listOfValues/hotels/{hotelId}/rateCodesValid": { "get": { - "summary": "Fetch List Of Values for Posting Transaction Codes", - "description": "OperationId:getPostingTransactionCodesLOV
", - "operationId": "getPostingTransactionCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -34102,7 +34821,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 RateCodesValid LOV" }, { "name": "includeInactiveFlag", @@ -34176,7 +34895,7 @@ } }, "204": { - "description": "PostingTransactionCodesLOV not found." + "description": "RateCodesValidLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34226,11 +34945,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/prepaidCardInterfaces": { + "/listOfValues/hotels/{hotelId}/rateCommissionCodes": { "get": { - "summary": "Fetch List Of Values for Prepaid Card Interfaces", - "description": "OperationId:getPrepaidCardInterfacesLOV
", - "operationId": "getPrepaidCardInterfacesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -34239,7 +34958,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 RateCommissionCodes LOV" }, { "name": "includeInactiveFlag", @@ -34313,7 +35032,7 @@ } }, "204": { - "description": "PrepaidCardInterfacesLOV not found." + "description": "RateCommissionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34363,11 +35082,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/priorities": { + "/listOfValues/hotels/{hotelId}/rateConfigCurrencies": { "get": { - "summary": "Fetch List Of Values for Priorities", - "description": "OperationId:getPrioritiesLOV
", - "operationId": "getPrioritiesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -34376,7 +35095,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 RateConfigCurrencies LOV" }, { "name": "includeInactiveFlag", @@ -34450,7 +35169,7 @@ } }, "204": { - "description": "PrioritiesLOV not found." + "description": "RateConfigCurrenciesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34500,21 +35219,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/profiles/{profileId}/profileIdentifications": { + "/listOfValues/hotels/{hotelId}/rateGroups": { "get": { - "summary": "Fetch List Of Values for Profile Identifications", - "description": "OperationId:getProfileIdentificationsLOV
", - "operationId": "getProfileIdentificationsLOV", + "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", "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", @@ -34522,7 +35232,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 RateGroups LOV" }, { "name": "includeInactiveFlag", @@ -34596,7 +35306,7 @@ } }, "204": { - "description": "ProfileIdentificationsLOV not found." + "description": "RateGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34646,20 +35356,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/promoCode/{promoCode}/promoRates": { + "/listOfValues/hotels/{hotelId}/ratePlanCodes/{ratePlanCodes}/roomTypesForMassRate": { "get": { - "summary": "Fetch List Of Values for Promo Rates", - "description": "OperationId:getPromoRatesLOV
", - "operationId": "getPromoRatesLOV", + "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", "parameters": [ { - "name": "promoCode", + "name": "ratePlanCodes", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'promoCode' which is required to fetch PromoRates LOV" + "description": "Value of the parameter 'ratePlanCodes' which is required to fetch RoomTypesForMassRate LOV" }, { "name": "hotelId", @@ -34668,7 +35378,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 RoomTypesForMassRate LOV" }, { "name": "includeInactiveFlag", @@ -34742,7 +35452,7 @@ } }, "204": { - "description": "PromoRatesLOV not found." + "description": "RoomTypesForMassRateLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34792,11 +35502,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/promoGroups": { + "/listOfValues/hotels/{hotelId}/ratePlans": { "get": { - "summary": "Fetch List Of Values for Promo Groups", - "description": "OperationId:getPromoGroupsLOV
", - "operationId": "getPromoGroupsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -34805,7 +35515,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 RatePlans LOV" }, { "name": "includeInactiveFlag", @@ -34879,7 +35589,7 @@ } }, "204": { - "description": "PromoGroupsLOV not found." + "description": "RatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -34929,12 +35639,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/propertyAmenities": { + "/listOfValues/hotels/{hotelId}/relModuleName/{relModuleName}/applicationModules": { "get": { - "summary": "Fetch List Of Values for Property Amenities", - "description": "OperationId:getPropertyAmenitiesLOV
", - "operationId": "getPropertyAmenitiesLOV", + "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", "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", @@ -34942,7 +35661,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 ApplicationModules LOV" }, { "name": "includeInactiveFlag", @@ -35016,7 +35735,7 @@ } }, "204": { - "description": "PropertyAmenitiesLOV not found." + "description": "ApplicationModulesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35066,11 +35785,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCategories": { + "/listOfValues/hotels/{hotelId}/repBlockCodesParamOff": { "get": { - "summary": "Fetch List Of Values for Rate Categories", - "description": "OperationId:getRateCategoriesLOV
", - "operationId": "getRateCategoriesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -35079,7 +35798,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 RepBlockCodesParamOff LOV" }, { "name": "includeInactiveFlag", @@ -35153,7 +35872,7 @@ } }, "204": { - "description": "RateCategoriesLOV not found." + "description": "RepBlockCodesParamOffLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35203,21 +35922,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCode/{rateCode}/ratePlansForYieldAsConfig": { + "/listOfValues/hotels/{hotelId}/repBlockCodesParamOn": { "get": { - "summary": "Fetch List Of Values for Rate Plans For Yield As Config", - "description": "OperationId:getRatePlansForYieldAsConfigLOV
", - "operationId": "getRatePlansForYieldAsConfigLOV", + "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", "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", @@ -35225,7 +35935,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 RepBlockCodesParamOn LOV" }, { "name": "includeInactiveFlag", @@ -35299,7 +36009,7 @@ } }, "204": { - "description": "RatePlansForYieldAsConfigLOV not found." + "description": "RepBlockCodesParamOnLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35349,11 +36059,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCodeGlobalDescEdit": { + "/listOfValues/hotels/{hotelId}/repCashiers": { "get": { - "summary": "Fetch List Of Values for Rate Code Global Desc Edit", - "description": "OperationId:getRateCodeGlobalDescEditLOV
", - "operationId": "getRateCodeGlobalDescEditLOV", + "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", "parameters": [ { "name": "hotelId", @@ -35362,7 +36072,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 RepCashiers LOV" }, { "name": "includeInactiveFlag", @@ -35436,7 +36146,7 @@ } }, "204": { - "description": "RateCodeGlobalDescEditLOV not found." + "description": "RepCashiersLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35486,21 +36196,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/rateCodesByType": { + "/listOfValues/hotels/{hotelId}/repContactList": { "get": { - "summary": "Fetch List Of Values for Rate Codes By Type", - "description": "OperationId:getRateCodesByTypeLOV
", - "operationId": "getRateCodesByTypeLOV", + "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", "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", @@ -35508,7 +36209,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 RepContactList LOV" }, { "name": "includeInactiveFlag", @@ -35582,7 +36283,7 @@ } }, "204": { - "description": "RateCodesByTypeLOV not found." + "description": "RepContactListLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35632,21 +36333,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/ratePlanForMassRate": { + "/listOfValues/hotels/{hotelId}/repCurrencies": { "get": { - "summary": "Fetch List Of Values for Rate Plan For Mass Rate", - "description": "OperationId:getRatePlanForMassRateLOV
", - "operationId": "getRatePlanForMassRateLOV", + "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", "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", @@ -35654,7 +36346,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 RepCurrencies LOV" }, { "name": "includeInactiveFlag", @@ -35728,7 +36420,7 @@ } }, "204": { - "description": "RatePlanForMassRateLOV not found." + "description": "RepCurrenciesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35778,11 +36470,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCodesValid": { + "/listOfValues/hotels/{hotelId}/repDepartments": { "get": { - "summary": "Fetch List Of Values for Rate Codes Valid", - "description": "OperationId:getRateCodesValidLOV
", - "operationId": "getRateCodesValidLOV", + "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", "parameters": [ { "name": "hotelId", @@ -35791,7 +36483,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 RepDepartments LOV" }, { "name": "includeInactiveFlag", @@ -35865,7 +36557,7 @@ } }, "204": { - "description": "RateCodesValidLOV not found." + "description": "RepDepartmentsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -35915,11 +36607,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCommissionCodes": { + "/listOfValues/hotels/{hotelId}/repFiscalYears": { "get": { - "summary": "Fetch List Of Values for Rate Commission Codes", - "description": "OperationId:getRateCommissionCodesLOV
", - "operationId": "getRateCommissionCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -35928,7 +36620,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 RepFiscalYears LOV" }, { "name": "includeInactiveFlag", @@ -36002,7 +36694,7 @@ } }, "204": { - "description": "RateCommissionCodesLOV not found." + "description": "RepFiscalYearsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36052,11 +36744,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateConfigCurrencies": { + "/listOfValues/hotels/{hotelId}/repForeignCurrencies": { "get": { - "summary": "Fetch List Of Values for Rate Config Currencies", - "description": "OperationId:getRateConfigCurrenciesLOV
", - "operationId": "getRateConfigCurrenciesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -36065,7 +36757,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 RepForeignCurrencies LOV" }, { "name": "includeInactiveFlag", @@ -36139,7 +36831,7 @@ } }, "204": { - "description": "RateConfigCurrenciesLOV not found." + "description": "RepForeignCurrenciesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36189,11 +36881,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateGroups": { + "/listOfValues/hotels/{hotelId}/repGroups": { "get": { - "summary": "Fetch List Of Values for Rate Groups", - "description": "OperationId:getRateGroupsLOV
", - "operationId": "getRateGroupsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -36202,7 +36894,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 RepGroups LOV" }, { "name": "includeInactiveFlag", @@ -36276,7 +36968,7 @@ } }, "204": { - "description": "RateGroupsLOV not found." + "description": "RepGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36326,21 +37018,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/ratePlanCodes/{ratePlanCodes}/roomTypesForMassRate": { + "/listOfValues/hotels/{hotelId}/repInventoryItemPools": { "get": { - "summary": "Fetch List Of Values for Room Types For Mass Rate", - "description": "OperationId:getRoomTypesForMassRateLOV
", - "operationId": "getRoomTypesForMassRateLOV", + "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", "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", @@ -36348,7 +37031,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 RepInventoryItemPools LOV" }, { "name": "includeInactiveFlag", @@ -36422,7 +37105,7 @@ } }, "204": { - "description": "RoomTypesForMassRateLOV not found." + "description": "RepInventoryItemPoolsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36472,11 +37155,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/ratePlans": { + "/listOfValues/hotels/{hotelId}/repMarketCodes": { "get": { - "summary": "Fetch List Of Values for Rate Plans", - "description": "OperationId:getRatePlansLOV
", - "operationId": "getRatePlansLOV", + "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", "parameters": [ { "name": "hotelId", @@ -36485,7 +37168,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 RepMarketCodes LOV" }, { "name": "includeInactiveFlag", @@ -36559,7 +37242,7 @@ } }, "204": { - "description": "RatePlansLOV not found." + "description": "RepMarketCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36609,21 +37292,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/relModuleName/{relModuleName}/applicationModules": { + "/listOfValues/hotels/{hotelId}/repRoomStatuses": { "get": { - "summary": "Fetch List Of Values for Application Modules", - "description": "OperationId:getApplicationModulesLOV
", - "operationId": "getApplicationModulesLOV", + "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", "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", @@ -36631,7 +37305,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 RepRoomStatuses LOV" }, { "name": "includeInactiveFlag", @@ -36705,7 +37379,7 @@ } }, "204": { - "description": "ApplicationModulesLOV not found." + "description": "RepRoomStatusesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36755,11 +37429,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repBlockCodesParamOff": { + "/listOfValues/hotels/{hotelId}/repRoomTypes": { "get": { - "summary": "Fetch List Of Values for Rep Block Codes Param Off", - "description": "OperationId:getRepBlockCodesParamOffLOV
", - "operationId": "getRepBlockCodesParamOffLOV", + "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", "parameters": [ { "name": "hotelId", @@ -36768,7 +37442,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 RepRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -36842,7 +37516,7 @@ } }, "204": { - "description": "RepBlockCodesParamOffLOV not found." + "description": "RepRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -36892,11 +37566,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repBlockCodesParamOn": { + "/listOfValues/hotels/{hotelId}/repRooms": { "get": { - "summary": "Fetch List Of Values for Rep Block Codes Param On", - "description": "OperationId:getRepBlockCodesParamOnLOV
", - "operationId": "getRepBlockCodesParamOnLOV", + "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", "parameters": [ { "name": "hotelId", @@ -36905,7 +37579,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 RepRooms LOV" }, { "name": "includeInactiveFlag", @@ -36979,7 +37653,7 @@ } }, "204": { - "description": "RepBlockCodesParamOnLOV not found." + "description": "RepRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37029,11 +37703,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repCashiers": { + "/listOfValues/hotels/{hotelId}/repServiceRequestCodes": { "get": { - "summary": "Fetch List Of Values for Rep Cashiers", - "description": "OperationId:getRepCashiersLOV
", - "operationId": "getRepCashiersLOV", + "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", "parameters": [ { "name": "hotelId", @@ -37042,7 +37716,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 RepServiceRequestCodes LOV" }, { "name": "includeInactiveFlag", @@ -37116,7 +37790,7 @@ } }, "204": { - "description": "RepCashiersLOV not found." + "description": "RepServiceRequestCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37166,11 +37840,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repContactList": { + "/listOfValues/hotels/{hotelId}/repTransactionCodes": { "get": { - "summary": "Fetch List Of Values for Rep Contact List", - "description": "OperationId:getRepContactListLOV
", - "operationId": "getRepContactListLOV", + "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", "parameters": [ { "name": "hotelId", @@ -37179,7 +37853,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 RepTransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -37253,7 +37927,7 @@ } }, "204": { - "description": "RepContactListLOV not found." + "description": "RepTransactionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37303,11 +37977,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repCurrencies": { + "/listOfValues/hotels/{hotelId}/repTraveAgtCalendarYear": { "get": { - "summary": "Fetch List Of Values for Rep Currencies", - "description": "OperationId:getRepCurrenciesLOV
", - "operationId": "getRepCurrenciesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -37316,7 +37990,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 RepTraveAgtCalendarYear LOV" }, { "name": "includeInactiveFlag", @@ -37390,7 +38064,7 @@ } }, "204": { - "description": "RepCurrenciesLOV not found." + "description": "RepTraveAgtCalendarYearLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37440,11 +38114,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repDepartments": { + "/listOfValues/hotels/{hotelId}/reservationBasedBlocks": { "get": { - "summary": "Fetch List Of Values for Rep Departments", - "description": "OperationId:getRepDepartmentsLOV
", - "operationId": "getRepDepartmentsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -37453,7 +38127,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 ReservationBasedBlocks LOV" }, { "name": "includeInactiveFlag", @@ -37527,7 +38201,7 @@ } }, "204": { - "description": "RepDepartmentsLOV not found." + "description": "ReservationBasedBlocksLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37577,11 +38251,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repFiscalYears": { + "/listOfValues/hotels/{hotelId}/reservationBasedProfiles": { "get": { - "summary": "Fetch List Of Values for Rep Fiscal Years", - "description": "OperationId:getRepFiscalYearsLOV
", - "operationId": "getRepFiscalYearsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -37590,7 +38264,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 ReservationBasedProfiles LOV" }, { "name": "includeInactiveFlag", @@ -37664,7 +38338,7 @@ } }, "204": { - "description": "RepFiscalYearsLOV not found." + "description": "ReservationBasedProfilesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37714,11 +38388,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repForeignCurrencies": { + "/listOfValues/hotels/{hotelId}/reservationPreferences": { "get": { - "summary": "Fetch List Of Values for Rep Foreign Currencies", - "description": "OperationId:getRepForeignCurrenciesLOV
", - "operationId": "getRepForeignCurrenciesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -37727,7 +38401,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 ReservationPreferences LOV" }, { "name": "includeInactiveFlag", @@ -37801,7 +38475,7 @@ } }, "204": { - "description": "RepForeignCurrenciesLOV not found." + "description": "ReservationPreferencesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37851,11 +38525,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repGroups": { + "/listOfValues/hotels/{hotelId}/reservationStatusesHotel": { "get": { - "summary": "Fetch List Of Values for Rep Groups", - "description": "OperationId:getRepGroupsLOV
", - "operationId": "getRepGroupsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -37864,7 +38538,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 ReservationStatusesHotel LOV" }, { "name": "includeInactiveFlag", @@ -37938,7 +38612,7 @@ } }, "204": { - "description": "RepGroupsLOV not found." + "description": "ReservationStatusesHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -37988,11 +38662,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repInventoryItemPools": { + "/listOfValues/hotels/{hotelId}/resortAirports": { "get": { - "summary": "Fetch List Of Values for Rep Inventory Item Pools", - "description": "OperationId:getRepInventoryItemPoolsLOV
", - "operationId": "getRepInventoryItemPoolsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -38001,7 +38675,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 ResortAirports LOV" }, { "name": "includeInactiveFlag", @@ -38075,7 +38749,7 @@ } }, "204": { - "description": "RepInventoryItemPoolsLOV not found." + "description": "ResortAirportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38125,11 +38799,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repMarketCodes": { + "/listOfValues/hotels/{hotelId}/resortCROs": { "get": { - "summary": "Fetch List Of Values for Rep Market Codes", - "description": "OperationId:getRepMarketCodesLOV
", - "operationId": "getRepMarketCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -38138,7 +38812,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 ResortCROs LOV" }, { "name": "includeInactiveFlag", @@ -38212,7 +38886,7 @@ } }, "204": { - "description": "RepMarketCodesLOV not found." + "description": "ResortCROsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38262,11 +38936,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repRoomStatuses": { + "/listOfValues/hotels/{hotelId}/resortGuaranteeCodes": { "get": { - "summary": "Fetch List Of Values for Rep Room Statuses", - "description": "OperationId:getRepRoomStatusesLOV
", - "operationId": "getRepRoomStatusesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -38275,7 +38949,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 ResortGuaranteeCodes LOV" }, { "name": "includeInactiveFlag", @@ -38349,7 +39023,7 @@ } }, "204": { - "description": "RepRoomStatusesLOV not found." + "description": "ResortGuaranteeCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38399,11 +39073,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repRoomTypes": { + "/listOfValues/hotels/{hotelId}/resortMarketCodes": { "get": { - "summary": "Fetch List Of Values for Rep Room Types", - "description": "OperationId:getRepRoomTypesLOV
", - "operationId": "getRepRoomTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -38412,7 +39086,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 ResortMarketCodes LOV" }, { "name": "includeInactiveFlag", @@ -38486,7 +39160,7 @@ } }, "204": { - "description": "RepRoomTypesLOV not found." + "description": "ResortMarketCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38536,12 +39210,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repRooms": { + "/listOfValues/hotels/{hotelId}/resortNameId/{resortNameId}/stagedProfilePreferences": { "get": { - "summary": "Fetch List Of Values for Rep Rooms", - "description": "OperationId:getRepRoomsLOV
", - "operationId": "getRepRoomsLOV", + "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", "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", @@ -38549,7 +39232,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 StagedProfilePreferences LOV" }, { "name": "includeInactiveFlag", @@ -38623,7 +39306,7 @@ } }, "204": { - "description": "RepRoomsLOV not found." + "description": "StagedProfilePreferencesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38673,11 +39356,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repServiceRequestCodes": { + "/listOfValues/hotels/{hotelId}/resortRateClasses": { "get": { - "summary": "Fetch List Of Values for Rep Service Request Codes", - "description": "OperationId:getRepServiceRequestCodesLOV
", - "operationId": "getRepServiceRequestCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -38686,7 +39369,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 ResortRateClasses LOV" }, { "name": "includeInactiveFlag", @@ -38760,7 +39443,7 @@ } }, "204": { - "description": "RepServiceRequestCodesLOV not found." + "description": "ResortRateClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38810,11 +39493,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repTransactionCodes": { + "/listOfValues/hotels/{hotelId}/resortRestrictionStatuses": { "get": { - "summary": "Fetch List Of Values for Rep Transaction Codes", - "description": "OperationId:getRepTransactionCodesLOV
", - "operationId": "getRepTransactionCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -38823,7 +39506,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 ResortRestrictionStatuses LOV" }, { "name": "includeInactiveFlag", @@ -38897,7 +39580,7 @@ } }, "204": { - "description": "RepTransactionCodesLOV not found." + "description": "ResortRestrictionStatusesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -38947,11 +39630,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repTraveAgtCalendarYear": { + "/listOfValues/hotels/{hotelId}/resortRoomNumbers": { "get": { - "summary": "Fetch List Of Values for Rep Trave Agt Calendar Year", - "description": "OperationId:getRepTraveAgtCalendarYearLOV
", - "operationId": "getRepTraveAgtCalendarYearLOV", + "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", "parameters": [ { "name": "hotelId", @@ -38960,7 +39643,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 ResortRoomNumbers LOV" }, { "name": "includeInactiveFlag", @@ -39034,7 +39717,7 @@ } }, "204": { - "description": "RepTraveAgtCalendarYearLOV not found." + "description": "ResortRoomNumbersLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39084,11 +39767,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reportTextConfiguration": { + "/listOfValues/hotels/{hotelId}/resortRoomTypes": { "get": { - "summary": "Fetch List Of Values for Report Text Configuration", - "description": "OperationId:getReportTextConfigurationLOV
", - "operationId": "getReportTextConfigurationLOV", + "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", "parameters": [ { "name": "hotelId", @@ -39097,7 +39780,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ReportTextConfiguration LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ResortRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -39171,7 +39854,7 @@ } }, "204": { - "description": "ReportTextConfigurationLOV not found." + "description": "ResortRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39221,11 +39904,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationBasedBlocks": { + "/listOfValues/hotels/{hotelId}/resortTransportationLabels": { "get": { - "summary": "Fetch List Of Values for Reservation Based Blocks", - "description": "OperationId:getReservationBasedBlocksLOV
", - "operationId": "getReservationBasedBlocksLOV", + "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", "parameters": [ { "name": "hotelId", @@ -39234,7 +39917,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 ResortTransportationLabels LOV" }, { "name": "includeInactiveFlag", @@ -39308,7 +39991,7 @@ } }, "204": { - "description": "ReservationBasedBlocksLOV not found." + "description": "ResortTransportationLabelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39358,11 +40041,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationBasedProfiles": { + "/listOfValues/hotels/{hotelId}/resourceItemClasses": { "get": { - "summary": "Fetch List Of Values for Reservation Based Profiles", - "description": "OperationId:getReservationBasedProfilesLOV
", - "operationId": "getReservationBasedProfilesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -39371,7 +40054,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 ResourceItemClasses LOV" }, { "name": "includeInactiveFlag", @@ -39445,7 +40128,7 @@ } }, "204": { - "description": "ReservationBasedProfilesLOV not found." + "description": "ResourceItemClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39495,11 +40178,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationPreferences": { + "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesCodes": { "get": { - "summary": "Fetch List Of Values for Reservation Preferences", - "description": "OperationId:getReservationPreferencesLOV
", - "operationId": "getReservationPreferencesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -39508,7 +40191,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 ResvAutoAttachRulesCodes LOV" }, { "name": "includeInactiveFlag", @@ -39582,7 +40265,7 @@ } }, "204": { - "description": "ReservationPreferencesLOV not found." + "description": "ResvAutoAttachRulesCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39632,11 +40315,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationStatusesHotel": { + "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesRuleType": { "get": { - "summary": "Fetch List Of Values for Reservation Statuses Hotel", - "description": "OperationId:getReservationStatusesHotelLOV
", - "operationId": "getReservationStatusesHotelLOV", + "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", "parameters": [ { "name": "hotelId", @@ -39645,7 +40328,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 ResvAutoAttachRulesRuleType LOV" }, { "name": "includeInactiveFlag", @@ -39719,7 +40402,7 @@ } }, "204": { - "description": "ReservationStatusesHotelLOV not found." + "description": "ResvAutoAttachRulesRuleTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39769,11 +40452,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortAirports": { + "/listOfValues/hotels/{hotelId}/resvBasedProfiles": { "get": { - "summary": "Fetch List Of Values for Resort Airports", - "description": "OperationId:getResortAirportsLOV
", - "operationId": "getResortAirportsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -39782,7 +40465,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 ResvBasedProfiles LOV" }, { "name": "includeInactiveFlag", @@ -39856,7 +40539,7 @@ } }, "204": { - "description": "ResortAirportsLOV not found." + "description": "ResvBasedProfilesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -39906,149 +40589,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortCROs": { + "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/reservationTickets": { "get": { - "summary": "Fetch List Of Values for Resort CROs", - "description": "OperationId:getResortCROsLOV
", - "operationId": "getResortCROsLOV", + "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", "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 ResortCROs 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": "ResortCROsLOV 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}/resortGuaranteeCodes": { - "get": { - "summary": "Fetch List Of Values for Resort Guarantee Codes", - "description": "OperationId:getResortGuaranteeCodesLOV
", - "operationId": "getResortGuaranteeCodesLOV", - "parameters": [ { "name": "hotelId", "in": "path", @@ -40056,7 +40611,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 ReservationTickets LOV" }, { "name": "includeInactiveFlag", @@ -40130,7 +40685,7 @@ } }, "204": { - "description": "ResortGuaranteeCodesLOV not found." + "description": "ReservationTicketsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40180,12 +40735,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortMarketCodes": { + "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/resvTransactionDiversionCodes": { "get": { - "summary": "Fetch List Of Values for Resort Market Codes", - "description": "OperationId:getResortMarketCodesLOV
", - "operationId": "getResortMarketCodesLOV", + "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", "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", @@ -40193,7 +40757,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 ResvTransactionDiversionCodes LOV" }, { "name": "includeInactiveFlag", @@ -40267,7 +40831,7 @@ } }, "204": { - "description": "ResortMarketCodesLOV not found." + "description": "ResvTransactionDiversionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40317,21 +40881,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortNameId/{resortNameId}/stagedProfilePreferences": { + "/listOfValues/hotels/{hotelId}/revenueTypeMappingSpace": { "get": { - "summary": "Fetch List Of Values for Staged Profile Preferences", - "description": "OperationId:getStagedProfilePreferencesLOV
", - "operationId": "getStagedProfilePreferencesLOV", + "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", "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", @@ -40339,7 +40894,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 RevenueTypeMappingSpace LOV" }, { "name": "includeInactiveFlag", @@ -40413,7 +40968,7 @@ } }, "204": { - "description": "StagedProfilePreferencesLOV not found." + "description": "RevenueTypeMappingSpaceLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40463,11 +41018,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRateClasses": { + "/listOfValues/hotels/{hotelId}/revenueTypeMappingTrxCodes": { "get": { - "summary": "Fetch List Of Values for Resort Rate Classes", - "description": "OperationId:getResortRateClassesLOV
", - "operationId": "getResortRateClassesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -40476,7 +41031,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 RevenueTypeMappingTrxCodes LOV" }, { "name": "includeInactiveFlag", @@ -40550,7 +41105,7 @@ } }, "204": { - "description": "ResortRateClassesLOV not found." + "description": "RevenueTypeMappingTrxCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40600,12 +41155,25 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRestrictionStatuses": { + "/listOfValues/hotels/{hotelId}/roleWithDepartment/{roleWithDepartment}/userRoles": { "get": { - "summary": "Fetch List Of Values for Resort Restriction Statuses", - "description": "OperationId:getResortRestrictionStatusesLOV
", - "operationId": "getResortRestrictionStatusesLOV", + "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", "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", @@ -40613,7 +41181,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 UserRoles LOV" }, { "name": "includeInactiveFlag", @@ -40687,7 +41255,7 @@ } }, "204": { - "description": "ResortRestrictionStatusesLOV not found." + "description": "UserRolesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40737,12 +41305,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRoomNumbers": { + "/listOfValues/hotels/{hotelId}/room/{room}/assignRooms": { "get": { - "summary": "Fetch List Of Values for Resort Room Numbers", - "description": "OperationId:getResortRoomNumbersLOV
", - "operationId": "getResortRoomNumbersLOV", + "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", "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", @@ -40750,7 +41327,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 AssignRooms LOV" }, { "name": "includeInactiveFlag", @@ -40824,7 +41401,7 @@ } }, "204": { - "description": "ResortRoomNumbersLOV not found." + "description": "AssignRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -40874,12 +41451,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRoomTypes": { + "/listOfValues/hotels/{hotelId}/room/{room}/eventSetupStyles": { "get": { - "summary": "Fetch List Of Values for Resort Room Types", - "description": "OperationId:getResortRoomTypesLOV
", - "operationId": "getResortRoomTypesLOV", + "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", "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", @@ -40887,7 +41473,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 EventSetupStyles LOV" }, { "name": "includeInactiveFlag", @@ -40961,7 +41547,7 @@ } }, "204": { - "description": "ResortRoomTypesLOV not found." + "description": "EventSetupStylesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41011,12 +41597,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortTransportationLabels": { + "/listOfValues/hotels/{hotelId}/room/{room}/roomRates": { "get": { - "summary": "Fetch List Of Values for Resort Transportation Labels", - "description": "OperationId:getResortTransportationLabelsLOV
", - "operationId": "getResortTransportationLabelsLOV", + "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", "parameters": [ + { + "name": "room", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'room' which is required to fetch RoomRates LOV" + }, { "name": "hotelId", "in": "path", @@ -41024,7 +41619,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 RoomRates LOV" }, { "name": "includeInactiveFlag", @@ -41098,7 +41693,7 @@ } }, "204": { - "description": "ResortTransportationLabelsLOV not found." + "description": "RoomRatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41148,12 +41743,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resourceItemClasses": { + "/listOfValues/hotels/{hotelId}/room/{room}/roomsKeyCreation": { "get": { - "summary": "Fetch List Of Values for Resource Item Classes", - "description": "OperationId:getResourceItemClassesLOV
", - "operationId": "getResourceItemClassesLOV", + "summary": "Fetch List Of Values for Rooms Key Creation", + "description": "OperationId:getRoomsKeyCreationLOV
", + "operationId": "getRoomsKeyCreationLOV", "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", @@ -41161,7 +41765,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 RoomsKeyCreation LOV" }, { "name": "includeInactiveFlag", @@ -41235,7 +41839,7 @@ } }, "204": { - "description": "ResourceItemClassesLOV not found." + "description": "RoomsKeyCreationLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41285,11 +41889,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesCodes": { + "/listOfValues/hotels/{hotelId}/roomClassCategories": { "get": { - "summary": "Fetch List Of Values for Resv Auto Attach Rules Codes", - "description": "OperationId:getResvAutoAttachRulesCodesLOV
", - "operationId": "getResvAutoAttachRulesCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -41298,7 +41902,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 RoomClassCategories LOV" }, { "name": "includeInactiveFlag", @@ -41372,7 +41976,7 @@ } }, "204": { - "description": "ResvAutoAttachRulesCodesLOV not found." + "description": "RoomClassCategoriesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41422,11 +42026,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesRuleType": { + "/listOfValues/hotels/{hotelId}/roomClasses": { "get": { - "summary": "Fetch List Of Values for Resv Auto Attach Rules Rule Type", - "description": "OperationId:getResvAutoAttachRulesRuleTypeLOV
", - "operationId": "getResvAutoAttachRulesRuleTypeLOV", + "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", "parameters": [ { "name": "hotelId", @@ -41435,7 +42039,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 RoomClasses LOV" }, { "name": "includeInactiveFlag", @@ -41509,7 +42113,7 @@ } }, "204": { - "description": "ResvAutoAttachRulesRuleTypeLOV not found." + "description": "RoomClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41559,11 +42163,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvBasedProfiles": { + "/listOfValues/hotels/{hotelId}/roomFeatures": { "get": { - "summary": "Fetch List Of Values for Resv Based Profiles", - "description": "OperationId:getResvBasedProfilesLOV
", - "operationId": "getResvBasedProfilesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -41572,7 +42176,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 RoomFeatures LOV" }, { "name": "includeInactiveFlag", @@ -41646,7 +42250,7 @@ } }, "204": { - "description": "ResvBasedProfilesLOV not found." + "description": "RoomFeaturesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41696,21 +42300,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/reservationTickets": { + "/listOfValues/hotels/{hotelId}/roomHoldConditions": { "get": { - "summary": "Fetch List Of Values for Reservation Tickets", - "description": "OperationId:getReservationTicketsLOV
", - "operationId": "getReservationTicketsLOV", + "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", "parameters": [ { - "name": "resvNameId", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'resvNameId' which is required to fetch ReservationTickets LOV" + "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" + }, + "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", @@ -41718,7 +42450,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 RoomMaintenance LOV" }, { "name": "includeInactiveFlag", @@ -41792,7 +42524,7 @@ } }, "204": { - "description": "ReservationTicketsLOV not found." + "description": "RoomMaintenanceLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41842,20 +42574,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/resvTransactionDiversionCodes": { + "/listOfValues/hotels/{hotelId}/roomNumber/{roomNumber}/connectingSuites": { "get": { - "summary": "Fetch List Of Values for Resv Transaction Diversion Codes", - "description": "OperationId:getResvTransactionDiversionCodesLOV
", - "operationId": "getResvTransactionDiversionCodesLOV", + "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", "parameters": [ { - "name": "resvNameId", + "name": "roomNumber", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'resvNameId' which is required to fetch ResvTransactionDiversionCodes LOV" + "description": "Value of the parameter 'roomNumber' which is required to fetch ConnectingSuites LOV" }, { "name": "hotelId", @@ -41864,7 +42596,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 ConnectingSuites LOV" }, { "name": "includeInactiveFlag", @@ -41938,7 +42670,7 @@ } }, "204": { - "description": "ResvTransactionDiversionCodesLOV not found." + "description": "ConnectingSuitesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -41988,12 +42720,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/revenueTypeMappingSpace": { + "/listOfValues/hotels/{hotelId}/roomPool/{roomPool}/roomPoolRoomTypes": { "get": { - "summary": "Fetch List Of Values for Revenue Type Mapping Space", - "description": "OperationId:getRevenueTypeMappingSpaceLOV
", - "operationId": "getRevenueTypeMappingSpaceLOV", + "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", "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", @@ -42001,7 +42742,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 RoomPoolRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -42075,7 +42816,7 @@ } }, "204": { - "description": "RevenueTypeMappingSpaceLOV not found." + "description": "RoomPoolRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42125,11 +42866,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/revenueTypeMappingTrxCodes": { + "/listOfValues/hotels/{hotelId}/roomPools": { "get": { - "summary": "Fetch List Of Values for Revenue Type Mapping Trx Codes", - "description": "OperationId:getRevenueTypeMappingTrxCodesLOV
", - "operationId": "getRevenueTypeMappingTrxCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -42138,7 +42879,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 RoomPools LOV" }, { "name": "includeInactiveFlag", @@ -42212,7 +42953,7 @@ } }, "204": { - "description": "RevenueTypeMappingTrxCodesLOV not found." + "description": "RoomPoolsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42262,25 +43003,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roleWithDepartment/{roleWithDepartment}/userRoles": { + "/listOfValues/hotels/{hotelId}/roomRevenueTrxCodes": { "get": { - "summary": "Fetch List Of Values for User Roles", - "description": "OperationId:getUserRolesLOV
", - "operationId": "getUserRolesLOV", + "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", "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", @@ -42288,7 +43016,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 RoomRevenueTrxCodes LOV" }, { "name": "includeInactiveFlag", @@ -42362,7 +43090,7 @@ } }, "204": { - "description": "UserRolesLOV not found." + "description": "RoomRevenueTrxCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42412,21 +43140,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/room/{room}/assignRooms": { + "/listOfValues/hotels/{hotelId}/roomRotationGroups": { "get": { - "summary": "Fetch List Of Values for Assign Rooms", - "description": "OperationId:getAssignRoomsLOV
", - "operationId": "getAssignRoomsLOV", + "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", "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", @@ -42434,7 +43153,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 RoomRotationGroups LOV" }, { "name": "includeInactiveFlag", @@ -42508,7 +43227,7 @@ } }, "204": { - "description": "AssignRoomsLOV not found." + "description": "RoomRotationGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42558,21 +43277,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/room/{room}/eventSetupStyles": { + "/listOfValues/hotels/{hotelId}/roomRotationUnitGrades": { "get": { - "summary": "Fetch List Of Values for Event Setup Styles", - "description": "OperationId:getEventSetupStylesLOV
", - "operationId": "getEventSetupStylesLOV", + "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", "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 EventSetupStyles LOV" + "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" + }, + "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", @@ -42580,7 +43427,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 RoomSpecials LOV" }, { "name": "includeInactiveFlag", @@ -42654,7 +43501,7 @@ } }, "204": { - "description": "EventSetupStylesLOV not found." + "description": "RoomSpecialsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42704,20 +43551,38 @@ ] } }, - "/listOfValues/hotels/{hotelId}/room/{room}/roomRates": { + "/listOfValues/hotels/{hotelId}/roomType/{roomType}/arrival/{arrival}/departure/{departure}/roomingListHKRooms": { "get": { - "summary": "Fetch List Of Values for Room Rates", - "description": "OperationId:getRoomRatesLOV
", - "operationId": "getRoomRatesLOV", + "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", "parameters": [ { - "name": "room", + "name": "departure", "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 '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", + "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", @@ -42726,7 +43591,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 RoomingListHKRooms LOV" }, { "name": "includeInactiveFlag", @@ -42800,7 +43665,7 @@ } }, "204": { - "description": "RoomRatesLOV not found." + "description": "RoomingListHKRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42850,20 +43715,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/room/{room}/roomsKeyCreation": { + "/listOfValues/hotels/{hotelId}/roomType/{roomType}/availableRoomTypeComponents": { "get": { - "summary": "Fetch List Of Values for Rooms Key Creation", - "description": "OperationId:getRoomsKeyCreationLOV
", - "operationId": "getRoomsKeyCreationLOV", + "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", "parameters": [ { - "name": "room", + "name": "roomType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'room' which is required to fetch RoomsKeyCreation LOV" + "description": "Value of the parameter 'roomType' which is required to fetch AvailableRoomTypeComponents LOV" }, { "name": "hotelId", @@ -42872,7 +43737,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 AvailableRoomTypeComponents LOV" }, { "name": "includeInactiveFlag", @@ -42946,7 +43811,7 @@ } }, "204": { - "description": "RoomsKeyCreationLOV not found." + "description": "AvailableRoomTypeComponentsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -42996,12 +43861,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomClassCategories": { + "/listOfValues/hotels/{hotelId}/roomType/{roomType}/roomNumber/{roomNumber}/availableRoomComponents": { "get": { - "summary": "Fetch List Of Values for Room Class Categories", - "description": "OperationId:getRoomClassCategoriesLOV
", - "operationId": "getRoomClassCategoriesLOV", + "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", "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", @@ -43009,7 +43892,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 AvailableRoomComponents LOV" }, { "name": "includeInactiveFlag", @@ -43083,7 +43966,7 @@ } }, "204": { - "description": "RoomClassCategoriesLOV not found." + "description": "AvailableRoomComponentsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43133,12 +44016,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomClasses": { + "/listOfValues/hotels/{hotelId}/roomTypeLabel/{roomTypeLabel}/facilityTasksRoomType": { "get": { - "summary": "Fetch List Of Values for Room Classes", - "description": "OperationId:getRoomClassesLOV
", - "operationId": "getRoomClassesLOV", + "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", "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", @@ -43146,7 +44038,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 FacilityTasksRoomType LOV" }, { "name": "includeInactiveFlag", @@ -43220,7 +44112,7 @@ } }, "204": { - "description": "RoomClassesLOV not found." + "description": "FacilityTasksRoomTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43270,11 +44162,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomFeatures": { + "/listOfValues/hotels/{hotelId}/roomTypePool": { "get": { - "summary": "Fetch List Of Values for Room Features", - "description": "OperationId:getRoomFeaturesLOV
", - "operationId": "getRoomFeaturesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -43283,7 +44175,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 RoomTypePool LOV" }, { "name": "includeInactiveFlag", @@ -43357,7 +44249,7 @@ } }, "204": { - "description": "RoomFeaturesLOV not found." + "description": "RoomTypePoolLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43407,11 +44299,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomHoldConditions": { + "/listOfValues/hotels/{hotelId}/roomTypes": { "get": { - "summary": "Fetch List Of Values for Room Hold Conditions", - "description": "OperationId:getRoomHoldConditionsLOV
", - "operationId": "getRoomHoldConditionsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -43420,7 +44312,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomHoldConditions LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -43494,7 +44386,7 @@ } }, "204": { - "description": "RoomHoldConditionsLOV not found." + "description": "RoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43544,11 +44436,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomMaintenance": { + "/listOfValues/hotels/{hotelId}/rooms": { "get": { - "summary": "Fetch List Of Values for Room Maintenance", - "description": "OperationId:getRoomMaintenanceLOV
", - "operationId": "getRoomMaintenanceLOV", + "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", "parameters": [ { "name": "hotelId", @@ -43557,7 +44449,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 Rooms LOV" }, { "name": "includeInactiveFlag", @@ -43631,7 +44523,7 @@ } }, "204": { - "description": "RoomMaintenanceLOV not found." + "description": "RoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43681,21 +44573,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomNumber/{roomNumber}/connectingSuites": { + "/listOfValues/hotels/{hotelId}/roomsKeyGeneration": { "get": { - "summary": "Fetch List Of Values for Connecting Suites", - "description": "OperationId:getConnectingSuitesLOV
", - "operationId": "getConnectingSuitesLOV", + "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", "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", @@ -43703,7 +44586,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 RoomsKeyGeneration LOV" }, { "name": "includeInactiveFlag", @@ -43777,7 +44660,7 @@ } }, "204": { - "description": "ConnectingSuitesLOV not found." + "description": "RoomsKeyGenerationLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43827,21 +44710,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomPool/{roomPool}/roomPoolRoomTypes": { + "/listOfValues/hotels/{hotelId}/routingInstructions": { "get": { - "summary": "Fetch List Of Values for Room Pool Room Types", - "description": "OperationId:getRoomPoolRoomTypesLOV
", - "operationId": "getRoomPoolRoomTypesLOV", + "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", "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", @@ -43849,7 +44723,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 RoutingInstructions LOV" }, { "name": "includeInactiveFlag", @@ -43923,7 +44797,7 @@ } }, "204": { - "description": "RoomPoolRoomTypesLOV not found." + "description": "RoutingInstructionsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -43973,11 +44847,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomPools": { + "/listOfValues/hotels/{hotelId}/salesManagerGoalPeriod": { "get": { - "summary": "Fetch List Of Values for Room Pools", - "description": "OperationId:getRoomPoolsLOV
", - "operationId": "getRoomPoolsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -43986,7 +44860,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 SalesManagerGoalPeriod LOV" }, { "name": "includeInactiveFlag", @@ -44060,7 +44934,7 @@ } }, "204": { - "description": "RoomPoolsLOV not found." + "description": "SalesManagerGoalPeriodLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44110,11 +44984,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomRevenueTrxCodes": { + "/listOfValues/hotels/{hotelId}/scheduledReportsExport": { "get": { - "summary": "Fetch List Of Values for Room Revenue Trx Codes", - "description": "OperationId:getRoomRevenueTrxCodesLOV
", - "operationId": "getRoomRevenueTrxCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -44123,7 +44997,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 ScheduledReportsExport LOV" }, { "name": "includeInactiveFlag", @@ -44197,7 +45071,7 @@ } }, "204": { - "description": "RoomRevenueTrxCodesLOV not found." + "description": "ScheduledReportsExportLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44247,12 +45121,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomRotationGroups": { + "/listOfValues/hotels/{hotelId}/sectionType/{sectionType}/sitePlanSectionTypeLinks": { "get": { - "summary": "Fetch List Of Values for Room Rotation Groups", - "description": "OperationId:getRoomRotationGroupsLOV
", - "operationId": "getRoomRotationGroupsLOV", + "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", "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", @@ -44260,7 +45143,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 SitePlanSectionTypeLinks LOV" }, { "name": "includeInactiveFlag", @@ -44334,7 +45217,7 @@ } }, "204": { - "description": "RoomRotationGroupsLOV not found." + "description": "SitePlanSectionTypeLinksLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44384,12 +45267,34 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomRotationUnitGrades": { + "/listOfValues/hotels/{hotelId}/sell/{sell}/exchangeType/{exchangeType}/foreignCurrencies": { "get": { - "summary": "Fetch List Of Values for Room Rotation Unit Grades", - "description": "OperationId:getRoomRotationUnitGradesLOV
", - "operationId": "getRoomRotationUnitGradesLOV", + "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", "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", @@ -44397,7 +45302,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomRotationUnitGrades LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ForeignCurrencies LOV" }, { "name": "includeInactiveFlag", @@ -44471,7 +45376,7 @@ } }, "204": { - "description": "RoomRotationUnitGradesLOV not found." + "description": "ForeignCurrenciesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44521,12 +45426,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomSpecials": { + "/listOfValues/hotels/{hotelId}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/inventoryItems": { "get": { - "summary": "Fetch List Of Values for Room Specials", - "description": "OperationId:getRoomSpecialsLOV
", - "operationId": "getRoomSpecialsLOV", + "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", "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", @@ -44534,7 +45457,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 InventoryItems LOV" }, { "name": "includeInactiveFlag", @@ -44608,7 +45531,7 @@ } }, "204": { - "description": "RoomSpecialsLOV not found." + "description": "InventoryItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44658,38 +45581,29 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomType/{roomType}/arrival/{arrival}/departure/{departure}/roomingListHKRooms": { + "/listOfValues/hotels/{hotelId}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/resortInventoryItems": { "get": { - "summary": "Fetch List Of Values for Rooming List HKRooms", - "description": "OperationId:getRoomingListHKRoomsLOV
", - "operationId": "getRoomingListHKRoomsLOV", + "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", "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", + "name": "sellInEvent", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'arrival' which is required to fetch RoomingListHKRooms LOV" + "description": "Value of the parameter 'sellInEvent' which is required to fetch ResortInventoryItems LOV" }, { - "name": "roomType", + "name": "sellInReservation", "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 'sellInReservation' which is required to fetch ResortInventoryItems LOV" }, { "name": "hotelId", @@ -44698,7 +45612,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 ResortInventoryItems LOV" }, { "name": "includeInactiveFlag", @@ -44772,7 +45686,7 @@ } }, "204": { - "description": "RoomingListHKRoomsLOV not found." + "description": "ResortInventoryItemsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44822,21 +45736,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomType/{roomType}/availableRoomTypeComponents": { + "/listOfValues/hotels/{hotelId}/serviceRequestCodes": { "get": { - "summary": "Fetch List Of Values for Available Room Type Components", - "description": "OperationId:getAvailableRoomTypeComponentsLOV
", - "operationId": "getAvailableRoomTypeComponentsLOV", + "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", "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", @@ -44844,7 +45749,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 ServiceRequestCodes LOV" }, { "name": "includeInactiveFlag", @@ -44918,7 +45823,7 @@ } }, "204": { - "description": "AvailableRoomTypeComponentsLOV not found." + "description": "ServiceRequestCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -44968,30 +45873,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomType/{roomType}/roomNumber/{roomNumber}/availableRoomComponents": { + "/listOfValues/hotels/{hotelId}/setupStyles": { "get": { - "summary": "Fetch List Of Values for Available Room Components", - "description": "OperationId:getAvailableRoomComponentsLOV
", - "operationId": "getAvailableRoomComponentsLOV", + "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", "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", @@ -44999,7 +45886,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 SetupStyles LOV" }, { "name": "includeInactiveFlag", @@ -45073,7 +45960,7 @@ } }, "204": { - "description": "AvailableRoomComponentsLOV not found." + "description": "SetupStylesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45123,21 +46010,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomTypeLabel/{roomTypeLabel}/facilityTasksRoomType": { + "/listOfValues/hotels/{hotelId}/shiftReports": { "get": { - "summary": "Fetch List Of Values for Facility Tasks Room Type", - "description": "OperationId:getFacilityTasksRoomTypeLOV
", - "operationId": "getFacilityTasksRoomTypeLOV", + "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", "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", @@ -45145,7 +46023,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 ShiftReports LOV" }, { "name": "includeInactiveFlag", @@ -45219,7 +46097,7 @@ } }, "204": { - "description": "FacilityTasksRoomTypeLOV not found." + "description": "ShiftReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45269,12 +46147,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomTypePool": { + "/listOfValues/hotels/{hotelId}/siteType/{siteType}/sitePlans": { "get": { - "summary": "Fetch List Of Values for Room Type Pool", - "description": "OperationId:getRoomTypePoolLOV
", - "operationId": "getRoomTypePoolLOV", + "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", "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", @@ -45282,7 +46169,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 SitePlans LOV" }, { "name": "includeInactiveFlag", @@ -45356,7 +46243,7 @@ } }, "204": { - "description": "RoomTypePoolLOV not found." + "description": "SitePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45406,11 +46293,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomTypes": { + "/listOfValues/hotels/{hotelId}/snapshotTypes": { "get": { - "summary": "Fetch List Of Values for Room Types", - "description": "OperationId:getRoomTypesLOV
", - "operationId": "getRoomTypesLOV", + "summary": "Fetch List Of Values for Snapshot Types", + "description": "OperationId:getSnapshotTypesLOV
", + "operationId": "getSnapshotTypesLOV", "parameters": [ { "name": "hotelId", @@ -45419,7 +46306,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 SnapshotTypes LOV" }, { "name": "includeInactiveFlag", @@ -45493,7 +46380,7 @@ } }, "204": { - "description": "RoomTypesLOV not found." + "description": "SnapshotTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45543,12 +46430,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rooms": { + "/listOfValues/hotels/{hotelId}/space/{space}/cateringSetupStyles": { "get": { - "summary": "Fetch List Of Values for Rooms", - "description": "OperationId:getRoomsLOV
", - "operationId": "getRoomsLOV", + "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", "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", @@ -45556,7 +46452,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 CateringSetupStyles LOV" }, { "name": "includeInactiveFlag", @@ -45630,7 +46526,7 @@ } }, "204": { - "description": "RoomsLOV not found." + "description": "CateringSetupStylesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45680,12 +46576,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomsKeyGeneration": { + "/listOfValues/hotels/{hotelId}/space/{space}/eventRateCode": { "get": { - "summary": "Fetch List Of Values for Rooms Key Generation", - "description": "OperationId:getRoomsKeyGenerationLOV
", - "operationId": "getRoomsKeyGenerationLOV", + "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", "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", @@ -45693,7 +46598,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 EventRateCode LOV" }, { "name": "includeInactiveFlag", @@ -45767,7 +46672,7 @@ } }, "204": { - "description": "RoomsKeyGenerationLOV not found." + "description": "EventRateCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45817,11 +46722,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/routingInstructions": { + "/listOfValues/hotels/{hotelId}/spaces": { "get": { - "summary": "Fetch List Of Values for Routing Instructions", - "description": "OperationId:getRoutingInstructionsLOV
", - "operationId": "getRoutingInstructionsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -45830,7 +46735,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 Spaces LOV" }, { "name": "includeInactiveFlag", @@ -45904,7 +46809,7 @@ } }, "204": { - "description": "RoutingInstructionsLOV not found." + "description": "SpacesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -45954,11 +46859,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/salesManagerGoalPeriod": { + "/listOfValues/hotels/{hotelId}/specialRequests": { "get": { - "summary": "Fetch List Of Values for Sales Manager Goal Period", - "description": "OperationId:getSalesManagerGoalPeriodLOV
", - "operationId": "getSalesManagerGoalPeriodLOV", + "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", "parameters": [ { "name": "hotelId", @@ -45967,7 +46872,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 SpecialRequests LOV" }, { "name": "includeInactiveFlag", @@ -46041,7 +46946,7 @@ } }, "204": { - "description": "SalesManagerGoalPeriodLOV not found." + "description": "SpecialRequestsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46091,11 +46996,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/scheduledReportsExport": { + "/listOfValues/hotels/{hotelId}/specials": { "get": { - "summary": "Fetch List Of Values for Scheduled Reports Export", - "description": "OperationId:getScheduledReportsExportLOV
", - "operationId": "getScheduledReportsExportLOV", + "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", "parameters": [ { "name": "hotelId", @@ -46104,7 +47009,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 Specials LOV" }, { "name": "includeInactiveFlag", @@ -46178,7 +47083,7 @@ } }, "204": { - "description": "ScheduledReportsExportLOV not found." + "description": "SpecialsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46228,21 +47133,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/sectionType/{sectionType}/sitePlanSectionTypeLinks": { + "/listOfValues/hotels/{hotelId}/storedValueRedeemTrx": { "get": { - "summary": "Fetch List Of Values for Site Plan Section Type Links", - "description": "OperationId:getSitePlanSectionTypeLinksLOV
", - "operationId": "getSitePlanSectionTypeLinksLOV", + "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", "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", @@ -46250,7 +47146,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 StoredValueRedeemTrx LOV" }, { "name": "includeInactiveFlag", @@ -46324,7 +47220,7 @@ } }, "204": { - "description": "SitePlanSectionTypeLinksLOV not found." + "description": "StoredValueRedeemTrxLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46374,34 +47270,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/sell/{sell}/exchangeType/{exchangeType}/foreignCurrencies": { + "/listOfValues/hotels/{hotelId}/summaryRefreshLog": { "get": { - "summary": "Fetch List Of Values for Foreign Currencies", - "description": "OperationId:getForeignCurrenciesLOV
", - "operationId": "getForeignCurrenciesLOV", + "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", "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", @@ -46409,7 +47283,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 SummaryRefreshLog LOV" }, { "name": "includeInactiveFlag", @@ -46483,7 +47357,7 @@ } }, "204": { - "description": "ForeignCurrenciesLOV not found." + "description": "SummaryRefreshLogLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46533,29 +47407,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/inventoryItems": { + "/listOfValues/hotels/{hotelId}/superBlock/{superBlock}/subBlock": { "get": { - "summary": "Fetch List Of Values for Inventory Items", - "description": "OperationId:getInventoryItemsLOV
", - "operationId": "getInventoryItemsLOV", + "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", "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", + "name": "superBlock", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'sellInReservation' which is required to fetch InventoryItems LOV" + "description": "Value of the parameter 'superBlock' which is required to fetch SubBlock LOV" }, { "name": "hotelId", @@ -46564,7 +47429,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 SubBlock LOV" }, { "name": "includeInactiveFlag", @@ -46638,7 +47503,7 @@ } }, "204": { - "description": "InventoryItemsLOV not found." + "description": "SubBlockLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46688,30 +47553,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/resortInventoryItems": { + "/listOfValues/hotels/{hotelId}/synchronizeRateCodes": { "get": { - "summary": "Fetch List Of Values for Resort Inventory Items", - "description": "OperationId:getResortInventoryItemsLOV
", - "operationId": "getResortInventoryItemsLOV", + "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", "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", @@ -46719,7 +47566,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 SynchronizeRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -46793,7 +47640,7 @@ } }, "204": { - "description": "ResortInventoryItemsLOV not found." + "description": "SynchronizeRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46843,12 +47690,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/serviceRequestCodes": { + "/listOfValues/hotels/{hotelId}/taskCode/{taskCode}/taskSheetNo/{taskSheetNo}/taskSheetRooms": { "get": { - "summary": "Fetch List Of Values for Service Request Codes", - "description": "OperationId:getServiceRequestCodesLOV
", - "operationId": "getServiceRequestCodesLOV", + "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", "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", @@ -46856,7 +47721,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 TaskSheetRooms LOV" }, { "name": "includeInactiveFlag", @@ -46930,7 +47795,7 @@ } }, "204": { - "description": "ServiceRequestCodesLOV not found." + "description": "TaskSheetRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -46980,12 +47845,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/setupStyles": { + "/listOfValues/hotels/{hotelId}/taxCode/{taxCode}/taxTransactionCode": { "get": { - "summary": "Fetch List Of Values for Setup Styles", - "description": "OperationId:getSetupStylesLOV
", - "operationId": "getSetupStylesLOV", + "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", "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", @@ -46993,7 +47867,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 TaxTransactionCode LOV" }, { "name": "includeInactiveFlag", @@ -47067,7 +47941,7 @@ } }, "204": { - "description": "SetupStylesLOV not found." + "description": "TaxTransactionCodeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47117,11 +47991,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/shiftReports": { + "/listOfValues/hotels/{hotelId}/taxTypes": { "get": { - "summary": "Fetch List Of Values for Shift Reports", - "description": "OperationId:getShiftReportsLOV
", - "operationId": "getShiftReportsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -47130,7 +48004,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 TaxTypes LOV" }, { "name": "includeInactiveFlag", @@ -47204,7 +48078,7 @@ } }, "204": { - "description": "ShiftReportsLOV not found." + "description": "TaxTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47254,21 +48128,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/siteType/{siteType}/sitePlans": { + "/listOfValues/hotels/{hotelId}/telephoneCategory": { "get": { - "summary": "Fetch List Of Values for Site Plans", - "description": "OperationId:getSitePlansLOV
", - "operationId": "getSitePlansLOV", + "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", "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", @@ -47276,7 +48141,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 TelephoneCategory LOV" }, { "name": "includeInactiveFlag", @@ -47350,7 +48215,7 @@ } }, "204": { - "description": "SitePlansLOV not found." + "description": "TelephoneCategoryLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47400,12 +48265,34 @@ ] } }, - "/listOfValues/hotels/{hotelId}/snapshotTypes": { + "/listOfValues/hotels/{hotelId}/tiered/{tiered}/currentRateCode/{currentRateCode}/configDynamicBaseRatePlans": { "get": { - "summary": "Fetch List Of Values for Snapshot Types", - "description": "OperationId:getSnapshotTypesLOV
", - "operationId": "getSnapshotTypesLOV", + "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", "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", @@ -47413,7 +48300,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 ConfigDynamicBaseRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -47487,7 +48374,7 @@ } }, "204": { - "description": "SnapshotTypesLOV not found." + "description": "ConfigDynamicBaseRatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47537,21 +48424,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/space/{space}/cateringSetupStyles": { + "/listOfValues/hotels/{hotelId}/transactionAdjustmentReasonCodes": { "get": { - "summary": "Fetch List Of Values for Catering Setup Styles", - "description": "OperationId:getCateringSetupStylesLOV
", - "operationId": "getCateringSetupStylesLOV", + "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", "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", @@ -47559,7 +48437,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 TransactionAdjustmentReasonCodes LOV" }, { "name": "includeInactiveFlag", @@ -47633,7 +48511,7 @@ } }, "204": { - "description": "CateringSetupStylesLOV not found." + "description": "TransactionAdjustmentReasonCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47683,21 +48561,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/space/{space}/eventRateCode": { + "/listOfValues/hotels/{hotelId}/transactionCodes": { "get": { - "summary": "Fetch List Of Values for Event Rate Code", - "description": "OperationId:getEventRateCodeLOV
", - "operationId": "getEventRateCodeLOV", + "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", "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", @@ -47705,7 +48574,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 TransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -47779,7 +48648,7 @@ } }, "204": { - "description": "EventRateCodeLOV not found." + "description": "TransactionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47829,11 +48698,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/spaces": { + "/listOfValues/hotels/{hotelId}/transactionCodesConsumption": { "get": { - "summary": "Fetch List Of Values for Spaces", - "description": "OperationId:getSpacesLOV
", - "operationId": "getSpacesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -47842,7 +48711,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 TransactionCodesConsumption LOV" }, { "name": "includeInactiveFlag", @@ -47916,7 +48785,7 @@ } }, "204": { - "description": "SpacesLOV not found." + "description": "TransactionCodesConsumptionLOV not found." }, "400": { "$ref": "#/responses/400" @@ -47966,11 +48835,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/specialRequests": { + "/listOfValues/hotels/{hotelId}/transactionCodesPayment": { "get": { - "summary": "Fetch List Of Values for Special Requests", - "description": "OperationId:getSpecialRequestsLOV
", - "operationId": "getSpecialRequestsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -47979,7 +48848,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 TransactionCodesPayment LOV" }, { "name": "includeInactiveFlag", @@ -48053,7 +48922,7 @@ } }, "204": { - "description": "SpecialRequestsLOV not found." + "description": "TransactionCodesPaymentLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48103,11 +48972,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/specials": { + "/listOfValues/hotels/{hotelId}/transactionDeleteReasonCodes": { "get": { - "summary": "Fetch List Of Values for Specials", - "description": "OperationId:getSpecialsLOV
", - "operationId": "getSpecialsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -48116,7 +48985,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 TransactionDeleteReasonCodes LOV" }, { "name": "includeInactiveFlag", @@ -48190,7 +49059,7 @@ } }, "204": { - "description": "SpecialsLOV not found." + "description": "TransactionDeleteReasonCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48240,11 +49109,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/storedValueRedeemTrx": { + "/listOfValues/hotels/{hotelId}/transactionDiversionRuleRooms": { "get": { - "summary": "Fetch List Of Values for Stored Value Redeem Trx", - "description": "OperationId:getStoredValueRedeemTrxLOV
", - "operationId": "getStoredValueRedeemTrxLOV", + "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", "parameters": [ { "name": "hotelId", @@ -48253,7 +49122,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 TransactionDiversionRuleRooms LOV" }, { "name": "includeInactiveFlag", @@ -48327,7 +49196,7 @@ } }, "204": { - "description": "StoredValueRedeemTrxLOV not found." + "description": "TransactionDiversionRuleRoomsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48377,11 +49246,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/summaryRefreshLog": { + "/listOfValues/hotels/{hotelId}/transactionGroups": { "get": { - "summary": "Fetch List Of Values for Summary Refresh Log", - "description": "OperationId:getSummaryRefreshLogLOV
", - "operationId": "getSummaryRefreshLogLOV", + "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", "parameters": [ { "name": "hotelId", @@ -48390,7 +49259,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 TransactionGroups LOV" }, { "name": "includeInactiveFlag", @@ -48464,7 +49333,7 @@ } }, "204": { - "description": "SummaryRefreshLogLOV not found." + "description": "TransactionGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48514,21 +49383,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/superBlock/{superBlock}/subBlock": { + "/listOfValues/hotels/{hotelId}/transactionSubgroups": { "get": { - "summary": "Fetch List Of Values for Sub Block", - "description": "OperationId:getSubBlockLOV
", - "operationId": "getSubBlockLOV", + "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", "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", @@ -48536,7 +49396,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 TransactionSubgroups LOV" }, { "name": "includeInactiveFlag", @@ -48610,7 +49470,7 @@ } }, "204": { - "description": "SubBlockLOV not found." + "description": "TransactionSubgroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48660,11 +49520,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/synchronizeRateCodes": { + "/listOfValues/hotels/{hotelId}/transportTypes": { "get": { - "summary": "Fetch List Of Values for Synchronize Rate Codes", - "description": "OperationId:getSynchronizeRateCodesLOV
", - "operationId": "getSynchronizeRateCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -48673,7 +49533,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 TransportTypes LOV" }, { "name": "includeInactiveFlag", @@ -48747,7 +49607,7 @@ } }, "204": { - "description": "SynchronizeRateCodesLOV not found." + "description": "TransportTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48797,30 +49657,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/taskCode/{taskCode}/taskSheetNo/{taskSheetNo}/taskSheetRooms": { + "/listOfValues/hotels/{hotelId}/transportTypesHotel": { "get": { - "summary": "Fetch List Of Values for Task Sheet Rooms", - "description": "OperationId:getTaskSheetRoomsLOV
", - "operationId": "getTaskSheetRoomsLOV", + "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", "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", @@ -48828,7 +49670,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 TransportTypesHotel LOV" }, { "name": "includeInactiveFlag", @@ -48902,7 +49744,7 @@ } }, "204": { - "description": "TaskSheetRoomsLOV not found." + "description": "TransportTypesHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -48952,21 +49794,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/taxCode/{taxCode}/taxTransactionCode": { + "/listOfValues/hotels/{hotelId}/travelAgentSource": { "get": { - "summary": "Fetch List Of Values for Tax Transaction Code", - "description": "OperationId:getTaxTransactionCodeLOV
", - "operationId": "getTaxTransactionCodeLOV", + "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": "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", @@ -48974,7 +49807,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 TravelAgentSource LOV" }, { "name": "includeInactiveFlag", @@ -49048,7 +49881,7 @@ } }, "204": { - "description": "TaxTransactionCodeLOV not found." + "description": "TravelAgentSourceLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49098,11 +49931,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/taxTypes": { + "/listOfValues/hotels/{hotelId}/travelAgentSourceResv": { "get": { - "summary": "Fetch List Of Values for Tax Types", - "description": "OperationId:getTaxTypesLOV
", - "operationId": "getTaxTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -49111,7 +49944,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 TravelAgentSourceResv LOV" }, { "name": "includeInactiveFlag", @@ -49185,7 +50018,7 @@ } }, "204": { - "description": "TaxTypesLOV not found." + "description": "TravelAgentSourceResvLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49235,11 +50068,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/telephoneCategory": { + "/listOfValues/hotels/{hotelId}/turnawayCodes": { "get": { - "summary": "Fetch List Of Values for Telephone Category", - "description": "OperationId:getTelephoneCategoryLOV
", - "operationId": "getTelephoneCategoryLOV", + "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", "parameters": [ { "name": "hotelId", @@ -49248,7 +50081,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 TurnawayCodes LOV" }, { "name": "includeInactiveFlag", @@ -49322,7 +50155,7 @@ } }, "204": { - "description": "TelephoneCategoryLOV not found." + "description": "TurnawayCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49372,34 +50205,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/tiered/{tiered}/currentRateCode/{currentRateCode}/configDynamicBaseRatePlans": { + "/listOfValues/hotels/{hotelId}/upsellDefaultTrxCode": { "get": { - "summary": "Fetch List Of Values for Config Dynamic Base Rate Plans", - "description": "OperationId:getConfigDynamicBaseRatePlansLOV
", - "operationId": "getConfigDynamicBaseRatePlansLOV", + "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", "parameters": [ { - "name": "currentRateCode", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'currentRateCode' which is required to fetch ConfigDynamicBaseRatePlans LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellDefaultTrxCode 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": "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": "UpsellDefaultTrxCodeLOV 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}/upsellFromRoomClassEdit": { + "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", + "parameters": [ { "name": "hotelId", "in": "path", @@ -49407,7 +50355,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 UpsellFromRoomClassEdit LOV" }, { "name": "includeInactiveFlag", @@ -49481,7 +50429,7 @@ } }, "204": { - "description": "ConfigDynamicBaseRatePlansLOV not found." + "description": "UpsellFromRoomClassEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49531,11 +50479,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionAdjustmentReasonCodes": { + "/listOfValues/hotels/{hotelId}/upsellFromRoomTypeEdit": { "get": { - "summary": "Fetch List Of Values for Transaction Adjustment Reason Codes", - "description": "OperationId:getTransactionAdjustmentReasonCodesLOV
", - "operationId": "getTransactionAdjustmentReasonCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -49544,7 +50492,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 UpsellFromRoomTypeEdit LOV" }, { "name": "includeInactiveFlag", @@ -49618,7 +50566,7 @@ } }, "204": { - "description": "TransactionAdjustmentReasonCodesLOV not found." + "description": "UpsellFromRoomTypeEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49668,11 +50616,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionCodes": { + "/listOfValues/hotels/{hotelId}/upsellHierarchyLevels": { "get": { - "summary": "Fetch List Of Values for Transaction Codes", - "description": "OperationId:getTransactionCodesLOV
", - "operationId": "getTransactionCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -49681,7 +50629,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 UpsellHierarchyLevels LOV" }, { "name": "includeInactiveFlag", @@ -49755,7 +50703,7 @@ } }, "204": { - "description": "TransactionCodesLOV not found." + "description": "UpsellHierarchyLevelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49805,11 +50753,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionCodesConsumption": { + "/listOfValues/hotels/{hotelId}/upsellRateCategoriesEdit": { "get": { - "summary": "Fetch List Of Values for Transaction Codes Consumption", - "description": "OperationId:getTransactionCodesConsumptionLOV
", - "operationId": "getTransactionCodesConsumptionLOV", + "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", "parameters": [ { "name": "hotelId", @@ -49818,7 +50766,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 UpsellRateCategoriesEdit LOV" }, { "name": "includeInactiveFlag", @@ -49892,7 +50840,7 @@ } }, "204": { - "description": "TransactionCodesConsumptionLOV not found." + "description": "UpsellRateCategoriesEditLOV not found." }, "400": { "$ref": "#/responses/400" @@ -49942,11 +50890,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionCodesPayment": { + "/listOfValues/hotels/{hotelId}/upsellRateCodes": { "get": { - "summary": "Fetch List Of Values for Transaction Codes Payment", - "description": "OperationId:getTransactionCodesPaymentLOV
", - "operationId": "getTransactionCodesPaymentLOV", + "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", "parameters": [ { "name": "hotelId", @@ -49955,7 +50903,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 UpsellRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -50029,7 +50977,7 @@ } }, "204": { - "description": "TransactionCodesPaymentLOV not found." + "description": "UpsellRateCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50079,11 +51027,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionDeleteReasonCodes": { + "/listOfValues/hotels/{hotelId}/upsellRoomClassView": { "get": { - "summary": "Fetch List Of Values for Transaction Delete Reason Codes", - "description": "OperationId:getTransactionDeleteReasonCodesLOV
", - "operationId": "getTransactionDeleteReasonCodesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -50092,7 +51040,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 UpsellRoomClassView LOV" }, { "name": "includeInactiveFlag", @@ -50166,7 +51114,7 @@ } }, "204": { - "description": "TransactionDeleteReasonCodesLOV not found." + "description": "UpsellRoomClassViewLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50216,11 +51164,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionDiversionRuleRooms": { + "/listOfValues/hotels/{hotelId}/upsellRoomTypeView": { "get": { - "summary": "Fetch List Of Values for Transaction Diversion Rule Rooms", - "description": "OperationId:getTransactionDiversionRuleRoomsLOV
", - "operationId": "getTransactionDiversionRuleRoomsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -50229,7 +51177,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 UpsellRoomTypeView LOV" }, { "name": "includeInactiveFlag", @@ -50303,7 +51251,7 @@ } }, "204": { - "description": "TransactionDiversionRuleRoomsLOV not found." + "description": "UpsellRoomTypeViewLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50353,11 +51301,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionGroups": { + "/listOfValues/hotels/{hotelId}/upsellRule": { "get": { - "summary": "Fetch List Of Values for Transaction Groups", - "description": "OperationId:getTransactionGroupsLOV
", - "operationId": "getTransactionGroupsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -50366,7 +51314,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 UpsellRule LOV" }, { "name": "includeInactiveFlag", @@ -50440,7 +51388,7 @@ } }, "204": { - "description": "TransactionGroupsLOV not found." + "description": "UpsellRuleLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50490,11 +51438,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionSubgroups": { + "/listOfValues/hotels/{hotelId}/upsellTrxCodes": { "get": { - "summary": "Fetch List Of Values for Transaction Subgroups", - "description": "OperationId:getTransactionSubgroupsLOV
", - "operationId": "getTransactionSubgroupsLOV", + "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", "parameters": [ { "name": "hotelId", @@ -50503,7 +51451,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 UpsellTrxCodes LOV" }, { "name": "includeInactiveFlag", @@ -50577,7 +51525,7 @@ } }, "204": { - "description": "TransactionSubgroupsLOV not found." + "description": "UpsellTrxCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50627,11 +51575,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transportTypes": { + "/listOfValues/hotels/{hotelId}/userLogActivityGroups": { "get": { - "summary": "Fetch List Of Values for Transport Types", - "description": "OperationId:getTransportTypesLOV
", - "operationId": "getTransportTypesLOV", + "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", "parameters": [ { "name": "hotelId", @@ -50640,7 +51588,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 UserLogActivityGroups LOV" }, { "name": "includeInactiveFlag", @@ -50714,7 +51662,7 @@ } }, "204": { - "description": "TransportTypesLOV not found." + "description": "UserLogActivityGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50764,11 +51712,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transportTypesHotel": { + "/listOfValues/hotels/{hotelId}/yearSetup": { "get": { - "summary": "Fetch List Of Values for Transport Types Hotel", - "description": "OperationId:getTransportTypesHotelLOV
", - "operationId": "getTransportTypesHotelLOV", + "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", "parameters": [ { "name": "hotelId", @@ -50777,7 +51725,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TransportTypesHotel LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch YearSetup LOV" }, { "name": "includeInactiveFlag", @@ -50851,7 +51799,7 @@ } }, "204": { - "description": "TransportTypesHotelLOV not found." + "description": "YearSetupLOV not found." }, "400": { "$ref": "#/responses/400" @@ -50901,11 +51849,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/travelAgentSource": { + "/listOfValues/hotels/{hotelId}/yieldMarkets": { "get": { - "summary": "Fetch List Of Values for Travel Agent Source", - "description": "OperationId:getTravelAgentSourceLOV
", - "operationId": "getTravelAgentSourceLOV", + "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", "parameters": [ { "name": "hotelId", @@ -50914,7 +51862,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 YieldMarkets LOV" }, { "name": "includeInactiveFlag", @@ -50988,7 +51936,7 @@ } }, "204": { - "description": "TravelAgentSourceLOV not found." + "description": "YieldMarketsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51038,20 +51986,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/travelAgentSourceResv": { + "/listOfValues/includeDayUse/{includeDayUse}/roomReservationStatus": { "get": { - "summary": "Fetch List Of Values for Travel Agent Source Resv", - "description": "OperationId:getTravelAgentSourceResvLOV
", - "operationId": "getTravelAgentSourceResvLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "includeDayUse", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TravelAgentSourceResv LOV" + "description": "Value of the parameter 'includeDayUse' which is required to fetch RoomReservationStatus LOV" }, { "name": "includeInactiveFlag", @@ -51125,7 +52073,7 @@ } }, "204": { - "description": "TravelAgentSourceResvLOV not found." + "description": "RoomReservationStatusLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51175,20 +52123,24 @@ ] } }, - "/listOfValues/hotels/{hotelId}/turnawayCodes": { + "/listOfValues/includeGlobals/{includeGlobals}/templatePreferences": { "get": { - "summary": "Fetch List Of Values for Turnaway Codes", - "description": "OperationId:getTurnawayCodesLOV
", - "operationId": "getTurnawayCodesLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "includeGlobals", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TurnawayCodes LOV" + "description": "Value of the parameter 'includeGlobals' which is required to fetch TemplatePreferences LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -51262,7 +52214,7 @@ } }, "204": { - "description": "TurnawayCodesLOV not found." + "description": "TemplatePreferencesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51312,20 +52264,24 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellDefaultTrxCode": { + "/listOfValues/includeInactive/{includeInactive}/templateMarketCodes": { "get": { - "summary": "Fetch List Of Values for Upsell Default Trx Code", - "description": "OperationId:getUpsellDefaultTrxCodeLOV
", - "operationId": "getUpsellDefaultTrxCodeLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "includeInactive", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellDefaultTrxCode LOV" + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateMarketCodes LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -51399,7 +52355,7 @@ } }, "204": { - "description": "UpsellDefaultTrxCodeLOV not found." + "description": "TemplateMarketCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51449,20 +52405,24 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellFromRoomClassEdit": { + "/listOfValues/includeInactive/{includeInactive}/templateMarketGroups": { "get": { - "summary": "Fetch List Of Values for Upsell From Room Class Edit", - "description": "OperationId:getUpsellFromRoomClassEditLOV
", - "operationId": "getUpsellFromRoomClassEditLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "includeInactive", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellFromRoomClassEdit LOV" + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateMarketGroups LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -51536,7 +52496,7 @@ } }, "204": { - "description": "UpsellFromRoomClassEditLOV not found." + "description": "TemplateMarketGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51586,20 +52546,24 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellFromRoomTypeEdit": { + "/listOfValues/includeInactive/{includeInactive}/templateRoomClasses": { "get": { - "summary": "Fetch List Of Values for Upsell From Room Type Edit", - "description": "OperationId:getUpsellFromRoomTypeEditLOV
", - "operationId": "getUpsellFromRoomTypeEditLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "includeInactive", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellFromRoomTypeEdit LOV" + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateRoomClasses LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -51673,7 +52637,7 @@ } }, "204": { - "description": "UpsellFromRoomTypeEditLOV not found." + "description": "TemplateRoomClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51723,20 +52687,24 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellHierarchyLevels": { + "/listOfValues/includeInactive/{includeInactive}/templateSourceCodes": { "get": { - "summary": "Fetch List Of Values for Upsell Hierarchy Levels", - "description": "OperationId:getUpsellHierarchyLevelsLOV
", - "operationId": "getUpsellHierarchyLevelsLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "includeInactive", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellHierarchyLevels LOV" + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateSourceCodes LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -51810,7 +52778,7 @@ } }, "204": { - "description": "UpsellHierarchyLevelsLOV not found." + "description": "TemplateSourceCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51860,20 +52828,24 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRateCategoriesEdit": { + "/listOfValues/includeInactive/{includeInactive}/templateSourceGroups": { "get": { - "summary": "Fetch List Of Values for Upsell Rate Categories Edit", - "description": "OperationId:getUpsellRateCategoriesEditLOV
", - "operationId": "getUpsellRateCategoriesEditLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "includeInactive", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRateCategoriesEdit LOV" + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateSourceGroups LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -51947,7 +52919,7 @@ } }, "204": { - "description": "UpsellRateCategoriesEditLOV not found." + "description": "TemplateSourceGroupsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -51997,20 +52969,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRateCodes": { + "/listOfValues/interfaceId/{interfaceId}/allRevenueTypes": { "get": { - "summary": "Fetch List Of Values for Upsell Rate Codes", - "description": "OperationId:getUpsellRateCodesLOV
", - "operationId": "getUpsellRateCodesLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "interfaceId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRateCodes LOV" + "description": "Value of the parameter 'interfaceId' which is required to fetch AllRevenueTypes LOV" }, { "name": "includeInactiveFlag", @@ -52084,7 +53056,7 @@ } }, "204": { - "description": "UpsellRateCodesLOV not found." + "description": "AllRevenueTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52134,20 +53106,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRoomClassView": { + "/listOfValues/interfaceId/{interfaceId}/oxiResorts": { "get": { - "summary": "Fetch List Of Values for Upsell Room Class View", - "description": "OperationId:getUpsellRoomClassViewLOV
", - "operationId": "getUpsellRoomClassViewLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "interfaceId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRoomClassView LOV" + "description": "Value of the parameter 'interfaceId' which is required to fetch OXIResorts LOV" }, { "name": "includeInactiveFlag", @@ -52221,7 +53193,7 @@ } }, "204": { - "description": "UpsellRoomClassViewLOV not found." + "description": "OXIResortsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52271,20 +53243,29 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRoomTypeView": { + "/listOfValues/interfaceType/{interfaceType}/databaseId/{databaseId}/externalDatabaseAvailableResorts": { "get": { - "summary": "Fetch List Of Values for Upsell Room Type View", - "description": "OperationId:getUpsellRoomTypeViewLOV
", - "operationId": "getUpsellRoomTypeViewLOV", + "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", "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 UpsellRoomTypeView 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", @@ -52358,7 +53339,7 @@ } }, "204": { - "description": "UpsellRoomTypeViewLOV not found." + "description": "ExternalDatabaseAvailableResortsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52408,20 +53389,47 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRule": { + "/listOfValues/levelCode/{levelCode}/levelType/{levelType}/settingName/{settingName}/channelCode/{channelCode}/channelParameters": { "get": { - "summary": "Fetch List Of Values for Upsell Rule", - "description": "OperationId:getUpsellRuleLOV
", - "operationId": "getUpsellRuleLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "channelCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRule 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", @@ -52495,7 +53503,7 @@ } }, "204": { - "description": "UpsellRuleLOV not found." + "description": "ChannelParametersLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52545,157 +53553,29 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellTrxCodes": { + "/listOfValues/levelCode/{levelCode}/settingName/{settingName}/applicationSettings": { "get": { - "summary": "Fetch List Of Values for Upsell Trx Codes", - "description": "OperationId:getUpsellTrxCodesLOV
", - "operationId": "getUpsellTrxCodesLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "settingName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellTrxCodes 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": "UpsellTrxCodesLOV 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 'settingName' which is required to fetch ApplicationSettings LOV" }, - "503": { - "$ref": "#/responses/503" - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/userLogActivityGroups": { - "get": { - "summary": "Fetch List Of Values for User Log Activity Groups", - "description": "OperationId:getUserLogActivityGroupsLOV
", - "operationId": "getUserLogActivityGroupsLOV", - "parameters": [ { - "name": "hotelId", + "name": "levelCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UserLogActivityGroups LOV" + "description": "Value of the parameter 'levelCode' which is required to fetch ApplicationSettings LOV" }, { "name": "includeInactiveFlag", @@ -52769,7 +53649,7 @@ } }, "204": { - "description": "UserLogActivityGroupsLOV not found." + "description": "ApplicationSettingsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52819,20 +53699,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/yearSetup": { + "/listOfValues/levelCode/{levelCode}/taskSheetDept": { "get": { - "summary": "Fetch List Of Values for Year Setup", - "description": "OperationId:getYearSetupLOV
", - "operationId": "getYearSetupLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "levelCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch YearSetup LOV" + "description": "Value of the parameter 'levelCode' which is required to fetch TaskSheetDept LOV" }, { "name": "includeInactiveFlag", @@ -52906,7 +53786,7 @@ } }, "204": { - "description": "YearSetupLOV not found." + "description": "TaskSheetDeptLOV not found." }, "400": { "$ref": "#/responses/400" @@ -52956,20 +53836,29 @@ ] } }, - "/listOfValues/hotels/{hotelId}/yieldMarkets": { + "/listOfValues/locationType/{locationType}/location/{location}/distributionTemplates": { "get": { - "summary": "Fetch List Of Values for Yield Markets", - "description": "OperationId:getYieldMarketsLOV
", - "operationId": "getYieldMarketsLOV", + "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", "parameters": [ { - "name": "hotelId", + "name": "location", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch YieldMarkets 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", @@ -53043,7 +53932,7 @@ } }, "204": { - "description": "YieldMarketsLOV not found." + "description": "DistributionTemplatesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53093,20 +53982,20 @@ ] } }, - "/listOfValues/includeDayUse/{includeDayUse}/roomReservationStatus": { + "/listOfValues/membershipId/{membershipId}/membershipStatementBatchList": { "get": { - "summary": "Fetch List Of Values for Room Reservation Status", - "description": "OperationId:getRoomReservationStatusLOV
", - "operationId": "getRoomReservationStatusLOV", + "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", "parameters": [ { - "name": "includeDayUse", + "name": "membershipId", "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 'membershipId' which is required to fetch MembershipStatementBatchList LOV" }, { "name": "includeInactiveFlag", @@ -53180,7 +54069,7 @@ } }, "204": { - "description": "RoomReservationStatusLOV not found." + "description": "MembershipStatementBatchListLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53230,24 +54119,20 @@ ] } }, - "/listOfValues/includeGlobals/{includeGlobals}/templatePreferences": { + "/listOfValues/membershipId/{membershipId}/membershipTotalPointsAvailable": { "get": { - "summary": "Fetch List Of Values for Template Preferences", - "description": "OperationId:getTemplatePreferencesLOV
", - "operationId": "getTemplatePreferencesLOV", + "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", "parameters": [ { - "name": "includeGlobals", + "name": "membershipId", "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 'membershipId' which is required to fetch MembershipTotalPointsAvailable LOV" }, { "name": "includeInactiveFlag", @@ -53321,7 +54206,7 @@ } }, "204": { - "description": "TemplatePreferencesLOV not found." + "description": "MembershipTotalPointsAvailableLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53371,24 +54256,20 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateMarketCodes": { + "/listOfValues/membershipLevel/{membershipLevel}/membershipCardFeeAmount": { "get": { - "summary": "Fetch List Of Values for Template Market Codes", - "description": "OperationId:getTemplateMarketCodesLOV
", - "operationId": "getTemplateMarketCodesLOV", + "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", "parameters": [ { - "name": "includeInactive", + "name": "membershipLevel", "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 'membershipLevel' which is required to fetch MembershipCardFeeAmount LOV" }, { "name": "includeInactiveFlag", @@ -53462,7 +54343,7 @@ } }, "204": { - "description": "TemplateMarketCodesLOV not found." + "description": "MembershipCardFeeAmountLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53512,24 +54393,29 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateMarketGroups": { + "/listOfValues/membershipLevelRank/{membershipLevelRank}/membershipType/{membershipType}/membershipMaxDowngradeLevel": { "get": { - "summary": "Fetch List Of Values for Template Market Groups", - "description": "OperationId:getTemplateMarketGroupsLOV
", - "operationId": "getTemplateMarketGroupsLOV", + "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", "parameters": [ { - "name": "includeInactive", + "name": "membershipType", "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 'membershipType' which is required to fetch MembershipMaxDowngradeLevel LOV" + }, + { + "name": "membershipLevelRank", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'membershipLevelRank' which is required to fetch MembershipMaxDowngradeLevel LOV" }, { "name": "includeInactiveFlag", @@ -53603,7 +54489,7 @@ } }, "204": { - "description": "TemplateMarketGroupsLOV not found." + "description": "MembershipMaxDowngradeLevelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53653,24 +54539,20 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateRoomClasses": { + "/listOfValues/membershipType/{membershipType}/membershipBenefitProgram": { "get": { - "summary": "Fetch List Of Values for Template Room Classes", - "description": "OperationId:getTemplateRoomClassesLOV
", - "operationId": "getTemplateRoomClassesLOV", + "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", "parameters": [ { - "name": "includeInactive", + "name": "membershipType", "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 'membershipType' which is required to fetch MembershipBenefitProgram LOV" }, { "name": "includeInactiveFlag", @@ -53744,7 +54626,7 @@ } }, "204": { - "description": "TemplateRoomClassesLOV not found." + "description": "MembershipBenefitProgramLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53794,24 +54676,20 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateSourceCodes": { + "/listOfValues/membershipType/{membershipType}/membershipBenefits": { "get": { - "summary": "Fetch List Of Values for Template Source Codes", - "description": "OperationId:getTemplateSourceCodesLOV
", - "operationId": "getTemplateSourceCodesLOV", + "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", "parameters": [ { - "name": "includeInactive", + "name": "membershipType", "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 'membershipType' which is required to fetch MembershipBenefits LOV" }, { "name": "includeInactiveFlag", @@ -53885,7 +54763,7 @@ } }, "204": { - "description": "TemplateSourceCodesLOV not found." + "description": "MembershipBenefitsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -53935,24 +54813,20 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateSourceGroups": { + "/listOfValues/membershipType/{membershipType}/membershipPointsRuleCodes": { "get": { - "summary": "Fetch List Of Values for Template Source Groups", - "description": "OperationId:getTemplateSourceGroupsLOV
", - "operationId": "getTemplateSourceGroupsLOV", + "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", "parameters": [ { - "name": "includeInactive", + "name": "membershipType", "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 'membershipType' which is required to fetch MembershipPointsRuleCodes LOV" }, { "name": "includeInactiveFlag", @@ -54026,7 +54900,7 @@ } }, "204": { - "description": "TemplateSourceGroupsLOV not found." + "description": "MembershipPointsRuleCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54076,20 +54950,20 @@ ] } }, - "/listOfValues/interfaceId/{interfaceId}/allRevenueTypes": { + "/listOfValues/membershipType/{membershipType}/upsellMembershipLevelsOnly": { "get": { - "summary": "Fetch List Of Values for All Revenue Types", - "description": "OperationId:getAllRevenueTypesLOV
", - "operationId": "getAllRevenueTypesLOV", + "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", "parameters": [ { - "name": "interfaceId", + "name": "membershipType", "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 'membershipType' which is required to fetch UpsellMembershipLevelsOnly LOV" }, { "name": "includeInactiveFlag", @@ -54163,7 +55037,7 @@ } }, "204": { - "description": "AllRevenueTypesLOV not found." + "description": "UpsellMembershipLevelsOnlyLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54213,20 +55087,20 @@ ] } }, - "/listOfValues/interfaceId/{interfaceId}/oxiResorts": { + "/listOfValues/menuClassId/{menuClassId}/menu": { "get": { - "summary": "Fetch List Of Values for OXIResorts", - "description": "OperationId:getOXIResortsLOV
", - "operationId": "getOXIResortsLOV", + "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", "parameters": [ { - "name": "interfaceId", + "name": "menuClassId", "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 'menuClassId' which is required to fetch Menu LOV" }, { "name": "includeInactiveFlag", @@ -54300,7 +55174,7 @@ } }, "204": { - "description": "OXIResortsLOV not found." + "description": "MenuLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54350,29 +55224,20 @@ ] } }, - "/listOfValues/interfaceType/{interfaceType}/databaseId/{databaseId}/externalDatabaseAvailableResorts": { + "/listOfValues/mode/{mode}/folioGroupingTransactionCodes": { "get": { - "summary": "Fetch List Of Values for External Database Available Resorts", - "description": "OperationId:getExternalDatabaseAvailableResortsLOV
", - "operationId": "getExternalDatabaseAvailableResortsLOV", + "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", "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": "mode", "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 'mode' which is required to fetch FolioGroupingTransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -54446,7 +55311,7 @@ } }, "204": { - "description": "ExternalDatabaseAvailableResortsLOV not found." + "description": "FolioGroupingTransactionCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54496,47 +55361,20 @@ ] } }, - "/listOfValues/levelCode/{levelCode}/levelType/{levelType}/settingName/{settingName}/channelCode/{channelCode}/channelParameters": { + "/listOfValues/module/{module}/actionTypes": { "get": { - "summary": "Fetch List Of Values for Channel Parameters", - "description": "OperationId:getChannelParametersLOV
", - "operationId": "getChannelParametersLOV", + "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", "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": "module", "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 'module' which is required to fetch ActionTypes LOV" }, { "name": "includeInactiveFlag", @@ -54610,7 +55448,7 @@ } }, "204": { - "description": "ChannelParametersLOV not found." + "description": "ActionTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54660,29 +55498,29 @@ ] } }, - "/listOfValues/levelCode/{levelCode}/settingName/{settingName}/applicationSettings": { + "/listOfValues/moduleId/{moduleId}/parameterName/{parameter}/reportsGeneric": { "get": { - "summary": "Fetch List Of Values for Application Settings", - "description": "OperationId:getApplicationSettingsLOV
", - "operationId": "getApplicationSettingsLOV", + "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", "parameters": [ { - "name": "settingName", + "name": "parameter", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'settingName' which is required to fetch ApplicationSettings LOV" + "description": "Value of the parameter 'parameter' which is required to fetch ReportsGeneric LOV" }, { - "name": "levelCode", + "name": "moduleId", "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 'moduleId' which is required to fetch ReportsGeneric LOV" }, { "name": "includeInactiveFlag", @@ -54756,7 +55594,7 @@ } }, "204": { - "description": "ApplicationSettingsLOV not found." + "description": "ReportsGenericLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54806,20 +55644,20 @@ ] } }, - "/listOfValues/levelCode/{levelCode}/taskSheetDept": { + "/listOfValues/moduleName/{moduleName}/configReports": { "get": { - "summary": "Fetch List Of Values for Task Sheet Dept", - "description": "OperationId:getTaskSheetDeptLOV
", - "operationId": "getTaskSheetDeptLOV", + "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", "parameters": [ { - "name": "levelCode", + "name": "moduleName", "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 'moduleName' which is required to fetch ConfigReports LOV" }, { "name": "includeInactiveFlag", @@ -54893,7 +55731,7 @@ } }, "204": { - "description": "TaskSheetDeptLOV not found." + "description": "ConfigReportsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -54943,29 +55781,20 @@ ] } }, - "/listOfValues/locationType/{locationType}/location/{location}/distributionTemplates": { + "/listOfValues/moduleName/{moduleName}/udfMappings": { "get": { - "summary": "Fetch List Of Values for Distribution Templates", - "description": "OperationId:getDistributionTemplatesLOV
", - "operationId": "getDistributionTemplatesLOV", + "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", "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": "moduleName", "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 'moduleName' which is required to fetch UDFMappings LOV" }, { "name": "includeInactiveFlag", @@ -55039,7 +55868,7 @@ } }, "204": { - "description": "DistributionTemplatesLOV not found." + "description": "UDFMappingsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55089,20 +55918,20 @@ ] } }, - "/listOfValues/membershipId/{membershipId}/membershipStatementBatchList": { + "/listOfValues/nameType/{nameType}/profileEnrollmentMatchCriteria": { "get": { - "summary": "Fetch List Of Values for Membership Statement Batch List", - "description": "OperationId:getMembershipStatementBatchListLOV
", - "operationId": "getMembershipStatementBatchListLOV", + "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", "parameters": [ { - "name": "membershipId", + "name": "nameType", "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 'nameType' which is required to fetch ProfileEnrollmentMatchCriteria LOV" }, { "name": "includeInactiveFlag", @@ -55176,7 +56005,7 @@ } }, "204": { - "description": "MembershipStatementBatchListLOV not found." + "description": "ProfileEnrollmentMatchCriteriaLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55226,20 +56055,20 @@ ] } }, - "/listOfValues/membershipId/{membershipId}/membershipTotalPointsAvailable": { + "/listOfValues/nameType/{nameType}/profileEnrollmentRuleDoNotMergeCriteria": { "get": { - "summary": "Fetch List Of Values for Membership Total Points Available", - "description": "OperationId:getMembershipTotalPointsAvailableLOV
", - "operationId": "getMembershipTotalPointsAvailableLOV", + "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", "parameters": [ { - "name": "membershipId", + "name": "nameType", "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 'nameType' which is required to fetch ProfileEnrollmentRuleDoNotMergeCriteria LOV" }, { "name": "includeInactiveFlag", @@ -55313,7 +56142,7 @@ } }, "204": { - "description": "MembershipTotalPointsAvailableLOV not found." + "description": "ProfileEnrollmentRuleDoNotMergeCriteriaLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55363,20 +56192,20 @@ ] } }, - "/listOfValues/membershipLevel/{membershipLevel}/membershipCardFeeAmount": { + "/listOfValues/nameType/{nameType}/profileEnrollmentRuleFilterCriteria": { "get": { - "summary": "Fetch List Of Values for Membership Card Fee Amount", - "description": "OperationId:getMembershipCardFeeAmountLOV
", - "operationId": "getMembershipCardFeeAmountLOV", + "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", "parameters": [ { - "name": "membershipLevel", + "name": "nameType", "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 'nameType' which is required to fetch ProfileEnrollmentRuleFilterCriteria LOV" }, { "name": "includeInactiveFlag", @@ -55450,7 +56279,7 @@ } }, "204": { - "description": "MembershipCardFeeAmountLOV not found." + "description": "ProfileEnrollmentRuleFilterCriteriaLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55500,29 +56329,33 @@ ] } }, - "/listOfValues/membershipLevelRank/{membershipLevelRank}/membershipType/{membershipType}/membershipMaxDowngradeLevel": { + "/listOfValues/newEvent/{newEvent}/waitList/{waitList}/cateringEventStatus": { "get": { - "summary": "Fetch List Of Values for Membership Max Downgrade Level", - "description": "OperationId:getMembershipMaxDowngradeLevelLOV
", - "operationId": "getMembershipMaxDowngradeLevelLOV", + "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", "parameters": [ { - "name": "membershipType", + "name": "waitList", "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 'waitList' which is required to fetch CateringEventStatus LOV" }, { - "name": "membershipLevelRank", + "name": "newEvent", "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 'newEvent' which is required to fetch CateringEventStatus LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -55596,7 +56429,7 @@ } }, "204": { - "description": "MembershipMaxDowngradeLevelLOV not found." + "description": "CateringEventStatusLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55646,20 +56479,20 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/membershipBenefitProgram": { + "/listOfValues/number/{number}/autoNumberGenerator": { "get": { - "summary": "Fetch List Of Values for Membership Benefit Program", - "description": "OperationId:getMembershipBenefitProgramLOV
", - "operationId": "getMembershipBenefitProgramLOV", + "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", "parameters": [ { - "name": "membershipType", + "name": "number", "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 'number' which is required to fetch AutoNumberGenerator LOV" }, { "name": "includeInactiveFlag", @@ -55733,7 +56566,7 @@ } }, "204": { - "description": "MembershipBenefitProgramLOV not found." + "description": "AutoNumberGeneratorLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55783,20 +56616,20 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/membershipBenefits": { + "/listOfValues/operaParam/{operaParam}/profileNameValidationsType": { "get": { - "summary": "Fetch List Of Values for Membership Benefits", - "description": "OperationId:getMembershipBenefitsLOV
", - "operationId": "getMembershipBenefitsLOV", + "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", "parameters": [ { - "name": "membershipType", + "name": "operaParam", "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 'operaParam' which is required to fetch ProfileNameValidationsType LOV" }, { "name": "includeInactiveFlag", @@ -55870,7 +56703,7 @@ } }, "204": { - "description": "MembershipBenefitsLOV not found." + "description": "ProfileNameValidationsTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -55920,20 +56753,29 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/membershipPointsRuleCodes": { + "/listOfValues/outboundType/{outboundType}/protocol/{protocol}/outboundServiceNames": { "get": { - "summary": "Fetch List Of Values for Membership Points Rule Codes", - "description": "OperationId:getMembershipPointsRuleCodesLOV
", - "operationId": "getMembershipPointsRuleCodesLOV", + "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", "parameters": [ { - "name": "membershipType", + "name": "protocol", "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 '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", @@ -56007,7 +56849,7 @@ } }, "204": { - "description": "MembershipPointsRuleCodesLOV not found." + "description": "ServiceNameLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56057,20 +56899,29 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/upsellMembershipLevelsOnly": { + "/listOfValues/parameterName/{parameter}/chainCode/{chainCode}/parameterActiveUnderChain": { "get": { - "summary": "Fetch List Of Values for Upsell Membership Levels Only", - "description": "OperationId:getUpsellMembershipLevelsOnlyLOV
", - "operationId": "getUpsellMembershipLevelsOnlyLOV", + "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", "parameters": [ { - "name": "membershipType", + "name": "chainCode", "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 '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", @@ -56144,7 +56995,7 @@ } }, "204": { - "description": "UpsellMembershipLevelsOnlyLOV not found." + "description": "ParameterActiveUnderChainLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56194,20 +57045,20 @@ ] } }, - "/listOfValues/menuClassId/{menuClassId}/menu": { + "/listOfValues/period/{period}/repCalendarYears": { "get": { - "summary": "Fetch List Of Values for Menu", - "description": "OperationId:getMenuLOV
", - "operationId": "getMenuLOV", + "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", "parameters": [ { - "name": "menuClassId", + "name": "period", "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 'period' which is required to fetch RepCalendarYears LOV" }, { "name": "includeInactiveFlag", @@ -56281,7 +57132,7 @@ } }, "204": { - "description": "MenuLOV not found." + "description": "RepCalendarYearsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56331,20 +57182,20 @@ ] } }, - "/listOfValues/mode/{mode}/folioGroupingTransactionCodes": { + "/listOfValues/pkgId/{pkgId}/cateringPackageRevenueEventType": { "get": { - "summary": "Fetch List Of Values for Folio Grouping Transaction Codes", - "description": "OperationId:getFolioGroupingTransactionCodesLOV
", - "operationId": "getFolioGroupingTransactionCodesLOV", + "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", "parameters": [ { - "name": "mode", + "name": "pkgId", "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 'pkgId' which is required to fetch CateringPackageRevenueEventType LOV" }, { "name": "includeInactiveFlag", @@ -56418,7 +57269,7 @@ } }, "204": { - "description": "FolioGroupingTransactionCodesLOV not found." + "description": "CateringPackageRevenueEventTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56468,20 +57319,20 @@ ] } }, - "/listOfValues/module/{module}/actionTypes": { + "/listOfValues/pkgLinkId/{pkgLinkId}/cateringPackageRevenueConfigEventType": { "get": { - "summary": "Fetch List Of Values for Action Types", - "description": "OperationId:getActionTypesLOV
", - "operationId": "getActionTypesLOV", + "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", "parameters": [ { - "name": "module", + "name": "pkgLinkId", "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 'pkgLinkId' which is required to fetch CateringPackageRevenueConfigEventType LOV" }, { "name": "includeInactiveFlag", @@ -56555,7 +57406,7 @@ } }, "204": { - "description": "ActionTypesLOV not found." + "description": "CateringPackageRevenueConfigEventTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56605,29 +57456,20 @@ ] } }, - "/listOfValues/moduleId/{moduleId}/parameterName/{parameter}/reportsGeneric": { + "/listOfValues/policyType/{policyType}/depositCancelRulesMultiHotel": { "get": { - "summary": "Fetch List Of Values for Reports Generic", - "description": "OperationId:getReportsGenericLOV
", - "operationId": "getReportsGenericLOV", + "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", "parameters": [ { - "name": "parameter", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'parameter' which is required to fetch ReportsGeneric LOV" - }, - { - "name": "moduleId", + "name": "policyType", "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 'policyType' which is required to fetch DepositCancelRulesMultiHotel LOV" }, { "name": "includeInactiveFlag", @@ -56701,7 +57543,7 @@ } }, "204": { - "description": "ReportsGenericLOV not found." + "description": "DepositCancelRulesMultiHotelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56751,20 +57593,20 @@ ] } }, - "/listOfValues/moduleName/{moduleName}/configReports": { + "/listOfValues/policyType/{policyType}/templatePolicyCodes": { "get": { - "summary": "Fetch List Of Values for Config Reports", - "description": "OperationId:getConfigReportsLOV
", - "operationId": "getConfigReportsLOV", + "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", "parameters": [ { - "name": "moduleName", + "name": "policyType", "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 'policyType' which is required to fetch TemplatePolicyCodes LOV" }, { "name": "includeInactiveFlag", @@ -56838,7 +57680,7 @@ } }, "204": { - "description": "ConfigReportsLOV not found." + "description": "TemplatePolicyCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -56888,20 +57730,20 @@ ] } }, - "/listOfValues/moduleName/{moduleName}/udfMappings": { + "/listOfValues/preferenceGroup/{preferenceGroup}/preferencesMultiHotels": { "get": { - "summary": "Fetch List Of Values for UDFMappings", - "description": "OperationId:getUDFMappingsLOV
", - "operationId": "getUDFMappingsLOV", + "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", "parameters": [ { - "name": "moduleName", + "name": "preferenceGroup", "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 'preferenceGroup' which is required to fetch PreferencesMultiHotels LOV" }, { "name": "includeInactiveFlag", @@ -56975,7 +57817,7 @@ } }, "204": { - "description": "UDFMappingsLOV not found." + "description": "PreferencesMultiHotelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57025,20 +57867,20 @@ ] } }, - "/listOfValues/nameType/{nameType}/profileEnrollmentMatchCriteria": { + "/listOfValues/profiles/{profileId}/claimMembershipDetails": { "get": { - "summary": "Fetch List Of Values for Profile Enrollment Match Criteria", - "description": "OperationId:getProfileEnrollmentMatchCriteriaLOV
", - "operationId": "getProfileEnrollmentMatchCriteriaLOV", + "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", "parameters": [ { - "name": "nameType", + "name": "profileId", "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 'profileId' which is required to fetch ClaimMembershipDetails LOV" }, { "name": "includeInactiveFlag", @@ -57112,7 +57954,7 @@ } }, "204": { - "description": "ProfileEnrollmentMatchCriteriaLOV not found." + "description": "ClaimMembershipDetailsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57162,20 +58004,20 @@ ] } }, - "/listOfValues/nameType/{nameType}/profileEnrollmentRuleDoNotMergeCriteria": { + "/listOfValues/profiles/{profileId}/hotelsForARProfile": { "get": { - "summary": "Fetch List Of Values for Profile Enrollment Rule Do Not Merge Criteria", - "description": "OperationId:getProfileEnrollmentRuleDoNotMergeCriteriaLOV
", - "operationId": "getProfileEnrollmentRuleDoNotMergeCriteriaLOV", + "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", "parameters": [ { - "name": "nameType", + "name": "profileId", "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 'profileId' which is required to fetch HotelsForARProfile LOV" }, { "name": "includeInactiveFlag", @@ -57249,7 +58091,7 @@ } }, "204": { - "description": "ProfileEnrollmentRuleDoNotMergeCriteriaLOV not found." + "description": "HotelsForARProfileLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57299,20 +58141,20 @@ ] } }, - "/listOfValues/nameType/{nameType}/profileEnrollmentRuleFilterCriteria": { + "/listOfValues/profiles/{profileId}/membershipTransferPoints": { "get": { - "summary": "Fetch List Of Values for Profile Enrollment Rule Filter Criteria", - "description": "OperationId:getProfileEnrollmentRuleFilterCriteriaLOV
", - "operationId": "getProfileEnrollmentRuleFilterCriteriaLOV", + "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", "parameters": [ { - "name": "nameType", + "name": "profileId", "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 'profileId' which is required to fetch MembershipTransferPoints LOV" }, { "name": "includeInactiveFlag", @@ -57386,7 +58228,7 @@ } }, "204": { - "description": "ProfileEnrollmentRuleFilterCriteriaLOV not found." + "description": "MembershipTransferPointsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57436,33 +58278,20 @@ ] } }, - "/listOfValues/newEvent/{newEvent}/waitList/{waitList}/cateringEventStatus": { + "/listOfValues/profiles/{profileId}/negotiatedRateHotels": { "get": { - "summary": "Fetch List Of Values for Catering Event Status", - "description": "OperationId:getCateringEventStatusLOV
", - "operationId": "getCateringEventStatusLOV", + "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", "parameters": [ { - "name": "waitList", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'waitList' which is required to fetch CateringEventStatus LOV" - }, - { - "name": "newEvent", + "name": "profileId", "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 'profileId' which is required to fetch NegotiatedRateHotels LOV" }, { "name": "includeInactiveFlag", @@ -57536,7 +58365,7 @@ } }, "204": { - "description": "CateringEventStatusLOV not found." + "description": "NegotiatedRateHotelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57586,20 +58415,20 @@ ] } }, - "/listOfValues/number/{number}/autoNumberGenerator": { + "/listOfValues/profiles/{profileId}/profileCommunications": { "get": { - "summary": "Fetch List Of Values for Auto Number Generator", - "description": "OperationId:getAutoNumberGeneratorLOV
", - "operationId": "getAutoNumberGeneratorLOV", + "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", "parameters": [ { - "name": "number", + "name": "profileId", "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 'profileId' which is required to fetch ProfileCommunications LOV" }, { "name": "includeInactiveFlag", @@ -57673,7 +58502,7 @@ } }, "204": { - "description": "AutoNumberGeneratorLOV not found." + "description": "ProfileCommunicationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57723,20 +58552,29 @@ ] } }, - "/listOfValues/operaParam/{operaParam}/profileNameValidationsType": { + "/listOfValues/profiles/{profileId}/taxTypeCheck/{taxTypeCheck}/profileHotels": { "get": { - "summary": "Fetch List Of Values for Profile Name Validations Type", - "description": "OperationId:getProfileNameValidationsTypeLOV
", - "operationId": "getProfileNameValidationsTypeLOV", + "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", "parameters": [ { - "name": "operaParam", + "name": "taxTypeCheck", "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 'taxTypeCheck' which is required to fetch ProfileHotels LOV" + }, + { + "name": "profileId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'profileId' which is required to fetch ProfileHotels LOV" }, { "name": "includeInactiveFlag", @@ -57810,7 +58648,7 @@ } }, "204": { - "description": "ProfileNameValidationsTypeLOV not found." + "description": "ProfileHotelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -57860,29 +58698,20 @@ ] } }, - "/listOfValues/outboundType/{outboundType}/protocol/{protocol}/outboundServiceNames": { + "/listOfValues/property/{property}/roomHierarchyClassesCopy": { "get": { - "summary": "Fetch List Of Values for Service Name", - "description": "OperationId:getServiceNameLOV
", - "operationId": "getServiceNameLOV", + "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", "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": "property", "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 'property' which is required to fetch RoomHierarchyClassesCopy LOV" }, { "name": "includeInactiveFlag", @@ -57956,7 +58785,7 @@ } }, "204": { - "description": "ServiceNameLOV not found." + "description": "RoomHierarchyClassesCopyLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58006,29 +58835,20 @@ ] } }, - "/listOfValues/parameterName/{parameter}/chainCode/{chainCode}/parameterActiveUnderChain": { + "/listOfValues/property/{property}/roomHierarchyRoomClasses": { "get": { - "summary": "Fetch List Of Values for Parameter Active Under Chain", - "description": "OperationId:getParameterActiveUnderChainLOV
", - "operationId": "getParameterActiveUnderChainLOV", + "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", "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": "property", "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 'property' which is required to fetch RoomHierarchyRoomClasses LOV" }, { "name": "includeInactiveFlag", @@ -58102,7 +58922,7 @@ } }, "204": { - "description": "ParameterActiveUnderChainLOV not found." + "description": "RoomHierarchyRoomClassesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58152,20 +58972,20 @@ ] } }, - "/listOfValues/period/{period}/repCalendarYears": { + "/listOfValues/property/{property}/roomHierarchyRoomTypes": { "get": { - "summary": "Fetch List Of Values for Rep Calendar Years", - "description": "OperationId:getRepCalendarYearsLOV
", - "operationId": "getRepCalendarYearsLOV", + "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", "parameters": [ { - "name": "period", + "name": "property", "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 'property' which is required to fetch RoomHierarchyRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -58239,7 +59059,7 @@ } }, "204": { - "description": "RepCalendarYearsLOV not found." + "description": "RoomHierarchyRoomTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58289,20 +59109,20 @@ ] } }, - "/listOfValues/pkgId/{pkgId}/cateringPackageRevenueEventType": { + "/listOfValues/property/{property}/roomHierarchyTypesCopy": { "get": { - "summary": "Fetch List Of Values for Catering Package Revenue Event Type", - "description": "OperationId:getCateringPackageRevenueEventTypeLOV
", - "operationId": "getCateringPackageRevenueEventTypeLOV", + "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", "parameters": [ { - "name": "pkgId", + "name": "property", "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 'property' which is required to fetch RoomHierarchyTypesCopy LOV" }, { "name": "includeInactiveFlag", @@ -58376,7 +59196,7 @@ } }, "204": { - "description": "CateringPackageRevenueEventTypeLOV not found." + "description": "RoomHierarchyTypesCopyLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58426,20 +59246,20 @@ ] } }, - "/listOfValues/pkgLinkId/{pkgLinkId}/cateringPackageRevenueConfigEventType": { + "/listOfValues/propertyList/{propertyList}/repRatePlans": { "get": { - "summary": "Fetch List Of Values for Catering Package Revenue Config Event Type", - "description": "OperationId:getCateringPackageRevenueConfigEventTypeLOV
", - "operationId": "getCateringPackageRevenueConfigEventTypeLOV", + "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", "parameters": [ { - "name": "pkgLinkId", + "name": "propertyList", "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 'propertyList' which is required to fetch RepRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -58513,7 +59333,7 @@ } }, "204": { - "description": "CateringPackageRevenueConfigEventTypeLOV not found." + "description": "RepRatePlansLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58563,20 +59383,29 @@ ] } }, - "/listOfValues/policyType/{policyType}/depositCancelRulesMultiHotel": { + "/listOfValues/radioType/{radioType}/hotels/{hotelId}/cateringPackageCodes": { "get": { - "summary": "Fetch List Of Values for Deposit Cancel Rules Multi Hotel", - "description": "OperationId:getDepositCancelRulesMultiHotelLOV
", - "operationId": "getDepositCancelRulesMultiHotelLOV", + "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", "parameters": [ { - "name": "policyType", + "name": "hotelId", "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 '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", @@ -58650,7 +59479,7 @@ } }, "204": { - "description": "DepositCancelRulesMultiHotelLOV not found." + "description": "CateringPackageCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58700,20 +59529,29 @@ ] } }, - "/listOfValues/policyType/{policyType}/templatePolicyCodes": { + "/listOfValues/rateCode/{rateCode}/profiles/{profileId}/negotiatedRatesHotels": { "get": { - "summary": "Fetch List Of Values for Template Policy Codes", - "description": "OperationId:getTemplatePolicyCodesLOV
", - "operationId": "getTemplatePolicyCodesLOV", + "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", "parameters": [ { - "name": "policyType", + "name": "profileId", "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 '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", @@ -58787,7 +59625,7 @@ } }, "204": { - "description": "TemplatePolicyCodesLOV not found." + "description": "NegotiatedRatesHotelsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58837,20 +59675,29 @@ ] } }, - "/listOfValues/preferenceGroup/{preferenceGroup}/preferencesMultiHotels": { + "/listOfValues/roleLevel/{roleLevel}/levelCode/{levelCode}/rolesForLevel": { "get": { - "summary": "Fetch List Of Values for Preferences Multi Hotels", - "description": "OperationId:getPreferencesMultiHotelsLOV
", - "operationId": "getPreferencesMultiHotelsLOV", + "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", "parameters": [ { - "name": "preferenceGroup", + "name": "levelCode", "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 '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", @@ -58924,7 +59771,7 @@ } }, "204": { - "description": "PreferencesMultiHotelsLOV not found." + "description": "RolesForLevelLOV not found." }, "400": { "$ref": "#/responses/400" @@ -58974,20 +59821,38 @@ ] } }, - "/listOfValues/profiles/{profileId}/claimMembershipDetails": { + "/listOfValues/roles/{roles}/chainCode/{chainCode}/actionTask/{actionTask}/organizations": { "get": { - "summary": "Fetch List Of Values for Claim Membership Details", - "description": "OperationId:getClaimMembershipDetailsLOV
", - "operationId": "getClaimMembershipDetailsLOV", + "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", "parameters": [ { - "name": "profileId", + "name": "actionTask", "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 '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", @@ -59061,7 +59926,7 @@ } }, "204": { - "description": "ClaimMembershipDetailsLOV not found." + "description": "OrganizationsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59111,20 +59976,24 @@ ] } }, - "/listOfValues/profiles/{profileId}/hotelsForARProfile": { + "/listOfValues/salesFormat/{salesFormat}/addressFormatElements": { "get": { - "summary": "Fetch List Of Values for Hotels For ARProfile", - "description": "OperationId:getHotelsForARProfileLOV
", - "operationId": "getHotelsForARProfileLOV", + "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", "parameters": [ { - "name": "profileId", + "name": "salesFormat", "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 'salesFormat' which is required to fetch AddressFormatElements LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -59198,7 +60067,7 @@ } }, "204": { - "description": "HotelsForARProfileLOV not found." + "description": "AddressFormatElementsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59248,20 +60117,20 @@ ] } }, - "/listOfValues/profiles/{profileId}/membershipTransferPoints": { + "/listOfValues/shiftGroupId/{shiftGroupId}/shiftReportsNoParam": { "get": { - "summary": "Fetch List Of Values for Membership Transfer Points", - "description": "OperationId:getMembershipTransferPointsLOV
", - "operationId": "getMembershipTransferPointsLOV", + "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", "parameters": [ { - "name": "profileId", + "name": "shiftGroupId", "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 'shiftGroupId' which is required to fetch ShiftReportsNoParam LOV" }, { "name": "includeInactiveFlag", @@ -59335,7 +60204,7 @@ } }, "204": { - "description": "MembershipTransferPointsLOV not found." + "description": "ShiftReportsNoParamLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59385,20 +60254,20 @@ ] } }, - "/listOfValues/profiles/{profileId}/negotiatedRateHotels": { + "/listOfValues/siteType/{siteType}/sitePlanSectionTypes": { "get": { - "summary": "Fetch List Of Values for Negotiated Rate Hotels", - "description": "OperationId:getNegotiatedRateHotelsLOV
", - "operationId": "getNegotiatedRateHotelsLOV", + "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", "parameters": [ { - "name": "profileId", + "name": "siteType", "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 'siteType' which is required to fetch SitePlanSectionTypes LOV" }, { "name": "includeInactiveFlag", @@ -59472,7 +60341,7 @@ } }, "204": { - "description": "NegotiatedRateHotelsLOV not found." + "description": "SitePlanSectionTypesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59522,20 +60391,20 @@ ] } }, - "/listOfValues/profiles/{profileId}/profileCommunications": { + "/listOfValues/sourceId/{sourceId}/globalAlertFieldQuery": { "get": { - "summary": "Fetch List Of Values for Profile Communications", - "description": "OperationId:getProfileCommunicationsLOV
", - "operationId": "getProfileCommunicationsLOV", + "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", "parameters": [ { - "name": "profileId", + "name": "sourceId", "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 'sourceId' which is required to fetch GlobalAlertFieldQuery LOV" }, { "name": "includeInactiveFlag", @@ -59609,7 +60478,7 @@ } }, "204": { - "description": "ProfileCommunicationsLOV not found." + "description": "GlobalAlertFieldQueryLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59659,29 +60528,47 @@ ] } }, - "/listOfValues/profiles/{profileId}/taxTypeCheck/{taxTypeCheck}/profileHotels": { + "/listOfValues/sourceIdIn/{sourceIdIn}/fieldType/{fieldType}/fieldName/{fieldName}/tableName/{tableName}/globalAlertOperator": { "get": { - "summary": "Fetch List Of Values for Profile Hotels", - "description": "OperationId:getProfileHotelsLOV
", - "operationId": "getProfileHotelsLOV", + "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", "parameters": [ { - "name": "taxTypeCheck", + "name": "tableName", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'taxTypeCheck' which is required to fetch ProfileHotels LOV" + "description": "Value of the parameter 'tableName' which is required to fetch GlobalAlertOperator LOV" }, { - "name": "profileId", + "name": "fieldName", "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 '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", @@ -59755,7 +60642,7 @@ } }, "204": { - "description": "ProfileHotelsLOV not found." + "description": "GlobalAlertOperatorLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59805,20 +60692,20 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyClassesCopy": { + "/listOfValues/sourceIdIn/{sourceIdIn}/mailGeneric": { "get": { - "summary": "Fetch List Of Values for Room Hierarchy Classes Copy", - "description": "OperationId:getRoomHierarchyClassesCopyLOV
", - "operationId": "getRoomHierarchyClassesCopyLOV", + "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", "parameters": [ { - "name": "property", + "name": "sourceIdIn", "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 'sourceIdIn' which is required to fetch MailGeneric LOV" }, { "name": "includeInactiveFlag", @@ -59892,7 +60779,7 @@ } }, "204": { - "description": "RoomHierarchyClassesCopyLOV not found." + "description": "MailGenericLOV not found." }, "400": { "$ref": "#/responses/400" @@ -59942,20 +60829,20 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyRoomClasses": { + "/listOfValues/subscriber/{subscriber}/publisherProperties": { "get": { - "summary": "Fetch List Of Values for Room Hierarchy Room Classes", - "description": "OperationId:getRoomHierarchyRoomClassesLOV
", - "operationId": "getRoomHierarchyRoomClassesLOV", + "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", "parameters": [ { - "name": "property", + "name": "subscriber", "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 'subscriber' which is required to fetch PublisherProperties LOV" }, { "name": "includeInactiveFlag", @@ -60029,7 +60916,7 @@ } }, "204": { - "description": "RoomHierarchyRoomClassesLOV not found." + "description": "PublisherPropertiesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60079,20 +60966,20 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyRoomTypes": { + "/listOfValues/tableName/{tableName}/interfaceTabColumns": { "get": { - "summary": "Fetch List Of Values for Room Hierarchy Room Types", - "description": "OperationId:getRoomHierarchyRoomTypesLOV
", - "operationId": "getRoomHierarchyRoomTypesLOV", + "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", "parameters": [ { - "name": "property", + "name": "tableName", "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 'tableName' which is required to fetch InterfaceTabColumns LOV" }, { "name": "includeInactiveFlag", @@ -60166,7 +61053,7 @@ } }, "204": { - "description": "RoomHierarchyRoomTypesLOV not found." + "description": "InterfaceTabColumnsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60216,20 +61103,29 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyTypesCopy": { + "/listOfValues/tableName/{tableName}/traceGroup/{traceGroup}/autoTraceExpressionFields": { "get": { - "summary": "Fetch List Of Values for Room Hierarchy Types Copy", - "description": "OperationId:getRoomHierarchyTypesCopyLOV
", - "operationId": "getRoomHierarchyTypesCopyLOV", + "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", "parameters": [ { - "name": "property", + "name": "traceGroup", "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 '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", @@ -60303,7 +61199,7 @@ } }, "204": { - "description": "RoomHierarchyTypesCopyLOV not found." + "description": "AutoTraceExpressionFieldsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60353,20 +61249,20 @@ ] } }, - "/listOfValues/propertyList/{propertyList}/repRatePlans": { + "/listOfValues/templateCode/{templateCode}/templateFiscalFolioParameters": { "get": { - "summary": "Fetch List Of Values for Rep Rate Plans", - "description": "OperationId:getRepRatePlansLOV
", - "operationId": "getRepRatePlansLOV", + "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", "parameters": [ { - "name": "propertyList", + "name": "templateCode", "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 'templateCode' which is required to fetch TemplateFiscalFolioParameters LOV" }, { "name": "includeInactiveFlag", @@ -60440,7 +61336,7 @@ } }, "204": { - "description": "RepRatePlansLOV not found." + "description": "TemplateFiscalFolioParametersLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60490,29 +61386,20 @@ ] } }, - "/listOfValues/radioType/{radioType}/hotels/{hotelId}/cateringPackageCodes": { + "/listOfValues/type/{type}/arrangementCodesNumber": { "get": { - "summary": "Fetch List Of Values for Catering Package Codes", - "description": "OperationId:getCateringPackageCodesLOV
", - "operationId": "getCateringPackageCodesLOV", + "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", "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": "type", "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 'type' which is required to fetch ArrangementCodesNumber LOV" }, { "name": "includeInactiveFlag", @@ -60586,7 +61473,7 @@ } }, "204": { - "description": "CateringPackageCodesLOV not found." + "description": "ArrangementCodesNumberLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60636,29 +61523,20 @@ ] } }, - "/listOfValues/rateCode/{rateCode}/profiles/{profileId}/negotiatedRatesHotels": { + "/listOfValues/type/{type}/enrollmentMatchCommunicationType": { "get": { - "summary": "Fetch List Of Values for Negotiated Rates Hotels", - "description": "OperationId:getNegotiatedRatesHotelsLOV
", - "operationId": "getNegotiatedRatesHotelsLOV", + "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", "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": "type", "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 'type' which is required to fetch EnrollmentMatchCommunicationType LOV" }, { "name": "includeInactiveFlag", @@ -60732,7 +61610,7 @@ } }, "204": { - "description": "NegotiatedRatesHotelsLOV not found." + "description": "EnrollmentMatchCommunicationTypeLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60782,29 +61660,20 @@ ] } }, - "/listOfValues/roleLevel/{roleLevel}/levelCode/{levelCode}/rolesForLevel": { + "/listOfValues/type/{type}/folioGroupingCodes": { "get": { - "summary": "Fetch List Of Values for Roles For Level", - "description": "OperationId:getRolesForLevelLOV
", - "operationId": "getRolesForLevelLOV", + "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", "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": "type", "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 'type' which is required to fetch FolioGroupingCodes LOV" }, { "name": "includeInactiveFlag", @@ -60878,7 +61747,7 @@ } }, "204": { - "description": "RolesForLevelLOV not found." + "description": "FolioGroupingCodesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -60928,38 +61797,20 @@ ] } }, - "/listOfValues/roles/{roles}/chainCode/{chainCode}/actionTask/{actionTask}/organizations": { + "/listOfValues/type/{type}/revenueBuckets": { "get": { - "summary": "Fetch List Of Values for Organizations", - "description": "OperationId:getOrganizationsLOV
", - "operationId": "getOrganizationsLOV", + "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", "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": "type", "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 'type' which is required to fetch RevenueBuckets LOV" }, { "name": "includeInactiveFlag", @@ -61033,7 +61884,7 @@ } }, "204": { - "description": "OrganizationsLOV not found." + "description": "RevenueBucketsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61083,24 +61934,20 @@ ] } }, - "/listOfValues/salesFormat/{salesFormat}/addressFormatElements": { + "/listOfValues/type/{type}/trxCodeArrangement": { "get": { - "summary": "Fetch List Of Values for Address Format Elements", - "description": "OperationId:getAddressFormatElementsLOV
", - "operationId": "getAddressFormatElementsLOV", + "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", "parameters": [ { - "name": "salesFormat", + "name": "type", "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 'type' which is required to fetch TrxCodeArrangement LOV" }, { "name": "includeInactiveFlag", @@ -61174,7 +62021,7 @@ } }, "204": { - "description": "AddressFormatElementsLOV not found." + "description": "TrxCodeArrangementLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61224,121 +62071,29 @@ ] } }, - "/listOfValues/searchPostingTransactionCodes": { - "post": { - "summary": "Fetch List Of Values for Posting Transaction Codes", - "description": "OperationId:searchPostingTransactionCodesLOV
", - "operationId": "searchPostingTransactionCodesLOV", + "/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", "parameters": [ { - "name": "listOfValuesCriteria", - "in": "body", + "name": "udfCategory", + "in": "path", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/listOfValuesCriteria" - } - ] - } - }, - { - "$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" + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'udfCategory' which is required to fetch UdfAttributes LOV" }, - "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", + "name": "udfType", "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 'udfType' which is required to fetch UdfAttributes LOV" }, { "name": "includeInactiveFlag", @@ -61412,7 +62167,7 @@ } }, "204": { - "description": "ShiftReportsNoParamLOV not found." + "description": "UdfAttributesLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61462,20 +62217,20 @@ ] } }, - "/listOfValues/siteType/{siteType}/sitePlanSectionTypes": { + "/listOfValues/userId/{userId}/croUsers": { "get": { - "summary": "Fetch List Of Values for Site Plan Section Types", - "description": "OperationId:getSitePlanSectionTypesLOV
", - "operationId": "getSitePlanSectionTypesLOV", + "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", "parameters": [ { - "name": "siteType", + "name": "userId", "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 'userId' which is required to fetch CroUsers LOV" }, { "name": "includeInactiveFlag", @@ -61549,7 +62304,7 @@ } }, "204": { - "description": "SitePlanSectionTypesLOV not found." + "description": "CroUsersLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61599,60 +62354,24 @@ ] } }, - "/listOfValues/sourceId/{sourceId}/globalAlertFieldQuery": { - "get": { - "summary": "Fetch List Of Values for Global Alert Field Query", - "description": "OperationId:getGlobalAlertFieldQueryLOV
", - "operationId": "getGlobalAlertFieldQueryLOV", + "/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, "parameters": [ { - "name": "sourceId", - "in": "path", + "name": "validateListOfValues", + "in": "body", "required": true, - "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 + "schema": { + "allOf": [ + { + "$ref": "#/definitions/validateListOfValues" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -61678,16 +62397,17 @@ "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" + "$ref": "#/definitions/validateListOfValuesDetails" } }, - "204": { - "description": "GlobalAlertFieldQueryLOV not found." - }, "400": { "$ref": "#/responses/400" }, @@ -61736,47 +62456,20 @@ ] } }, - "/listOfValues/sourceIdIn/{sourceIdIn}/fieldType/{fieldType}/fieldName/{fieldName}/tableName/{tableName}/globalAlertOperator": { + "/listOfValues/view/{view}/traceDateCalc": { "get": { - "summary": "Fetch List Of Values for Global Alert Operator", - "description": "OperationId:getGlobalAlertOperatorLOV
", - "operationId": "getGlobalAlertOperatorLOV", + "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", "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", - "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", + "name": "view", "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 'view' which is required to fetch TraceDateCalc LOV" }, { "name": "includeInactiveFlag", @@ -61850,7 +62543,7 @@ } }, "204": { - "description": "GlobalAlertOperatorLOV not found." + "description": "TraceDateCalcLOV not found." }, "400": { "$ref": "#/responses/400" @@ -61900,20 +62593,20 @@ ] } }, - "/listOfValues/sourceIdIn/{sourceIdIn}/mailGeneric": { + "/listOfValues/view/{view}/traceField": { "get": { - "summary": "Fetch List Of Values for Mail Generic", - "description": "OperationId:getMailGenericLOV
", - "operationId": "getMailGenericLOV", + "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", "parameters": [ { - "name": "sourceIdIn", + "name": "view", "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 'view' which is required to fetch TraceField LOV" }, { "name": "includeInactiveFlag", @@ -61987,7 +62680,7 @@ } }, "204": { - "description": "MailGenericLOV not found." + "description": "TraceFieldLOV not found." }, "400": { "$ref": "#/responses/400" @@ -62037,29 +62730,20 @@ ] } }, - "/listOfValues/stationery/{stationery}/section/{section}/qrMergeCodes": { + "/listOfValues/year/{year}/repCalendarMonths": { "get": { - "summary": "Fetch List Of Values for QrMergeCodes", - "description": "OperationId:getQrMergeCodesLOV
", - "operationId": "getQrMergeCodesLOV", + "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", "parameters": [ { - "name": "stationery", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'stationery' which is required to fetch QrMergeCodesLOV" - }, - { - "name": "section", + "name": "year", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'section' which is required to fetch QrMergeCodesLOV" + "description": "Value of the parameter 'year' which is required to fetch RepCalendarMonths LOV" }, { "name": "includeInactiveFlag", @@ -62133,7 +62817,7 @@ } }, "204": { - "description": "QrMergeCodesLOV not found." + "description": "RepCalendarMonthsLOV not found." }, "400": { "$ref": "#/responses/400" @@ -62183,20 +62867,20 @@ ] } }, - "/listOfValues/stationery/{stationery}/stationerySection": { + "/listOfValues/year/{year}/repCalendarWeeks": { "get": { - "summary": "Fetch List Of Values for Stationery Section", - "description": "OperationId:getStationerySectionLOV
", - "operationId": "getStationerySectionLOV", + "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", "parameters": [ { - "name": "stationery", + "name": "year", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'stationery' which is required to fetch StationerySection LOV" + "description": "Value of the parameter 'year' which is required to fetch RepCalendarWeeks LOV" }, { "name": "includeInactiveFlag", @@ -62270,7 +62954,7 @@ } }, "204": { - "description": "StationerySectionLOV not found." + "description": "RepCalendarWeeksLOV not found." }, "400": { "$ref": "#/responses/400" @@ -62320,2195 +63004,20 @@ ] } }, - "/listOfValues/subscriber/{subscriber}/publisherProperties": { + "/listOfValues/year/{year}/statisticsYears": { "get": { - "summary": "Fetch List Of Values for Publisher Properties", - "description": "OperationId:getPublisherPropertiesLOV
", - "operationId": "getPublisherPropertiesLOV", + "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", "parameters": [ { - "name": "subscriber", + "name": "year", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "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" + "description": "Value of the parameter 'year' which is required to fetch StatisticsYears LOV" }, { "name": "includeInactiveFlag", @@ -64634,8 +63143,8 @@ }, "/listOfValues/{name}": { "get": { - "summary": "Fetch List Of Values for the given name of the LOV", - "description": "OperationId:getListOfValues
", + "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
", "operationId": "getListOfValues", "parameters": [ { @@ -64751,7 +63260,6 @@ "CardTypes", "CardTypesIfc", "CashierShiftDropLocations", - "CashierStartingAmountCurrencyCodes", "CashieringTransactionTypes", "Cashiers", "CashiersConfig", @@ -64800,7 +63308,6 @@ "CompositeResvStatuses", "ConfigModes", "ConfigTitles", - "ConsumableItemsMultiHotel", "ContactMethod", "Container", "ContractBillingInstructions", @@ -65379,7 +63886,8 @@ "QrCodeName", "ChannelNegotiatedRateCode", "FiscalTerminals", - "ChainJobProcedures" + "ChainJobProcedures", + "OtaTaxType" ] }, { @@ -65504,10 +64012,99 @@ ] } }, + "/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": "Retrieve List of Values Service Version", - "description": "OperationId:pingLOVService
", + "summary": "Ping list of values service version", + "description": "Use this API to return the the list of values service version.OperationId:pingLOVService
", "operationId": "pingLOVService", "parameters": [ { @@ -66011,12 +64608,6 @@ }, "active": { "type": "boolean" - }, - "imageURL": { - "type": "string", - "description": "The URL where the images are stored.", - "minLength": 0, - "maxLength": 2000 } } }, @@ -66147,27 +64738,25 @@ } } }, - "operaVersion": { + "status": { "type": "object", - "description": "Response for Ping operation.", + "description": "Response Body.", "properties": { - "operaVersion": { - "description": "Current Opera Version Number", - "type": "string" + "warnings": { + "$ref": "#/definitions/warningsType" }, "links": { "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" } } }, - "listOfValuesCriteria": { + "operaVersion": { "type": "object", + "description": "Response for Ping operation.", "properties": { - "criteria": { - "$ref": "#/definitions/listOfValuesCriteriaType" + "operaVersion": { + "description": "Current Opera Version Number", + "type": "string" }, "links": { "$ref": "#/definitions/links" diff --git a/rest-api-specs/property/medcfg.json b/rest-api-specs/property/medcfg.json index cd26c4e..4a6e6d2 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.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", + "description": "Opera Content Service offers capability to manage large content such as images and files.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.4", "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 d5bf1a0..05cbb10 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.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", + "description": "APIs to cater to provisioning and deprovisioning of new properties and chains in OPERA.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.4", "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 381078d..567d453 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -1948,7 +1948,7 @@ "/externalSystems/{extSystemCode}/profiles/{externalProfileId}/memberships": { "get": { "summary": "Get membership information on a profile", - "description": "Use this API to retrieve membership details on a profile.OperationId:getMembershipDetails
", + "description": "Use this API to retrieve membership details on a profile.OperationId:getMembershipDetails
This API allows a time span of 90 days.
", "operationId": "getMembershipDetails", "parameters": [ { @@ -13606,6 +13606,12 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "hotelId": { + "description": "External Hotel Id to generate membership number.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, diff --git a/rest-api-specs/property/outbound/cshoutbound.json b/rest-api-specs/property/outbound/cshoutbound.json index 3ca7880..aba04e0 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/outbound/fofoutbound.json b/rest-api-specs/property/outbound/fofoutbound.json index 2f25561..f623831 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/par.json b/rest-api-specs/property/par.json index a92ffc6..04add02 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.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", + "description": "APIs to cater for Price and Rate Availability functionality in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -24,7 +24,7 @@ "/availability": { "get": { "summary": "Get Hotel Availability", - "description": " This API fetches hotel availablity for multiple hotels, given dates, RatePlans, Rate Category, Rate Group, Membership Rates, Number of People.OperationId:getHotelAvailabilityCRO
", + "description": " This API fetches hotel availablity for multiple hotels, given dates, RatePlans, Rate Category, Rate Group, Membership Rates, Number of People.OperationId:getHotelAvailabilityCRO
This API allows a time span of 90 days.
", "operationId": "getHotelAvailabilityCRO", "parameters": [ { @@ -4101,7 +4101,7 @@ "/hotels/{hotelId}/analyzeRateAvailability": { "get": { "summary": "Analyze Rate Availability ", - "description": "This API allows to Analyze Rate Availability. Rate analysis request to include the rate code, room type and room span to analyze whether a rate is closed and the reasons.OperationId:analyzeRateAvailability
", + "description": "This API allows to Analyze Rate Availability. Rate analysis request to include the rate code, room type and room span to analyze whether a rate is closed and the reasons.OperationId:analyzeRateAvailability
This API allows a time span of 90 days.
", "operationId": "analyzeRateAvailability", "parameters": [ { @@ -11820,7 +11820,7 @@ "/hotels/{hotelId}/availableUpsells": { "get": { "summary": "Get for Available Up-sells", - "description": "This API allows to fetch for Available Up-sells for specific hotel and date range.OperationId:getAvailableUpsells
", + "description": "This API allows to fetch for Available Up-sells for specific hotel and date range.OperationId:getAvailableUpsells
This API allows a time span of 90 days.
", "operationId": "getAvailableUpsells", "parameters": [ { @@ -12070,144 +12070,6 @@ ] } }, - "/hotels/{hotelId}/guaranteeablePreferences": { - "get": { - "summary": "Get Guarantee-able Preference Codes", - "description": "Get Guarantee-able Preference Codes for a specified property.OperationId:getGuaranteeablePreferences
", - "operationId": "getGuaranteeablePreferences", - "parameters": [ - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID that identifies a single hotel property." - }, - { - "name": "startDate", - "in": "query", - "required": false, - "type": "string", - "format": "date" - }, - { - "name": "endDate", - "in": "query", - "required": false, - "type": "string", - "format": "date" - }, - { - "name": "roomType", - "in": "query", - "required": false, - "description": "Room Type for which the Guaranteeable Preference Code Mapping is requested.", - "type": "string" - }, - { - "name": "availableCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "requestedCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "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" - } - }, - "description": "Response of Guaranteeable Preferences Request.", - "schema": { - "$ref": "#/definitions/guaranteeablePreferences" - } - }, - "204": { - "description": "GuaranteeablePreferences 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": [ - "Availability" - ] - } - }, "/hotels/{hotelId}/guarantees": { "get": { "summary": "Get reservation guarantees", @@ -12532,7 +12394,7 @@ { "name": "hurdleDate", "in": "query", - "required": true, + "required": false, "description": "Date criteria for which the hurdle rate is scheduled.", "type": "string", "format": "date" @@ -12563,6 +12425,22 @@ "description": "Wildcard search on the code.", "type": "string" }, + { + "name": "hurdleRangeStart", + "in": "query", + "type": "string", + "description": "Hurdle date start range from which the hurdle rate is scheduled.", + "format": "date", + "required": false + }, + { + "name": "hurdleRangeEnd", + "in": "query", + "type": "string", + "description": "Hurdle date end range to which the hurdle rate is scheduled.", + "format": "date", + "required": false + }, { "$ref": "#/parameters/authKey" }, @@ -12943,6 +12821,30 @@ }, "required": false }, + { + "name": "hurdleRangeStart", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Hurdle date start range from which the hurdle rate is scheduled.", + "items": { + "type": "string", + "format": "date" + }, + "required": false + }, + { + "name": "hurdleRangeEnd", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Hurdle date end range to which the hurdle rate is scheduled.", + "items": { + "type": "string", + "format": "date" + }, + "required": false + }, { "$ref": "#/parameters/authKey" }, @@ -25124,45 +25026,6 @@ } } }, - "guaranteeablePreferences": { - "type": "object", - "description": "Response of Guarantee-able Preferences Request.", - "properties": { - "availablePreferences": { - "description": "Contains requested criteria and the Mapping of Requested and Available Preference Codes.", - "$ref": "#/definitions/availablePreferencesType" - }, - "links": { - "$ref": "#/definitions/links" - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } - } - }, - "availablePreferencesType": { - "type": "array", - "description": "Collection of Requested and Available Guaranteeable Preference Codes.", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/requestedAvailablePreferenceType" - } - }, - "requestedAvailablePreferenceType": { - "type": "object", - "properties": { - "requestedCode": { - "type": "string", - "minLength": 0, - "maxLength": 80 - }, - "availableCode": { - "type": "string", - "minLength": 0, - "maxLength": 80 - } - } - }, "reservationGuaranteesPolicies": { "type": "object", "description": "Response object to fetch reservation guarantees.", @@ -25290,6 +25153,16 @@ "override": { "description": "Specifies whether to override hurdle rate or not.", "type": "boolean" + }, + "hurdleRangeStart": { + "description": "Hurdle date start range from which the hurdle rate is scheduled.", + "type": "string", + "format": "date" + }, + "hurdleRangeEnd": { + "description": "Hurdle date end range to which the hurdle rate is scheduled.", + "type": "string", + "format": "date" } } }, diff --git a/rest-api-specs/property/parasync.json b/rest-api-specs/property/parasync.json index f4450c9..ea32a2f 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.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", + "description": "APIs to cater for Price and Rate Availability Asynchronous functionality in OPERA Cloud.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.4", "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 ec42002..11de6f0 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.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", + "description": "APIs for adding, updating, and deleting stationery reports in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" diff --git a/rest-api-specs/property/rmcfg.json b/rest-api-specs/property/rmcfg.json index 0719e75..16395f8 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.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", + "description": "APIs to cater for room configuration, such as configuring room types, room Classes, creating new room features, or updating housekeeping room maintenance reasons.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -6476,7 +6476,7 @@ "/hotels/{hotelId}/outOfOrderServiceReasons": { "get": { "summary": "Get Out Of Order Service Reasons", - "description": "Use this API to return out of order service reasons for a specific hotel based on search criteria such as hotelId, includeInactive, limit offset, reasonCodes. Out of order (OO) and out of service (OS) are two additional housekeeping statuses. These options are used when changing the status for rooms that should not be sold due to damage, maintenance, low occupancy wing, etc.OperationId:getOutOfOrderServiceReasons
", + "description": "Use this API to return out of order service reasons for a specific hotel based on search criteria such as hotelId, includeInactive, limit offset, reasonCodes. Out of order (OO) and out of service (OS) are two additional housekeeping statuses. These options are used when changing the status for rooms that should not be sold due to damage, maintenance, low occupancy wing, etc.OperationId:getOutOfOrderServiceReasons
The maximum allowable limit for this API is 1000.
", "operationId": "getOutOfOrderServiceReasons", "parameters": [ { @@ -8820,7 +8820,7 @@ "/hotels/{hotelId}/roomMaintenanceReasons": { "get": { "summary": "Get Hotel Room Maintenance Reasons", - "description": "Use this API to get Hotel Room Maintenance Reasons.OperationId:getHotelRoomMaintenanceReasons
", + "description": "Use this API to get Hotel Room Maintenance Reasons.OperationId:getHotelRoomMaintenanceReasons
The maximum allowable limit for this API is 1000.
", "operationId": "getHotelRoomMaintenanceReasons", "parameters": [ { @@ -10770,7 +10770,7 @@ "/hotels/{hotelId}/vacantRoomStatus": { "get": { "summary": "Get vacant room status configuration.", - "description": "Use this API to retrieve vacant room status configuration.OperationId:getVacantRoomStatus
", + "description": "Use this API to retrieve vacant room status configuration.OperationId:getVacantRoomStatus
This API allows a time span of 90 days.
", "operationId": "getVacantRoomStatus", "parameters": [ { @@ -18305,6 +18305,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -18635,6 +18638,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -19014,6 +19020,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -19102,6 +19111,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -19553,6 +19565,9 @@ "inactive": { "description": "Indicates whether the attendant is active or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -19729,6 +19744,16 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "membershipType": { + "description": "Specify a Membership Type to associate to a specific housekeeping task code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "membershipLevels": { + "description": "Specify one or more Membership Levels to associate to a specific housekeeping task code.", + "$ref": "#/definitions/codeListType" } } }, @@ -20012,6 +20037,9 @@ "inactive": { "description": "Indicates if the Section Code is active.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -20500,11 +20528,18 @@ "description": "Indicator for room status display. Room status configured with 'true' will be displayed as OOO, 'false' will be displayed as OOS.", "type": "boolean" }, + "returnTimeRequired": { + "description": "Indicator for Return Time Required display. If configured to true, then a time will be mandatory to determine when this unit (room) will be back to the inventory of the available rooms.", + "type": "boolean" + }, "hotelId": { "description": "Hotel code the out of order/service reason belongs to.", "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -20587,6 +20622,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -20677,6 +20715,9 @@ "roomTypes": { "description": "Room types of a room class.", "$ref": "#/definitions/roomTypesSummaryType" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -20773,6 +20814,9 @@ "inactive": { "description": "Indicates the room type is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -20966,6 +21010,9 @@ "mappedPreferenceCodes": { "description": "Preference codes mapped to the room feature.", "$ref": "#/definitions/configHotelPreferencesType" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -21130,6 +21177,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -21649,6 +21699,9 @@ "inactive": { "description": "Is Room type inactive?", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -22536,6 +22589,13 @@ "deductYn": { "description": "Indicator for room status display. Room status configured with 'true' will be displayed as OOO, 'false' will be displayed as OOS.", "type": "boolean" + }, + "returnTimeRequired": { + "description": "Indicator for Return Time Required display. If configured to true, then a time will be mandatory to determine when this unit (room) will be back to the inventory of the available rooms.", + "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -22608,6 +22668,9 @@ "inactive": { "description": "Indicates the code type is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -22801,6 +22864,9 @@ "global": { "description": "Specifies whether the room feature is to be available for selection at all hotels.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -23064,6 +23130,9 @@ "inactive": { "description": "Inactive flag for a particular room maintenance reason.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -23140,6 +23209,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -23220,6 +23292,9 @@ "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -23296,6 +23371,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -23662,6 +23740,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -23748,6 +23829,9 @@ "global": { "description": "Specifies whether the floor is to be available for selection at all hotels.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -23988,6 +24072,16 @@ "moveup": { "description": "Automatically moves the template task up one day if it falls on the day before the guest's departure. It will only be available when the schedule is set to every 3 days or more.", "type": "boolean" + }, + "membershipType": { + "description": "Specify a Membership Type associated to a specific template housekeeping task code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "membershipLevels": { + "description": "Specify one or more Membership Levels associated to a specific template housekeeping task code.", + "$ref": "#/definitions/codeListType" } } }, @@ -24024,6 +24118,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -24248,6 +24345,16 @@ "description": "Component Suite Room Status to which the Component Room is attached." } } + }, + "managedByOptions": { + "description": "Describes of the Configuration is Managed by Enterprise or Property.", + "type": "string", + "enum": [ + "EnterpriseManaged", + "PropertyManaged", + "EnterpriseEnforced", + "PropertyOverridden" + ] } }, "tags": [ diff --git a/rest-api-specs/property/rmr.json b/rest-api-specs/property/rmr.json index af9e607..761dbab 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -24,7 +24,7 @@ "/hotels/{hotelId}/departureStartDate/{departureStartDate}/departureEndDate/{departureEndDate}/reservationRotationPoints": { "get": { "summary": "Get list of reservations and the associated rotations points", - "description": "This API will allow a user to retrieve list of reservations and the number of rotation points associated with a given reservation for requested hotel, departure start date, departure end date, and room numbers.OperationId:getReservationRotationPoints
", + "description": "This API will allow a user to retrieve list of reservations and the number of rotation points associated with a given reservation for requested hotel, departure start date, departure end date, and room numbers.OperationId:getReservationRotationPoints
This API allows a time span of 30 days.
", "operationId": "getReservationRotationPoints", "parameters": [ { @@ -445,7 +445,7 @@ "/hotels/{hotelId}/roomRotationPoints": { "get": { "summary": "Get Room Rotation Points", - "description": "Use this API to fetch the individual units' rotation points.OperationId:getRoomRotationPoints
", + "description": "Use this API to fetch the individual units' rotation points.OperationId:getRoomRotationPoints
The maximum allowable limit for this API is 100.
", "operationId": "getRoomRotationPoints", "parameters": [ { diff --git a/rest-api-specs/property/rmrcfg.json b/rest-api-specs/property/rmrcfg.json index 91b60f0..9ead835 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -3408,6 +3408,9 @@ "type": "number", "minimum": 0, "maximum": 99999 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -4403,6 +4406,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -4493,6 +4499,9 @@ "type": "number", "minimum": 0, "maximum": 99999 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -5014,6 +5023,16 @@ "Owner", "OwnerReferral" ] + }, + "managedByOptions": { + "description": "Describes of the Configuration is Managed by Enterprise or Property.", + "type": "string", + "enum": [ + "EnterpriseManaged", + "PropertyManaged", + "EnterpriseEnforced", + "PropertyOverridden" + ] } }, "tags": [ diff --git a/rest-api-specs/property/rsv.json b/rest-api-specs/property/rsv.json index 52c9999..3c40614 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.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", + "description": "APIs to cater for Reservation functionality in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -24,7 +24,7 @@ "/blockReservationStatisticsByDateAndRoomPool": { "get": { "summary": "Get block Reservation Statistics", - "description": "Get block Reservation statistics by date and room poolOperationId:getBlockReservationStatisticsByDateAndRoomPool
", + "description": "Get block Reservation statistics by date and room poolOperationId:getBlockReservationStatisticsByDateAndRoomPool
This API allows a time span of 90 days.
", "operationId": "getBlockReservationStatisticsByDateAndRoomPool", "parameters": [ { @@ -241,7 +241,7 @@ "/calls/statistics": { "get": { "summary": "Get call statistics", - "description": "Use this API to get call statistics.OperationId:getCallStatistics
", + "description": "Use this API to get call statistics.OperationId:getCallStatistics
This API allows a time span of 30 days.
", "operationId": "getCallStatistics", "parameters": [ { @@ -2124,7 +2124,7 @@ "/hotels/{hotelId}/confirmationLetters": { "get": { "summary": "Fetch Confirmation Letters", - "description": "Get a list of Reservations for which confirmation letters need to be sent.OperationId:getConfirmationLetters
", + "description": "Get a list of Reservations for which confirmation letters need to be sent.OperationId:getConfirmationLetters
This API allows a time span of 90 days.
", "operationId": "getConfirmationLetters", "parameters": [ { @@ -2898,7 +2898,7 @@ "in": "query", "type": "array", "collectionFormat": "multi", - "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.", + "description": "Instruction on which of the reservation's elements are to be returned e.g. DailySummary will return summarized information for each day of the reservation. Instructions are cumulative i.e. if multiple instructions are sent in a request, then the combined reservation elements would be returned, elements will not be duplicated in the response.", "uniqueItems": true, "items": { "type": "string", @@ -2940,7 +2940,8 @@ "GuestMemberships", "ECertificates", "UpsellInfo", - "RoomAssignedByAI" + "RoomAssignedByAI", + "DailySummary" ] }, "required": false @@ -3182,11 +3183,11 @@ ] } }, - "/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/cancellations": { + "/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/addOnReservationPackagesByExtId": { "put": { - "summary": "Reinstate a Reservation", - "description": "Use this API to reinstate a cancelled reservation.OperationId:putReinstateReservationByExtId
", - "operationId": "putReinstateReservationByExtId", + "summary": "Update Add On (Sell Separate) packages on a reservation", + "description": "This API will allow you to update Add On (Sell Separate) packages on a reservation's. Note: this API works as a full overlay for Reservation Add On Packages./OperationId:putAddOnReservationPackagesByExtId
", + "operationId": "putAddOnReservationPackagesByExtId", "parameters": [ { "name": "reservationExternalId", @@ -3194,7 +3195,7 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 2000, + "maxLength": 50, "description": "External reservation ID." }, { @@ -3203,7 +3204,7 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 2000, + "maxLength": 50, "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { @@ -3212,18 +3213,25 @@ "required": true, "type": "string", "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel where reservation is searched based on reservation ID." + "maxLength": 20, + "description": "Unique ID of the hotel where reservation is searched based on External reservation ID." }, { - "name": "reinstateReservation", + "name": "legNumber", + "in": "query", + "required": false, + "type": "number", + "description": "External system Leg Number for the reservation." + }, + { + "name": "reservationAddOnPackages", "in": "body", "required": true, - "description": "Overriding the validation check will log the supposed errors in the warnings log if they would fail.", + "description": "Request object to overlay addon packages on an existing reservation.", "schema": { "allOf": [ { - "$ref": "#/definitions/reinstateReservation" + "$ref": "#/definitions/reservationAddOnPackagesType" } ] } @@ -3260,7 +3268,7 @@ }, "description": "Response Body.", "schema": { - "$ref": "#/definitions/reinstateReservationDetails" + "$ref": "#/definitions/addOnReservationPackagesType" } }, "400": { @@ -3309,11 +3317,13 @@ "tags": [ "Reservation" ] - }, - "post": { - "summary": "Cancel Reservation by ID", - "description": "Use this if a guest would like to cancel their reservation. You will receive a cancellation number in the response.OperationId:postCancelReservationByExtId
", - "operationId": "postCancelReservationByExtId", + } + }, + "/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/cancellations": { + "put": { + "summary": "Reinstate a Reservation", + "description": "Use this API to reinstate a cancelled reservation.OperationId:putReinstateReservationByExtId
", + "operationId": "putReinstateReservationByExtId", "parameters": [ { "name": "reservationExternalId", @@ -3343,14 +3353,14 @@ "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, { - "name": "cancelReservation", + "name": "reinstateReservation", "in": "body", "required": true, - "description": "Request object for canceling reservations.", + "description": "Overriding the validation check will log the supposed errors in the warnings log if they would fail.", "schema": { "allOf": [ { - "$ref": "#/definitions/cancelReservation" + "$ref": "#/definitions/reinstateReservation" } ] } @@ -3372,7 +3382,7 @@ } ], "responses": { - "201": { + "200": { "headers": { "Content-Language": { "type": "string", @@ -3385,9 +3395,9 @@ "description": "Location of newly created resource" } }, - "description": "Response object for the request to cancel reservations. Response contains the reservations which were successfully canceled.", + "description": "Response Body.", "schema": { - "$ref": "#/definitions/cancelReservationDetails" + "$ref": "#/definitions/reinstateReservationDetails" } }, "400": { @@ -3436,13 +3446,11 @@ "tags": [ "Reservation" ] - } - }, - "/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/routingInstructions": { + }, "post": { - "summary": "Create routing instructions", - "description": "You can use this API to create routing instructions on a reservation.OperationId:postRoutingInstructionsByExtId
", - "operationId": "postRoutingInstructionsByExtId", + "summary": "Cancel Reservation by ID", + "description": "Use this if a guest would like to cancel their reservation. You will receive a cancellation number in the response.OperationId:postCancelReservationByExtId
", + "operationId": "postCancelReservationByExtId", "parameters": [ { "name": "reservationExternalId", @@ -3472,14 +3480,14 @@ "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, { - "name": "reservationRoutingCriteria", + "name": "cancelReservation", "in": "body", "required": true, - "description": "Request to create a routing instruction.", + "description": "Request object for canceling reservations.", "schema": { "allOf": [ { - "$ref": "#/definitions/reservationRoutingCriteria" + "$ref": "#/definitions/cancelReservation" } ] } @@ -3514,9 +3522,9 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response object for the request to cancel reservations. Response contains the reservations which were successfully canceled.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/cancelReservationDetails" } }, "400": { @@ -3565,11 +3573,13 @@ "tags": [ "Reservation" ] - }, - "put": { - "summary": "Change routing instructions", - "description": "Change routing instructions on an existing reservation.OperationId:putRoutingInstructionsByExtId
", - "operationId": "putRoutingInstructionsByExtId", + } + }, + "/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/routingInstructions": { + "post": { + "summary": "Create routing instructions", + "description": "You can use this API to create routing instructions on a reservation.OperationId:postRoutingInstructionsByExtId
", + "operationId": "postRoutingInstructionsByExtId", "parameters": [ { "name": "reservationExternalId", @@ -3599,14 +3609,14 @@ "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, { - "name": "routingInstructionsInfo", + "name": "reservationRoutingCriteria", "in": "body", "required": true, - "description": "Request when changing a routing instruction.", + "description": "Request to create a routing instruction.", "schema": { "allOf": [ { - "$ref": "#/definitions/routingInstructionsInfo" + "$ref": "#/definitions/reservationRoutingCriteria" } ] } @@ -3628,7 +3638,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -3641,7 +3651,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" } @@ -3692,126 +3702,11 @@ "tags": [ "Reservation" ] - } - }, - "/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/shares": { - "get": { - "summary": "Get share Reservations", - "description": "This API can be used to retrieve the share reservations that exist on a reservation.OperationId:getShareReservationsByExtId
", - "operationId": "getShareReservationsByExtId", - "parameters": [ - { - "name": "reservationExternalId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "External reservation ID." - }, - { - "name": "externalSystemCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." - }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel where reservation is searched based on external reservation ID." - }, - { - "$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 the fetch share reservation request. This returns all sharer reservations including the request reservation.", - "schema": { - "$ref": "#/definitions/shareReservations" - } - }, - "204": { - "description": "ShareReservationsByExtId 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" - ] }, - "post": { - "summary": "Combine Share Reservations", - "description": "Combine share reservation for a given reservation idOperationId:postCombineShareReservationsByExtId
", - "operationId": "postCombineShareReservationsByExtId", + "put": { + "summary": "Change routing instructions", + "description": "Change routing instructions on an existing reservation.OperationId:putRoutingInstructionsByExtId
", + "operationId": "putRoutingInstructionsByExtId", "parameters": [ { "name": "reservationExternalId", @@ -3841,14 +3736,14 @@ "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, { - "name": "combineShareReservations", + "name": "routingInstructionsInfo", "in": "body", "required": true, - "description": "Request to combine sharer reservations. This request requires a Reservation Name Id(Joining to) and a Joining Reservation Id", + "description": "Request when changing a routing instruction.", "schema": { "allOf": [ { - "$ref": "#/definitions/combineShareReservations" + "$ref": "#/definitions/routingInstructionsInfo" } ] } @@ -3870,7 +3765,7 @@ } ], "responses": { - "201": { + "200": { "headers": { "Content-Language": { "type": "string", @@ -3883,9 +3778,9 @@ "description": "Location of newly created resource" } }, - "description": "Response for the combine share reservation request. Based on the request, this will return all sharer reservations including the request reservation.", + "description": "Response Body.", "schema": { - "$ref": "#/definitions/combineShareReservationsDetails" + "$ref": "#/definitions/status" } }, "400": { @@ -3934,11 +3829,13 @@ "tags": [ "Reservation" ] - }, - "delete": { - "summary": "Separate share Reservations", - "description": "This API can be used to separate the share reservations.OperationId:deleteShareReservationByExtId
", - "operationId": "deleteShareReservationByExtId", + } + }, + "/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/shares": { + "get": { + "summary": "Get share Reservations", + "description": "This API can be used to retrieve the share reservations that exist on a reservation.OperationId:getShareReservationsByExtId
", + "operationId": "getShareReservationsByExtId", "parameters": [ { "name": "reservationExternalId", @@ -3965,35 +3862,275 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of the hotel where reservation is searched based on reservation ID." - }, - { - "name": "overrideInventoryCheck", - "in": "query", - "required": false, - "description": "Indicate to Override the Room Inventory Check if applicable.", - "type": "boolean" - }, - { - "name": "overrideMaxOccupancyCheck", - "in": "query", - "required": false, - "description": "Indicate to Override the check on Maximum Room Occupancy if applicable.", - "type": "boolean" - }, - { - "name": "overrideRateAvailabilityCheck", - "in": "query", - "required": false, - "description": "Indicate to Override the check on Maximum Room Occupancy if applicable.", - "type": "boolean" - }, - { - "name": "returnShareReservations", - "in": "query", - "required": false, - "description": "After the break share operation, return the new list of Sharer Reservations.", - "type": "boolean" + "description": "Unique ID of the hotel where reservation is searched based on external reservation ID." + }, + { + "$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 the fetch share reservation request. This returns all sharer reservations including the request reservation.", + "schema": { + "$ref": "#/definitions/shareReservations" + } + }, + "204": { + "description": "ShareReservationsByExtId 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" + ] + }, + "post": { + "summary": "Combine Share Reservations", + "description": "Combine share reservation for a given reservation idOperationId:postCombineShareReservationsByExtId
", + "operationId": "postCombineShareReservationsByExtId", + "parameters": [ + { + "name": "reservationExternalId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "External reservation ID." + }, + { + "name": "externalSystemCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel where reservation is searched based on reservation ID." + }, + { + "name": "combineShareReservations", + "in": "body", + "required": true, + "description": "Request to combine sharer reservations. This request requires a Reservation Name Id(Joining to) and a Joining Reservation Id", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/combineShareReservations" + } + ] + } + }, + { + "$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": "Response for the combine share reservation request. Based on the request, this will return all sharer reservations including the request reservation.", + "schema": { + "$ref": "#/definitions/combineShareReservationsDetails" + } + }, + "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" + ] + }, + "delete": { + "summary": "Separate share Reservations", + "description": "This API can be used to separate the share reservations.OperationId:deleteShareReservationByExtId
", + "operationId": "deleteShareReservationByExtId", + "parameters": [ + { + "name": "reservationExternalId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "External reservation ID." + }, + { + "name": "externalSystemCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel where reservation is searched based on reservation ID." + }, + { + "name": "overrideInventoryCheck", + "in": "query", + "required": false, + "description": "Indicate to Override the Room Inventory Check if applicable.", + "type": "boolean" + }, + { + "name": "overrideMaxOccupancyCheck", + "in": "query", + "required": false, + "description": "Indicate to Override the check on Maximum Room Occupancy if applicable.", + "type": "boolean" + }, + { + "name": "overrideRateAvailabilityCheck", + "in": "query", + "required": false, + "description": "Indicate to Override the check on Maximum Room Occupancy if applicable.", + "type": "boolean" + }, + { + "name": "returnShareReservations", + "in": "query", + "required": false, + "description": "After the break share operation, return the new list of Sharer Reservations.", + "type": "boolean" }, { "$ref": "#/parameters/authKey" @@ -4192,7 +4329,7 @@ "/hotels/{hotelId}/guestMessages": { "get": { "summary": "Get guest messages", - "description": "Get guest messages which exist on a reservation.OperationId:getGuestMessages
", + "description": "Get guest messages which exist on a reservation.OperationId:getGuestMessages
The maximum allowable limit for this API is 100.
", "operationId": "getGuestMessages", "parameters": [ { @@ -5055,7 +5192,7 @@ "/hotels/{hotelId}/profiles/{profileIdtoShare}/share": { "get": { "summary": "Get Reservations to share ", - "description": "Get Reservations to share by profile id.OperationId:getReservationsToShareByProfileId
", + "description": "Get Reservations to share by profile id.OperationId:getReservationsToShareByProfileId
The maximum allowable limit for this API is 100.
", "operationId": "getReservationsToShareByProfileId", "parameters": [ { @@ -5831,6 +5968,13 @@ }, "required": false }, + { + "name": "reservationsWithMembershipType", + "in": "query", + "required": false, + "description": "When set to true, only reservations with a membership belonging to the specified membership type will be returned", + "type": "boolean" + }, { "name": "surname", "in": "query", @@ -6195,7 +6339,7 @@ "in": "query", "type": "array", "collectionFormat": "multi", - "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.", + "description": "Instruction on which elements of the reservation are to be fetched. Instructions are cumulative i.e. additional elements would be added, but not duplicated.", "uniqueItems": true, "items": { "type": "string", @@ -6432,6 +6576,21 @@ "description": "Use the Number of Days For Settlement, defined for the Reservation.", "type": "boolean" }, + { + "name": "daysSinceLastAutoSettled", + "in": "query", + "required": false, + "description": "Use the Number of days since last auto settled.", + "type": "number" + }, + { + "name": "dateSinceLastAutoSettled", + "in": "query", + "required": false, + "description": "Use the Date since last auto settled.", + "type": "string", + "format": "date" + }, { "name": "excludePseudoRoomReservations", "in": "query", @@ -6821,6 +6980,13 @@ "Pending" ] }, + { + "name": "excludeBackToBackReservations", + "in": "query", + "required": false, + "description": "When this flag is set to true, it will exclude the linked reservations which are marked as Back to Back in the result. Marking reservations as Back to Back is available when the Back to Back Handling for Linked Reservations OPERA control is active.", + "type": "boolean" + }, { "$ref": "#/parameters/authKey" }, @@ -8964,7 +9130,7 @@ "/hotels/{hotelId}/reservations/{reservationIdtoShare}/share": { "get": { "summary": "Get Reservations to share by Reservation id", - "description": "Fetch the reservation that can be shared with an existing reservation.OperationId:getReservationsToShareByReservationId
", + "description": "Fetch the reservation that can be shared with an existing reservation.OperationId:getReservationsToShareByReservationId
The maximum allowable limit for this API is 100.
", "operationId": "getReservationsToShareByReservationId", "parameters": [ { @@ -9319,7 +9485,7 @@ "in": "query", "type": "array", "collectionFormat": "multi", - "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.", + "description": "Instruction on which of the reservation's elements are to be returned e.g. DailySummary will return summarized information for each day of the reservation. Instructions are cumulative i.e. if multiple instructions are sent in a request, then the combined reservation elements would be returned, elements will not be duplicated in the response.", "uniqueItems": true, "items": { "type": "string", @@ -9369,7 +9535,9 @@ "AccompanyingGuestMembership", "AccompanyingGuestRelationship", "Voucher", - "ScheduledRoomMoves" + "ScheduledRoomMoves", + "DailySummary", + "RateInfoDetails" ] }, "required": false @@ -9630,168 +9798,170 @@ }, { "example": { - "reservations": { - "sourceOfSale": { - "sourceType": "PMS", - "sourceCode": "HOTEL1" - }, - "roomStay": { - "roomRates": [ - { - "total": { - "amountBeforeTax": "120" - }, - "rates": { - "rate": [ - { - "base": { - "amountBeforeTax": "120", - "currencyCode": "USD" - }, - "shareDistributionInstruction": "Full", - "total": { - "amountBeforeTax": "120" - }, - "start": "2021-02-27", - "end": "2021-02-27" - } - ] - }, - "guestCounts": { - "adults": "1", - "children": "0" - }, - "roomType": "STDK", - "ratePlanCode": "IHUBFAST", - "start": "2021-02-27", - "end": "2021-02-27", - "suppressRate": false, - "marketCode": "CORP", - "marketCodeDescription": "Group Corporate", - "sourceCode": "REF", - "sourceCodeDescription": "Referral", - "numberOfUnits": "1", - "pseudoRoom": false, - "roomTypeCharged": "STDK", - "houseUseOnly": false, - "complimentary": false, - "fixedRate": false, - "discountAllowed": false, - "bogoDiscount": false - } - ], - "guestCounts": { - "adults": "1", - "children": "0" - }, - "arrivalDate": "2021-02-27", - "departureDate": "2021-02-28", - "guarantee": { - "guaranteeCode": "GDED", - "shortDescription": "Group Deduct" + "reservations": [ + { + "sourceOfSale": { + "sourceType": "PMS", + "sourceCode": "HOTEL1" }, - "total": { - "amountBeforeTax": "120", - "amountAfterTax": "121" + "roomStay": { + "roomRates": [ + { + "total": { + "amountBeforeTax": "120" + }, + "rates": { + "rate": [ + { + "base": { + "amountBeforeTax": "120", + "currencyCode": "USD" + }, + "shareDistributionInstruction": "Full", + "total": { + "amountBeforeTax": "120" + }, + "start": "2021-02-27", + "end": "2021-02-27" + } + ] + }, + "guestCounts": { + "adults": "1", + "children": "0" + }, + "roomType": "STDK", + "ratePlanCode": "IHUBFAST", + "start": "2021-02-27", + "end": "2021-02-27", + "suppressRate": false, + "marketCode": "CORP", + "marketCodeDescription": "Group Corporate", + "sourceCode": "REF", + "sourceCodeDescription": "Referral", + "numberOfUnits": "1", + "pseudoRoom": false, + "roomTypeCharged": "STDK", + "houseUseOnly": false, + "complimentary": false, + "fixedRate": false, + "discountAllowed": false, + "bogoDiscount": false + } + ], + "guestCounts": { + "adults": "1", + "children": "0" + }, + "arrivalDate": "2021-02-27", + "departureDate": "2021-02-28", + "guarantee": { + "guaranteeCode": "GDED", + "shortDescription": "Group Deduct" + }, + "total": { + "amountBeforeTax": "120", + "amountAfterTax": "121" + }, + "roomNumberLocked": false, + "printRate": false, + "remoteCheckInAllowed": false, + "bookingMedium": "PMS", + "bookingMediumDescription": "PMS Channel" }, - "roomNumberLocked": false, - "printRate": false, - "remoteCheckInAllowed": false, - "bookingMedium": "PMS", - "bookingMediumDescription": "PMS Channel" - }, - "reservationGuests": { - "reservationGuest": [ - { - "profileInfo": { - "profileIdList": [ - { - "id": "687128", - "type": "Profile" + "reservationGuests": { + "reservationGuest": [ + { + "profileInfo": { + "profileIdList": [ + { + "id": "687128", + "type": "Profile" + } + ], + "profile": { + "customer": { + "personName": [ + { + "givenName": "Sam", + "surname": "Jones", + "nameTitle": "Mr", + "nameType": "Primary" + }, + { + "nameType": "External" + } + ], + "language": "E", + "vipStatus": "GOLD", + "vipDescription": "Gold Level" + }, + "profileType": "Guest" } - ], - "profile": { - "customer": { - "personName": [ - { - "givenName": "Sam", - "surname": "Jones", - "nameTitle": "Mr", - "nameType": "Primary" - }, - { - "nameType": "External" - } - ], - "language": "E", - "vipStatus": "GOLD", - "vipDescription": "Gold Level" + }, + "primary": true + } + ] + }, + "comments": { + "commentInfo": [ + { + "comment": { + "text": { + "value": "The guest will be a late arrival" }, - "profileType": "Guest" - } - }, - "primary": true - } - ] - }, - "comments": { - "commentInfo": [ - { - "comment": { - "text": { - "value": "The guest will be a late arrival" + "commentTitle": "InHouse Comment", + "notificationLocation": "PROPDFLT", + "type": "RESERVATION", + "internal": false }, - "commentTitle": "InHouse Comment", - "notificationLocation": "PROPDFLT", - "type": "RESERVATION", - "internal": false + "id": "120303", + "type": "Comment" }, - "id": "120303", - "type": "Comment" - }, - { - "comment": { - "text": { - "value": "reservation comments" + { + "comment": { + "text": { + "value": "reservation comments" + }, + "commentTitle": "No Change To Reservation Comment", + "notificationLocation": "GEN", + "type": "RESERVATION", + "internal": false }, - "commentTitle": "No Change To Reservation Comment", - "notificationLocation": "GEN", - "type": "RESERVATION", - "internal": false + "id": "120304", + "type": "Comment" }, - "id": "120304", - "type": "Comment" - }, - { - "comment": { - "text": { - "value": "New Cashier Comment" - }, - "commentTitle": "New Cashier Comment", - "notificationLocation": "Note1", - "type": "CASHIER", - "internal": false + { + "comment": { + "text": { + "value": "New Cashier Comment" + }, + "commentTitle": "New Cashier Comment", + "notificationLocation": "Note1", + "type": "CASHIER", + "internal": false + } } - } - ] - }, - "hotelId": "HOTEL1", - "roomStayReservation": true, - "reservationStatus": "Reserved", - "computedReservationStatus": "DueIn", - "walkIn": false, - "printRate": false, - "createBusinessDate": "2021-02-27", - "preRegistered": false, - "upgradeEligible": false, - "allowAutoCheckin": false, - "hasOpenFolio": false, - "allowMobileCheckout": false, - "allowMobileViewFolio": false, - "allowPreRegistration": false, - "optedForCommunication": false, - "chargeCardNumber": "5904606" - } + ] + }, + "hotelId": "HOTEL1", + "roomStayReservation": true, + "reservationStatus": "Reserved", + "computedReservationStatus": "DueIn", + "walkIn": false, + "printRate": false, + "createBusinessDate": "2021-02-27", + "preRegistered": false, + "upgradeEligible": false, + "allowAutoCheckin": false, + "hasOpenFolio": false, + "allowMobileCheckout": false, + "allowMobileViewFolio": false, + "allowPreRegistration": false, + "optedForCommunication": false, + "chargeCardNumber": "5904606" + } + ] } } ] @@ -9983,6 +10153,124 @@ ] } }, + "/hotels/{hotelId}/reservations/{reservationId}/addOnReservationPackages": { + "put": { + "summary": "Update Add On (Sell Separate) packages on a reservation.", + "description": "This API will allow you to update Add On (Sell Separate) packages on a reservation. Note: this API works as a full overlay for Reservation's Add On Packages.OperationId:putAddOnReservationPackages
", + "operationId": "putAddOnReservationPackages", + "parameters": [ + { + "name": "reservationId", + "in": "path", + "required": true, + "type": "number", + "description": "Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Unique ID of the hotel where reservation is searched based on reservation ID." + }, + { + "name": "reservationAddOnPackages", + "in": "body", + "required": true, + "description": "Request object to overlay addon packages on an existing reservation.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/reservationAddOnPackagesType" + } + ] + } + }, + { + "$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/addOnReservationPackagesType" + } + }, + "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/{reservationId}/alerts": { "get": { "summary": "Fetch Alert Notices", @@ -10586,7 +10874,7 @@ "/hotels/{hotelId}/reservations/{reservationId}/cancellationHistory": { "get": { "summary": "Get cancellation history", - "description": "Get cancellation history for a reservation.OperationId:getCancellationHistory
", + "description": "Get cancellation history for a reservation.OperationId:getCancellationHistory
This API allows a time span of 30 days.
", "operationId": "getCancellationHistory", "parameters": [ { @@ -14845,6 +15133,13 @@ }, "required": false }, + { + "name": "backToBackOnly", + "in": "query", + "required": false, + "description": "Indicates that only reservations marked as Back to Back should be expected in the result. Returned linked Back to Back reservations will belong to the same group of linked Back to Back reservations as the specified reservation with the given reservation name id and hotel code.", + "type": "boolean" + }, { "$ref": "#/parameters/authKey" }, @@ -16288,11 +16583,236 @@ "tags": [ "Reservation" ] - }, + }, + "put": { + "summary": "Update a package on a Reservation", + "description": "This API will allow you to update existing packages on a reservation.OperationId:putReservationPackage
", + "operationId": "putReservationPackage", + "parameters": [ + { + "name": "reservationId", + "in": "path", + "required": true, + "type": "string", + "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." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel where reservation is searched based on reservation ID." + }, + { + "name": "reservationPackagesInfo", + "in": "body", + "required": true, + "description": "Method to change/modify a reservation package on an existing reservation. The main information required are the Package Code, Resort, RateCode(if applicable), Original Begin Date(if applicable) and Original End Date(if applicable). These are the criteria by which the package will be identified in order to be modified/changed. The elements that can be changed are the Quantity, Excluded Quantity, Unit Price and Unit Allowance if existing. For RateCode packages, the begin date and end date cannot be changed. For non-RateCode packages, the begin date or end date can be changed.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/reservationPackagesInfo" + } + ] + } + }, + { + "$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/reservationPackagesInfo" + } + }, + "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" + ] + }, + "delete": { + "summary": "Delete a package from a Reservation", + "description": "This API will allow you to delete packages from a reservation.OperationId:deleteReservationPackage
", + "operationId": "deleteReservationPackage", + "parameters": [ + { + "name": "reservationId", + "in": "path", + "required": true, + "type": "string", + "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." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel where reservation is searched based on reservation ID." + }, + { + "$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": [ + "Reservation" + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/payeeSharer": { "put": { - "summary": "Update a package on a Reservation", - "description": "This API will allow you to update existing packages on a reservation.OperationId:putReservationPackage
", - "operationId": "putReservationPackage", + "summary": "Update Payee Sharer Information by ID.", + "description": "Use this API to mark or un mark a shared reservation as the payee sharer for the group of shared reservations.OperationId:putPayeeSharer
", + "operationId": "putPayeeSharer", "parameters": [ { "name": "reservationId", @@ -16313,14 +16833,14 @@ "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, { - "name": "reservationPackagesInfo", + "name": "changePayeeSharer", "in": "body", "required": true, - "description": "Method to change/modify a reservation package on an existing reservation. The main information required are the Package Code, Resort, RateCode(if applicable), Original Begin Date(if applicable) and Original End Date(if applicable). These are the criteria by which the package will be identified in order to be modified/changed. The elements that can be changed are the Quantity, Excluded Quantity, Unit Price and Unit Allowance if existing. For RateCode packages, the begin date and end date cannot be changed. For non-RateCode packages, the begin date or end date can be changed.", + "description": "Request object to to mark or unmark the payee sharer information.", "schema": { "allOf": [ { - "$ref": "#/definitions/reservationPackagesInfo" + "$ref": "#/definitions/changePayeeSharerType" } ] } @@ -16341,111 +16861,6 @@ "$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/reservationPackagesInfo" - } - }, - "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" - ] - }, - "delete": { - "summary": "Delete a package from a Reservation", - "description": "This API will allow you to delete packages from a reservation.OperationId:deleteReservationPackage
", - "operationId": "deleteReservationPackage", - "parameters": [ - { - "name": "reservationId", - "in": "path", - "required": true, - "type": "string", - "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." - }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel where reservation is searched based on reservation ID." - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" - }, - { - "$ref": "#/parameters/x-hotelid" - }, - { - "$ref": "#/parameters/x-externalsystem" - }, - { - "$ref": "#/parameters/Accept-Language" - } - ], "responses": { "200": { "headers": { @@ -18377,7 +18792,7 @@ "/hotels/{hotelId}/reservations/{reservationId}/routingInstructions": { "get": { "summary": "Get routing instructions", - "description": "Use this API to fetch a reservation's routing instructions. It requires a reservation ID, which can be fetched using getReservations.OperationId:getRoutingInstructions
", + "description": "Use this API to fetch a reservation's routing instructions. It requires a reservation ID, which can be fetched using getReservations.OperationId:getRoutingInstructions
The maximum allowable limit for this API is 20.
", "operationId": "getRoutingInstructions", "parameters": [ { @@ -18858,6 +19273,134 @@ ] } }, + "/hotels/{hotelId}/reservations/{reservationId}/scheduledRoomMoves/{scheduledMoveDate}": { + "put": { + "summary": "Update Scheduled Room Move Details based on reservationID and move date", + "description": "Use this to update an existing scheduled room move for a reservation in a hotel and for a specific date. Use this to update move comments, move time etc.OperationId:putScheduledRoomMove
", + "operationId": "putScheduledRoomMove", + "parameters": [ + { + "name": "reservationId", + "in": "path", + "type": "string", + "required": true, + "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." + }, + { + "name": "hotelId", + "in": "path", + "description": "Property code of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20, + "required": true + }, + { + "name": "scheduledMoveDate", + "in": "path", + "type": "string", + "description": "The scheduled date of room move.", + "format": "date", + "required": true + }, + { + "name": "scheduledRoomMoveDetails", + "in": "body", + "required": true, + "description": "Request method to change a scheduled room move details.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/scheduledRoomMoveDetails" + } + ] + } + }, + { + "$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/scheduledRoomMoveDetails" + } + }, + "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/{reservationId}/shareRateAmount": { "put": { "summary": "Change Share Rate Amount", @@ -21798,6 +22341,20 @@ "description": "If 'Y', then filter room results to only connecting rooms.", "type": "string" }, + { + "name": "backToBackOnly", + "in": "query", + "required": false, + "description": "Indicates that only reservations marked as Back to Back should be expected in the result.", + "type": "boolean" + }, + { + "name": "scheduledRoomMoveOnly", + "in": "query", + "required": false, + "description": "Indicates that only reservations having scheduled room moves should be expected in the result.", + "type": "boolean" + }, { "name": "dueOut", "in": "query", @@ -22007,6 +22564,13 @@ }, "required": false }, + { + "name": "showRoomMoveSegments", + "in": "query", + "required": false, + "description": "If set to true then reservations having past or future room moves will come according to the exact stay dates in the rooms.", + "type": "boolean" + }, { "$ref": "#/parameters/authKey" }, @@ -23061,7 +23625,7 @@ "/hotels/{hotelId}/upgradeEligibleReservations": { "get": { "summary": "Fetch Reservations Eligible for an Upgrade", - "description": "You can use this API to fetch Reservations Eligible for an Upgrade.OperationId:getUpgradeEligibilityReservations
", + "description": "You can use this API to fetch Reservations Eligible for an Upgrade.OperationId:getUpgradeEligibilityReservations
This API allows a time span of 30 days.
", "operationId": "getUpgradeEligibilityReservations", "parameters": [ { @@ -23726,6 +24290,13 @@ }, "required": false }, + { + "name": "reservationsWithMembershipType", + "in": "query", + "required": false, + "description": "When set to true, only reservations with a membership belonging to the specified membership type will be returned", + "type": "boolean" + }, { "name": "surname", "in": "query", @@ -24067,7 +24638,7 @@ "in": "query", "type": "array", "collectionFormat": "multi", - "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.", + "description": "Instruction on which of the reservation's elements are to be returned. Instructions are cumulative i.e. if multiple instructions are sent in a request, then the combined reservation elements would be returned, elements will not be duplicated in the response.", "uniqueItems": true, "items": { "type": "string", @@ -26877,8 +27448,7 @@ "statisticDate": { "description": "Date of statistics.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "blockStats": { "description": "Collection of block statistics.", @@ -27619,8 +28189,7 @@ "date": { "description": "Date when reservation was last cancelled.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -27672,8 +28241,7 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "reservationStatus": { "description": "Indicates the status of the reservation.", @@ -27789,6 +28357,10 @@ "description": "The Original Time Span covers the Room Stay dates of the original reservation.", "$ref": "#/definitions/timeSpanType" }, + "bookingTimeSpan": { + "description": "The booking time span of the reservation, only applicable when time increments are being used.", + "$ref": "#/definitions/bookingTimeSpanType" + }, "expectedTimes": { "description": "The expected arrival, return and departure times of the guest.", "$ref": "#/definitions/resExpectedTimesType" @@ -27952,6 +28524,16 @@ "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" + }, + "scheduledRoomMoveResponseType": { + "description": "Scheduled Room Move Response Information.", + "$ref": "#/definitions/scheduledRoomMoveResponseType" + }, + "backToBackGroupId": { + "description": "This attribute represents a common identifier for a subgroup of linked reservations marked as Back to Back in a group of linked reservations.", + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, @@ -27961,13 +28543,11 @@ "properties": { "startDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "endDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "duration": { "type": "string" @@ -28140,8 +28720,7 @@ "birthDate": { "description": "Date of birth", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "language": { "description": "Language identification.", @@ -28439,8 +29018,7 @@ "lastStayDate": { "description": "Guest's last stay date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "lastStayRoom": { "description": "Room Number where the guest stayed.", @@ -28659,8 +29237,7 @@ "expirationDate": { "description": "Expiration date of the credit card", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "expirationDateMasked": { "description": "Masked Expiration date of the credit card", @@ -29009,13 +29586,11 @@ "properties": { "startDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "endDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "duration": { "type": "string" @@ -29045,8 +29620,7 @@ "queueDate": { "description": "The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -29125,14 +29699,13 @@ "$ref": "#/definitions/resCompAccountingType" }, "reservationPreConfiguredRoutingInstruction": { - "description": "Information regarding the selected preconfigured routing instruction on the reservation.", + "description": "Information regarding the selected preconfigured routing instruction on the reservation. This will be used when Multiple Promotion Code Comp Routings is inactive.", "$ref": "#/definitions/resPreConfiguredRoutingInstrType" }, "lastRoomAndTaxPostedDate": { "description": "Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "reverseCheckInAllowed": { "description": "This attribute is to verify if reverse check-in is allowed for the reservation.", @@ -29145,6 +29718,10 @@ "transactionsPosted": { "description": "Specifies whether reservation has a financial transaction associated with it.", "type": "boolean" + }, + "reservationPreConfiguredRoutingInstructions": { + "description": "Information regarding the selected preconfigured routing instructions on the reservation. This will be used when Multiple Promotion Code Comp Routings is active.", + "$ref": "#/definitions/reservationPreConfiguredRoutingInstructionsType" } } }, @@ -29353,6 +29930,10 @@ "description": "End Date for attached Routing Instruction.", "type": "string", "format": "date" + }, + "folioView": { + "description": "Folio Window.", + "type": "integer" } } }, @@ -29416,14 +29997,12 @@ "dueDate": { "description": "Deposit Due Date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "postingDate": { "description": "Deposit Posting Date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "hasPaid": { "description": "Resolves whether reservation has paid deposit.", @@ -29941,8 +30520,7 @@ "date": { "description": "Date on which the award details like points required and penalty points are applicable.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "pointsRequired": { "description": "Points required for the award detail date.", @@ -30049,8 +30627,7 @@ "expirationDate": { "description": "Expiration Date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "gift": { "description": "Signifies whether award is gift or not.", @@ -30129,8 +30706,7 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -30467,8 +31043,7 @@ "date": { "description": "Date when reservation was last cancelled.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -30625,20 +31200,17 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "createBusinessDate": { "description": "Business Date when the reservation was created.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "reinstateDate": { "description": "Business Date when the reservation was last reinstated.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "party": { "description": "Party/PartyCode when reservation is part of a party(a small group).", @@ -30775,6 +31347,20 @@ "routeAllTransactionsToShare": { "description": "Indicates if this joining reservation should route all transactions to the 'Share To' reservation when including Share Reservations Instructions.", "type": "boolean" + }, + "backToBackGroupId": { + "description": "This attribute represents a common identifier for a subgroup of linked reservations marked as Back to Back in a group of linked reservations.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "overrideSharesStayingPastDepartureCheck": { + "description": "Indicates to override the check on shared reservations to whom changes can be propagated until their departure date.", + "type": "boolean" + }, + "trxCodesInfo": { + "description": "Summary of Transaction codes information which are related to reservation.", + "$ref": "#/definitions/trxCodesInfoType" } } }, @@ -30808,6 +31394,10 @@ "type": "string", "format": "date" }, + "bookingTimeSpan": { + "description": "The booking time span of the reservation, only applicable when time increments are being used.", + "$ref": "#/definitions/bookingTimeSpanType" + }, "reservationKeyInfo": { "description": "Holds the room key information provided by the Door Lock System.", "$ref": "#/definitions/reservationKeyInfoType" @@ -31042,14 +31632,16 @@ "start": { "description": "The starting value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" + }, + "rateIncludesTax": { + "description": "Indicates if the calculated amount for the day is inclusive of tax.", + "type": "boolean" }, "suppressRate": { "type": "boolean" @@ -31198,7 +31790,11 @@ "maxLength": 2000 }, "amountBeforeTax": { - "description": "The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).", + "description": "The total amount does not include any associated tax (e.g., sales tax, VAT, GST or any associated tax), if the amount is Tax Exclusive. However, it does Include Taxes if it is marked as Tax Inclusive.", + "type": "number" + }, + "amountBeforeAnyTax": { + "description": "The total amount per room does not include any associated tax (e.g., sales tax, VAT, GST or any associated tax), for both Tax Exclusive/Inclusive.", "type": "number" }, "amountAfterTax": { @@ -31234,6 +31830,14 @@ "baseAmount": { "description": "The rate's base price. Amount excluding price for any add to rate combine line package attached to the rate.Also excludes any discounts", "type": "number" + }, + "amountBeforeTaxPerRoom": { + "description": "The total amount per room not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).", + "type": "number" + }, + "amountAfterTaxPerRoom": { + "description": "The total amount per room including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).", + "type": "number" } } }, @@ -31253,6 +31857,10 @@ "description": "A monetary amount.", "type": "number" }, + "totalTax": { + "description": "A sum of the taxes which are related to Rate Info.", + "type": "number" + }, "currencyCode": { "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", "type": "string", @@ -31280,6 +31888,12 @@ "minLength": 0, "maxLength": 20 }, + "generateTransactionCode": { + "description": "Unique identifier for Generate Tax Transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, "amount": { "description": "A monetary amount.", "type": "number" @@ -31351,14 +31965,12 @@ "start": { "description": "The starting value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -31423,13 +32035,11 @@ }, "startDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "endDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "packageCode": { "type": "string" @@ -31937,8 +32547,7 @@ "birthDate": { "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "birthDateMasked": { "description": "Indicates the date of birth as masked.", @@ -32114,8 +32723,7 @@ "issuedDate": { "description": "Issued date of Identification.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "issuedPlace": { "description": "The place where Identification was issued.", @@ -32126,8 +32734,7 @@ "expirationDate": { "description": "Expiration date of Identification.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "registeredProperty": { "description": "Property where the identification belongs to.", @@ -32490,8 +33097,7 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "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.", @@ -32792,20 +33398,17 @@ "signupDate": { "description": "Indicates when the member signed up for the loyalty program.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "effectiveDate": { "description": "Indicates the starting date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "expireDate": { "description": "Indicates the ending date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "expireDateExclusiveIndicator": { "description": "When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).", @@ -33756,8 +34359,7 @@ "value": { "description": "Value of user defined field.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "alternateName": { "description": "Label of user defined field used by vendors or customers.", @@ -33797,8 +34399,7 @@ "expiryDate": { "description": "Date of expiry.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "profileId": { "description": "NameId.", @@ -33822,8 +34423,7 @@ "issueDate": { "description": "Date when certificate was issued.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -33964,8 +34564,7 @@ "date": { "description": "Date the certificate was consumed.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "userName": { "description": "Application user who created the consumption.", @@ -34036,14 +34635,12 @@ "startDate": { "description": "Start Date of the room ownership record.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "endDate": { "description": "End Date of the room ownership record.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "profileId": { "description": "Profile ID of the room ownership record.", @@ -34234,8 +34831,7 @@ "upsellDate": { "description": "The date on which reservation is upgraded.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "upsellUser": { "description": "User who upgraded the reservation.", @@ -34304,6 +34900,10 @@ "type": "string", "minLength": 0, "maxLength": 40 + }, + "attachDetachType": { + "description": "Attach and Detach information for accompanying guest profile.", + "$ref": "#/definitions/attachDetachType" } } }, @@ -34408,6 +35008,12 @@ "minLength": 0, "maxLength": 20 }, + "otaTaxType": { + "description": "Open Travel Alliance(OTA) tax type for the given Transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, "hotelId": { "description": "Hotel context of the Transaction code.", "type": "string", @@ -34494,13 +35100,11 @@ "properties": { "visaIssueDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "visaExpiryDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "visaNumber": { "type": "string", @@ -34521,8 +35125,7 @@ "dateOfEntry": { "description": "Entry Date into the country. (Croatian Requirements).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "nextDestination": { "description": "Entry Date into the country. (Croatian Requirements).", @@ -34539,7 +35142,7 @@ "$ref": "#/definitions/guestLastStayInfoType" }, "purposeOfStay": { - "description": "Purpose of stay.", + "description": "Purpose of stay. This is field is mandatory for putReservation/postReservation Request when the Advanced Daily Details functionality is not active. When Advanced Daily Details is active, if a value is sent in the roomRateType object then it will take precedence over this value.", "type": "string", "minLength": 0, "maxLength": 20 @@ -34605,8 +35208,7 @@ }, "followUpDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "description": { "type": "string", @@ -34765,18 +35367,15 @@ }, "expiryDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "disabledUntil": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "passwordChangeDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "userInfo": { "$ref": "#/definitions/employeeInfoType" @@ -34820,8 +35419,7 @@ "birthDate": { "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "birthDateMasked": { "description": "Indicates the date of birth as masked.", @@ -34834,13 +35432,11 @@ "properties": { "businessDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "systemDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "terminal": { "type": "string" @@ -35019,8 +35615,7 @@ }, "businessDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "logUserId": { "type": "integer" @@ -35080,14 +35675,12 @@ "start": { "description": "The starting value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -35195,8 +35788,7 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -35535,8 +36127,7 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "giftCard": { "description": "Indicates a gift card type.", @@ -35587,14 +36178,12 @@ "startDate": { "description": "Required value when changing a reservation package. If the original start date was null, then null is required.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "endDate": { "description": "Required value when changing a reservation package. If the original end date was null, then null is required.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "packageGroup": { "description": "Package group code. If this package is part of a package group, the group code is indicated here. This is a required element and is part of the key to fetch the correct package record .", @@ -35666,14 +36255,12 @@ "beginSellDate": { "description": "Indicates the begin sell date of the package.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "endSellDate": { "description": "Indicates the end sell date of the package.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -36009,8 +36596,7 @@ "consumptionDate": { "description": "The date the package was used or can be used.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "unitPrice": { "description": "The price per unit of the package.", @@ -36031,8 +36617,7 @@ "reservationDate": { "description": "The date of the Reservation when this package is applicable. This can be different from the date the package will be consumed. Example are next day packages. Reservation date is when the package is applied to the guest and Consumption date is when the guest can consume the package.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "originalUnitPrice": { "description": "The original price per unit of the package if it has been changed.", @@ -36049,7 +36634,7 @@ "description": "Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.", "properties": { "defaultQuantity": { - "description": "The default quantity attached in the package.", + "description": "Quantity of packages to be attached i.e. the multiplier to be applied against the calculation rule to determine the total quantity of the packages.", "type": "integer" }, "excludedQuantity": { @@ -36057,7 +36642,7 @@ "type": "integer" }, "totalQuantity": { - "description": "The total quantity of the package, calculated based on the calculation rule as defined in the PackageHeaderType.", + "description": "The total quantity of the package, calculated based on the calculation rule as defined in the PackageHeaderType and defaultQuantity.", "type": "integer" }, "allowanceConsumed": { @@ -36452,20 +37037,17 @@ "signupDate": { "description": "Indicates when the member signed up for the loyalty program.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "effectiveDate": { "description": "Indicates the starting date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "expireDate": { "description": "Indicates the ending date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "expireDateExclusiveIndicator": { "description": "When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).", @@ -36500,8 +37082,7 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -36653,20 +37234,17 @@ "signupDate": { "description": "Indicates when the member signed up for the loyalty program.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "effectiveDate": { "description": "Indicates the starting date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "expireDate": { "description": "Indicates the ending date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "expireDateExclusiveIndicator": { "description": "When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15 the last date of the period is Oct 14).", @@ -36701,8 +37279,7 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "linkMembership": { "type": "boolean" @@ -37297,8 +37874,7 @@ "transactionDate": { "description": "Transaction Date associated with the deposit policy", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "depositReqReversed": { "description": "Flag to indicate if deposit policy is reversed", @@ -37481,6 +38057,16 @@ "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" + }, + "shared": { + "description": "This attribute indicates if the linked reservation is a shared reservation or not.", + "type": "boolean" + }, + "backToBackGroupId": { + "description": "This attribute represents a common identifier for a subgroup of linked reservations marked as Back to Back in a group of linked reservations.", + "type": "string", + "minLength": 0, + "maxLength": 80 } } }, @@ -37694,8 +38280,7 @@ "lastStayDate": { "description": "Last stay date at the property.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "totalStay": { "description": "Holds total number of days that the guest have stayed in the property.", @@ -37724,8 +38309,7 @@ "birthDate": { "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "birthDateMasked": { "description": "Indicates the date of birth as masked.", @@ -37873,8 +38457,7 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -37908,8 +38491,7 @@ "resolvedOn": { "description": "Date the trace was resolved", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "resolvedBy": { "description": "User that resolved the trace", @@ -38216,14 +38798,12 @@ "start": { "description": "The starting value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "frequency": { "description": "Frequency of a fixed charge.", @@ -38238,8 +38818,7 @@ "dateToExecute": { "description": "Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -38486,8 +39065,7 @@ "date": { "description": "The date when the override was done.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "type": { "description": "The type of override done. If done for Availability, then it will be AVAILABILITY.", @@ -38764,8 +39342,7 @@ "date": { "description": "Daily details Date about when the rules are posted or diverted.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -38808,8 +39385,7 @@ "issueDate": { "description": "Tickets issue date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "price": { "description": "Tickets price.", @@ -38818,8 +39394,7 @@ "consumptionDate": { "description": "Tickets comsumption date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "rateCode": { "description": "The Rate Code to which tickets belong to.", @@ -39075,8 +39650,7 @@ "date": { "description": "Contains Custom Charge Exemption date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "quantity": { "description": "Contains number of Custom Charge Exemption for a day.", @@ -39106,8 +39680,7 @@ "date": { "description": "Contains exclusion date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "reason": { "description": "Contains reason for exclusion.", @@ -39198,7 +39771,8 @@ "CustomNameValue", "CustomChargeExemptions", "FiscalInfo", - "ScheduledRoomMoves" + "ScheduledRoomMoves", + "DailySummary" ] }, "reservationsInstructionsType": { @@ -39358,14 +39932,12 @@ "start": { "description": "The starting value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -40054,8 +40626,7 @@ "date": { "description": "Date when reservation was last cancelled.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -40216,20 +40787,17 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "createBusinessDate": { "description": "Business Date when the reservation was created.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "reinstateDate": { "description": "Business Date when the reservation was last reinstated.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "party": { "description": "Party/PartyCode when reservation is part of a party(a small group).", @@ -40399,6 +40967,10 @@ }, "facilitySchedulerOption": { "$ref": "#/definitions/facilitySchedulerOptionType" + }, + "applyUntilLastShareDepartureDate": { + "description": "Indicates whether the chosen changes will be made not only to overlapping dates of share reservations but also to non-overlapping dates after the departure date of the edited reservation. When false or omitted the chosen changes are applied only to overlapping dates of share reservations.", + "type": "boolean" } } }, @@ -40702,8 +41274,7 @@ "lastPrivacyPromptDate": { "description": "Last Privacy Prompt Date", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "displayColor": { "description": "Color setting of the reservation.", @@ -40804,8 +41375,7 @@ "date": { "description": "Date when reservation was last cancelled.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -40857,8 +41427,7 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "reservationStatus": { "description": "Indicates the status of the reservation.", @@ -41156,8 +41725,7 @@ }, "cxlDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "userId": { "type": "number" @@ -41237,14 +41805,12 @@ "start": { "description": "The starting value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -41842,8 +42408,7 @@ "deliveryDate": { "description": "Delivery Date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "createDateTime": { "description": "Time stamp of the creation.", @@ -41870,8 +42435,7 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -42013,8 +42577,7 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -42168,8 +42731,7 @@ "createdOn": { "description": "This is the time when the record was locked.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "timeToLive": { "description": "This is the validity of the lock in seconds.", @@ -42178,8 +42740,7 @@ "expiresOn": { "description": "This is the estimated expiry time of the lock.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "internal": { "description": "Notification flag to specify if the lock is based on an Internal Opera9 lock versus an External lock.", @@ -42223,8 +42784,7 @@ "arrivalDate": { "description": "Arrival Date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "membershipId": { "description": "Membership Card number.", @@ -42443,8 +43003,7 @@ "detailDate": { "description": "This field is only required when the criteria is meant for a detailed results. The date for the rate detail is needed.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "blockId": { "description": "Block Id for which the rate info has to be fetched.", @@ -42615,14 +43174,12 @@ "start": { "description": "The starting value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "hasSuppressedRate": { "description": "Whether suppressed rate is present or not.", @@ -42636,8 +43193,7 @@ "summaryDate": { "description": "Stay date for which revenue calculation is done.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "revenue": { "description": "Base Amount of rate.", @@ -42668,8 +43224,7 @@ "revenueSimulationDate": { "description": "Date revenue calculation is based on.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "currencyCode": { "description": "Currency revenue calculation is based on.", @@ -43705,14 +44260,12 @@ "startDate": { "description": "The date of the reservation stay.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "endDate": { "description": "The date of the reservation stay. If the same details need to be applied to a date range of the stay, then the Start Date and End Date would specify the range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "commissionCode": { "description": "The Commission Code used for the reservation.", @@ -44431,8 +44984,7 @@ "date": { "description": "Date when reservation was last cancelled.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -44593,20 +45145,17 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "createBusinessDate": { "description": "Business Date when the reservation was created.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "reinstateDate": { "description": "Business Date when the reservation was last reinstated.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "party": { "description": "Party/PartyCode when reservation is part of a party(a small group).", @@ -44933,14 +45482,12 @@ "purgeDate": { "description": "Date an item will be purged from a database (e.g., from a live database to an archive).", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "createBusinessDate": { "description": "Business Date when the reservation was created.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -45058,6 +45605,10 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "retainRateCodeAndAmount": { + "description": "If true, it indicates that rate codes and amounts for different days of the source reservation will be moved to target reservation. When false or null that means available rate codes from target property is used and will be part of REST request already.", + "type": "boolean" } } }, @@ -45543,14 +46094,12 @@ "start": { "description": "The starting value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "end": { "description": "The ending value of the date range.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -46094,8 +46643,7 @@ "date": { "description": "Reservation date", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "requiredAmount": { "description": "Amount / number of points required to upgrade", @@ -46355,6 +46903,10 @@ "description": "Room Move History for the reservation.", "$ref": "#/definitions/roomMoveDetailsType" }, + "scheduledRoomMove": { + "description": "Information related to the room moves scheduled for a reservation .", + "$ref": "#/definitions/scheduledRoomMoveDetailType" + }, "reservationStatus": { "description": "Indicates the Actual status of the reservation.", "$ref": "#/definitions/pMS_ResStatusType" @@ -46363,6 +46915,10 @@ "description": "Indicates whether the reservation has any linked reservation.", "$ref": "#/definitions/linkedReservationType" }, + "backToBackReservation": { + "description": "This attribute indicates if the linked reservation is marked as Back to Back or not.", + "type": "boolean" + }, "assignedByAI": { "description": "Indicates whether the room was assigned by AI Room Assignment.", "type": "boolean" @@ -46875,8 +47431,7 @@ "accessDate": { "description": "The date the record was accessed.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" } } }, @@ -46979,8 +47534,7 @@ }, "businessDate": { "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "dailyPaceStats": { "description": "Contains the statistical data.", @@ -47006,8 +47560,7 @@ "consideredDate": { "description": "The day to which the information belongs.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "rooms": { "description": "Number of rooms reserved.", @@ -47085,8 +47638,7 @@ "fiscalDate": { "description": "Hotel fiscal date for statistics.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "reportCode": { "description": "Identifies the type of statistics collected. Each ReportCode corresponds to a set of category summaries based upon a predetermined agreement.", @@ -47163,8 +47715,7 @@ "statisticDate": { "description": "Date of the statistic.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "weekendDate": { "description": "Determines whether statistic date is a weekend date.", @@ -47377,8 +47928,7 @@ "beginDate": { "description": "This is the Begin date for the configured SellMessage.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "url": { "description": "URL that identifies the location associated with the record identified by the UniqueID.", @@ -47821,26 +48371,22 @@ "arrivalDate": { "description": "Date of arrival.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "departureDate": { "description": "Date of departure.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "cancelledOn": { "description": "Date when reservation(s) was cancelled.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "folioClosedOn": { "description": "Date when folio was closed.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "createDateTime": { "description": "Date when reservation(s) was created.", @@ -48284,6 +48830,14 @@ "description": "Guest Last Name /Surname on reservation when room status is occupied.", "minLength": 0, "maxLength": 40 + }, + "roomStatus": { + "description": "Room status", + "$ref": "#/definitions/housekeepingRoomStatusType" + }, + "reservationIdList": { + "description": "A list of Ids for reservation( ResvNameId and ConfirmationNumber).", + "$ref": "#/definitions/uniqueIDListType" } } }, @@ -48321,7 +48875,8 @@ }, "estimatedMoveTime": { "type": "string", - "description": "Estimated Move Time in 24Hour Format" + "description": "Estimated Move Time.", + "format": "date-time" }, "moveOutRoomId": { "type": "string", @@ -48334,6 +48889,10 @@ "description": "Scheduled Move Out Room Type.", "minLength": 0, "maxLength": 20 + }, + "moveOutRoomStatus": { + "description": "Scheduled Move Out Room Status.", + "$ref": "#/definitions/housekeepingRoomStatusType" } } }, @@ -48394,14 +48953,12 @@ "arrivalDate": { "description": "Arrival Date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "departureDate": { "description": "Departure Date.", "type": "string", - "format": "date", - "maxLength": 8 + "format": "date" }, "creationDate": { "description": "Creation Date.", @@ -48491,6 +49048,277 @@ "$ref": "#/definitions/warningsType" } } + }, + "bookingTimeSpanType": { + "type": "object", + "description": "The booking time span of the reservation, only applicable when time increments are being used.", + "properties": { + "startDateTime": { + "type": "string", + "description": "The start time of the reservation booking", + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "description": "The end time of the reservation booking", + "format": "date-time" + } + } + }, + "changePayeeSharerType": { + "description": "Request object to to mark or unmark the payee sharer information.", + "type": "object", + "properties": { + "shareReservation": { + "description": "Information of the Shared reservation to be updated.", + "$ref": "#/definitions/payeeSharerInfoType" + } + } + }, + "payeeSharerInfoType": { + "description": "Holds the information to mark or unmark a shared reservation as a payee sharer.", + "type": "object", + "properties": { + "reservationId": { + "description": "Unique identifier of the reservation.", + "$ref": "#/definitions/uniqueID_Type" + }, + "hotelId": { + "description": "Property code of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "payeeSharer": { + "description": "This attribute indicates if the Shared reservation is marked as the Payee Sharer or not.", + "type": "boolean" + } + } + }, + "addOnReservationPackageType": { + "type": "object", + "description": "AddOn ReservationPackageType class.", + "properties": { + "scheduleList": { + "description": "A HotelPackageSchedule type.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationPackageScheduleType" + } + }, + "consumptionDetails": { + "description": "Package consumption details. Includes information for quantity , allowance etc.", + "$ref": "#/definitions/packageConsumptionType" + }, + "packageCode": { + "description": "Package code. This is the unique code used for the package and is a required element.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "internalId": { + "description": "Reservation Package Opera Internal Unique Id. This is the unique Id used for this reservation package.", + "type": "number" + }, + "startDate": { + "description": "Package begin date.", + "type": "string", + "format": "date" + }, + "endDate": { + "description": "Package End Date.", + "type": "string", + "format": "date" + }, + "packageGroup": { + "description": "Package group code. Package group code is used to link multiple packages that are members of a group.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "source": { + "description": "Indicates if the source of the product is Rate header, Rate Detail or Reservation. For new development this field is to be used for passing the product scource", + "$ref": "#/definitions/productSourceType" + }, + "awardCode": { + "description": "This is the Award code used to redeem the package if the package is a redemption package.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "points": { + "description": "Indicates the points used to redeem the redemption package.", + "type": "integer" + }, + "calculationRule": { + "description": "The price calculation rule for this package.", + "$ref": "#/definitions/packageCalculationRuleType" + } + } + }, + "reservationAddOnPackagesType": { + "type": "object", + "description": "A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.", + "properties": { + "reservationPackages": { + "description": "A Service object represents a package provided to guests. Service packages may have associated inventory and charges.", + "type": "array", + "items": { + "$ref": "#/definitions/addOnReservationPackageType" + } + }, + "overridePackageConfiguration": { + "default": true, + "type": "boolean", + "description": "Indicates if scheduleList and calculationRule provided in this request should override package configuration. When overridePackageConfiguration is true the scheduleList is mandatory." + }, + "overrideInventoryItemAvailabilty": { + "default": false, + "type": "boolean", + "description": "Indicates if Availablity should be overriden when an Inventory Item based on a package is not available." + } + } + }, + "addOnReservationPackagesType": { + "type": "object", + "description": "A collection of Reservation packages.", + "properties": { + "reservationId": { + "description": "Unique identifier of the reservation.", + "$ref": "#/definitions/uniqueID_Type" + }, + "hotelId": { + "description": "Property code of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "reservationPackages": { + "description": "A Service object represents a package provided to guests. Service packages may have associated inventory and charges.", + "type": "array", + "items": { + "$ref": "#/definitions/reservationPackageType" + } + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "reservationPreConfiguredRoutingInstructionsType": { + "type": "object", + "properties": { + "consumableInventory": { + "description": "List of default routing instructions.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/resPreConfiguredRoutingInstrType" + } + } + } + }, + "scheduledRoomMoveResponseType": { + "description": "Scheduled Room Move information.", + "type": "object", + "properties": { + "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", + "format": "date-time" + } + } + }, + "scheduledRoomMoveDetails": { + "description": "Details regarding a specific scheduled room move.", + "type": "object", + "properties": { + "moveComments": { + "type": "string", + "description": "Comments about scheduled move.", + "minLength": 0, + "maxLength": 200 + }, + "scheduledMoveTime": { + "type": "string", + "description": "The scheduled time of room move.", + "format": "date-time" + } + } + }, + "scheduledRoomMoveDetailType": { + "type": "object", + "description": "Scheduled room move information.", + "properties": { + "scheduledRoomMoveFrom": { + "description": "Indicates if the reservation is scheduled to be moved from a room", + "$ref": "#/definitions/scheduleRoomMoveType" + }, + "scheduledRoomMoveTo": { + "description": "Indicates if the reservation is scheduled to be moved to a room", + "$ref": "#/definitions/scheduleRoomMoveType" + } + } + }, + "scheduleRoomMoveType": { + "type": "object", + "description": "Type of room move scheduled either from or to information", + "properties": { + "scheduleRoomMoveStatus": { + "description": "Indicates if the reservation is scheduled to be moved from or to a room.", + "$ref": "#/definitions/scheduledRoomMoveStatusType" + }, + "scheduleRoomMoveDate": { + "description": "Business date on which room is scheduled to be moved from or to another room.", + "type": "string", + "format": "date" + }, + "scheduleMoveRoomNumber": { + "description": "Room to which guest is scheduled to be moved.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "scheduledMoveTime": { + "type": "string", + "description": "The scheduled time of room move.", + "format": "date-time" + } + } + }, + "attachDetachType": { + "type": "object", + "description": "This type contains attach and detach information for accompanying guest profile.", + "properties": { + "attachDateTime": { + "description": "Time stamp the accompanying guest was last attached.", + "type": "string", + "format": "date-time" + }, + "detachDateTime": { + "description": "Time stamp the accompanying guest was last detached.", + "type": "string", + "format": "date-time" + }, + "detached": { + "description": "This attribute indicates if the accompanying guest is marked as detached or attached.", + "type": "boolean" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/rsvasync.json b/rest-api-specs/property/rsvasync.json index 80576e4..02e6e64 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
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", + "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
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.4", "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 ed6386f..869074b 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.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", + "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.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -9704,7 +9704,7 @@ "/hotels/{hotelId}/guestMessages": { "get": { "summary": "Get Guest Messages", - "description": "You can use this API to get Guest Messages.OperationId:getGuestMessages
", + "description": "You can use this API to get Guest Messages.OperationId:getGuestMessages
The maximum allowable limit for this API is 100.
", "operationId": "getGuestMessages", "parameters": [ { @@ -18403,7 +18403,7 @@ "/marketGroupTemplates": { "get": { "summary": "Get Market Group Templates", - "description": "Use this API to get Market Group Templates.OperationId:getTemplateMarketGroups
", + "description": "Use this API to get Market Group Templates.OperationId:getTemplateMarketGroups
The maximum allowable limit for this API is _.
", "operationId": "getTemplateMarketGroups", "parameters": [ { @@ -23913,6 +23913,9 @@ "displaySequence": { "description": "Sequence for alert template.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -24563,6 +24566,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -24677,6 +24683,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -24753,6 +24762,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -24829,6 +24841,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -25414,6 +25429,9 @@ "items": { "$ref": "#/definitions/advancedDiscountRuleType" } + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -25598,6 +25616,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -25678,6 +25699,9 @@ "inactive": { "description": "Determines whether this code is inactive or not.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -26255,6 +26279,9 @@ "displaySequence": { "description": "Sequence for guest message template.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -26307,6 +26334,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -27002,6 +27032,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -27092,6 +27125,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -27177,6 +27213,9 @@ "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -27299,6 +27338,9 @@ "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28307,6 +28349,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28427,6 +28472,9 @@ "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28540,6 +28588,9 @@ "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -28714,6 +28765,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29351,6 +29405,9 @@ "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29481,6 +29538,9 @@ "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29627,6 +29687,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29703,6 +29766,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -29779,6 +29845,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -30042,6 +30111,9 @@ "inactive": { "description": "Indicates whether the locator code is active or not", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -30140,6 +30212,9 @@ "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -30257,6 +30332,9 @@ "central": { "description": "Indicates if market code is originated from Central.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -30415,6 +30493,9 @@ "canDelete": { "description": "Determines whether this TurnAway code can be deleted.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -30459,6 +30540,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -30535,6 +30619,9 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -30569,6 +30656,16 @@ "$ref": "#/definitions/warningsType" } } + }, + "managedByOptions": { + "description": "Describes of the Configuration is Managed by Enterprise or Property.", + "type": "string", + "enum": [ + "EnterpriseManaged", + "PropertyManaged", + "EnterpriseEnforced", + "PropertyOverridden" + ] } }, "tags": [ diff --git a/rest-api-specs/property/rtp.json b/rest-api-specs/property/rtp.json index 81d0f41..7485ea1 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.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", + "description": "APIs to cater for Rate Availability functionality in OPERA Cloud.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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -452,7 +452,7 @@ "/hotels/{hotelId}/bestavailablerates": { "get": { "summary": "Fetch Best Available Rates", - "description": "This API allows to fetch Best Available rates for rate code(s).OperationId:getBestAvailableRates
", + "description": "This API allows to fetch Best Available rates for rate code(s).OperationId:getBestAvailableRates
The maximum allowable limit for this API is 500.
This API allows a time span of 90 days.
", "operationId": "getBestAvailableRates", "parameters": [ { @@ -1564,7 +1564,7 @@ "/hotels/{hotelId}/negotiatedRates": { "get": { "summary": "Get negotiated rates and profiles ", - "description": "This API allows you to fetch negotiated rates and profile for a given hotel id.OperationId:getNegotiatedRates
", + "description": "This API allows you to fetch negotiated rates and profile for a given hotel id.OperationId:getNegotiatedRates
The maximum allowable limit for this API is 500.
This API allows a time span of 90 days.
", "operationId": "getNegotiatedRates", "parameters": [ { @@ -2053,7 +2053,7 @@ "/hotels/{hotelId}/negotiatedRates/{rateCode}/profiles": { "get": { "summary": "Fetch Negotiated Rates", - "description": "This API allows you to fetch a Rate Plan and Profile for given hotel id and negotiated rate code.OperationId:getNegotiatedRatesForGivenHotelAndRate
", + "description": "This API allows you to fetch a Rate Plan and Profile for given hotel id and negotiated rate code.OperationId:getNegotiatedRatesForGivenHotelAndRate
The maximum allowable limit for this API is 500.
This API allows a time span of 90 days.
", "operationId": "getNegotiatedRatesForGivenHotelAndRate", "parameters": [ { @@ -2211,7 +2211,7 @@ "/hotels/{hotelId}/packageForecastGroups": { "get": { "summary": "Get Hotel Package Forecast Groups", - "description": "This API allows you to fetch package forecast groups.OperationId:getHotelPackageForecastGroups
", + "description": "This API allows you to fetch package forecast groups.OperationId:getHotelPackageForecastGroups
The maximum allowable limit for this API is 1000.
", "operationId": "getHotelPackageForecastGroups", "parameters": [ { @@ -3138,7 +3138,7 @@ "/hotels/{hotelId}/packageGroups": { "get": { "summary": "Get package groups", - "description": "This API allows you to fetch package group.OperationId:getPackageGroups
", + "description": "This API allows you to fetch package group.OperationId:getPackageGroups
The maximum allowable limit for this API is 1000.
", "operationId": "getPackageGroups", "parameters": [ { @@ -4058,7 +4058,7 @@ "/hotels/{hotelId}/packages/{packageCode}/rates": { "get": { "summary": "Get package rates", - "description": "This API allows you to fetch rate plan codes associated for a package.OperationId:getPackageRates
", + "description": "This API allows you to fetch rate plan codes associated for a package.OperationId:getPackageRates
The maximum allowable limit for this API is 1000.
", "operationId": "getPackageRates", "parameters": [ { @@ -4296,7 +4296,7 @@ "/hotels/{hotelId}/promotionCodes": { "get": { "summary": "Get promotion codes", - "description": "This API allows you to fetch promotion codes.OperationId:getPromotionCodes
", + "description": "This API allows you to fetch promotion codes.OperationId:getPromotionCodes
The maximum allowable limit for this API is 1000.
", "operationId": "getPromotionCodes", "parameters": [ { @@ -4687,7 +4687,7 @@ "/hotels/{hotelId}/promotionGroups": { "get": { "summary": "Get promotion groups", - "description": "This API allows you to fetch promotion codes.OperationId:getPromotionGroups
", + "description": "This API allows you to fetch promotion codes.OperationId:getPromotionGroups
The maximum allowable limit for this API is 1000.
", "operationId": "getPromotionGroups", "parameters": [ { @@ -5401,7 +5401,7 @@ }, "delete": { "summary": "Delete rate access exclusions", - "description": "This API allows you to delete rate access exclusions.OperationId:deleteRateAccessExclusions
", + "description": "This API allows you to delete rate access exclusions.OperationId:deleteRateAccessExclusions
This API allows a time span of 90 days.
", "operationId": "deleteRateAccessExclusions", "parameters": [ { @@ -6069,7 +6069,7 @@ "/hotels/{hotelId}/rateClasses": { "get": { "summary": "Get rate classes", - "description": "Use this API to get rate classes.OperationId:getRateClass
", + "description": "Use this API to get rate classes.OperationId:getRateClass
The maximum allowable limit for this API is 1000.
", "operationId": "getRateClass", "parameters": [ { @@ -9733,6 +9733,126 @@ ] } }, + "/hotels/{hotelId}/ratePlans/{ratePlanCode}/schedules/set": { + "put": { + "summary": "Set rate plan schedules", + "description": "This API allows you to set Rate Plan schedules.OperationId:setRatePlanSchedules
", + "operationId": "setRatePlanSchedules", + "parameters": [ + { + "name": "ratePlanCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Rate Plan Code." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID that identifies a single hotel property." + }, + { + "name": "ratePlanSchedules", + "in": "body", + "required": true, + "description": "Request object to set rate plan schedules.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/ratePlanSchedulesToSet" + } + ] + } + }, + { + "$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": [ + "RatePlan" + ] + } + }, "/hotels/{hotelId}/ratePlans/{ratePlanCode}/sourceTiers/{sourceTierId}/destinationTiers/{destinationTierId}/schedules/copy": { "put": { "summary": "Copy tiered rate schedules", @@ -9874,7 +9994,7 @@ "/hotels/{hotelId}/rateSeasons": { "get": { "summary": "Get Hotel Rate Seasons", - "description": "Use this API to get Hotel Rate Seasons.OperationId:getRateSeasons
", + "description": "Use this API to get Hotel Rate Seasons.OperationId:getRateSeasons
The maximum allowable limit for this API is 1000.
", "operationId": "getRateSeasons", "parameters": [ { @@ -10343,7 +10463,7 @@ "/hotels/{hotelId}/rateStrategies": { "get": { "summary": "Get rate strategies", - "description": "This API allows you to fetch rate strategies.OperationId:getRateStrategies
", + "description": "This API allows you to fetch rate strategies.OperationId:getRateStrategies
The maximum allowable limit for this API is 1000.
", "operationId": "getRateStrategies", "parameters": [ { @@ -10797,7 +10917,7 @@ "/hotels/{hotelId}/rates/activityLog": { "get": { "summary": "Get rate activity log", - "description": "This API allows you to fetch Rate Activity Log.OperationId:getRateActivityLog
", + "description": "This API allows you to fetch Rate Activity Log.OperationId:getRateActivityLog
The maximum allowable limit for this API is 500.
This API allows a time span of 90 days.
", "operationId": "getRateActivityLog", "parameters": [ { @@ -11346,7 +11466,7 @@ "/hotels/{hotelId}/yieldAdjustments": { "get": { "summary": "Get yield adjustments", - "description": "This API allows you to fetch yield adjustments.OperationId:getYieldAdjustments
", + "description": "This API allows you to fetch yield adjustments.OperationId:getYieldAdjustments
The maximum allowable limit for this API is 1000.
", "operationId": "getYieldAdjustments", "parameters": [ { @@ -12210,7 +12330,7 @@ "/profiles/{profileId}/negotiatedRates": { "get": { "summary": "Get negotiated rate details for given profile", - "description": "This API allows you to fetch negotiated Rates for a given profile.OperationId:getNegotiatedRatesForGivenProfile
", + "description": "This API allows you to fetch negotiated Rates for a given profile.OperationId:getNegotiatedRatesForGivenProfile
The maximum allowable limit for this API is 500.
This API allows a time span of 90 days.
", "operationId": "getNegotiatedRatesForGivenProfile", "parameters": [ { @@ -12385,7 +12505,7 @@ "/promotionCodes": { "get": { "summary": "Get Template Promotion Codes", - "description": "This API allows you to fetch Promotion Code template.OperationId:getTemplatePromotionCodes
", + "description": "This API allows you to fetch Promotion Code template.OperationId:getTemplatePromotionCodes
The maximum allowable limit for this API is 1000.
", "operationId": "getTemplatePromotionCodes", "parameters": [ { @@ -14617,6 +14737,9 @@ "protected": { "description": "Determines whether this code is protected from deleting and making inactive", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -15591,6 +15714,12 @@ "maximumAge": { "description": "Maximum age for age bucket.", "type": "integer" + }, + "bucketLabel": { + "description": "Guest age label configured for the bucket when Guest Age Categories OPERA Control is active.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, @@ -16007,6 +16136,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -16274,6 +16406,9 @@ "description": "Flag to configure the package as Award Package so they can be redeemed for points on a reservation", "type": "boolean" }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" + }, "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" @@ -16359,6 +16494,10 @@ "description": "Package is marked as an allowance, in case charge is expected back to the guest account from external interface eg. POS. which need to be offset against a consumption allowance.", "type": "boolean" }, + "packageAllowanceValidUntilEOD": { + "description": "For the Packages with allowance, the allowance will remain available past check out for a reservation until End of Day; else the Package Profit / Loss will be posted upon Check Out.", + "type": "boolean" + }, "currency": { "description": "The currency code for this package.", "type": "string", @@ -17175,6 +17314,9 @@ "discountAllowed": { "description": "Indicates whether the rate plan is allowed to be discounted.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -17394,6 +17536,14 @@ "description": "Routing fetchInstructions item which is uniquely identified by its Time Span.", "$ref": "#/definitions/promoCodeRoutingInstructionType" }, + "promoCodeRoutingInstructions": { + "type": "array", + "description": "Routing fetchInstructions item which is uniquely identified by its Time Span", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/promoCodeRoutingInstructionType" + } + }, "hotelId": { "description": "Hotel code the property promotion code belongs to.", "type": "string", @@ -18306,6 +18456,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -18480,6 +18633,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -19450,6 +19606,9 @@ "floorAmount": { "description": "An amount that act as Floor value for Rate Plan.", "type": "number" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -21404,6 +21563,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -21513,6 +21675,9 @@ "usedInAppSetting": { "description": "Flag to check the package code is used in application setting.", "type": "boolean" + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -21900,6 +22065,9 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "managedBy": { + "$ref": "#/definitions/managedByOptions" } } }, @@ -22069,6 +22237,38 @@ "required": [ "hotelIds" ] + }, + "managedByOptions": { + "description": "Describes of the Configuration is Managed by Enterprise or Property.", + "type": "string", + "enum": [ + "EnterpriseManaged", + "PropertyManaged", + "EnterpriseEnforced", + "PropertyOverridden" + ] + }, + "ratePlanSchedulesToSet": { + "type": "object", + "description": "Request object to set rate plan schedules.", + "properties": { + "hotelId": { + "description": "Hotel Code of the rate plan schedule.", + "$ref": "#/definitions/codeType" + }, + "ratePlanCode": { + "description": "Rate plan code of the rate plan schedule.", + "$ref": "#/definitions/codeType" + }, + "ratePlanScheduleList": { + "description": "List of rate plan schedules to be created / updated.", + "type": "array", + "maxItems": 20, + "items": { + "$ref": "#/definitions/ratePlanScheduleDetailType" + } + } + } } }, "tags": [ diff --git a/rest-api-specs/property/rtpasync.json b/rest-api-specs/property/rtpasync.json index 6d83796..012a9e5 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
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", + "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
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.4", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -1688,6 +1688,16 @@ "type": "string", "format": "date" }, + "rateDateRangeStart": { + "description": "The start date for the range for which the daily rate amounts will be applied.", + "type": "string", + "format": "date" + }, + "rateDateRangeEnd": { + "description": "The end date for the range for which the daily rate amounts will be applied.", + "type": "string", + "format": "date" + }, "ratePlanCode": { "description": "The rate code for which the daily rate amounts will be applied.", "type": "string",