This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.
", - "version": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -406,6 +406,42 @@ }, "204": { "description": "ActivitiesByMultipleHotelIds 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": [ @@ -468,6 +504,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -570,6 +642,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -808,6 +916,42 @@ }, "204": { "description": "Emails 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": [ @@ -888,6 +1032,42 @@ }, "204": { "description": "ActivityWithOutHotelId 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": [ @@ -959,6 +1139,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1030,6 +1246,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1304,6 +1556,42 @@ }, "204": { "description": "Activities 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": [ @@ -1397,6 +1685,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1499,6 +1823,42 @@ }, "204": { "description": "ActivityStatistics 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": [ @@ -1851,6 +2211,42 @@ }, "204": { "description": "Activity 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": [ @@ -1960,6 +2356,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2040,6 +2472,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2141,6 +2609,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2229,6 +2733,42 @@ }, "204": { "description": "ActivityAttachments 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": [ @@ -2309,6 +2849,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2393,6 +2969,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2568,6 +3180,42 @@ }, "204": { "description": "ActivityLog 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": [ @@ -2629,6 +3277,42 @@ }, "204": { "description": "RecentlyAccessedActivities 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": [ @@ -2681,6 +3365,42 @@ }, "204": { "description": "RecentlyAccessedActivitiesWithOutHotelId 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": [ @@ -5422,4 +6142,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/actcfg.json b/rest-api-specs/property/actcfg.json index e97243a..3ad43ab 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -108,6 +108,42 @@ }, "204": { "description": "ActivityResultsConfig not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -172,6 +208,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -234,6 +306,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -307,6 +415,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -410,6 +554,42 @@ }, "204": { "description": "AutoTraceCodes not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -474,6 +654,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -536,6 +752,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -609,6 +861,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -671,6 +959,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -733,6 +1057,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -807,6 +1167,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -882,6 +1278,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -983,6 +1415,42 @@ }, "204": { "description": "ActivityTypes not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1056,6 +1524,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1127,6 +1631,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1209,6 +1749,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1321,6 +1897,42 @@ }, "204": { "description": "AutoTraceDefinitions not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1394,6 +2006,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1478,6 +2126,42 @@ "schema": { "$ref": "#/definitions/autoTraceDefinitionsStatus" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1576,6 +2260,42 @@ }, "204": { "description": "AutoTraceOwnerAssignments not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1649,6 +2369,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1733,6 +2489,42 @@ "schema": { "$ref": "#/definitions/autoTraceOwnerAssignmentsStatus" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3032,4 +3824,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/ars.json b/rest-api-specs/property/ars.json index 5324643..c45ba94 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -115,6 +115,42 @@ }, "204": { "description": "Reminders 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": [ @@ -179,6 +215,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -423,6 +495,42 @@ }, "204": { "description": "Accounts 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": [ @@ -541,6 +649,42 @@ }, "204": { "description": "RemindersHistory 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": [ @@ -1730,6 +1874,42 @@ }, "204": { "description": "Statements 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": [ @@ -1897,6 +2077,42 @@ }, "204": { "description": "ARTransactions 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": [ @@ -1972,6 +2188,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2133,6 +2385,42 @@ }, "204": { "description": "InvoicesOnHold 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": [ @@ -2257,6 +2545,42 @@ }, "204": { "description": "Account 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": [ @@ -2339,6 +2663,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2408,6 +2768,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2491,6 +2887,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2575,6 +3007,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2659,6 +3127,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2743,6 +3247,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2825,6 +3365,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2915,6 +3491,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2999,6 +3611,42 @@ "schema": { "$ref": "#/definitions/compressedARInvoices" } + }, + "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": [ @@ -3083,6 +3731,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3167,6 +3851,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3260,6 +3980,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3338,6 +4094,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3682,6 +4474,42 @@ }, "204": { "description": "ARFolioPrinters 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": [ @@ -3766,6 +4594,42 @@ "schema": { "$ref": "#/definitions/arInvoiceDetails" } + }, + "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": [ @@ -3850,6 +4714,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3934,6 +4834,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4016,6 +4952,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4107,6 +5079,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4221,6 +5229,42 @@ }, "204": { "description": "InvoicePaymentDetail 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": [ @@ -4305,6 +5349,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4366,6 +5446,42 @@ }, "204": { "description": "ARAgingCycles 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": [ @@ -4441,6 +5557,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4516,6 +5668,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4591,6 +5779,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4676,6 +5900,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4772,6 +6032,42 @@ }, "204": { "description": "InvoiceAppliedPayments 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": [ @@ -4885,6 +6181,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4979,6 +6311,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5072,6 +6440,42 @@ "schema": { "$ref": "#/definitions/arPayments" } + }, + "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": [ @@ -5180,6 +6584,42 @@ }, "204": { "description": "StatementsHistory 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": [ @@ -5282,6 +6722,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5368,6 +6844,42 @@ }, "204": { "description": "AppliedInvoicePayments 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": [ @@ -5469,6 +6981,42 @@ }, "204": { "description": "ARCreditCardPayments 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": [ @@ -5572,6 +7120,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5647,6 +7231,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5917,6 +7537,42 @@ }, "204": { "description": "InvoicesPayments 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": [ @@ -6970,6 +8626,42 @@ }, "204": { "description": "InvoicePostings 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": [ @@ -7036,6 +8728,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7102,6 +8830,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7168,6 +8932,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7247,6 +9047,42 @@ }, "204": { "description": "ProfileAging 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": [ @@ -7326,6 +9162,42 @@ }, "204": { "description": "ProfileYearView 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": [ @@ -7392,6 +9264,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8586,6 +10494,42 @@ }, "204": { "description": "ARStatements 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": [ @@ -8652,6 +10596,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8718,6 +10698,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17887,4 +19903,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/blk.json b/rest-api-specs/property/blk.json index bd46eee..6f8495f 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -74,6 +74,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -247,6 +283,42 @@ }, "204": { "description": "BlockActivityLog 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": [ @@ -313,6 +385,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -391,6 +499,42 @@ }, "204": { "description": "BlockWashInfo 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": [ @@ -997,106 +1141,6 @@ "description": "Curency in which the grid rates should be fetched.", "type": "string" }, - { - "name": "customCharUDFsAltname", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Label of user defined field used by vendors or customers.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "customCharUDFsName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "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.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "customCharUDFsValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of user defined field.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "customNumericUDFsAltname", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Label of user defined field used by vendors or customers.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "customNumericUDFsName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of user defined field.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "customNumericUDFsValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of user defined field.", - "items": { - "type": "number" - }, - "required": false - }, - { - "name": "customDateUDFsAltname", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Label of user defined field used by vendors or customers.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "customDateUDFsName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "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.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "customDateUDFsValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of user defined field.", - "items": { - "type": "string", - "format": "date" - }, - "required": false - }, { "name": "accessRestriction", "in": "query", @@ -1148,6 +1192,42 @@ }, "204": { "description": "Blocks 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": [ @@ -1214,6 +1294,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1311,6 +1427,42 @@ }, "204": { "description": "BlockDailyStatistics 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": [ @@ -1716,6 +1868,42 @@ }, "204": { "description": "BlockStats 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": [ @@ -1789,6 +1977,42 @@ }, "204": { "description": "NextBlockStatus 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": [ @@ -1864,6 +2088,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1939,6 +2199,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2012,6 +2308,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2072,6 +2404,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2158,6 +2526,42 @@ }, "204": { "description": "BlockAttachments 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": [ @@ -2229,6 +2633,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2304,6 +2744,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2370,6 +2846,42 @@ }, "204": { "description": "BlockAccessExclusion 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": [ @@ -2486,6 +2998,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2561,6 +3109,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2629,6 +3213,42 @@ }, "204": { "description": "BlockOwners 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": [ @@ -2702,6 +3322,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2762,6 +3418,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2835,6 +3527,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2910,6 +3638,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10771,6 +11535,42 @@ ] } } + }, + "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": [ @@ -14430,6 +15230,42 @@ }, "204": { "description": "BlockReservations 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": [ @@ -14530,6 +15366,42 @@ }, "204": { "description": "BlockRestrictions 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": [ @@ -14603,6 +15475,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14706,6 +15614,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14779,6 +15723,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14890,6 +15870,42 @@ }, "204": { "description": "BlockRevenueChanges 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": [ @@ -14965,6 +15981,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15063,6 +16115,42 @@ }, "204": { "description": "BlockRoomTypes 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": [ @@ -15138,6 +16226,42 @@ "schema": { "$ref": "#/definitions/roomingListDetails" } + }, + "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": [ @@ -15206,6 +16330,42 @@ }, "204": { "description": "BlockRoomsStatus 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": [ @@ -15485,6 +16645,42 @@ }, "204": { "description": "BlockStatistics 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": [ @@ -15596,6 +16792,42 @@ }, "204": { "description": "BlockStatusChanges 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": [ @@ -15671,6 +16903,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15739,6 +17007,42 @@ }, "204": { "description": "BlockWashSchedules 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": [ @@ -15812,6 +17116,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15885,6 +17225,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15945,6 +17321,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16020,6 +17432,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17797,6 +19245,42 @@ ] } } + }, + "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": [ @@ -17863,6 +19347,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17944,6 +19464,42 @@ }, "204": { "description": "DefaultBlockCode 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": [ @@ -18019,6 +19575,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18145,6 +19737,42 @@ }, "204": { "description": "Blocks 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": [ @@ -19142,6 +20770,42 @@ }, "204": { "description": "Block 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": [ @@ -20892,6 +22556,42 @@ ] } } + }, + "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": [ @@ -20961,6 +22661,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21045,6 +22781,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21129,6 +22901,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21204,6 +23012,42 @@ }, "204": { "description": "BlockRangeInfo 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": [ @@ -21381,6 +23225,42 @@ }, "204": { "description": "BlockAvailability 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": [ @@ -21465,6 +23345,161 @@ "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}/cateringRevenue": { + "put": { + "summary": "Recalculate Catering Revenue", + "description": "Use this API to recalculate catering revenue for the business block.OperationId:putCateringRevenue
", + "operationId": "putCateringRevenue", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA." + }, + { + "in": "body", + "name": "cateringRevenueToChange", + "description": "Request object for recalculating the catering revenue for a business block.", + "required": true, + "schema": { + "allOf": [ + { + "$ref": "#/definitions/cateringRevenueToChange" + } + ] + } + }, + { + "$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": [ @@ -21549,6 +23584,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21633,6 +23704,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -25601,6 +27708,42 @@ }, "204": { "description": "BlockPMReservations 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": [ @@ -25685,6 +27828,42 @@ "schema": { "$ref": "#/definitions/rateOverrideStatus" } + }, + "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": [ @@ -25769,6 +27948,42 @@ "schema": { "$ref": "#/definitions/shiftedBlock" } + }, + "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": [ @@ -27556,6 +29771,42 @@ ] } } + }, + "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": [ @@ -27640,6 +29891,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -27837,6 +30124,42 @@ }, "204": { "description": "BlockByExtId 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": [ @@ -27928,6 +30251,42 @@ "schema": { "$ref": "#/definitions/blockChanged" } + }, + "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": [ @@ -28030,6 +30389,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -28077,17 +30472,141 @@ "description": "Hotel Id" }, { - "name": "blockAllocationRange", - "in": "body", - "required": true, - "description": "Request for updating block allocation for a range of dates.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/blockAllocationRange" - } - ] - } + "name": "blockAllocationRange", + "in": "body", + "required": true, + "description": "Request for updating block allocation for a range of dates.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/blockAllocationRange" + } + ] + } + }, + { + "$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}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}/postingMaster/reservations": { + "get": { + "summary": "Get Posting Master Reservations for a Block", + "description": "Use this API to retrieve PM (Posting Master) reservations for a block.OperationId:getBlockPMReservationsByExtId
", + "operationId": "getBlockPMReservationsByExtId", + "parameters": [ + { + "name": "blockExternalId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "External Block 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": "Hotel Id" + }, + { + "name": "postingmaster", + "in": "query", + "default": true, + "required": false, + "description": "If true, a PM reservation will be created for the block if no PM reservations exist.", + "type": "boolean" }, { "$ref": "#/parameters/authKey" @@ -28113,16 +30632,51 @@ "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": "The response object that contains the PM reservations belonging to a block.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/blockPMReservations" } + }, + "204": { + "description": "BlockPMReservationsByExtId 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": [ @@ -28136,11 +30690,11 @@ ] } }, - "/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}/postingMaster/reservations": { - "get": { - "summary": "Get Posting Master Reservations for a Block", - "description": "Use this API to retrieve PM (Posting Master) reservations for a block.OperationId:getBlockPMReservationsByExtId
", - "operationId": "getBlockPMReservationsByExtId", + "/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}/status": { + "put": { + "summary": "Change the Status of a Block", + "description": "Use this to change the status of a block in Opera. To know a hotels Block status codes, use the List Of Values API - BlockStatuses. Also note, you can only change the status in a particular order, for example INQ to DEF, but not DEF to INQ.OperationId:putBlockStatusByExtId
", + "operationId": "putBlockStatusByExtId", "parameters": [ { "name": "blockExternalId", @@ -28167,15 +30721,20 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Hotel Id" + "description": "HotelId" }, { - "name": "postingmaster", - "in": "query", - "default": true, - "required": false, - "description": "If true, a PM reservation will be created for the block if no PM reservations exist.", - "type": "boolean" + "name": "blockStatusToChange", + "in": "body", + "required": true, + "description": "Request object for changing the booking status of the business block.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/blockStatusToChange" + } + ] + } }, { "$ref": "#/parameters/authKey" @@ -28201,15 +30760,52 @@ "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": "The response object that contains the PM reservations belonging to a block.", + "description": "Response object for the request to change block status. Response contains information on the block whose status was successfully changed.", "schema": { - "$ref": "#/definitions/blockPMReservations" + "$ref": "#/definitions/changedBlockStatus" } }, - "204": { - "description": "BlockPMReservationsByExtId 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": [ @@ -28223,11 +30819,11 @@ ] } }, - "/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}/status": { - "put": { - "summary": "Change the Status of a Block", - "description": "Use this to change the status of a block in Opera. To know a hotels Block status codes, use the List Of Values API - BlockStatuses. Also note, you can only change the status in a particular order, for example INQ to DEF, but not DEF to INQ.OperationId:putBlockStatusByExtId
", - "operationId": "putBlockStatusByExtId", + "/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}/subBlocks": { + "post": { + "summary": "Create a sub-Block", + "description": "Use this when you want to create a sub block.You will need to know the OPERA Block ID, which you want this sub block to fall under.OperationId:postSubBlockByExtId
", + "operationId": "postSubBlockByExtId", "parameters": [ { "name": "blockExternalId", @@ -28254,17 +30850,17 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "HotelId" + "description": "Hotel Id" }, { - "name": "blockStatusToChange", + "name": "subBlock", "in": "body", "required": true, - "description": "Request object for changing the booking status of the business block.", + "description": "Request object to create new sub block.", "schema": { "allOf": [ { - "$ref": "#/definitions/blockStatusToChange" + "$ref": "#/definitions/subBlock" } ] } @@ -28286,7 +30882,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -28299,10 +30895,46 @@ "description": "Location of newly created resource" } }, - "description": "Response object for the request to change block status. Response contains information on the block whose status was successfully changed.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/changedBlockStatus" + "$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": [ @@ -28316,48 +30948,39 @@ ] } }, - "/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}/subBlocks": { + "/hotels/{hotelId}/leads/{leadId}/propertyLeads": { "post": { - "summary": "Create a sub-Block", - "description": "Use this when you want to create a sub block.You will need to know the OPERA Block ID, which you want this sub block to fall under.OperationId:postSubBlockByExtId
", - "operationId": "postSubBlockByExtId", + "summary": "Use this API to create Property Leads", + "description": "You would use this request to create property leads for the properties provided. You will need to know the Central Lead ID, which you want the property leads to fall under.OperationId:createPropertyLeads
", + "operationId": "createPropertyLeads", "parameters": [ { - "name": "blockExternalId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "External Block Id" - }, - { - "name": "externalSystemCode", "in": "path", + "name": "hotelId", + "description": "Central Hotel Id", "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." + "maxLength": 2000 }, { - "name": "hotelId", "in": "path", + "name": "leadId", + "description": "Central Lead Id", "required": true, "type": "string", "minLength": 1, - "maxLength": 2000, - "description": "Hotel Id" + "maxLength": 2000 }, { - "name": "subBlock", "in": "body", + "name": "propertyLeads", + "description": "Request object for property leads. This object contains a list of hotel codes for which property leads will be created.", "required": true, - "description": "Request object to create new sub block.", "schema": { "allOf": [ { - "$ref": "#/definitions/subBlock" + "$ref": "#/definitions/propertyLeadsType" } ] } @@ -28396,6 +31019,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -28497,6 +31156,42 @@ }, "204": { "description": "TracesByDateRange 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": [ @@ -28563,6 +31258,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -28629,6 +31360,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -28796,6 +31563,42 @@ }, "204": { "description": "InventoryToBorrow 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": [ @@ -28848,6 +31651,42 @@ }, "204": { "description": "RecentlyAccessedBlocks 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": [ @@ -28911,6 +31750,42 @@ }, "204": { "description": "SalesAllowances 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": [ @@ -52446,6 +55321,48 @@ "type": "integer" } } + }, + "cateringRevenueToChange": { + "type": "object", + "description": "Request object for changing the catering revenue for a business block.", + "properties": { + "eventId": { + "description": "Unique ID on a catering event for which the catering revenue will be recalculated. If empty, all events belonging to the block will be processed.", + "$ref": "#/definitions/eventId" + }, + "expectedRevenue": { + "description": "Indicates if the expected revenue will be corrected.", + "type": "boolean" + }, + "guaranteedRevenue": { + "description": "Indicates if the guaranteed revenue will be corrected.", + "type": "boolean" + }, + "actualRevenue": { + "description": "Indicates if the actual revenue will be corrected.", + "type": "boolean" + }, + "billedRevenue": { + "description": "Indicates if the billed revenue will be corrected.", + "type": "boolean" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "propertyLeadsType": { + "type": "object", + "description": "Request object to create Property Leads.", + "properties": { + "hotelCodeList": { + "description": "List of hotel codes for which property leads will be created.", + "$ref": "#/definitions/hotelCodeListType" + } + } } }, "tags": [ @@ -52462,4 +55379,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/blkasync.json b/rest-api-specs/property/blkasync.json index fed38e5..b701d4b 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -47,6 +47,42 @@ "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" } }, "parameters": [ @@ -150,6 +186,42 @@ } }, "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "parameters": [ @@ -221,6 +293,42 @@ }, "204": { "description": "BlockAllocationSummary 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" } }, "parameters": [ @@ -272,11 +380,377 @@ ] } }, - "/hotels/{hotelId}/blocks/{blockId}/allocation": { + "/hotels/{hotelId}/blocks/{blockId}/allocation": { + "post": { + "summary": "This API facilitates setting Block Allocations for a Hotel.", + "description": "Use this API to add block room type allocations and rates to a specified Block.OperationId:startBlockAllocationProcess
", + "operationId": "startBlockAllocationProcess", + "x-interaction": [ + "async-polling" + ], + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA." + }, + { + "name": "allocation", + "in": "body", + "required": true, + "description": "A Request message that sets the room allocations as a collection of room types and dates.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/allocation" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "202": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of process status resource" + } + }, + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/links" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "BlockAsync" + ] + } + }, + "/hotels/{hotelId}/blocks/{blockId}/allocation/{requestId}": { + "head": { + "summary": "This API returns the status of asynchronous process scheduled for given id.", + "description": "OperationId:getBlockAllocationProcessStatus
", + "operationId": "getBlockAllocationProcessStatus", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA." + }, + { + "name": "requestId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Status": { + "type": "string", + "description": "Status of the requested process.", + "enum": [ + "Processing", + "Invalid" + ] + }, + "Cache-Control": { + "type": "string", + "description": "number of seconds to wait before polling again.", + "x-example": "max-age=10" + } + }, + "description": "Response for status of scheduled asynchronous process." + }, + "201": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Status": { + "type": "string", + "description": "Status of the requested process.", + "enum": [ + "Completed" + ] + }, + "Location": { + "type": "string", + "description": "Location of newly created resource once the status of process run is Complete." + } + }, + "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "BlockAsync" + ] + }, + "get": { + "summary": "This API returns information about the set allocation process.", + "description": "This API will fetch Block allocation warnings for a hotel to allow for overbooking information to be returned as part of the response.OperationId:getBlockAllocationProcessInfo
", + "operationId": "getBlockAllocationProcessInfo", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA." + }, + { + "name": "requestId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + } + }, + "description": "Callback request object for fetched block allocation process information.", + "schema": { + "$ref": "#/definitions/processDetails" + } + }, + "204": { + "description": "BlockAllocationProcessInfo not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "BlockAsync" + ] + } + }, + "/hotels/{hotelId}/blocks/{blockId}/allocationRanges": { "post": { - "summary": "This API facilitates setting Block Allocations for a Hotel.", - "description": "Use this API to add block room type allocations and rates to a specified Block.OperationId:startBlockAllocationProcess
", - "operationId": "startBlockAllocationProcess", + "summary": "This API facilitates setting Block Allocation Ranges for a Hotel.", + "description": "Use this API to set business block allocation for one or more date ranges, which are within business block date range, and for a list of room types.OperationId:startAllocationRangesProcess
", + "operationId": "startAllocationRangesProcess", "x-interaction": [ "async-polling" ], @@ -299,14 +773,14 @@ "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": "allocation", + "name": "allocationRanges", "in": "body", "required": true, - "description": "A Request message that sets the room allocations as a collection of room types and dates.", + "description": "Request for updating block allocations for ranges of dates and list of room types.", "schema": { "allOf": [ { - "$ref": "#/definitions/allocation" + "$ref": "#/definitions/allocationRanges" } ] } @@ -342,6 +816,42 @@ "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": [ @@ -355,11 +865,11 @@ ] } }, - "/hotels/{hotelId}/blocks/{blockId}/allocation/{requestId}": { + "/hotels/{hotelId}/blocks/{blockId}/allocationRanges/{requestId}": { "head": { "summary": "This API returns the status of asynchronous process scheduled for given id.", - "description": "OperationId:getBlockAllocationProcessStatus
", - "operationId": "getBlockAllocationProcessStatus", + "description": "OperationId:getAllocationRangesProcessStatus
", + "operationId": "getAllocationRangesProcessStatus", "parameters": [ { "name": "hotelId", @@ -445,6 +955,42 @@ } }, "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -458,9 +1004,9 @@ ] }, "get": { - "summary": "This API returns information about the set allocation process.", - "description": "This API will fetch Block allocation warnings for a hotel to allow for overbooking information to be returned as part of the response.OperationId:getBlockAllocationProcessInfo
", - "operationId": "getBlockAllocationProcessInfo", + "summary": "This API returns information about the set allocation ranges process.", + "description": "This API will fetch Block allocation ranges warnings for a hotel to allow for overbooking information to be returned as part of the response.OperationId:getAllocationRangesProcessInfo
", + "operationId": "getAllocationRangesProcessInfo", "parameters": [ { "name": "hotelId", @@ -516,7 +1062,43 @@ } }, "204": { - "description": "BlockAllocationProcessInfo not found." + "description": "AllocationRangesProcessInfo 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": [ @@ -970,9 +1552,162 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "blockProfiles": { + "description": "A collection of all the Primary Profiles associated to a this block.", + "type": "object", + "properties": { + "blockProfile": { + "description": "The list of primary profiles associated with the block.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/blockProfilesType" + } + } + } + } + } + }, + "blockProfilesType": { + "type": "object", + "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.", + "$ref": "#/definitions/uniqueIDListType" + }, + "profile": { + "description": "Provides detailed information regarding either a company or a customer profile.", + "$ref": "#/definitions/profileType" + }, + "blockProfileType": { + "description": "Determines the type of the block profile.", + "$ref": "#/definitions/blockProfileTypeType" + } + } + }, + "uniqueIDListType": { + "type": "array", + "description": "Unique Id that references an object uniquely in the system.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "uniqueID_Type": { + "type": "object", + "description": "An identifier used to uniquely reference an object in a system.", + "properties": { + "id": { + "description": "A unique identifying value assigned by the creating system.", + "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": 20 + } + } + }, + "profileType": { + "type": "object", + "description": "Type provides the detailed information about the profile and its children.", + "properties": { + "customer": { + "description": "Detailed customer information for this profile.", + "$ref": "#/definitions/customerType" + }, + "company": { + "description": "Detailed company information for this profile.", + "$ref": "#/definitions/companyType" + }, + "profileType": { + "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", + "$ref": "#/definitions/profileTypeType" + } + } + }, + "customerType": { + "type": "object", + "description": "Contains basic data on the customer's identity.", + "properties": { + "personName": { + "description": "Detailed name information for thecustomer.", + "type": "array", + "maxItems": 5, + "items": { + "$ref": "#/definitions/personNameType" + } } } }, + "profileTypeType": { + "type": "string", + "description": "The types of Profile handled by the web service.", + "enum": [ + "Guest", + "Agent", + "Company", + "Group", + "Source", + "Employee", + "Hotel", + "Vendor", + "Contact", + "Purge", + "BusinessHeader", + "BillingAccount", + "Activity", + "Potential", + "Account" + ] + }, + "personNameType": { + "type": "object", + "description": "This provides name information for a person.", + "properties": { + "givenName": { + "description": "Given name, first name or names.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "surname": { + "description": "Family name, last name.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "companyType": { + "type": "object", + "properties": { + "companyName": { + "description": "Name of the company.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "blockProfileTypeType": { + "type": "string", + "description": "Simple type for block profile types.", + "enum": [ + "Company", + "Group", + "Agent", + "Source", + "CompanyContact", + "AgentContact", + "SourceContact" + ] + }, "roomAllocationDateType": { "type": "object", "properties": { @@ -1052,6 +1787,12 @@ "sellLimit": { "description": "Indicates the sell limit", "type": "integer" + }, + "cutoffDate": { + "description": "Indicates the cutoff date.Date when inventory left in the block will be cut-off.", + "type": "string", + "format": "date", + "maxLength": 8 } } }, @@ -1586,6 +2327,179 @@ "$ref": "#/definitions/warningsType" } } + }, + "allocationType": { + "type": "string", + "description": "Simple type for block allocation used in room rate grid.", + "enum": [ + "Initial", + "Actual", + "Rates", + "Pickup", + "Contract", + "Available", + "Pickupperc", + "Changes", + "Released", + "Houseavailability", + "SellLimit", + "AvailableSellLimit", + "MasterAllocInitial", + "Allocated", + "SubAllocResv", + "CutoffDate", + "ForecastRooms", + "ForecastRates" + ] + }, + "blockRangeModeType": { + "type": "string", + "description": "Enumerates range operation modes.", + "enum": [ + "Core", + "ShoulderStart", + "ShoulderEnd" + ] + }, + "blockAllocationRangeType": { + "type": "object", + "description": "Container for information related to block allocation range update operation", + "properties": { + "blockId": { + "description": "Specifies the Block ID which is the unique identifier for the Block for both internal and external systems.", + "$ref": "#/definitions/blockId" + }, + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomTypes": { + "description": "List of room types for which the range update has to be applied.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "beginDate": { + "description": "Begin date for range update operation.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "endDate": { + "description": "End date for range update operation.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "allocationType": { + "description": "Allocation type for which the range operation is applied.", + "$ref": "#/definitions/allocationType" + }, + "incrementFlag": { + "description": "Flag to indicate if the occupancy data is absolute or relative to the current value.", + "type": "boolean" + }, + "blockInventory": { + "description": "Occupancy data for range operation.", + "$ref": "#/definitions/blockGridInvType" + }, + "blockRates": { + "description": "Rate details for range operation.", + "$ref": "#/definitions/blockGridRatesType" + }, + "cutoffDate": { + "description": "Date after which unused block rooms should be returned to house.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "cutoffDays": { + "description": "Number of days from block start date after which unused block rooms should be returned to house.", + "type": "integer" + }, + "overrideCutoffSchedule": { + "description": "A true value indicates that the cutoff schedule, if added to Business Block, can be overridden.", + "type": "boolean" + }, + "includedDays": { + "type": "string", + "minLength": 0, + "maxLength": 8 + }, + "rangeMode": { + "description": "Indicates whether the range is being applied on shoulder dates or core dates.", + "$ref": "#/definitions/blockRangeModeType" + }, + "overbookList": { + "description": "Date which has to be overbooked or excluded.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "object", + "properties": { + "stayDate": { + "description": "Date which has to be overbooked or excluded.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "roomType": { + "description": "Room type that has to be overbooked or excluded.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "overbook": { + "description": "A true value indicates that the date/room type should be overbooked for inventory. A false value indicates that this combination should be excluded from range.", + "type": "boolean" + } + } + } + }, + "genericRoomType": { + "description": "Indicates if the Allocation objects refer to Generic Room Types (Room Pools).", + "type": "boolean" + } + } + }, + "blockAllocationRanges": { + "type": "object", + "description": "Collection of block allocation ranges.", + "properties": { + "blockAllocationRanges": { + "description": "Collection of Range information for the block allocation ranges operation.", + "type": "array", + "maxItems": 20, + "items": { + "$ref": "#/definitions/blockAllocationRangeType" + } + } + } + }, + "allocationRanges": { + "type": "object", + "description": "Request for setting block allocation for ranges of dates for a list of room types.", + "properties": { + "allocationRanges": { + "description": "Collection of Range information for the block allocation ranges operation.", + "$ref": "#/definitions/blockAllocationRanges" + }, + "genericRoomType": { + "description": "Indicates if the Allocation objects refer to Generic Room Types (Room Pools).", + "type": "boolean" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } } }, "tags": [ @@ -1598,4 +2512,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/blkcfg.json b/rest-api-specs/property/blkcfg.json index ee4b380..dcbecad 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -93,6 +93,42 @@ }, "204": { "description": "BlockCancellationReasons 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": [ @@ -157,6 +193,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -232,6 +304,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -303,6 +411,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -388,6 +532,42 @@ }, "204": { "description": "BlockLostBookingCodes 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": [ @@ -452,6 +632,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -527,6 +743,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -598,6 +850,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -683,6 +971,42 @@ }, "204": { "description": "BlockRateOverrideReasons 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": [ @@ -747,6 +1071,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -822,6 +1182,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -893,6 +1289,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -978,6 +1410,42 @@ }, "204": { "description": "BlockRefusedReasons 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": [ @@ -1042,6 +1510,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1117,6 +1621,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1188,6 +1728,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1251,6 +1827,42 @@ }, "204": { "description": "BlockStatusCodes 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": [ @@ -1315,6 +1927,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1385,6 +2033,42 @@ }, "204": { "description": "NextBlockStatusCodes 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": [ @@ -1447,6 +2131,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1520,6 +2240,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1595,6 +2351,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1680,6 +2472,42 @@ }, "204": { "description": "DestinationCodes 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": [ @@ -1744,6 +2572,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1819,6 +2683,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1890,6 +2790,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1965,6 +2901,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2060,6 +3032,42 @@ }, "204": { "description": "BlockSalesAllowance 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": [ @@ -2180,6 +3188,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2253,6 +3297,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2347,6 +3427,42 @@ }, "204": { "description": "Cutoff Schedule Codes 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": [ @@ -2420,6 +3536,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2503,6 +3655,42 @@ }, "204": { "description": "Cutoff Schedule 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": [ @@ -2583,6 +3771,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2650,6 +3874,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2751,6 +4011,42 @@ }, "204": { "description": "SalesManagers 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": [ @@ -2860,6 +4156,42 @@ }, "204": { "description": "SalesManagerGoals 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": [ @@ -2942,6 +4274,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3035,6 +4403,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3110,6 +4514,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3181,6 +4621,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3263,6 +4739,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3348,6 +4860,42 @@ }, "204": { "description": "ReservationMethods 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": [ @@ -3412,6 +4960,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3487,6 +5071,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3558,6 +5178,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3661,6 +5317,42 @@ }, "204": { "description": "SalesManagersMultipleHotelIds 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": [ @@ -3734,6 +5426,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3843,6 +5571,42 @@ }, "204": { "description": "SalesManagerGoalsMultipleHotelIds 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": [ @@ -3914,6 +5678,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3996,6 +5796,42 @@ }, "204": { "description": "WashSchedule 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": [ @@ -4143,6 +5979,10 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "inactive": { + "description": "Indicates whether the Block Cancellation Reason is inactive or not, returns TRUE when inactive", + "type": "boolean" } } }, @@ -4473,6 +6313,10 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "inactive": { + "description": "Indicates whether the Block Lost Reason is inactive or not, returns TRUE when inactive", + "type": "boolean" } } }, @@ -4625,6 +6469,10 @@ "displayOrder": { "description": "Common Master record sequence number.", "type": "number" + }, + "inactive": { + "description": "Indicates whether the Block Refused Reason is inactive or not, returns TRUE when inactive", + "type": "boolean" } } }, @@ -5593,13 +7441,13 @@ } } }, - "operaVersion": { + "washScheduleDetails": { "type": "object", - "description": "Response for Ping operation.", + "description": "Response object for FetchWashSchedule operation which will contain all the information of 'WashCodes' like Days prior to arrival, Occupancy detail, Sell limit and Wash by percent value if exists.", "properties": { - "operaVersion": { - "description": "Opera version number.", - "$ref": "#/definitions/operaVersionNumberType" + "washCodes": { + "description": "Collection of Block Wash Schedule fetched.", + "$ref": "#/definitions/washCodesType" }, "links": { "$ref": "#/definitions/links" @@ -5609,21 +7457,6 @@ } } }, - "operaVersionNumberType": { - "type": "string", - "description": "Current Opera Version Number", - "minLength": 0, - "maxLength": 40 - }, - "washScheduleDetails": { - "type": "object", - "description": "Cutoff Code Detail for a single entry", - "properties": { - "cutoffCodeDetail": { - "$ref": "#/definitions/cutoffCodeDetail" - } - } - }, "cutoffCodeDetail": { "type": "object", "description": "A representation of the single entry information for cutoff schedule detail.", @@ -5663,6 +7496,194 @@ "$ref": "#/definitions/warningsType" } } + }, + "cutoffScheduleDetails": { + "type": "object", + "description": "Object which will contain all the information of 'CutoffCodes'. ", + "properties": { + "cutoffCodes": { + "type": "array", + "description": "Cutoff Code, which will allow the user to define standard cutoff schedules. 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.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/cutoffCodeType" + } + }, + "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" + } + } + }, + "cutoffCodeCriteria": { + "type": "object", + "description": "Object which will contain all the information of 'CutoffCodes'. ", + "properties": { + "cutoffCodes": { + "type": "array", + "description": "Cutoff Code, which will allow the user to define standard cutoff schedules. 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.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/cutoffCodeType" + } + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "cutoffCodeType": { + "type": "object", + "description": "A representation of the information contained by a Cutoff Code.", + "properties": { + "cutoffCodeDetails": { + "type": "array", + "description": "Detail information of the Cutoff Code.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/cutoffCodeDetailType" + } + }, + "hotelCode": { + "description": "Hotel Code to which the cutoff Code belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "code": { + "description": "Unique Cutoff Schedule Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "id": { + "description": "Unique Cutoff Schedule Code Id", + "type": "integer" + }, + "description": { + "description": "Description of the Cutoff Schedule Code.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "cutoffCodeStartDate": { + "type": "string", + "description": "Cutoff Schedule Code Start Date.", + "format": "date" + }, + "cutoffCodeEndDate": { + "type": "string", + "description": "Cutoff Schedule Code End Date.", + "format": "date" + }, + "defaultDays": { + "description": "Cutoff Schedule Code Default Days. This value will be used if no pre defined schedule exist for a date or room type.", + "type": "integer" + } + } + }, + "cutoffCodeDetailType": { + "type": "object", + "description": "Cutoff Code Detail for a single entry", + "properties": { + "cutoffCodeDetail": { + "$ref": "#/definitions/cutoffCodeDetail" + } + } + }, + "blockCutoffScheduleRangeType": { + "type": "object", + "description": "Object to create block cutoff schedule details by providing date range, room type, days of week and cutoff days.", + "properties": { + "hotelId": { + "description": "Contains Hotel Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "cutoffCodeId": { + "description": "Contains Cutoff Schedule Code Id.", + "type": "integer" + }, + "roomTypes": { + "description": "Contains Room Types.", + "type": "array", + "maxItems": 20, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "cutoffDays": { + "description": "Number of cutoff Days.", + "type": "integer" + }, + "overwriteExistingcutoffschedule": { + "description": "Flag to indicate if the cutoff schedule already exists for criteria then overwrite the records.", + "type": "boolean" + }, + "stayDateFrom": { + "description": "The starting value of the date range.", + "type": "string", + "format": "date" + }, + "stayDateTo": { + "description": "The ending value of the date range.", + "type": "string", + "format": "date" + }, + "sunday": { + "type": "boolean" + }, + "monday": { + "type": "boolean" + }, + "tuesday": { + "type": "boolean" + }, + "wednesday": { + "type": "boolean" + }, + "thursday": { + "type": "boolean" + }, + "friday": { + "type": "boolean" + }, + "saturday": { + "type": "boolean" + } + } } }, "tags": [ @@ -5679,4 +7700,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/bof.json b/rest-api-specs/property/bof.json index 506abe7..6620589 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -79,6 +79,42 @@ }, "204": { "description": "BusinessDate 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": [ @@ -442,4 +478,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/chl.json b/rest-api-specs/property/chl.json index 7637fca..87754da 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -149,6 +149,42 @@ }, "204": { "description": "RegionalRateParity 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": [ @@ -259,6 +295,42 @@ }, "204": { "description": "Channels 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": [ @@ -324,6 +396,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -389,6 +497,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -515,6 +659,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -582,6 +762,42 @@ "schema": { "$ref": "#/definitions/channelAccountContractsDetailsCopy" } + }, + "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": [ @@ -730,6 +946,42 @@ }, "204": { "description": "ChannelAccounts 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": [ @@ -795,6 +1047,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -860,6 +1148,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -950,6 +1274,42 @@ }, "204": { "description": "ChannelAccount 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": [ @@ -1026,6 +1386,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1100,6 +1496,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1211,6 +1643,42 @@ }, "204": { "description": "ChannelAccountContractElements 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": [ @@ -1278,6 +1746,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1343,6 +1847,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1515,6 +2055,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1629,6 +2205,42 @@ }, "204": { "description": "AmenitiesMapping 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": [ @@ -1696,6 +2308,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1823,6 +2471,42 @@ }, "204": { "description": "ChannelBillingStatements 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": [ @@ -1888,6 +2572,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1953,6 +2673,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2049,10 +2805,46 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -2116,6 +2908,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2194,6 +3022,42 @@ }, "204": { "description": "ChannelBillingStatement 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": [ @@ -2310,6 +3174,42 @@ }, "204": { "description": "ChannelBillingStatementDetails 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": [ @@ -2404,6 +3304,42 @@ }, "204": { "description": "StatementDetailsStatistics 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": [ @@ -2537,6 +3473,42 @@ }, "204": { "description": "ChannelCardTypeMappings 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": [ @@ -2604,6 +3576,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2669,6 +3677,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2823,6 +3867,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2944,6 +4024,42 @@ }, "204": { "description": "CreditCardsMapping 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": [ @@ -3041,6 +4157,42 @@ }, "204": { "description": "ChannelHotelLetters 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": [ @@ -3106,6 +4258,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3171,6 +4359,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3281,6 +4505,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3348,6 +4608,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3413,6 +4709,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3589,6 +4921,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3710,6 +5078,42 @@ }, "204": { "description": "CurrenciesMapping 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": [ @@ -3811,6 +5215,42 @@ }, "204": { "description": "DistributionTemplates 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": [ @@ -3876,6 +5316,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3941,6 +5417,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4026,6 +5538,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4102,6 +5650,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4169,6 +5753,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4234,6 +5854,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4399,6 +6055,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4520,6 +6212,42 @@ }, "204": { "description": "GuaranteesMapping 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": [ @@ -4587,6 +6315,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4652,6 +6416,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4941,6 +6741,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5062,6 +6898,42 @@ }, "204": { "description": "HotelsMapping 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": [ @@ -5252,6 +7124,42 @@ }, "204": { "description": "ChannelMarketingText 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": [ @@ -5317,6 +7225,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5382,6 +7326,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5579,6 +7559,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5646,6 +7662,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5713,6 +7765,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5778,6 +7866,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6042,6 +8166,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6145,6 +8305,42 @@ }, "204": { "description": "ChannelNegotiatedRate 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": [ @@ -6221,6 +8417,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6297,6 +8529,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6459,10 +8727,46 @@ }, "204": { "description": "ChannelRateMapping not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -6524,6 +8828,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6589,6 +8929,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6707,6 +9083,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6805,6 +9217,42 @@ }, "204": { "description": "ChannelRatesGlobalDescriptions 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": [ @@ -6870,6 +9318,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6935,6 +9419,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7042,6 +9562,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7109,6 +9665,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7176,6 +9768,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7252,6 +9880,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7319,6 +9983,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7384,6 +10084,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7451,6 +10187,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7549,6 +10321,42 @@ }, "204": { "description": "ChannelRoomsGlobalDescriptions 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": [ @@ -7614,6 +10422,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7679,6 +10523,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7786,6 +10666,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7862,6 +10778,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7954,6 +10906,42 @@ }, "204": { "description": "Channel 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": [ @@ -8030,6 +11018,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8104,6 +11128,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8180,6 +11240,42 @@ }, "204": { "description": "ChannelHotelCodeMapping 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": [ @@ -8256,6 +11352,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8332,6 +11464,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8406,6 +11574,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8482,6 +11686,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8556,6 +11796,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8632,6 +11908,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8754,6 +12066,42 @@ }, "204": { "description": "ChannelRateRoomSeq 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": [ @@ -8839,6 +12187,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8915,6 +12299,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8989,6 +12409,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9065,6 +12521,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9139,6 +12631,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9215,6 +12743,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9300,6 +12864,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9376,6 +12976,42 @@ }, "204": { "description": "ChannelOrgMapping 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": [ @@ -9453,6 +13089,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9520,6 +13192,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9585,6 +13293,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9662,6 +13406,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9729,6 +13509,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9813,6 +13629,42 @@ }, "204": { "description": "ChannelSellLimits 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": [ @@ -9889,6 +13741,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9961,6 +13849,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10104,6 +14028,42 @@ }, "204": { "description": "ChannelGuaranteeCodeMappings 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": [ @@ -10180,6 +14140,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10256,6 +14252,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10367,6 +14399,42 @@ }, "204": { "description": "TotalPricingElements 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": [ @@ -10461,6 +14529,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10553,6 +14657,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10639,6 +14779,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10733,6 +14909,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10825,6 +15037,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10904,6 +15152,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10982,6 +15266,42 @@ }, "204": { "description": "ChannelParameters 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": [ @@ -11133,6 +15453,42 @@ }, "204": { "description": "ChannelPolicies 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": [ @@ -11227,6 +15583,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11322,6 +15714,42 @@ }, "204": { "description": "ChannelRoomMappingById 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": [ @@ -11414,6 +15842,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11516,6 +15980,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11677,6 +16177,42 @@ }, "204": { "description": "ChannelInventorySnapshotByRoomType 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": [ @@ -11762,6 +16298,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11915,6 +16487,42 @@ }, "204": { "description": "GeneralAvailabilitySimulator 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": [ @@ -12080,6 +16688,42 @@ }, "204": { "description": "ChannelInventorySnapshot 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": [ @@ -12265,6 +16909,42 @@ }, "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": [ @@ -12336,6 +17016,42 @@ }, "204": { "description": "ChannelRateCodeGlobalDesc 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": [ @@ -12479,6 +17195,42 @@ }, "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": [ @@ -12550,6 +17302,42 @@ }, "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": [ @@ -20423,4 +25211,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/cms.json b/rest-api-specs/property/cms.json index 2a068aa..af6ac79 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -246,6 +246,42 @@ }, "204": { "description": "CalendarTasks 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": [ @@ -313,6 +349,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -388,6 +460,42 @@ }, "204": { "description": "CalendarTask 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": [ @@ -463,6 +571,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -547,6 +691,42 @@ }, "204": { "description": "CalendarTaskAttachments 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": [ @@ -631,6 +811,42 @@ "schema": { "$ref": "#/definitions/calendarTask" } + }, + "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": [ @@ -700,6 +916,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -775,6 +1027,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -848,6 +1136,42 @@ "schema": { "$ref": "#/definitions/trackItItems" } + }, + "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": [ @@ -941,6 +1265,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1200,6 +1560,42 @@ }, "204": { "description": "TrackItItems 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": [ @@ -3415,4 +3811,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/crm.json b/rest-api-specs/property/crm.json index 0c83f18..bd1bb14 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -102,6 +102,42 @@ }, "204": { "description": "Address 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": [ @@ -192,6 +228,42 @@ }, "204": { "description": "AirlineTransactionsStatus 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": [ @@ -569,6 +641,42 @@ }, "204": { "description": "AvailableAwardsBasedOnType 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": [ @@ -643,6 +751,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -780,6 +924,42 @@ }, "204": { "description": "AwardsToGrant 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": [ @@ -833,6 +1013,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -899,6 +1115,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1020,6 +1272,42 @@ }, "204": { "description": "CompanyProfile 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": [ @@ -1115,6 +1403,42 @@ }, "204": { "description": "DuplicateExternalSubscriptions 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": [ @@ -1210,6 +1534,42 @@ }, "204": { "description": "DuplicateOPERASubscriptions 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": [ @@ -1357,132 +1717,42 @@ }, "204": { "description": "ECertificates not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Profile" - ] - }, - "post": { - "summary": "Create e-certificate", - "description": "This API allows you to create a new eCertificates onto a profile in OPERA Cloud.OperationId:postECertificate
", - "operationId": "postECertificate", - "parameters": [ - { - "name": "eCertificateGeneration", - "in": "body", - "required": true, - "description": "Request object to issue E-Certificate.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/eCertificateGeneration" - } - ] - } }, - { - "$ref": "#/parameters/authKey" + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/x-app-key" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-hotelid" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-externalsystem" + "404": { + "$ref": "#/responses/404" }, - { - "$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" - } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Profile" - ] - } - }, - "/ecertificates/{certificateId}": { - "delete": { - "summary": "Delete e-certificate", - "description": "This API allows you to delete an eCertificates which exist on a profile in OPERA Cloud.OperationId:deleteECertificate
", - "operationId": "deleteECertificate", - "parameters": [ - { - "name": "certificateId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/authKey" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-app-key" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-hotelid" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-externalsystem" + "415": { + "$ref": "#/responses/415" }, - { - "$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" - } + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1495,29 +1765,227 @@ "Profile" ] }, - "put": { - "summary": "Consume an E-Certificate", - "description": "Use this API to consume (use) an E-Certificate.OperationId:consumeECertificate
", - "operationId": "consumeECertificate", + "post": { + "summary": "Create e-certificate", + "description": "This API allows you to create a new eCertificates onto a profile in OPERA Cloud.OperationId:postECertificate
", + "operationId": "postECertificate", "parameters": [ { - "name": "certificateId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "" - }, - { - "name": "eCertificateToConsume", + "name": "eCertificateGeneration", "in": "body", "required": true, - "description": "Request object to Consume an E-Certificate.", + "description": "Request object to issue E-Certificate.", "schema": { "allOf": [ { - "$ref": "#/definitions/eCertificateToConsume" + "$ref": "#/definitions/eCertificateGeneration" + } + ] + } + }, + { + "$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": [ + "Profile" + ] + } + }, + "/ecertificates/{certificateId}": { + "delete": { + "summary": "Delete e-certificate", + "description": "This API allows you to delete an eCertificates which exist on a profile in OPERA Cloud.OperationId:deleteECertificate
", + "operationId": "deleteECertificate", + "parameters": [ + { + "name": "certificateId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "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" + }, + "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" + ] + }, + "put": { + "summary": "Consume an E-Certificate", + "description": "Use this API to consume (use) an E-Certificate.OperationId:consumeECertificate
", + "operationId": "consumeECertificate", + "parameters": [ + { + "name": "certificateId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" + }, + { + "name": "eCertificateToConsume", + "in": "body", + "required": true, + "description": "Request object to Consume an E-Certificate.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/eCertificateToConsume" } ] } @@ -1556,6 +2024,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1631,6 +2135,42 @@ "schema": { "$ref": "#/definitions/verifiedECertificate" } + }, + "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": [ @@ -1706,6 +2246,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1772,6 +2348,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2370,6 +2982,42 @@ }, "204": { "description": "ProfileByExtId 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": [ @@ -2436,6 +3084,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2952,6 +3636,42 @@ }, "204": { "description": "GuestProfile 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": [ @@ -3022,6 +3742,42 @@ }, "204": { "description": "MembershipAwardPointsByHotel 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": [ @@ -3106,6 +3862,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3378,6 +4170,42 @@ }, "204": { "description": "MembershipClaims 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": [ @@ -3442,6 +4270,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3540,6 +4404,42 @@ }, "204": { "description": "MembershipClaim 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": [ @@ -3613,6 +4513,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3679,6 +4615,144 @@ "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": [ + "ProfileMembership" + ] + } + }, + "/membershipPointsExceptions": { + "put": { + "summary": "Update membership points exceptions", + "description": "Use this API to update membership points exceptions.OperationId:putMembershipPointsExceptions
", + "operationId": "putMembershipPointsExceptions", + "parameters": [ + { + "name": "membershipPointsExceptions", + "in": "body", + "required": true, + "description": "Request object for updating membership points exceptions.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/membershipPointsExceptions" + } + ] + } + }, + { + "$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": [ @@ -3787,6 +4861,42 @@ }, "204": { "description": "MembershipTierProjections 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": [ @@ -3869,6 +4979,42 @@ }, "204": { "description": "MembershipTransaction 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": [ @@ -3945,6 +5091,42 @@ }, "204": { "description": "MembershipTransactionAwardPoints 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": [ @@ -4021,6 +5203,42 @@ }, "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": [ @@ -4097,82 +5315,42 @@ }, "204": { "description": "MembershipTransactionRates not found." - } - }, - "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
", - "operationId": "getMembershipTransactionRevenue", - "parameters": [ - { - "name": "membershipTransactionId", - "in": "path", - "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" + "400": { + "$ref": "#/responses/400" }, - { - "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" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/authKey" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-app-key" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-hotelid" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-externalsystem" + "406": { + "$ref": "#/responses/406" }, - { - "$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" - } + "413": { + "$ref": "#/responses/413" }, - "204": { - "description": "MembershipTransactionRevenue not found." + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4186,11 +5364,123 @@ ] } }, - "/membershipTransactions/{membershipTransactionId}/tierPoints": { + "/membershipTransactions/{membershipTransactionId}/revenue": { "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": "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", + "parameters": [ + { + "name": "membershipTransactionId", + "in": "path", + "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" + }, + { + "$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
", + "operationId": "getMembershipTransactionTierPoints", "parameters": [ { "name": "membershipTransactionId", @@ -4249,6 +5539,42 @@ }, "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": [ @@ -5085,6 +6411,42 @@ }, "204": { "description": "exportMembershipAward 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": [ @@ -5153,6 +6515,42 @@ }, "204": { "description": "MembershipAwardExportInfo 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": [ @@ -5277,6 +6675,42 @@ }, "204": { "description": "MembershipIssueAwardsList 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": [ @@ -5549,6 +6983,42 @@ }, "204": { "description": "MembershipClaims 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": [ @@ -5638,6 +7108,42 @@ }, "204": { "description": "FulfillmentExportLogs 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": [ @@ -5699,6 +7205,42 @@ }, "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": [ @@ -5772,6 +7314,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5840,6 +7418,42 @@ }, "204": { "description": "MembershipPromotions 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": [ @@ -5913,6 +7527,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5997,6 +7647,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6066,6 +7752,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6127,6 +7849,42 @@ }, "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": [ @@ -6200,6 +7958,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6275,6 +8069,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6733,6 +8563,42 @@ }, "204": { "description": "EnrollmentMatchProfiles 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": [ @@ -6827,6 +8693,42 @@ }, "204": { "description": "AvailableARAddresses 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": [ @@ -6900,6 +8802,42 @@ }, "204": { "description": "AvailablePreferences 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": [ @@ -7043,6 +8981,42 @@ }, "204": { "description": "ProfileMembershipStatistics 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": [ @@ -7219,6 +9193,42 @@ }, "204": { "description": "ProfileStatistics 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": [ @@ -7791,6 +9801,42 @@ }, "204": { "description": "Profiles 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": [ @@ -8034,6 +10080,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8118,6 +10200,42 @@ }, "204": { "description": "checkProfileType 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": [ @@ -8291,6 +10409,42 @@ }, "204": { "description": "ProfileActivityLog 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": [ @@ -8894,6 +11048,42 @@ }, "204": { "description": "Profile 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": [ @@ -9146,6 +11336,42 @@ "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": [ @@ -9206,6 +11432,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9300,6 +11562,42 @@ }, "204": { "description": "ProfileAccounts 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": [ @@ -9362,6 +11660,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9455,6 +11789,42 @@ }, "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": [ @@ -9598,6 +11968,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9673,6 +12079,42 @@ "schema": { "$ref": "#/definitions/award" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9755,6 +12197,42 @@ }, "204": { "description": "Awards 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": [ @@ -9856,6 +12334,42 @@ }, "204": { "description": "CashieringDetails 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": [ @@ -9929,6 +12443,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10001,6 +12551,42 @@ }, "204": { "description": "ProfileCommissionAccount 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": [ @@ -10138,6 +12724,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10211,6 +12833,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10284,6 +12942,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10373,6 +13067,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10465,6 +13195,42 @@ }, "204": { "description": "AccountForecasts 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": [ @@ -10547,6 +13313,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10626,6 +13428,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10719,6 +13557,42 @@ "schema": { "$ref": "#/definitions/changeAccountForecastsRS" } + }, + "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": [ @@ -10808,6 +13682,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10904,6 +13814,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11179,6 +14125,42 @@ }, "204": { "description": "LinkedProfiles 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": [ @@ -11261,6 +14243,42 @@ }, "204": { "description": "MatchProfiles 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": [ @@ -11401,6 +14419,42 @@ }, "204": { "description": "MembershipTransactionExceptions 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": [ @@ -11494,6 +14548,42 @@ "schema": { "$ref": "#/definitions/changedMembership" } + }, + "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": [ @@ -11572,6 +14662,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11647,6 +14773,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11796,6 +14958,42 @@ }, "204": { "description": "MembershipDetails not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11890,6 +15088,42 @@ }, "204": { "description": "ProfileOwners 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": [ @@ -11987,6 +15221,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12060,6 +15330,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12147,6 +15453,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12259,6 +15601,42 @@ }, "204": { "description": "PreferenceForProfile 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": [ @@ -12332,6 +15710,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12405,6 +15819,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12517,6 +15967,42 @@ }, "204": { "description": "ProfileRelationships 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": [ @@ -12592,6 +16078,42 @@ "schema": { "$ref": "#/definitions/futurePastBookings" } + }, + "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": [ @@ -12745,6 +16267,42 @@ }, "204": { "description": "StayHistory 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": [ @@ -12841,6 +16399,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12946,6 +16540,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13048,6 +16678,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13130,6 +16796,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13245,6 +16947,42 @@ }, "204": { "description": "MergeProfilesSnapshot 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": [ @@ -13348,6 +17086,42 @@ }, "204": { "description": "MergeStageProfileSnapshot 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": [ @@ -13534,6 +17308,144 @@ }, "204": { "description": "ProfilesByIds 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" + ] + } + }, + "/profilesMatchList": { + "put": { + "summary": "Updates a list of matchIds to skip or don't skip profile match.", + "description": "Use this API to update a list of records of profiles match to skip or don't skip profile match", + "operationId": "putProfilesMatchList", + "parameters": [ + { + "name": "matchList", + "in": "body", + "required": true, + "description": "Parameter that contains a list of matchIds that will be updated to skip or don't skip profile match.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/matchListType" + } + ] + } + }, + { + "$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": [ @@ -13688,72 +17600,42 @@ "schema": { "$ref": "#/definitions/profilesMatch" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Profile" - ] - } - }, - "/profilesMatchList": { - "put": { - "summary": "Updates a list of matchIds to skip or don't skip profile match.", - "description": "Use this API to update a list of records of profiles match to skip or don't skip profile match", - "operationId": "putProfilesMatchList", - "parameters": [ - { - "name": "matchList", - "in": "body", - "required": true, - "description": "Parameter that contains a list of matchIds that will be updated to skip or don't skip profile match.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/matchListType" - } - ] - } }, - { - "$ref": "#/parameters/authKey" + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/x-app-key" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-hotelid" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-externalsystem" + "404": { + "$ref": "#/responses/404" }, - { - "$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" - } + "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": [ @@ -13806,6 +17688,42 @@ }, "204": { "description": "RecentlyAccessedProfiles 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": [ @@ -13859,6 +17777,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13974,6 +17928,42 @@ }, "204": { "description": "StagedProfile 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": [ @@ -14037,201 +18027,273 @@ "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" + }, + "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" + ] + } + }, + "/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
", + "operationId": "getStagedProfiles", + "parameters": [ + { + "name": "limit", + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" + }, + { + "name": "offset", + "in": "query", + "default": 0, + "required": false, + "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", + "type": "integer" + }, + { + "name": "hotelIds", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "id", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "idContext", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "type", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "A reference to the type of object defined by the UniqueID element.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "name", + "in": "query", + "required": false, + "description": "Family name, last name or Company Name.", + "type": "string" + }, + { + "name": "givenName", + "in": "query", + "required": false, + "description": "Given name, first name or names.", + "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.", + "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 + }, + { + "$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 Body.", + "description": "Response object for the staged profiles.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/stagedProfiles" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Profile" - ] - } - }, - "/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
", - "operationId": "getStagedProfiles", - "parameters": [ - { - "name": "limit", - "in": "query", - "required": false, - "description": "Indicates maximum number of records a Web Service should return.", - "type": "integer" - }, - { - "name": "offset", - "in": "query", - "default": 0, - "required": false, - "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.", - "type": "integer" - }, - { - "name": "hotelIds", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false - }, - { - "name": "id", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "idContext", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "type", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "items": { - "type": "string" - }, - "required": false - }, - { - "name": "name", - "in": "query", - "required": false, - "description": "Family name, last name or Company Name.", - "type": "string" - }, - { - "name": "givenName", - "in": "query", - "required": false, - "description": "Given name, first name or names.", - "type": "string" }, - { - "name": "region", - "in": "query", - "required": false, - "description": "The profile region for which the staged profiles shall be fetched.", - "type": "string" + "204": { + "description": "StagedProfiles not found." }, - { - "name": "countryCode", - "in": "query", - "required": false, - "description": "Code for a country or a nationality.", - "type": "string" + "400": { + "$ref": "#/responses/400" }, - { - "name": "profileType", - "in": "query", - "required": false, - "description": "Profile type to be included in the search.", - "type": "string" + "401": { + "$ref": "#/responses/401" }, - { - "name": "importDate", - "in": "query", - "required": false, - "description": "The date on which the staged profiles have been received.", - "type": "string", - "format": "date" + "403": { + "$ref": "#/responses/403" }, - { - "name": "stageStatus", - "in": "query", - "required": false, - "description": "The status of the staged profiles.", - "type": "string" + "404": { + "$ref": "#/responses/404" }, - { - "name": "applyTo", - "in": "query", - "required": false, - "type": "string", - "description": "Membership filter of staged profiles.", - "uniqueItems": true, - "enum": [ - "StagedProfiles", - "MatchingProfiles", - "StagedAndMatchingProfiles" - ] + "405": { + "$ref": "#/responses/405" }, - { - "name": "membershipCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/authKey" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-app-key" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-hotelid" + "415": { + "$ref": "#/responses/415" }, - { - "$ref": "#/parameters/x-externalsystem" + "500": { + "$ref": "#/responses/500" }, - { - "$ref": "#/parameters/Accept-Language" - } - ], - "responses": { - "200": { - "headers": { - "Content-Language": { - "type": "string", - "description": "Audience language", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "x-example": "en-GB" - } - }, - "description": "Response object for the staged profiles.", - "schema": { - "$ref": "#/definitions/stagedProfiles" - } + "502": { + "$ref": "#/responses/502" }, - "204": { - "description": "StagedProfiles not found." + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14334,6 +18396,42 @@ }, "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": [ @@ -14397,6 +18495,42 @@ }, "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": [ @@ -14463,6 +18597,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14529,6 +18699,42 @@ "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": [ @@ -26054,6 +30260,10 @@ "description": "Indicates if the points have been calculated on this transaction.", "type": "boolean" }, + "exceptionRejected": { + "description": "Indicates if the exception points were rejected.", + "type": "boolean" + }, "exception": { "description": "Indicates if the transaction was flagged as an exception.", "type": "boolean" @@ -33925,6 +38135,53 @@ "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" + } + }, + "acceptPoints": { + "description": "Indicates if the membership points exception are to be accepted or rejected.", + "type": "boolean" + }, + "userNotes": { + "description": "Notes regarding the resolution of the membership transaction exception or for any other reason.", + "type": "string", + "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" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "fileType": { + "description": "File Type of the staging file.", + "type": "string", + "enum": [ + "IMPORT_TAX_PERC" + ] } }, "tags": [ diff --git a/rest-api-specs/property/crmasync.json b/rest-api-specs/property/crmasync.json index 87a0f87..a8d35a1 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -47,6 +47,42 @@ "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" } }, "parameters": [ @@ -134,6 +170,42 @@ } }, "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "parameters": [ @@ -189,6 +261,42 @@ }, "204": { "description": "Stay Record 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" } }, "parameters": [ diff --git a/rest-api-specs/property/crmcfg.json b/rest-api-specs/property/crmcfg.json index a21cdfd..f55d7dc 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -109,6 +109,42 @@ }, "204": { "description": "AccountOwners 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": [ @@ -194,6 +230,42 @@ }, "204": { "description": "AccountPriorities 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": [ @@ -258,6 +330,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -333,6 +441,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -393,6 +537,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -478,6 +658,42 @@ }, "204": { "description": "AccountTypes 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": [ @@ -542,6 +758,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -617,6 +869,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -677,6 +965,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -748,6 +1072,42 @@ }, "204": { "description": "AddressFormats 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": [ @@ -812,6 +1172,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -874,6 +1270,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -938,6 +1370,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1023,6 +1491,42 @@ }, "204": { "description": "AddressTypes 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": [ @@ -1087,6 +1591,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1162,6 +1702,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1222,6 +1798,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1303,6 +1915,42 @@ }, "204": { "description": "AlternateLanguageGuestTitles 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": [ @@ -1367,6 +2015,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1442,6 +2126,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1579,6 +2299,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1651,10 +2407,46 @@ }, "204": { "description": "AvailablePreferences not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -1736,6 +2528,42 @@ }, "204": { "description": "BusinessSegments 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": [ @@ -1800,6 +2628,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1875,6 +2739,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1935,6 +2835,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2099,6 +3035,42 @@ }, "204": { "description": "CityPostalCodes 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": [ @@ -2163,6 +3135,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2238,6 +3246,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2298,6 +3342,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2387,6 +3467,42 @@ }, "204": { "description": "CommunicationTypes 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": [ @@ -2451,6 +3567,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2513,6 +3665,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2586,6 +3774,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2671,6 +3895,42 @@ }, "204": { "description": "CompanyTypes 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": [ @@ -2735,6 +3995,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2810,6 +4106,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2870,6 +4202,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2956,6 +4324,42 @@ }, "204": { "description": "CompetitionCodes 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": [ @@ -3020,6 +4424,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3095,6 +4535,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3155,6 +4631,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3240,6 +4752,42 @@ }, "204": { "description": "CreditRatings 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": [ @@ -3304,6 +4852,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3366,6 +4950,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3430,6 +5050,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3515,6 +5171,42 @@ }, "204": { "description": "DistanceTypes 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": [ @@ -3579,6 +5271,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3654,6 +5382,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3714,6 +5478,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3799,6 +5599,42 @@ }, "204": { "description": "Districts 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": [ @@ -3863,6 +5699,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3938,6 +5810,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3998,6 +5906,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4083,6 +6027,42 @@ }, "204": { "description": "TemplateExclusivePreferences 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": [ @@ -4147,6 +6127,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4212,6 +6228,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4276,6 +6328,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4342,6 +6430,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4427,6 +6551,42 @@ }, "204": { "description": "TravelAgentTypes 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": [ @@ -4491,6 +6651,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4566,6 +6762,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4626,6 +6858,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4711,10 +6979,46 @@ }, "204": { "description": "GenderTypes not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -4775,6 +7079,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4850,6 +7190,42 @@ "schema": { "$ref": "#/definitions/genderTypesToChange" } + }, + "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": [ @@ -4921,6 +7297,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5006,6 +7418,42 @@ }, "204": { "description": "GuestStatuses 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": [ @@ -5070,6 +7518,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5145,6 +7629,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5205,6 +7725,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5286,6 +7842,42 @@ }, "204": { "description": "GuestTitles 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": [ @@ -5350,6 +7942,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5425,6 +8053,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5562,6 +8226,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5647,6 +8347,42 @@ }, "204": { "description": "GuestTypes 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": [ @@ -5711,6 +8447,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5786,6 +8558,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5846,6 +8654,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5940,6 +8784,42 @@ }, "204": { "description": "EcertificateLocationTypes 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": [ @@ -6013,6 +8893,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6097,6 +9013,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6166,6 +9118,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6260,6 +9248,42 @@ }, "204": { "description": "ExclusivePreferences 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": [ @@ -6333,6 +9357,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6407,6 +9467,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6480,6 +9576,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6574,6 +9706,42 @@ }, "204": { "description": "Preferences 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": [ @@ -6647,6 +9815,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6721,6 +9925,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6794,6 +10034,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6879,6 +10155,42 @@ }, "204": { "description": "IdentificationCountries 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": [ @@ -6943,6 +10255,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7018,6 +10366,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7078,6 +10462,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7163,6 +10583,42 @@ }, "204": { "description": "IdentificationTypes 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": [ @@ -7227,6 +10683,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7302,6 +10794,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7362,6 +10890,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7447,6 +11011,42 @@ }, "204": { "description": "ImmigrationStatuses 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": [ @@ -7511,6 +11111,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7586,6 +11222,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7646,6 +11318,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7731,6 +11439,42 @@ }, "204": { "description": "IndustryCodes 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": [ @@ -7795,6 +11539,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7870,10 +11650,46 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -7930,6 +11746,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8015,6 +11867,42 @@ }, "204": { "description": "InfluenceCodes 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": [ @@ -8079,6 +11967,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8154,6 +12078,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8214,6 +12174,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8299,6 +12295,42 @@ }, "204": { "description": "KeywordTypes 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": [ @@ -8363,6 +12395,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8438,6 +12506,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8498,6 +12602,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8583,6 +12723,42 @@ }, "204": { "description": "MailingActionCodes 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": [ @@ -8647,6 +12823,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8722,6 +12934,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8782,6 +13030,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8889,6 +13173,42 @@ }, "204": { "description": "MembershipAwards 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": [ @@ -8953,6 +13273,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9028,6 +13384,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9099,6 +13491,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9195,6 +13623,42 @@ }, "204": { "description": "MembershipBenefitPrograms 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": [ @@ -9259,6 +13723,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9334,6 +13834,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9405,6 +13941,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9490,6 +14062,42 @@ }, "204": { "description": "MembershipClaimOrigins 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": [ @@ -9554,6 +14162,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9629,6 +14273,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9689,6 +14369,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9774,6 +14490,42 @@ }, "204": { "description": "MembershipClaimTypes 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": [ @@ -9838,6 +14590,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9913,6 +14701,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9973,6 +14797,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10058,6 +14918,42 @@ }, "204": { "description": "MembershipClasses 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": [ @@ -10122,6 +15018,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10197,6 +15129,42 @@ "schema": { "$ref": "#/definitions/membershipClassesInfo" } + }, + "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": [ @@ -10257,6 +15225,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10342,6 +15346,42 @@ }, "204": { "description": "MembershipEnrollmentCodes 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": [ @@ -10406,6 +15446,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10481,6 +15557,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10541,6 +15653,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10634,6 +15782,42 @@ }, "204": { "description": "MembershipEnrollmentGroups 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": [ @@ -10698,6 +15882,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10773,6 +15993,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10833,6 +16089,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10899,10 +16191,46 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -10984,6 +16312,42 @@ }, "204": { "description": "MembershipLevels 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": [ @@ -11048,6 +16412,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11123,6 +16523,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11194,6 +16630,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11279,6 +16751,42 @@ }, "204": { "description": "MembershipMarketGroups 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": [ @@ -11343,6 +16851,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11418,6 +16962,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11478,6 +17058,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11563,6 +17179,42 @@ }, "204": { "description": "MembershipPropertyGroups 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": [ @@ -11627,6 +17279,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11702,6 +17390,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11762,6 +17486,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11847,6 +17607,42 @@ }, "204": { "description": "MembershipRateGroups 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": [ @@ -11911,6 +17707,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11986,6 +17818,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12046,6 +17914,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12148,6 +18052,42 @@ }, "204": { "description": "MembershipRates 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": [ @@ -12212,6 +18152,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12287,6 +18263,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12358,6 +18370,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12443,6 +18491,42 @@ }, "204": { "description": "MembershipStatusCodes 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": [ @@ -12507,6 +18591,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12582,6 +18702,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12642,6 +18798,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12749,6 +18941,42 @@ }, "204": { "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": [ @@ -12813,6 +19041,42 @@ "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": [ @@ -12905,6 +19169,42 @@ }, "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": [ @@ -12978,6 +19278,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13049,6 +19385,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13146,6 +19518,42 @@ }, "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": [ @@ -13210,6 +19618,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13299,6 +19743,42 @@ }, "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": [ @@ -13372,6 +19852,42 @@ "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": [ @@ -13432,6 +19948,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13517,6 +20069,42 @@ }, "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": [ @@ -13581,6 +20169,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13656,6 +20280,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13716,6 +20376,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13801,6 +20497,42 @@ }, "204": { "description": "OwnerTeams 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": [ @@ -13865,6 +20597,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13940,6 +20708,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14000,10 +20804,46 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -14085,6 +20925,42 @@ }, "204": { "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": [ @@ -14149,6 +21025,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14224,6 +21136,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14284,6 +21232,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14358,6 +21342,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14428,6 +21448,42 @@ }, "204": { "description": "PreferenceGroups 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": [ @@ -14492,6 +21548,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14550,6 +21642,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14614,6 +21742,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14688,6 +21852,42 @@ }, "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": [ @@ -14752,6 +21952,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14817,6 +22053,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14881,6 +22153,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14947,6 +22255,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15032,6 +22376,42 @@ }, "204": { "description": "ProfileInactiveReasons 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": [ @@ -15096,6 +22476,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15171,6 +22587,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15231,6 +22683,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15309,6 +22797,42 @@ }, "204": { "description": "ProfileNameValidations 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": [ @@ -15373,6 +22897,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15444,6 +23004,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15508,6 +23104,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15593,6 +23225,42 @@ }, "204": { "description": "ProfileRestrictionReasons 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": [ @@ -15657,6 +23325,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15732,6 +23436,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15792,6 +23532,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15859,6 +23635,42 @@ }, "204": { "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": [ @@ -15924,6 +23736,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16004,6 +23852,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16069,6 +23953,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16133,8 +24053,44 @@ "$ref": "#/definitions/profileLinks" } }, - "204": { - "description": "ProfileRelationships not found." + "204": { + "description": "ProfileRelationships 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": [ @@ -16199,6 +24155,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16278,6 +24270,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16342,6 +24370,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16427,6 +24491,42 @@ }, "204": { "description": "Sources 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": [ @@ -16491,6 +24591,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16566,6 +24702,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16626,6 +24798,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16704,6 +24912,42 @@ }, "204": { "description": "States 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": [ @@ -16768,6 +25012,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16853,6 +25133,42 @@ }, "204": { "description": "Territories 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": [ @@ -16917,6 +25233,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16992,6 +25344,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17052,6 +25440,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17137,6 +25561,42 @@ }, "204": { "description": "Titles 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": [ @@ -17201,6 +25661,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17276,6 +25772,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17336,6 +25868,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17421,6 +25989,42 @@ }, "204": { "description": "VIPLevels 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": [ @@ -17485,6 +26089,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17560,6 +26200,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17620,6 +26296,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ diff --git a/rest-api-specs/property/csh.json b/rest-api-specs/property/csh.json index dc29850..860c764 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -144,6 +144,42 @@ }, "204": { "description": "CashierReportPostings 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": [ @@ -219,6 +255,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -280,6 +352,42 @@ }, "204": { "description": "CashierLock 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": [ @@ -340,6 +448,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -429,6 +573,42 @@ }, "204": { "description": "CashierTransactions 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": [ @@ -491,6 +671,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -688,6 +904,42 @@ }, "204": { "description": "CompAccountingJournal 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": [ @@ -754,6 +1006,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -820,6 +1108,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -886,147 +1210,42 @@ "schema": { "$ref": "#/definitions/calculatedForeignCurrency" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Cashiering" - ] - } - }, - "/foreignCurrencyExchange": { - "post": { - "summary": "Create Foreign Currency Exchange", - "description": "You can use this API to Create Foreign Currency Exchange.OperationId:postForeignCurrencyExchange
", - "operationId": "postForeignCurrencyExchange", - "parameters": [ - { - "name": "foreignCurrencyExchange", - "in": "body", - "required": true, - "description": "A set of posting transactions that need to be posted with regards to exchange.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/foreignCurrencyExchange" - } - ] - } }, - { - "$ref": "#/parameters/authKey" + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/x-app-key" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-hotelid" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-externalsystem" + "404": { + "$ref": "#/responses/404" }, - { - "$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 of the posting foreign currency exchange transaction.", - "schema": { - "$ref": "#/definitions/foreignCurrencyExchangeTransaction" - } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Cashiering" - ] - } - }, - "/hotels/{hotelId}/advanceFolio/batchJobs": { - "post": { - "summary": "Create Batch Advance Folio", - "description": "You can use this API to create Batch Advance Folio.OperationId:postAdvanceFolio
", - "operationId": "postAdvanceFolio", - "parameters": [ - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel" + "405": { + "$ref": "#/responses/405" }, - { - "name": "batchAdvanceFolio", - "in": "body", - "required": true, - "description": "Request for submitting batch advance folio.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/batchAdvanceFolio" - } - ] - } + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/authKey" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-app-key" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-hotelid" + "415": { + "$ref": "#/responses/415" }, - { - "$ref": "#/parameters/x-externalsystem" + "500": { + "$ref": "#/responses/500" }, - { - "$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" - } + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1040,30 +1259,243 @@ ] } }, - "/hotels/{hotelId}/articlesSale": { + "/foreignCurrencyExchange": { "post": { - "summary": "Create Articles Sale", - "description": "You can use this API to create Articles Sale.OperationId:postArticlesSale
", - "operationId": "postArticlesSale", + "summary": "Create Foreign Currency Exchange", + "description": "You can use this API to Create Foreign Currency Exchange.OperationId:postForeignCurrencyExchange
", + "operationId": "postForeignCurrencyExchange", "parameters": [ { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel" - }, - { - "name": "articlesSaleCriteria", + "name": "foreignCurrencyExchange", "in": "body", "required": true, - "description": "Request to post a set of charges, payments and generate a bill for a PasserBy or for the Post-It functionality . A PasserBy is someone who is not staying at the Property. A PasserBy transaction requires a Profile in Opera for whom the the folio is being created.", + "description": "A set of posting transactions that need to be posted with regards to exchange.", "schema": { "allOf": [ { - "$ref": "#/definitions/articlesSaleCriteria" + "$ref": "#/definitions/foreignCurrencyExchange" + } + ] + } + }, + { + "$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 of the posting foreign currency exchange transaction.", + "schema": { + "$ref": "#/definitions/foreignCurrencyExchangeTransaction" + } + }, + "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}/advanceFolio/batchJobs": { + "post": { + "summary": "Create Batch Advance Folio", + "description": "You can use this API to create Batch Advance Folio.OperationId:postAdvanceFolio
", + "operationId": "postAdvanceFolio", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel" + }, + { + "name": "batchAdvanceFolio", + "in": "body", + "required": true, + "description": "Request for submitting batch advance folio.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/batchAdvanceFolio" + } + ] + } + }, + { + "$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": [ + "Cashiering" + ] + } + }, + "/hotels/{hotelId}/articlesSale": { + "post": { + "summary": "Create Articles Sale", + "description": "You can use this API to create Articles Sale.OperationId:postArticlesSale
", + "operationId": "postArticlesSale", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel" + }, + { + "name": "articlesSaleCriteria", + "in": "body", + "required": true, + "description": "Request to post a set of charges, payments and generate a bill for a PasserBy or for the Post-It functionality . A PasserBy is someone who is not staying at the Property. A PasserBy transaction requires a Profile in Opera for whom the the folio is being created.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/articlesSaleCriteria" } ] } @@ -1102,6 +1534,42 @@ "schema": { "$ref": "#/definitions/articlesSale" } + }, + "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": [ @@ -1201,6 +1669,42 @@ }, "204": { "description": "AuthorizersCreditInfo 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": [ @@ -1276,6 +1780,42 @@ "schema": { "$ref": "#/definitions/batchAutoCheckoutDetails" } + }, + "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": [ @@ -1351,6 +1891,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1426,6 +2002,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1495,6 +2107,42 @@ }, "204": { "description": "BedTaxInfo 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": [ @@ -1568,6 +2216,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1653,6 +2337,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1723,6 +2443,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1798,6 +2554,42 @@ "schema": { "$ref": "#/definitions/putBillingChargesStatus" } + }, + "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": [ @@ -1901,6 +2693,42 @@ }, "204": { "description": "BatchCCSettlementsStatus 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": [ @@ -1976,6 +2804,42 @@ "schema": { "$ref": "#/definitions/bulkPrepaidCardsType" } + }, + "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": [ @@ -2053,6 +2917,42 @@ }, "204": { "description": "CashierClosure 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": [ @@ -2151,6 +3051,42 @@ }, "204": { "description": "CashierClosureReportsList 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": [ @@ -2235,6 +3171,42 @@ "schema": { "$ref": "#/definitions/folioTaxPaymentReversal" } + }, + "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": [ @@ -2319,6 +3291,42 @@ "schema": { "$ref": "#/definitions/extendedCashierLock" } + }, + "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": [ @@ -2394,6 +3402,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2469,6 +3513,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2539,6 +3619,42 @@ }, "204": { "description": "CheckDetails 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": [ @@ -2621,6 +3737,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2770,6 +3922,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2874,6 +4062,42 @@ }, "204": { "description": "CashierClosureInfo 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": [ @@ -3068,6 +4292,42 @@ }, "204": { "description": "CompAccountingJournal 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": [ @@ -3263,6 +4523,42 @@ }, "204": { "description": "CompRoutingInstructions 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": [ @@ -3437,6 +4733,42 @@ }, "204": { "description": "CompTrxAuthorizers 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": [ @@ -3517,6 +4849,42 @@ }, "204": { "description": "PostCovers 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": [ @@ -3590,6 +4958,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3665,6 +5069,42 @@ "schema": { "$ref": "#/definitions/postedCreditBill" } + }, + "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": [ @@ -3740,6 +5180,42 @@ "schema": { "$ref": "#/definitions/validatedCreditBill" } + }, + "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": [ @@ -3826,6 +5302,42 @@ }, "204": { "description": "CreditLimitOveragePayments 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": [ @@ -3899,6 +5411,42 @@ "schema": { "$ref": "#/definitions/creditLimitOveragePaymentsDetails" } + }, + "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": [ @@ -3974,6 +5522,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4438,6 +6022,42 @@ }, "204": { "description": "CCSurchargeInfo 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": [ @@ -4535,6 +6155,42 @@ }, "204": { "description": "DepositFolio 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": [ @@ -4622,6 +6278,42 @@ }, "204": { "description": "DepositFolioTransactionDetails 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": [ @@ -4697,6 +6389,42 @@ "schema": { "$ref": "#/definitions/depositedFolioValidate" } + }, + "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": [ @@ -4790,6 +6518,42 @@ "schema": { "$ref": "#/definitions/depositedPayment" } + }, + "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": [ @@ -5152,6 +6916,42 @@ }, "204": { "description": "FinancialPostings 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": [ @@ -5257,6 +7057,42 @@ }, "204": { "description": "FinancialPostings 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": [ @@ -5332,6 +7168,42 @@ "schema": { "$ref": "#/definitions/fiscalCommandsResponseInfo" } + }, + "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": [ @@ -5400,6 +7272,42 @@ }, "204": { "description": "FiscalFolioActivity 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": [ @@ -5477,6 +7385,42 @@ }, "204": { "description": "FiscalFolioActivityDetails 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": [ @@ -5552,6 +7496,42 @@ "schema": { "$ref": "#/definitions/fiscalInformationFolio" } + }, + "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": [ @@ -5750,6 +7730,42 @@ }, "204": { "description": "ValidateFiscalPrintingDetails 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": [ @@ -5959,6 +7975,42 @@ }, "204": { "description": "Supporting Documents 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": [ @@ -6032,6 +8084,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6116,6 +8204,42 @@ "schema": { "$ref": "#/definitions/convertFolioDetails" } + }, + "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": [ @@ -6201,6 +8325,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6467,6 +8627,42 @@ }, "204": { "description": "FolioHistory 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": [ @@ -6727,6 +8923,42 @@ }, "204": { "description": "FolioPrinters 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": [ @@ -6826,6 +9058,42 @@ }, "204": { "description": "FolioTypeName 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": [ @@ -6908,6 +9176,42 @@ }, "204": { "description": "FolioTypes 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": [ @@ -6992,6 +9296,42 @@ "schema": { "$ref": "#/definitions/processFiscalRetryStatus" } + }, + "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": [ @@ -7067,6 +9407,42 @@ "schema": { "$ref": "#/definitions/passerBySale" } + }, + "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": [ @@ -7151,6 +9527,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7244,6 +9656,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7361,6 +9809,42 @@ }, "204": { "description": "PostingSummary 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": [ @@ -7436,6 +9920,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7511,6 +10031,42 @@ "schema": { "$ref": "#/definitions/activatePrepaidCardStatus" } + }, + "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": [ @@ -7586,6 +10142,42 @@ "schema": { "$ref": "#/definitions/cancelPrepaidCardTransactionStatus" } + }, + "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": [ @@ -7661,6 +10253,42 @@ "schema": { "$ref": "#/definitions/cashOutPrepaidCardStatus" } + }, + "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": [ @@ -7736,6 +10364,42 @@ "schema": { "$ref": "#/definitions/reloadPrepaidCardStatus" } + }, + "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": [ @@ -7806,6 +10470,42 @@ }, "204": { "description": "HotelCreditCardWallet 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": [ @@ -7890,6 +10590,42 @@ "schema": { "$ref": "#/definitions/authorizationInfo" } + }, + "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": [ @@ -8479,6 +11215,42 @@ }, "204": { "description": "CCAuthorizationInstructionsByProfile 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": [ @@ -8598,6 +11370,42 @@ }, "204": { "description": "ReceiptHistory 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": [ @@ -8691,6 +11499,42 @@ "schema": { "$ref": "#/definitions/postedRateCode" } + }, + "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": [ @@ -8784,6 +11628,42 @@ "schema": { "$ref": "#/definitions/checkedRateCode" } + }, + "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": [ @@ -8859,6 +11739,42 @@ "schema": { "$ref": "#/definitions/postedBillingChargesInBatch" } + }, + "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": [ @@ -8949,6 +11865,42 @@ }, "204": { "description": "BatchCCSettlements 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": [ @@ -9021,6 +11973,42 @@ }, "204": { "description": "Get reservation vouchers 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": [ @@ -9119,6 +12107,42 @@ }, "204": { "description": "AdditionalTaxes 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": [ @@ -9231,6 +12255,42 @@ }, "204": { "description": "AdvancePaymentBalance 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": [ @@ -9315,6 +12375,42 @@ "schema": { "$ref": "#/definitions/advanceRoomChargesReservationInfo" } + }, + "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": [ @@ -9391,6 +12487,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9476,6 +12608,42 @@ }, "204": { "description": "Alerts 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": [ @@ -9622,6 +12790,42 @@ }, "204": { "description": "AuthorizationHistory 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": [ @@ -9908,6 +13112,42 @@ }, "204": { "description": "PostBillingCharges 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": [ @@ -9990,6 +13230,42 @@ "schema": { "$ref": "#/definitions/billingChargesDetails" } + }, + "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": [ @@ -10074,6 +13350,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10167,174 +13479,42 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Cashiering" - ] - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/checkOuts": { - "post": { - "summary": "Check out a guest", - "description": "This API enables you to check out a guest reservation which is in due out status, with options to update the room's housekeeping status and set a flag to email the guests folio.OperationId:postCheckOut
", - "operationId": "postCheckOut", - "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": "reservation", - "in": "body", - "required": true, - "description": "Checkout request can be used to verify a reservation for checkout and do an actual checkout. In case the verificationOnly attribute is sent false, the operation will perform an actual checkout. In case the verificationOnly attribute is sent true, the operation goes through the reservation in question and verifies if it's Ok to checkout, otherwise the verification status element will provide you the verification code. The verification codes are described in the documentation of verificationOnly attribute.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/reservation" - } - ] - } }, - { - "$ref": "#/parameters/authKey" + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/x-app-key" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-hotelid" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-externalsystem" + "404": { + "$ref": "#/responses/404" }, - { - "$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" - } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Cashiering" - ] - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/checkOuts/reinstate": { - "put": { - "summary": "Reinstate Checked Out Reservation", - "description": "You can use this API to reinstate Checked Out Reservation.OperationId:reinstateCheckOut
", - "operationId": "reinstateCheckOut", - "parameters": [ - { - "name": "reservationId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the reservation" + "405": { + "$ref": "#/responses/405" }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel" + "406": { + "$ref": "#/responses/406" }, - { - "name": "reinstateCheckedOutReservation", - "in": "body", - "required": true, - "description": "Request to reinstate checkout reservation in order to post additional transactions, etc.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/reinstateCheckedOutReservation" - } - ] - } + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/authKey" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-app-key" + "415": { + "$ref": "#/responses/415" }, - { - "$ref": "#/parameters/x-hotelid" + "500": { + "$ref": "#/responses/500" }, - { - "$ref": "#/parameters/x-externalsystem" + "502": { + "$ref": "#/responses/502" }, - { - "$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" - } + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10348,11 +13528,11 @@ ] } }, - "/hotels/{hotelId}/reservations/{reservationId}/comp/folios/autoSettlements": { - "put": { - "summary": "Operation to auto settle comp folios.", - "description": "You can use this API to auto Settle CompFoliosOperationId:autoSettleCompFolios
", - "operationId": "autoSettleCompFolios", + "/hotels/{hotelId}/reservations/{reservationId}/checkOuts": { + "post": { + "summary": "Check out a guest", + "description": "This API enables you to check out a guest reservation which is in due out status, with options to update the room's housekeeping status and set a flag to email the guests folio.OperationId:postCheckOut
", + "operationId": "postCheckOut", "parameters": [ { "name": "reservationId", @@ -10361,7 +13541,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of the reservation." + "description": "Unique ID of the reservation" }, { "name": "hotelId", @@ -10373,14 +13553,14 @@ "description": "Unique ID of the hotel" }, { - "name": "autoSettleCompFolios", + "name": "reservation", "in": "body", "required": true, - "description": "Request to auto settle comp folios. OPERA will reference the 'Default Comp Payment Method' setting to settle the folio if no authorizer AR account is associated with the folio.", + "description": "Checkout request can be used to verify a reservation for checkout and do an actual checkout. In case the verificationOnly attribute is sent false, the operation will perform an actual checkout. In case the verificationOnly attribute is sent true, the operation goes through the reservation in question and verifies if it's Ok to checkout, otherwise the verification status element will provide you the verification code. The verification codes are described in the documentation of verificationOnly attribute.", "schema": { "allOf": [ { - "$ref": "#/definitions/autoSettleCompFolios" + "$ref": "#/definitions/reservation" } ] } @@ -10402,7 +13582,7 @@ } ], "responses": { - "200": { + "201": { "headers": { "Content-Language": { "type": "string", @@ -10415,10 +13595,46 @@ "description": "Location of newly created resource" } }, - "description": "Response for auto settle comp folios. This includes collection of auto settled comp folios.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/autoSettleCompFoliosStatus" + "$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": [ @@ -10432,11 +13648,11 @@ ] } }, - "/hotels/{hotelId}/reservations/{reservationId}/compRedemptionPostings": { - "post": { - "summary": "Operation to post complimentary bucket redemptions for a guest having PTS Membership Type", - "description": "You can use this API to post complimentary bucket redemptions for a guest having PTS Membership TypeOperationId:postCompRedemptions
", - "operationId": "postCompRedemptions", + "/hotels/{hotelId}/reservations/{reservationId}/checkOuts/reinstate": { + "put": { + "summary": "Reinstate Checked Out Reservation", + "description": "You can use this API to reinstate Checked Out Reservation.OperationId:reinstateCheckOut
", + "operationId": "reinstateCheckOut", "parameters": [ { "name": "reservationId", @@ -10457,14 +13673,14 @@ "description": "Unique ID of the hotel" }, { - "name": "postCompRedemptions", + "name": "reinstateCheckedOutReservation", "in": "body", "required": true, - "description": "Request type of Complimentary Bucket Redemptions posting.", + "description": "Request to reinstate checkout reservation in order to post additional transactions, etc.", "schema": { "allOf": [ { - "$ref": "#/definitions/postCompRedemptions" + "$ref": "#/definitions/reinstateCheckedOutReservation" } ] } @@ -10486,7 +13702,7 @@ } ], "responses": { - "201": { + "200": { "headers": { "Content-Language": { "type": "string", @@ -10499,10 +13715,46 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "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": [ @@ -10516,11 +13768,11 @@ ] } }, - "/hotels/{hotelId}/reservations/{reservationId}/compRedemptionReversals": { - "post": { - "summary": "Operation to reverse complimentary bucket redemptions for a guest having PTS Membership Type", - "description": "You can use this API to reverse complimentary bucket redemptions for a guest having PTS Membership TypeOperationId:reverseCompRedemptions
", - "operationId": "reverseCompRedemptions", + "/hotels/{hotelId}/reservations/{reservationId}/comp/folios/autoSettlements": { + "put": { + "summary": "Operation to auto settle comp folios.", + "description": "You can use this API to auto Settle CompFoliosOperationId:autoSettleCompFolios
", + "operationId": "autoSettleCompFolios", "parameters": [ { "name": "reservationId", @@ -10529,7 +13781,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of the reservation" + "description": "Unique ID of the reservation." }, { "name": "hotelId", @@ -10541,14 +13793,14 @@ "description": "Unique ID of the hotel" }, { - "name": "reverseCompRedemptions", + "name": "autoSettleCompFolios", "in": "body", "required": true, - "description": "Request type of Complimentary Bucket Redemptions reversal.", + "description": "Request to auto settle comp folios. OPERA will reference the 'Default Comp Payment Method' setting to settle the folio if no authorizer AR account is associated with the folio.", "schema": { "allOf": [ { - "$ref": "#/definitions/reverseCompRedemptions" + "$ref": "#/definitions/autoSettleCompFolios" } ] } @@ -10570,7 +13822,7 @@ } ], "responses": { - "201": { + "200": { "headers": { "Content-Language": { "type": "string", @@ -10583,10 +13835,46 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response for auto settle comp folios. This includes collection of auto settled comp folios.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/autoSettleCompFoliosStatus" } + }, + "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": [ @@ -10600,11 +13888,11 @@ ] } }, - "/hotels/{hotelId}/reservations/{reservationId}/deferredTaxesProcess": { + "/hotels/{hotelId}/reservations/{reservationId}/compRedemptionPostings": { "post": { - "summary": "Request to submit a job to post the deferred taxes.", - "description": "Request to submit a job to post the deferred taxes.OperationId:postDeferredTaxesProcess
", - "operationId": "postDeferredTaxesProcess", + "summary": "Operation to post complimentary bucket redemptions for a guest having PTS Membership Type", + "description": "You can use this API to post complimentary bucket redemptions for a guest having PTS Membership TypeOperationId:postCompRedemptions
", + "operationId": "postCompRedemptions", "parameters": [ { "name": "reservationId", @@ -10625,14 +13913,14 @@ "description": "Unique ID of the hotel" }, { - "name": "deferredTaxesProcess", + "name": "postCompRedemptions", "in": "body", "required": true, - "description": "Request to submit a job to post the deferred taxes.", + "description": "Request type of Complimentary Bucket Redemptions posting.", "schema": { "allOf": [ { - "$ref": "#/definitions/deferredTaxesProcess" + "$ref": "#/definitions/postCompRedemptions" } ] } @@ -10667,10 +13955,46 @@ "description": "Location of newly created resource" } }, - "description": "Response containing the job identifier to post the deferred taxes. Returns appropriate warnings in case if deferred tax is not enabled for the hotel or deferred tax is enabled but the reservation has deferred taxes already posted or currently under process", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { - "$ref": "#/definitions/deferredTaxesProcessDetails" + "$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": [ @@ -10684,11 +14008,11 @@ ] } }, - "/hotels/{hotelId}/reservations/{reservationId}/deposit": { + "/hotels/{hotelId}/reservations/{reservationId}/compRedemptionReversals": { "post": { - "summary": "Process Reservations deposit", - "description": "You can use this API to Process reservations deposit.OperationId:processReservationDeposit
", - "operationId": "processReservationDeposit", + "summary": "Operation to reverse complimentary bucket redemptions for a guest having PTS Membership Type", + "description": "You can use this API to reverse complimentary bucket redemptions for a guest having PTS Membership TypeOperationId:reverseCompRedemptions
", + "operationId": "reverseCompRedemptions", "parameters": [ { "name": "reservationId", @@ -10697,7 +14021,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of the reservation." + "description": "Unique ID of the reservation" }, { "name": "hotelId", @@ -10709,14 +14033,14 @@ "description": "Unique ID of the hotel" }, { - "name": "reservationDepositCriteria", + "name": "reverseCompRedemptions", "in": "body", "required": true, - "description": "Request object to process reservation deposit.", + "description": "Request type of Complimentary Bucket Redemptions reversal.", "schema": { "allOf": [ { - "$ref": "#/definitions/reservationDepositCriteria" + "$ref": "#/definitions/reverseCompRedemptions" } ] } @@ -10755,6 +14079,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10768,11 +14128,11 @@ ] } }, - "/hotels/{hotelId}/reservations/{reservationId}/depositFolios": { + "/hotels/{hotelId}/reservations/{reservationId}/deferredTaxesProcess": { "post": { - "summary": "Create Deposit Folio", - "description": "You can use this API to create Deposit Folio.OperationId:postDepositFolio
", - "operationId": "postDepositFolio", + "summary": "Request to submit a job to post the deferred taxes.", + "description": "Request to submit a job to post the deferred taxes.OperationId:postDeferredTaxesProcess
", + "operationId": "postDeferredTaxesProcess", "parameters": [ { "name": "reservationId", @@ -10781,7 +14141,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of the reservation." + "description": "Unique ID of the reservation" }, { "name": "hotelId", @@ -10793,14 +14153,14 @@ "description": "Unique ID of the hotel" }, { - "name": "depositFolioCriteria", + "name": "deferredTaxesProcess", "in": "body", "required": true, - "description": "Request to create a Deposit Folio for a reservation.", + "description": "Request to submit a job to post the deferred taxes.", "schema": { "allOf": [ { - "$ref": "#/definitions/depositFolioCriteria" + "$ref": "#/definitions/deferredTaxesProcess" } ] } @@ -10835,101 +14195,46 @@ "description": "Location of newly created resource" } }, - "description": "Response to the request to create a Deposit Folio for a reservation.", + "description": "Response containing the job identifier to post the deferred taxes. Returns appropriate warnings in case if deferred tax is not enabled for the hotel or deferred tax is enabled but the reservation has deferred taxes already posted or currently under process", "schema": { - "$ref": "#/definitions/postedDepositFolio" + "$ref": "#/definitions/deferredTaxesProcessDetails" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Cashiering" - ] - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/depositMaturity": { - "get": { - "summary": "Get Deposit Maturity Information", - "description": "You can use this API to get Deposit Maturity Information.OperationId:getDepositMaturityInfo
", - "operationId": "getDepositMaturityInfo", - "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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "cashierId", - "in": "query", - "required": false, - "type": "number", - "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." + "401": { + "$ref": "#/responses/401" }, - { - "name": "idContext", - "in": "query", - "required": false, - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "type": "string" + "403": { + "$ref": "#/responses/403" }, - { - "name": "type", - "in": "query", - "required": false, - "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).", - "type": "string" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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 deposit maturity information type.", - "schema": { - "$ref": "#/definitions/depositMaturityDetails" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "DepositMaturityInfo not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10943,11 +14248,11 @@ ] } }, - "/hotels/{hotelId}/reservations/{reservationId}/depositPayments": { + "/hotels/{hotelId}/reservations/{reservationId}/deposit": { "post": { - "summary": "Create Deposit Payment", - "description": "You can use this API to create Deposit Payment.OperationId:postDepositPayment
", - "operationId": "postDepositPayment", + "summary": "Process Reservations deposit", + "description": "You can use this API to Process reservations deposit.OperationId:processReservationDeposit
", + "operationId": "processReservationDeposit", "parameters": [ { "name": "reservationId", @@ -10956,7 +14261,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of the reservation" + "description": "Unique ID of the reservation." }, { "name": "hotelId", @@ -10968,14 +14273,381 @@ "description": "Unique ID of the hotel" }, { - "name": "depositPayment", + "name": "reservationDepositCriteria", "in": "body", "required": true, - "description": "Request to post a deposit payment to a reservation.", + "description": "Request object to process reservation deposit.", "schema": { "allOf": [ { - "$ref": "#/definitions/depositPayment" + "$ref": "#/definitions/reservationDepositCriteria" + } + ] + } + }, + { + "$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": [ + "Cashiering" + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/depositFolios": { + "post": { + "summary": "Create Deposit Folio", + "description": "You can use this API to create Deposit Folio.OperationId:postDepositFolio
", + "operationId": "postDepositFolio", + "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": "depositFolioCriteria", + "in": "body", + "required": true, + "description": "Request to create a Deposit Folio for a reservation.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/depositFolioCriteria" + } + ] + } + }, + { + "$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 to the request to create a Deposit Folio for a reservation.", + "schema": { + "$ref": "#/definitions/postedDepositFolio" + } + }, + "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}/depositMaturity": { + "get": { + "summary": "Get Deposit Maturity Information", + "description": "You can use this API to get Deposit Maturity Information.OperationId:getDepositMaturityInfo
", + "operationId": "getDepositMaturityInfo", + "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": "cashierId", + "in": "query", + "required": false, + "type": "number", + "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." + }, + { + "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. Refer to OpenTravel Code List Unique ID Type (UIT).", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + } + }, + "description": "Response object for deposit maturity information type.", + "schema": { + "$ref": "#/definitions/depositMaturityDetails" + } + }, + "204": { + "description": "DepositMaturityInfo 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": [ + "Cashiering" + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/depositPayments": { + "post": { + "summary": "Create Deposit Payment", + "description": "You can use this API to create Deposit Payment.OperationId:postDepositPayment
", + "operationId": "postDepositPayment", + "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": "depositPayment", + "in": "body", + "required": true, + "description": "Request to post a deposit payment to a reservation.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/depositPayment" } ] } @@ -11014,6 +14686,42 @@ "schema": { "$ref": "#/definitions/depositedPayment" } + }, + "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": [ @@ -11082,6 +14790,42 @@ }, "204": { "description": "MaturedDeposits 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": [ @@ -11166,6 +14910,42 @@ "schema": { "$ref": "#/definitions/depositTransitionStatus" } + }, + "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": [ @@ -11250,6 +15030,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11377,6 +15193,42 @@ }, "204": { "description": "verifyForEarlyDeparture 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": [ @@ -11454,6 +15306,42 @@ }, "204": { "description": "EligibleBillAmount 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": [ @@ -11538,6 +15426,42 @@ }, "204": { "description": "fetchStagedTransactions 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": [ @@ -11622,6 +15546,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11706,6 +15666,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11834,6 +15830,42 @@ }, "204": { "description": "FiscalPrintingDetails 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": [ @@ -11918,6 +15950,42 @@ }, "204": { "description": "FixedCharges 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": [ @@ -12000,6 +16068,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12080,6 +16184,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12162,6 +16302,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12246,6 +16422,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13129,6 +17341,42 @@ }, "204": { "description": "FolioTaxPaymentsInfo 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": [ @@ -13354,6 +17602,42 @@ }, "204": { "description": "Folio 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": [ @@ -13436,6 +17720,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13518,6 +17838,42 @@ "schema": { "$ref": "#/definitions/generatedFolio" } + }, + "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": [ @@ -13605,6 +17961,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13676,6 +18068,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13746,6 +18174,42 @@ }, "204": { "description": "ReservationPackageOptions 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": [ @@ -13830,6 +18294,42 @@ "schema": { "$ref": "#/definitions/authorizationInfo" } + }, + "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": [ @@ -13914,6 +18414,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14503,6 +19039,42 @@ }, "204": { "description": "CCAuthorizationInstructions 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": [ @@ -14587,6 +19159,42 @@ "schema": { "$ref": "#/definitions/postedBillingPayment" } + }, + "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": [ @@ -14733,6 +19341,42 @@ }, "204": { "description": "PostingActivityDetail 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": [ @@ -14817,6 +19461,42 @@ "schema": { "$ref": "#/definitions/redeemPrepaidCardsStatus" } + }, + "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": [ @@ -14835,6 +19515,7 @@ "summary": "Create proforma", "description": "You can use this API to create proforma for a specific reservation.OperationId:postProforma
", "operationId": "postProforma", + "deprecated": true, "parameters": [ { "name": "reservationId", @@ -14901,6 +19582,42 @@ "schema": { "$ref": "#/definitions/reservationFolioInformation" } + }, + "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": [ @@ -14999,6 +19716,42 @@ }, "204": { "description": "ReservationRevenueBucketTotals 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": [ @@ -15083,6 +19836,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15196,6 +19985,42 @@ }, "204": { "description": "RoutingInstructions 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": [ @@ -15266,6 +20091,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15350,6 +20211,42 @@ "schema": { "$ref": "#/definitions/changedRoutingInstructions" } + }, + "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": [ @@ -15618,6 +20515,42 @@ "schema": { "$ref": "#/definitions/roomRoutingPostings" } + }, + "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": [ @@ -15702,6 +20635,42 @@ "schema": { "$ref": "#/definitions/createdRoutingInstructions" } + }, + "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": [ @@ -15936,6 +20905,42 @@ "schema": { "$ref": "#/definitions/roomRoutingPostings" } + }, + "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": [ @@ -16097,6 +21102,42 @@ "schema": { "$ref": "#/definitions/roomRoutingPostings" } + }, + "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": [ @@ -16325,6 +21366,42 @@ "schema": { "$ref": "#/definitions/roomRoutingPostings" } + }, + "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": [ @@ -16418,6 +21495,42 @@ }, "204": { "description": "isDepositRefundEligible 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": [ @@ -16509,6 +21622,42 @@ "schema": { "$ref": "#/definitions/splitDepositTransactionStatus" } + }, + "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": [ @@ -16593,6 +21742,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16677,6 +21862,42 @@ "schema": { "$ref": "#/definitions/transferTransactionToWindow" } + }, + "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": [ @@ -16770,6 +21991,42 @@ "schema": { "$ref": "#/definitions/voidedFolio" } + }, + "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": [ @@ -16840,6 +22097,42 @@ }, "204": { "description": "Get reservation vouchers 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": [ @@ -16909,6 +22202,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16993,6 +22322,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17077,6 +22442,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17146,6 +22547,42 @@ }, "204": { "description": "HotelRevenue 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": [ @@ -17263,6 +22700,42 @@ }, "204": { "description": "BillingInstructionCodes 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": [ @@ -17356,6 +22829,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17837,6 +23346,42 @@ }, "204": { "description": "PostingsForRefresh 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": [ @@ -17928,6 +23473,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18051,6 +23632,42 @@ }, "204": { "description": "StoredFolioDetails 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": [ @@ -18133,6 +23750,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18208,6 +23861,42 @@ "schema": { "$ref": "#/definitions/postSupplementalFolioStatus" } + }, + "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": [ @@ -18407,6 +24096,42 @@ }, "204": { "description": "TransactionCodes 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": [ @@ -18494,6 +24219,42 @@ }, "204": { "description": "FolioTransactionDetails 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": [ @@ -18826,6 +24587,42 @@ }, "204": { "description": "GuestsTransactions 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": [ @@ -18901,6 +24698,42 @@ "schema": { "$ref": "#/definitions/adjustedTransactions" } + }, + "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": [ @@ -18989,6 +24822,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19064,6 +24933,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19139,6 +25044,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19293,6 +25234,42 @@ }, "204": { "description": "validateTransactionCodes 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": [ @@ -19375,6 +25352,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19459,6 +25472,42 @@ "schema": { "$ref": "#/definitions/billingChargeStatus" } + }, + "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": [ @@ -19529,6 +25578,42 @@ }, "204": { "description": "GamingRequestStatusInfo 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": [ @@ -19600,6 +25685,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19684,6 +25805,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19768,6 +25925,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19852,6 +26045,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20290,6 +26519,42 @@ }, "204": { "description": "BalanceInfo 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": [ @@ -20365,6 +26630,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20440,6 +26741,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20515,6 +26852,42 @@ "schema": { "$ref": "#/definitions/batchZeroBalanceCheckoutDetails" } + }, + "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": [ @@ -20590,6 +26963,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21026,6 +27435,42 @@ }, "204": { "description": "RoundingDifference 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": [ @@ -37678,6 +44123,10 @@ "type": "string", "minLength": 0, "maxLength": 2000 + }, + "reason": { + "description": "The Reason Code and Reason Text which is required when a folio is voided. This input is mandatory when the parameter Void Bill Reason is active for Void Bills", + "$ref": "#/definitions/folioReasonType" } } }, @@ -39936,6 +46385,10 @@ }, "cashierId": { "type": "number" + }, + "giftCard": { + "description": "Indicates a gift card type.", + "type": "boolean" } } }, @@ -40213,4 +46666,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/dvm.json b/rest-api-specs/property/dvm.json index 4966784..5d41858 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -85,6 +85,42 @@ }, "204": { "description": "OperaHotelCode 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": [ @@ -317,6 +353,42 @@ }, "204": { "description": "ConvertedValues 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": [ @@ -387,6 +459,42 @@ }, "204": { "description": "DefaultValues 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": [ @@ -440,6 +548,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1110,4 +1254,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/entcfg.json b/rest-api-specs/property/entcfg.json index caee72d..055a92a 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -72,6 +72,42 @@ }, "204": { "description": "TemplateAirports 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": [ @@ -136,6 +172,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -211,6 +283,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -271,6 +379,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -348,6 +492,42 @@ }, "204": { "description": "TemplateAmenities 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": [ @@ -412,6 +592,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -487,6 +703,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -547,6 +799,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -632,6 +920,42 @@ }, "204": { "description": "AttractionClasses 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": [ @@ -696,6 +1020,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -771,6 +1131,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -831,6 +1227,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -913,6 +1345,42 @@ }, "204": { "description": "AttractionTemplates 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": [ @@ -977,6 +1445,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1052,6 +1556,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1112,6 +1652,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1197,6 +1773,42 @@ }, "204": { "description": "BrandCodes 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": [ @@ -1261,6 +1873,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1336,6 +1984,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1407,6 +2091,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1496,6 +2216,42 @@ }, "204": { "description": "PropertyCalendar 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": [ @@ -1590,6 +2346,42 @@ }, "204": { "description": "Chain 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": [ @@ -1665,6 +2457,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1750,6 +2578,42 @@ }, "204": { "description": "CommunicationMethodsEntDetails 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": [ @@ -1814,6 +2678,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1889,6 +2789,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1960,6 +2896,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2132,6 +3104,42 @@ }, "204": { "description": "ConfigActivityLog 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": [ @@ -2196,6 +3204,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2281,6 +3325,42 @@ }, "204": { "description": "CorporateBusinessUnits 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": [ @@ -2345,6 +3425,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2420,6 +3536,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2491,6 +3643,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2576,6 +3764,42 @@ }, "204": { "description": "CorporateDepartmentCodes 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": [ @@ -2640,6 +3864,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2715,6 +3975,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2775,6 +4071,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2860,6 +4192,42 @@ }, "204": { "description": "CorporateDivisions 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": [ @@ -2924,6 +4292,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2999,6 +4403,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3070,6 +4510,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3155,6 +4631,42 @@ }, "204": { "description": "CorporateOperatingUnits 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": [ @@ -3219,6 +4731,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3294,6 +4842,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3365,6 +4949,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3436,6 +5056,42 @@ }, "204": { "description": "TemplateCountries 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": [ @@ -3500,6 +5156,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3585,6 +5277,42 @@ }, "204": { "description": "CountryGuestTypes 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": [ @@ -3649,6 +5377,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3724,6 +5488,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3795,6 +5595,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3870,6 +5706,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3930,6 +5802,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4015,6 +5923,42 @@ }, "204": { "description": "CountryMainGroups 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": [ @@ -4079,6 +6023,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4154,6 +6134,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4225,6 +6241,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4325,6 +6377,42 @@ }, "204": { "description": "CurrencyExchangeRates 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": [ @@ -4396,6 +6484,42 @@ }, "204": { "description": "TemplateDayTypeCodes 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": [ @@ -4460,6 +6584,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4522,6 +6682,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4586,6 +6782,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4652,6 +6884,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4787,6 +7055,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4860,6 +7164,42 @@ }, "204": { "description": "DefaultNote 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": [ @@ -4942,6 +7282,42 @@ }, "204": { "description": "Departments 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": [ @@ -5006,6 +7382,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5075,6 +7487,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5148,6 +7596,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5257,6 +7741,42 @@ }, "204": { "description": "Flex field 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": [ @@ -5321,6 +7841,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5406,6 +7962,42 @@ }, "204": { "description": "HotelCategories 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": [ @@ -5470,6 +8062,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5545,6 +8173,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5605,6 +8269,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5679,6 +8379,42 @@ }, "204": { "description": "TemplateHotelDetails 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": [ @@ -5743,143 +8479,42 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "HotelConfig" - ] - }, - "put": { - "summary": "Change hotel details specified at the template level", - "description": "Use this API to update hotel details specified at the template level.OperationId:changeTemplateHotelDetails
", - "operationId": "changeTemplateHotelDetails", - "parameters": [ - { - "name": "templateHotelDetailsToBeChanged", - "in": "body", - "required": true, - "description": "Request object for changing hotel details at the template level.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/templateHotelDetailsToBeChanged" - } - ] - } }, - { - "$ref": "#/parameters/authKey" + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/x-app-key" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-hotelid" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-externalsystem" + "404": { + "$ref": "#/responses/404" }, - { - "$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" - } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "HotelConfig" - ] - }, - "delete": { - "summary": "Delete hotel details specified at the template level", - "description": "Use this API to delete hotel details specified at the template level.OperationId:removeTemplateHotelDetails
", - "operationId": "removeTemplateHotelDetails", - "parameters": [ - { - "name": "templateHotelDetailCode", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Specifies the hotel detail code.", - "items": { - "type": "string" - }, - "required": false + "405": { + "$ref": "#/responses/405" }, - { - "name": "templateHotelDetailCategory", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Specifies the hotel detail category.", - "items": { - "type": "string" - }, - "required": false + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/authKey" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-app-key" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-hotelid" + "415": { + "$ref": "#/responses/415" }, - { - "$ref": "#/parameters/x-externalsystem" + "500": { + "$ref": "#/responses/500" }, - { - "$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" - } + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5891,23 +8526,21 @@ "tags": [ "HotelConfig" ] - } - }, - "/hotelDetails/copy": { + }, "put": { - "summary": "Copy template hotel details to other properties", - "description": "Use this API to copy template hotel details to other properties.OperationId:copyHotelDetails
", - "operationId": "copyHotelDetails", + "summary": "Change hotel details specified at the template level", + "description": "Use this API to update hotel details specified at the template level.OperationId:changeTemplateHotelDetails
", + "operationId": "changeTemplateHotelDetails", "parameters": [ { - "name": "copyHotelDetails", + "name": "templateHotelDetailsToBeChanged", "in": "body", "required": true, - "description": "Request object for copying template hotel details to hotel(s).", + "description": "Request object for changing hotel details at the template level.", "schema": { "allOf": [ { - "$ref": "#/definitions/copyHotelDetails" + "$ref": "#/definitions/templateHotelDetailsToBeChanged" } ] } @@ -5946,6 +8579,253 @@ "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": [ + "HotelConfig" + ] + }, + "delete": { + "summary": "Delete hotel details specified at the template level", + "description": "Use this API to delete hotel details specified at the template level.OperationId:removeTemplateHotelDetails
", + "operationId": "removeTemplateHotelDetails", + "parameters": [ + { + "name": "templateHotelDetailCode", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Specifies the hotel detail code.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "templateHotelDetailCategory", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Specifies the hotel detail category.", + "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": [ + "HotelConfig" + ] + } + }, + "/hotelDetails/copy": { + "put": { + "summary": "Copy template hotel details to other properties", + "description": "Use this API to copy template hotel details to other properties.OperationId:copyHotelDetails
", + "operationId": "copyHotelDetails", + "parameters": [ + { + "name": "copyHotelDetails", + "in": "body", + "required": true, + "description": "Request object for copying template hotel details to hotel(s).", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/copyHotelDetails" + } + ] + } + }, + { + "$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": [ @@ -6066,6 +8946,42 @@ }, "204": { "description": "Hotels 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": [ @@ -6139,6 +9055,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9740,6 +12692,42 @@ }, "204": { "description": "Hotel 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": [ @@ -9813,6 +12801,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9912,6 +12936,42 @@ }, "204": { "description": "Airports 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": [ @@ -9985,6 +13045,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10069,6 +13165,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10138,6 +13270,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10213,6 +13381,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10297,6 +13501,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10366,6 +13606,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10464,6 +13740,42 @@ }, "204": { "description": "Amenities 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": [ @@ -10537,6 +13849,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10621,6 +13969,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10702,6 +14086,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10805,6 +14225,42 @@ }, "204": { "description": "Attractions 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": [ @@ -10878,6 +14334,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10962,6 +14454,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11042,6 +14570,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11133,6 +14697,277 @@ }, "204": { "description": "HotelCalendar not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "HotelConfig" + ] + } + }, + "/hotels/{hotelId}/centralConfigs/{config}": { + "get": { + "summary": "Lists the configurations managed centrally", + "description": "This API will get the configuration items added from central within the property for this Configuration.OperationId:getCentralConfig
", + "operationId": "getCentralConfig", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID that identifies a single hotel property." + }, + { + "name": "config", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Configuration to be checked for listing the centrally managed items." + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + } + }, + "description": "List of configurations added from central.", + "schema": { + "$ref": "#/definitions/centralConfigsResponse" + } + }, + "204": { + "description": "Central Configs not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "HotelConfig" + ] + } + }, + "/hotels/{hotelId}/centralConfigs/{config}/items/{code}": { + "put": { + "summary": "Change the status for Central Config to manage at Hotel/Enterprise Level.", + "description": "This API will manage if config can be updated from Hotel.OperationId:changeCentralConfig
", + "operationId": "changeCentralConfig", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 200, + "description": "Unique ID that identifies a single hotel property." + }, + { + "name": "config", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 200, + "description": "Configuration to be checked for listing the configs." + }, + { + "name": "centralConfig", + "in": "body", + "required": true, + "description": "Central Configuration", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/centralConfigRequest" + } + ] + } + }, + { + "name": "code", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 200, + "description": "Configuration Item to be modified." + }, + { + "$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 updated 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": [ @@ -11208,6 +15043,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11292,6 +15163,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11368,6 +15275,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11463,6 +15406,42 @@ }, "204": { "description": "Countries 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": [ @@ -11547,6 +15526,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11653,6 +15668,42 @@ }, "204": { "description": "CreditCardTypes 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": [ @@ -11724,6 +15775,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11797,6 +15884,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11870,6 +15993,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11962,6 +16121,42 @@ }, "204": { "description": "HotelDayTypeCodes 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": [ @@ -12035,6 +16230,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12108,6 +16339,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12179,6 +16446,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12254,6 +16557,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12387,6 +16726,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12456,6 +16831,42 @@ }, "204": { "description": "Flex field 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": [ @@ -12536,6 +16947,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12603,6 +17050,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16358,6 +20841,42 @@ }, "204": { "description": "HotelBrochure 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": [ @@ -16453,6 +20972,42 @@ }, "204": { "description": "HotelDetails 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": [ @@ -16537,6 +21092,42 @@ }, "204": { "description": "JobTitles 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": [ @@ -16610,6 +21201,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16690,79 +21317,151 @@ "description": "Location of newly created resource" } }, - "description": "Response Body.", + "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": [ + "HotelConfig" + ] + }, + "delete": { + "summary": "Delete resort job titles", + "description": "Use this API to delete resort job titles.OperationId:removeJobTitles
", + "operationId": "removeJobTitles", + "parameters": [ + { + "name": "jobTitleCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Code for Job Title." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." + }, + { + "$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" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "HotelConfig" - ] - }, - "delete": { - "summary": "Delete resort job titles", - "description": "Use this API to delete resort job titles.OperationId:removeJobTitles
", - "operationId": "removeJobTitles", - "parameters": [ - { - "name": "jobTitleCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Code for Job Title." }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of hotel." + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/authKey" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-app-key" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-hotelid" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-externalsystem" + "405": { + "$ref": "#/responses/405" }, - { - "$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" - } + "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": [ @@ -16887,6 +21586,42 @@ }, "204": { "description": "MarketingCities 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": [ @@ -16960,6 +21695,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17044,6 +21815,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17120,6 +21927,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17195,6 +22038,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17279,6 +22158,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17340,6 +22255,42 @@ }, "204": { "description": "OperaHotelContext 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": [ @@ -17415,6 +22366,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17488,6 +22475,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17568,6 +22591,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17643,6 +22702,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17727,6 +22822,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17796,6 +22927,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17876,6 +23043,42 @@ }, "204": { "description": "TelephoneBookCategories 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": [ @@ -17949,6 +23152,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18033,6 +23272,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18132,6 +23407,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18207,6 +23518,42 @@ }, "204": { "description": "TelephoneBookEntries 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": [ @@ -18280,6 +23627,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18364,6 +23747,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18444,6 +23863,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18536,6 +23991,42 @@ }, "204": { "description": "Transportation 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": [ @@ -18609,6 +24100,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18693,6 +24220,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18962,6 +24525,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19068,6 +24667,42 @@ }, "204": { "description": "YieldAdjustmentCodes 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": [ @@ -19141,6 +24776,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19225,6 +24896,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19294,6 +25001,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19374,6 +25117,42 @@ }, "204": { "description": "YieldCategories 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": [ @@ -19447,6 +25226,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19527,79 +25342,151 @@ "description": "Location of newly created resource" } }, - "description": "Response Body.", + "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": [ + "HotelConfig" + ] + }, + "delete": { + "summary": "Delete Yield Category", + "description": "Use this API to delete Yield Category.OperationId:removeYieldCategories
", + "operationId": "removeYieldCategories", + "parameters": [ + { + "name": "code", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of yield category." + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of hotel." + }, + { + "$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" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "HotelConfig" - ] - }, - "delete": { - "summary": "Delete Yield Category", - "description": "Use this API to delete Yield Category.OperationId:removeYieldCategories
", - "operationId": "removeYieldCategories", - "parameters": [ - { - "name": "code", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique Code of yield category." }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of hotel." + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/authKey" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-app-key" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-hotelid" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-externalsystem" + "405": { + "$ref": "#/responses/405" }, - { - "$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" - } + "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": [ @@ -19671,6 +25558,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19746,6 +25669,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19821,6 +25780,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19896,6 +25891,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19959,6 +25990,42 @@ }, "204": { "description": "TemplateJobTitles 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": [ @@ -20023,6 +26090,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20098,6 +26201,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20158,6 +26297,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20235,6 +26410,42 @@ }, "204": { "description": "Languages 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": [ @@ -20282,7 +26493,118 @@ } ], "responses": { - "201": { + "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": [ + "HotelConfig" + ] + } + }, + "/languages/{languageCode}": { + "put": { + "summary": "Update a Language", + "description": "Update a Language.OperationId:changeLanguages
", + "operationId": "changeLanguages", + "parameters": [ + { + "name": "languageCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Code of language." + }, + { + "name": "languagesToBeChanged", + "in": "body", + "required": true, + "description": "Request object for changing details of existing language records.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/languagesToBeChanged" + } + ] + } + }, + { + "$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", @@ -20295,85 +26617,46 @@ "description": "Location of newly created resource" } }, - "description": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response Body.", "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "HotelConfig" - ] - } - }, - "/languages/{languageCode}": { - "put": { - "summary": "Update a Language", - "description": "Update a Language.OperationId:changeLanguages
", - "operationId": "changeLanguages", - "parameters": [ - { - "name": "languageCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique Code of language." }, - { - "name": "languagesToBeChanged", - "in": "body", - "required": true, - "description": "Request object for changing details of existing language records.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/languagesToBeChanged" - } - ] - } + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/authKey" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-app-key" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-hotelid" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-externalsystem" + "405": { + "$ref": "#/responses/405" }, - { - "$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" - } + "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": [ @@ -20434,6 +26717,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20537,6 +26856,42 @@ }, "204": { "description": "TemplateMarketingCities 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": [ @@ -20601,6 +26956,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20667,6 +27058,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20742,6 +27169,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20809,6 +27272,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20875,6 +27374,42 @@ }, "204": { "description": "MarketingCitiesByRegion 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": [ @@ -20960,6 +27495,42 @@ }, "204": { "description": "MarketingRegions 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": [ @@ -21024,6 +27595,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21099,6 +27706,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21170,6 +27813,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21261,6 +27940,42 @@ }, "204": { "description": "NoteTypes 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": [ @@ -21325,6 +28040,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21400,6 +28151,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21467,6 +28254,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21529,6 +28352,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21592,6 +28451,42 @@ }, "204": { "description": "OperaParameters 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": [ @@ -21677,6 +28572,42 @@ }, "204": { "description": "PropertyDetailCategories 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": [ @@ -21741,6 +28672,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21816,6 +28783,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21887,6 +28890,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21972,6 +29011,42 @@ }, "204": { "description": "PropertyTypes 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": [ @@ -22036,6 +29111,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22111,6 +29222,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22182,6 +29329,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22267,6 +29450,42 @@ }, "204": { "description": "RegionsCode 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": [ @@ -22331,6 +29550,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22406,6 +29661,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22466,6 +29757,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22551,6 +29878,42 @@ }, "204": { "description": "RoomAmenities 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": [ @@ -22615,6 +29978,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22690,6 +30089,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22761,6 +30196,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22837,6 +30308,42 @@ }, "204": { "description": "OperaSettings 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": [ @@ -22910,6 +30417,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22995,6 +30538,42 @@ }, "204": { "description": "TemplateCodes 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": [ @@ -23059,6 +30638,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23124,6 +30739,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23199,6 +30850,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23270,6 +30957,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23341,6 +31064,42 @@ }, "204": { "description": "TransportationTemplates 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": [ @@ -23405,6 +31164,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23480,6 +31275,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23540,6 +31371,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23611,6 +31478,42 @@ }, "204": { "description": "UserDefinedFieldGroups 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": [ @@ -23675,6 +31578,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23750,6 +31689,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23810,6 +31785,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23887,6 +31898,42 @@ }, "204": { "description": "UserDefinedFieldValues 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": [ @@ -23951,6 +31998,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24026,6 +32109,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24093,6 +32212,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24171,6 +32326,42 @@ }, "204": { "description": "YieldMarketTypes 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": [ @@ -24235,6 +32426,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24299,6 +32526,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -41098,6 +49361,61 @@ "$ref": "#/definitions/warningsType" } } + }, + "centralConfigsResponse": { + "type": "object", + "properties": { + "configs": { + "type": "array", + "description": "Collection of Central Config Details", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/centralConfig" + } + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "centralConfigRequest": { + "type": "object", + "properties": { + "configuration": { + "$ref": "#/definitions/centralConfig" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "centralConfig": { + "type": "object", + "description": "Type that holds Central Config", + "properties": { + "config": { + "description": "Configuarion Classification", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "code": { + "description": "Unique identifier of Configuation Item", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "status": { + "type": "string", + "description": "Status of the Configuation Item." + } + } } }, "tags": [ @@ -41114,4 +49432,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/evm.json b/rest-api-specs/property/evm.json index a884122..d62e4db 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -730,6 +730,42 @@ "schema": { "$ref": "#/definitions/manageAlternateEventsStatus" } + }, + "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": [ @@ -805,6 +841,42 @@ "schema": { "$ref": "#/definitions/blockCateringPackageDetails" } + }, + "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": [ @@ -885,6 +957,42 @@ }, "204": { "description": "CateringPackages 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": [ @@ -958,6 +1066,42 @@ "schema": { "$ref": "#/definitions/cateringPackages" } + }, + "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": [ @@ -1042,6 +1186,42 @@ "schema": { "$ref": "#/definitions/copyCateringPackageResponse" } + }, + "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": [ @@ -1247,6 +1427,42 @@ }, "204": { "description": "CateringPackageRevenue 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": [ @@ -1329,6 +1545,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2068,6 +2320,42 @@ "schema": { "$ref": "#/definitions/eventResourcesResponse" } + }, + "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": [ @@ -2807,6 +3095,42 @@ "schema": { "$ref": "#/definitions/eventResourcesResponse" } + }, + "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": [ @@ -4050,6 +4374,42 @@ }, "204": { "description": "EventResourceByMenu 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": [ @@ -4116,6 +4476,42 @@ "schema": { "$ref": "#/definitions/cateringEventsBulkUpdateStatus" } + }, + "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": [ @@ -4259,6 +4655,42 @@ "schema": { "$ref": "#/definitions/cateringPackageRevenue" } + }, + "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": [ @@ -4330,6 +4762,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6594,6 +7062,42 @@ ] } } + }, + "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": [ @@ -6840,6 +7344,52 @@ }, "required": false }, + { + "name": "eventHints", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "multi", + "description": "A collection of supported event hint values in UI for Events.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "Account", + "Attendees", + "BlockCode", + "BlockName", + "BlockNonCompete", + "BlockRateProtect", + "CateringDecisionDate", + "CateringFollowupDate", + "CateringOwner", + "CateringStatus", + "Contact", + "CreationDate", + "EventCategory", + "EventDuration", + "EventLabel", + "EventName", + "EventStatus", + "EventType", + "FunctionSpace", + "RoomStatus", + "RoomsCount", + "RoomsFollowupDate", + "RoomsOwner", + "SetupStyle", + "SpaceCode" + ] + } + }, + { + "name": "includeAdvancedHints", + "in": "query", + "description": "Determines whether to fetch profile and room related details.", + "required": false, + "type": "boolean" + }, { "$ref": "#/parameters/authKey" }, @@ -6873,6 +7423,42 @@ }, "204": { "description": "EventCalendarMultipleHotelIds 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": [ @@ -7108,7 +7694,7 @@ "in": "query", "type": "array", "collectionFormat": "multi", - "description": "Instructions to fetch details information about the selected event. The BlocksInfo fetch instructions will retain a limited amount of data for the associated block. The Indicators instruction will provide a count.", + "description": "Instructions to fetch details information about the selected event. The BlocksInfo fetch instructions will retain a limited amount of data for the associated block. The Indicators instruction will provide a count. The EventResources fetch instruction if passed with eventId will return the required page number and records on it, i.e. it will return same page records which has the passed eventId.", "uniqueItems": true, "items": { "type": "string", @@ -7124,7 +7710,8 @@ "IncludeInactiveSubEventsInfo", "IncludeInactiveMasterEventInfo", "ActualEventDetails", - "EligibleMasterEventDetails" + "EligibleMasterEventDetails", + "EventResources" ] }, "x-example": [ @@ -7433,6 +8020,42 @@ }, "204": { "description": "EventsMultipleHotels 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": [ @@ -8190,6 +8813,163 @@ "schema": { "$ref": "#/definitions/event" } + }, + "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": [ + "EventManagement" + ] + }, + "delete": { + "summary": "Delete Multiple Events", + "description": "This API will delete multiple existing eventsOperationId:deleteMultipleEvents
", + "operationId": "deleteMultipleEvents", + "parameters": [ + { + "name": "eventIds", + "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" + }, + "minItems": 1, + "required": true + }, + { + "name": "hotelIds", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Hotel code where event will be organized.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "includeSubEvents", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Indicates whether to delete/inactive the sub event(s) of the master event.", + "items": { + "type": "boolean" + }, + "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": [ @@ -9401,6 +10181,42 @@ }, "204": { "description": "EventItemSplitQuantity 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": [ @@ -9467,6 +10283,42 @@ "schema": { "$ref": "#/definitions/manageEventsResources" } + }, + "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": [ @@ -9551,6 +10403,42 @@ "schema": { "$ref": "#/definitions/copyCateringEventsResponse" } + }, + "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": [ @@ -9633,6 +10521,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9713,6 +10637,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9985,6 +10945,42 @@ }, "204": { "description": "CateringEventChanges 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": [ @@ -10228,6 +11224,52 @@ "required": false, "type": "boolean" }, + { + "name": "eventHints", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "multi", + "description": "A collection of supported event hint values in UI for Events.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "Account", + "Attendees", + "BlockCode", + "BlockName", + "BlockNonCompete", + "BlockRateProtect", + "CateringDecisionDate", + "CateringFollowupDate", + "CateringOwner", + "CateringStatus", + "Contact", + "CreationDate", + "EventCategory", + "EventDuration", + "EventLabel", + "EventName", + "EventStatus", + "EventType", + "FunctionSpace", + "RoomStatus", + "RoomsCount", + "RoomsFollowupDate", + "RoomsOwner", + "SetupStyle", + "SpaceCode" + ] + } + }, + { + "name": "includeAdvancedHints", + "in": "query", + "description": "Determines whether to fetch profile and room related details.", + "required": false, + "type": "boolean" + }, { "$ref": "#/parameters/authKey" }, @@ -10407,6 +11449,42 @@ }, "204": { "description": "EventCalendar 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": [ @@ -10905,6 +11983,42 @@ }, "204": { "description": "EventsOneHotel 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": [ @@ -11118,6 +12232,42 @@ }, "204": { "description": "Event 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": [ @@ -11856,6 +13006,42 @@ "schema": { "$ref": "#/definitions/event" } + }, + "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": [ @@ -11933,6 +13119,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12069,6 +13291,42 @@ }, "204": { "description": "CateringEventPostings 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": [ @@ -12836,6 +14094,42 @@ ] } } + }, + "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": [ @@ -12929,6 +14223,42 @@ "schema": { "$ref": "#/definitions/quickInsertResourceStatus" } + }, + "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": [ @@ -13008,6 +14338,42 @@ }, "204": { "description": "EventsResources 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": [ @@ -13081,6 +14447,42 @@ "schema": { "$ref": "#/definitions/manageEventsResources" } + }, + "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": [ @@ -13153,6 +14555,42 @@ }, "204": { "description": "BlockPostingAccountReservations 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": [ @@ -13467,6 +14905,42 @@ }, "204": { "description": "FunctionSpaceAvailability 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": [ @@ -13549,6 +15023,42 @@ }, "204": { "description": "SharedFunctionSpaceEvents 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": [ @@ -14769,6 +16279,42 @@ }, "204": { "description": "WaitlistedEvents 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": [ @@ -17261,6 +18807,42 @@ ] } } + }, + "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": [ @@ -17327,6 +18909,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23642,10 +25260,10 @@ "type": "integer" }, "restriction": { - "description": "Any particular restriction description in 100 charactera", + "description": "Any particular restriction description in 2000 characters", "type": "string", "minLength": 0, - "maxLength": 100 + "maxLength": 2000 }, "description": { "description": "Detailed description of menu items in 100 characters", @@ -24646,7 +26264,7 @@ "createdOn": { "description": "Date the event was created.", "type": "string", - "format": "date", + "format": "date-time", "maxLength": 8 }, "isComboRoomEventRef": { @@ -24671,6 +26289,53 @@ "type": "object", "description": "Booking information about the Function Diary Event.", "properties": { + "blockCode": { + "description": "Business Block Code.", + "type": "string" + }, + "blockName": { + "description": "Business Block Name.", + "type": "string" + }, + "roomStatus": { + "description": "Room Status of the Block.", + "type": "string" + }, + "cateringStatus": { + "description": "Catering Status of the Block.", + "type": "string" + }, + "catDecisionDate": { + "description": "Catering Decision Date of the Block.", + "type": "string", + "format": "date" + }, + "catFollowUpDate": { + "description": "Catering Follow Up Date of the Block.", + "type": "string", + "format": "date" + }, + "roomFollowUpDate": { + "description": "Room Follow Up Date of the Block.", + "type": "string", + "format": "date" + }, + "account": { + "description": "Account attached to the block.", + "type": "string" + }, + "contact": { + "description": "Contact attached to the block.", + "type": "string" + }, + "roomNights": { + "description": "Boolean to indicate whether rooms are booked for the block.", + "type": "boolean" + }, + "originalRooms": { + "description": "Original number of rooms booked for the block.", + "type": "number" + }, "catOwner": { "description": "Catering Sales Manager ID.", "type": "number" diff --git a/rest-api-specs/property/evmcfg.json b/rest-api-specs/property/evmcfg.json index 6d58ff1..d832509 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -74,6 +74,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -159,6 +195,42 @@ }, "204": { "description": "CateringContainers 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": [ @@ -223,6 +295,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -298,6 +406,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -358,6 +502,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -428,6 +608,42 @@ }, "204": { "description": "FunctionSpaceEventTypes 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": [ @@ -492,6 +708,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -567,6 +819,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -627,6 +915,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -712,6 +1036,42 @@ }, "204": { "description": "CateringItemRates 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": [ @@ -776,6 +1136,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -851,6 +1247,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -911,6 +1343,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -977,6 +1445,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1041,6 +1545,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1107,6 +1647,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1182,6 +1758,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1275,6 +1887,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1350,6 +1998,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1419,6 +2103,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1541,6 +2261,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1740,6 +2496,42 @@ }, "204": { "description": "CateringPackagesMultiProperties 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": [ @@ -1850,6 +2642,42 @@ }, "204": { "description": "CateringPackageByChain 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": [ @@ -1935,6 +2763,42 @@ }, "204": { "description": "CateringServings 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": [ @@ -2010,6 +2874,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2088,6 +2988,42 @@ }, "204": { "description": "TemplateEventCodes 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": [ @@ -2152,6 +3088,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2216,6 +3188,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2278,6 +3286,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2343,6 +3387,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2406,6 +3486,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2553,6 +3669,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2638,6 +3790,42 @@ }, "204": { "description": "CateringRentalCodes 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": [ @@ -2702,6 +3890,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2777,6 +4001,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2837,6 +4097,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2922,6 +4218,42 @@ }, "204": { "description": "FunctionSpaceTypes 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": [ @@ -2986,6 +4318,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3061,6 +4429,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3121,6 +4525,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3203,6 +4643,42 @@ }, "204": { "description": "FunctionSpaceLocations 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": [ @@ -3278,6 +4754,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3349,6 +4861,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3422,6 +4970,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3507,6 +5091,42 @@ }, "204": { "description": "FunctionSpaceSetupStyles 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": [ @@ -3571,6 +5191,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3633,6 +5289,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3706,6 +5398,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3824,6 +5552,42 @@ }, "204": { "description": "FunctionSpace 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": [ @@ -3928,6 +5692,42 @@ }, "204": { "description": "CateringMenuClasses 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": [ @@ -4049,6 +5849,42 @@ }, "204": { "description": "CateringMenuItemClasses 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": [ @@ -4196,6 +6032,42 @@ }, "204": { "description": "CateringMenuItems 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": [ @@ -4269,6 +6141,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4344,6 +6252,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4428,6 +6372,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4497,6 +6477,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4711,6 +6727,42 @@ }, "204": { "description": "CateringMenus 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": [ @@ -4784,6 +6836,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4876,8 +6964,44 @@ "$ref": "#/definitions/cateringMenusInfo" } }, - "204": { - "description": "CateringMenu not found." + "204": { + "description": "CateringMenu 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": [ @@ -4960,6 +7084,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5029,6 +7189,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5113,6 +7309,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5311,6 +7543,42 @@ }, "204": { "description": "CateringPackages 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": [ @@ -5384,6 +7652,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5496,6 +7800,42 @@ }, "204": { "description": "CateringPackage 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": [ @@ -5578,6 +7918,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5647,6 +8023,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5751,6 +8163,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5888,6 +8336,42 @@ }, "204": { "description": "DailyInventoryItems 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": [ @@ -5949,6 +8433,42 @@ }, "204": { "description": "checkDiscountAvailable 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": [ @@ -6048,6 +8568,42 @@ }, "204": { "description": "EventCodes 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": [ @@ -6121,6 +8677,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6192,6 +8784,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6265,6 +8893,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6428,6 +9092,42 @@ }, "204": { "description": "EventForecasts 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": [ @@ -6559,6 +9259,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6711,6 +9447,42 @@ }, "204": { "description": "FunctionSpaces 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": [ @@ -6784,6 +9556,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6868,6 +9676,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6937,6 +9781,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7007,6 +9887,42 @@ }, "204": { "description": "FunctionSpaceConfig 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": [ @@ -7128,6 +10044,42 @@ }, "204": { "description": "InventoryItems 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": [ @@ -7201,6 +10153,42 @@ "schema": { "$ref": "#/definitions/inventoryItemsCreated" } + }, + "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": [ @@ -7293,6 +10281,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7375,6 +10399,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7486,6 +10546,42 @@ }, "204": { "description": "ItemPools 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": [ @@ -7557,6 +10653,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7628,6 +10760,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7720,6 +10888,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7812,6 +11016,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7934,6 +11174,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8070,6 +11346,42 @@ }, "204": { "description": "RoomTypePool 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": [ @@ -8143,6 +11455,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8397,6 +11745,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8479,6 +11863,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8554,6 +11974,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8629,6 +12085,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8704,6 +12196,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8770,6 +12298,42 @@ }, "204": { "description": "InventoryItemTemplates 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": [ @@ -8834,6 +12398,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8929,6 +12529,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9002,6 +12638,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9102,6 +12774,42 @@ }, "204": { "description": "ItemClasses 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": [ @@ -9166,6 +12874,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9232,6 +12976,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9307,6 +13087,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9367,6 +13183,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9433,6 +13285,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9508,6 +13396,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9593,6 +13517,42 @@ }, "204": { "description": "MealTypes 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": [ @@ -9657,6 +13617,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9732,6 +13728,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9792,6 +13824,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9887,6 +13955,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9979,6 +14083,42 @@ }, "204": { "description": "RevenueGroups 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": [ @@ -10043,6 +14183,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10118,6 +14294,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10178,6 +14390,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10282,6 +14530,42 @@ }, "204": { "description": "RevenueTypes 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": [ @@ -10346,6 +14630,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10421,6 +14741,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10481,6 +14837,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11251,7 +15643,7 @@ "description": "This type holds name of Menu Class.", "type": "string", "minLength": 0, - "maxLength": 30 + "maxLength": 200 }, "webBookable": { "description": "This type tells about whether menu class is book through web or not.", @@ -11925,7 +16317,7 @@ "description": "Menu Item Class Name", "type": "string", "minLength": 0, - "maxLength": 30 + "maxLength": 200 }, "eventTypeList": { "description": "Event types associated with the Menu Class", @@ -15953,4 +20345,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/expcfg.json b/rest-api-specs/property/expcfg.json index 406bdbf..507c039 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -171,6 +171,42 @@ }, "204": { "description": "ExportsAvailable 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": [ @@ -267,6 +303,42 @@ }, "204": { "description": "ExportColumnsAndFunctions 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": [ @@ -333,6 +405,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -397,6 +505,42 @@ "schema": { "$ref": "#/definitions/exportMappingCodesDetails" } + }, + "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": [ @@ -463,6 +607,42 @@ "schema": { "$ref": "#/definitions/exportMappingLinkedTypesDetails" } + }, + "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": [ @@ -555,6 +735,42 @@ }, "204": { "description": "ExportMappingsByChain 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": [ @@ -621,6 +837,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -683,6 +935,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -758,6 +1046,42 @@ "schema": { "$ref": "#/definitions/exportSchedulesStatus" } + }, + "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": [ @@ -809,6 +1133,22 @@ "description": "The hotel code for the codes to fetch for linking.", "type": "string" }, + { + "name": "limit", + "in": "query", + "type": "integer", + "default": 25, + "maximum": 100, + "description": "Indicates maximum number of records a Web Service should return.", + "required": false + }, + { + "name": "offset", + "in": "query", + "type": "integer", + "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.", + "required": false + }, { "$ref": "#/parameters/authKey" }, @@ -842,6 +1182,42 @@ }, "204": { "description": "ExportMappingCodesToLink 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": [ @@ -1017,6 +1393,42 @@ }, "204": { "description": "ExportActivityLog 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": [ @@ -1088,6 +1500,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1158,6 +1606,42 @@ }, "204": { "description": "ExportMappingCodes 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": [ @@ -1252,6 +1736,42 @@ }, "204": { "description": "ExportMappings 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": [ @@ -1324,6 +1844,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1396,6 +1952,42 @@ "schema": { "$ref": "#/definitions/exportMappingsDetails" } + }, + "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": [ @@ -1521,6 +2113,42 @@ }, "204": { "description": "ExportMappingLinkedCodes 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": [ @@ -1601,6 +2229,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1757,6 +2421,42 @@ }, "204": { "description": "ExportSchedules 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": [ @@ -1841,6 +2541,42 @@ "schema": { "$ref": "#/definitions/exportSchedulesStatus" } + }, + "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": [ @@ -1876,6 +2612,22 @@ "description": "Unique ID of export data.", "type": "string" }, + { + "name": "limit", + "in": "query", + "type": "integer", + "default": 25, + "maximum": 100, + "description": "Indicates maximum number of records a Web Service should return.", + "required": false + }, + { + "name": "offset", + "in": "query", + "type": "integer", + "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.", + "required": false + }, { "$ref": "#/parameters/authKey" }, @@ -1909,6 +2661,42 @@ }, "204": { "description": "ExportsGenerated 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": [ @@ -3817,6 +4605,30 @@ "$ref": "#/definitions/exportMappingCodesToLinkType" } }, + "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" }, @@ -4071,6 +4883,30 @@ "description": "Contains the list of available exports.", "$ref": "#/definitions/generatedExportListType" }, + "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" }, @@ -4236,4 +5072,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/fof.json b/rest-api-specs/property/fof.json index df16d29..65df6b7 100644 --- a/rest-api-specs/property/fof.json +++ b/rest-api-specs/property/fof.json @@ -1,15 +1,9 @@ { - "produces": [ - "application/json" - ], - "schemes": [ - "https" - ], "swagger": "2.0", "info": { - "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.
", "title": "OPERA Cloud Front Desk Operations Service", - "version": "23.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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -19,47 +13,52 @@ "url": "https://opensource.org/licenses/upl" } }, + "schemes": [ + "https" + ], "basePath": "/fof/v1", + "produces": [ + "application/json" + ], "paths": { "/hotels/{hotelId}/authorizationReservations": { "get": { - "description": "This API is used to get reservations for batch CC Authorization.OperationId:getResvForBatchCCAuth
", - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "FrontDeskOperations" - ], "summary": "Get resrvation for batch CCAuth", + "description": "This API is used to get reservations for batch CC Authorization.OperationId:getResvForBatchCCAuth
", "operationId": "getResvForBatchCCAuth", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Used for Character Strings, length 0 to 80.", "name": "guestName", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "description": "Used for Character Strings, length 0 to 80." }, { - "type": "string", - "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", "name": "room", - "in": "query" + "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." }, { - "uniqueItems": true, + "name": "cardType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Ab", "Am", @@ -82,130 +81,93 @@ "Zz", "Cp", "Cu" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.", - "name": "cardType", - "in": "query" + "required": false }, { + "name": "userDefinedCardType", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Listing of user defined credit card types.", - "name": "userDefinedCardType", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response which contains a listing of reservations, and associated payment methods, that require credit card authorization.", - "schema": { - "$ref": "#/definitions/resvForBatchCCAut" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response which contains a listing of reservations, and associated payment methods, that require credit card authorization.", + "schema": { + "$ref": "#/definitions/resvForBatchCCAut" } }, "204": { "description": "ResvForBatchCCAuth not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/bankAccounts": { - "get": { - "description": "OperationId:getBankAccounts
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -213,143 +175,117 @@ "application/json;charset=UTF-8" ], "tags": [ - "Commissions" - ], + "FrontDeskOperations" + ] + } + }, + "/hotels/{hotelId}/bankAccounts": { + "get": { "summary": "Operation to fetch bank accounts.", + "description": "OperationId:getBankAccounts
", "operationId": "getBankAccounts", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the bank accounts.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the bank accounts." }, { - "type": "string", - "description": "Either full or first part of the bank name.", "name": "bankName", - "in": "query" + "in": "query", + "required": false, + "description": "Either full or first part of the bank name.", + "type": "string" }, { - "type": "string", - "description": "Either full or first part of the bank account number.", "name": "bankAccountNo", - "in": "query" + "in": "query", + "required": false, + "description": "Either full or first part of the bank account number.", + "type": "string" }, { - "type": "string", - "description": "Currency used by the bank account.", "name": "currency", - "in": "query" + "in": "query", + "required": false, + "description": "Currency used by the bank account.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Returns bank accounts that match the request criteria.", - "schema": { - "$ref": "#/definitions/bankAccountsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Returns bank accounts that match the request criteria.", + "schema": { + "$ref": "#/definitions/bankAccountsDetails" } }, "204": { "description": "BankAccounts not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/bankAccounts/{bankAccountId}/agents/{agentId}/reservationsForCommissions": { - "get": { - "description": "OperationId:getReservationsForCommissions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -358,201 +294,186 @@ ], "tags": [ "Commissions" - ], + ] + } + }, + "/hotels/{hotelId}/bankAccounts/{bankAccountId}/agents/{agentId}/reservationsForCommissions": { + "get": { "summary": "Operation to fetch Reservations for Commissions associated to a Travel Agent", + "description": "OperationId:getReservationsForCommissions
", "operationId": "getReservationsForCommissions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Reservations for commissions.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Reservations for commissions." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "A unique identifying value(ID) to represent the Bank.", "name": "bankAccountId", "in": "path", - "required": true + "required": true, + "description": "A unique identifying value(ID) to represent the Bank.", + "type": "string", + "minLength": 1, + "maxLength": 2000 }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "A unique identifying value(ID) to represent the Travel Agent associated with the commission.", "name": "agentId", "in": "path", - "required": true + "required": true, + "description": "A unique identifying value(ID) to represent the Travel Agent associated with the commission.", + "type": "string", + "minLength": 1, + "maxLength": 2000 }, { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "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.", - "name": "offset", - "in": "query" + "type": "integer" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Indicates the guest name of the reservation that is to be returned ", "name": "guestName", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates the guest name of the reservation that is to be returned ", + "type": "string", + "minLength": 1, + "maxLength": 2000 }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Indicates the confirmation number of the reservation that is to be returned ", "name": "confirmationNo", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates the confirmation number of the reservation that is to be returned ", + "type": "string", + "minLength": 1, + "maxLength": 2000 }, { - "uniqueItems": true, + "name": "reservationStatus", + "in": "query", + "required": false, + "description": "Indicates the status of the reservations that is to be returned ", "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Cancelled", "CheckedOut", "NoShow" - ], - "type": "string" - }, - "collectionFormat": "multi", - "description": "Indicates the status of the reservations that is to be returned ", - "name": "reservationStatus", - "in": "query" + ] + } }, { - "type": "boolean", - "default": false, - "description": "When set to true only reservations flagged for account receivables are returned", "name": "accountReceivableOffset", - "in": "query" + "in": "query", + "required": false, + "description": "When set to true only reservations flagged for account receivables are returned", + "type": "boolean", + "default": false }, { - "type": "boolean", - "default": false, - "description": "When set to true only reservations having a commission hold code are returned", "name": "onHold", - "in": "query" + "in": "query", + "required": false, + "description": "When set to true only reservations having a commission hold code are returned", + "type": "boolean", + "default": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "commissionPaid", + "in": "query", + "required": false, + "description": "When set to true only reservations having paid the commissions are returned", + "type": "boolean" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Commissions for the requested account or agent id.", - "schema": { - "$ref": "#/definitions/commissionsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Commissions for the requested account or agent id.", + "schema": { + "$ref": "#/definitions/commissionsDetails" } }, "204": { "description": "Commissions not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionChecks": { - "put": { - "description": "OperationId:changeCommissionCheck
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -561,33 +482,38 @@ ], "tags": [ "Commissions" - ], + ] + } + }, + "/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionChecks": { + "put": { "summary": "Operation to change commission check.", + "description": "OperationId:changeCommissionCheck
", "operationId": "changeCommissionCheck", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique id of bank account.", "name": "bankAccountId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique id of bank account." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commission record.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commission record." }, { - "description": "Request type for updating commission check.", "name": "commissionCheckToBeChanged", "in": "body", "required": true, + "description": "Request type for updating commission check.", "schema": { "allOf": [ { @@ -597,111 +523,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/commissionCheckStatus" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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/commissionCheckStatus" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionPayments": { - "get": { - "description": "OperationId:getCommissionPaymentsActivity
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -710,209 +602,193 @@ ], "tags": [ "Commissions" - ], + ] + } + }, + "/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionPayments": { + "get": { "summary": "Operation to fetch commission payments activity.", + "description": "OperationId:getCommissionPaymentsActivity
", "operationId": "getCommissionPaymentsActivity", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique id of bank account.", "name": "bankAccountId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique id of bank account." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commission record.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commission record." }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "idExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "idContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "type", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "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.", "name": "batchId", - "in": "query" + "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" }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "batchIdIdExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "batchIdIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "batchIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "description": "File name if payment method is EFT.", "name": "fileName", - "in": "query" + "in": "query", + "required": false, + "description": "File name if payment method is EFT.", + "type": "string" }, { - "type": "string", - "description": "File name if payment method is EFT.", "name": "payee", - "in": "query" + "in": "query", + "required": false, + "description": "File name if payment method is EFT.", + "type": "string" }, { - "type": "number", - "description": "Check no of payment.", "name": "checkNo", - "in": "query" + "in": "query", + "required": false, + "description": "Check no of payment.", + "type": "number" }, { - "uniqueItems": true, + "name": "status", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Simple type for payment activity status type. Valid values are Outstanding, Reconciled, Unpresented and Void.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Outstanding", "Reconciled", "Unpresented", "Void", "Failed" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Simple type for payment activity status type. Valid values are Outstanding, Reconciled, Unpresented and Void.", - "name": "status", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response type for commission payments activity.", - "schema": { - "$ref": "#/definitions/commissionPaymentsActivityDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response type for commission payments activity.", + "schema": { + "$ref": "#/definitions/commissionPaymentsActivityDetails" } }, "204": { "description": "CommissionPaymentsActivity not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "OperationId:changeCommissionPaymentActivityByRange
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -921,33 +797,36 @@ ], "tags": [ "Commissions" - ], + ] + }, + "put": { "summary": "Operation to change commission payment activity by range.", + "description": "OperationId:changeCommissionPaymentActivityByRange
", "operationId": "changeCommissionPaymentActivityByRange", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique id of bank account.", "name": "bankAccountId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique id of bank account." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commission record.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commission record." }, { - "description": "Request type for updating a range of payments activity.", "name": "commissionPaymentActivityByRangeToBeChanged", "in": "body", "required": true, + "description": "Request type for updating a range of payments activity.", "schema": { "allOf": [ { @@ -957,111 +836,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/commissionPaymentActivityByRangeStatus" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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/commissionPaymentActivityByRangeStatus" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/bankAccounts/{bankAccountId}/reprintCommission": { - "put": { - "description": "OperationId:reprintCommissionCheckByRange
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1070,33 +915,38 @@ ], "tags": [ "Commissions" - ], + ] + } + }, + "/hotels/{hotelId}/bankAccounts/{bankAccountId}/reprintCommission": { + "put": { "summary": "Operation to reprint commission check by range.", + "description": "OperationId:reprintCommissionCheckByRange
", "operationId": "reprintCommissionCheckByRange", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique id of bank account", "name": "bankAccountId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique id of bank account" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commission record.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commission record." }, { - "description": "Request type for reprinting a range of check payments.", "name": "reprintCommissionCheckByRange", "in": "body", "required": true, + "description": "Request type for reprinting a range of check payments.", "schema": { "allOf": [ { @@ -1106,111 +956,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response type for reprinting a range of check payments.", - "schema": { - "$ref": "#/definitions/reprintCommissionCheckByRangeStatus" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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" } - } - }, - "400": { - "description": "Bad Request", + }, + "description": "Response type for reprinting a range of check payments.", "schema": { - "$ref": "#/definitions/exceptionDetailType" + "$ref": "#/definitions/reprintCommissionCheckByRangeStatus" } }, + "400": { + "$ref": "#/responses/400" + }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/bankAccounts/{bankAccountId}/travelAgentsForCommissions": { - "get": { - "description": "OperationId:getTravelAgentsForCommissions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1219,133 +1035,104 @@ ], "tags": [ "Commissions" - ], + ] + } + }, + "/hotels/{hotelId}/bankAccounts/{bankAccountId}/travelAgentsForCommissions": { + "get": { "summary": "Operation to fetch Travel Agents associated with commissions for the given bank Account.", + "description": "OperationId:getTravelAgentsForCommissions
", "operationId": "getTravelAgentsForCommissions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the Travel Agent records.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the Travel Agent records." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "A unique identifying value(ID) to represent the Bank", "name": "bankAccountId", "in": "path", - "required": true + "required": true, + "description": "A unique identifying value(ID) to represent the Bank", + "type": "string", + "minLength": 1, + "maxLength": 2000 }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Travel Agents for the requested Bank ID.", - "schema": { - "$ref": "#/definitions/commissionsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Travel Agents for the requested Bank ID.", + "schema": { + "$ref": "#/definitions/commissionsDetails" } }, "204": { "description": "Travel Agents not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/batchReservationAuthorizations": { - "put": { - "description": "This API is used to process batch CC Authorization.OperationId:processBatchCCAuth
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1353,24 +1140,30 @@ "application/json;charset=UTF-8" ], "tags": [ - "FrontDeskOperations" - ], + "Commissions" + ] + } + }, + "/hotels/{hotelId}/batchReservationAuthorizations": { + "put": { "summary": "Process batch CC Auth", + "description": "This API is used to process batch CC Authorization.OperationId:processBatchCCAuth
", "operationId": "processBatchCCAuth", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to start a batch job that will process a list of reservation, and their associated payment methods, that require credit card authorizations.", "name": "batchCCAuth", "in": "body", "required": true, + "description": "Request to start a batch job that will process a list of reservation, and their associated payment methods, that require credit card authorizations.", "schema": { "allOf": [ { @@ -1380,111 +1173,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response for starting a credit card authorization batch job, which contains the batch ID upon success.", - "schema": { - "$ref": "#/definitions/batchCCAuthToProcess" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 starting a credit card authorization batch job, which contains the batch ID upon success.", + "schema": { + "$ref": "#/definitions/batchCCAuthToProcess" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/billingReservations": { - "get": { - "description": "You can use this API to fetch the reservations for billing.OperationId:getReservationsForBilling
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -1493,32 +1252,44 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/billingReservations": { + "get": { "summary": "Get Reservations for billing", + "description": "You can use this API to fetch the reservations for billing.OperationId:getReservationsForBilling
", "operationId": "getReservationsForBilling", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "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.", - "name": "offset", - "in": "query" + "type": "integer" }, { + "name": "searchType", + "in": "query", + "required": false, + "type": "string", "uniqueItems": true, "enum": [ "Any", @@ -1552,96 +1323,107 @@ "Routing", "PlayerSnapshot" ], - "type": "string", - "description": "Represents Reservation search type Player Snapshot.", - "name": "searchType", - "in": "query" + "description": "Represents Reservation search type Player Snapshot." }, { + "name": "multipleHotelsSearchList", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel code.", - "name": "multipleHotelsSearchList", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Free form text field for searching all reservation fields", "name": "superSearch", - "in": "query" + "in": "query", + "required": false, + "description": "Free form text field for searching all reservation fields", + "type": "string" }, { + "name": "reservationId", + "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" }, - "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.", - "name": "reservationId", - "in": "query" + "required": false }, { + "name": "reservationIdContext", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "reservationIdContext", - "in": "query" + "required": false }, { + "name": "reservationIdType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A reference to the type of object defined by the UniqueID element.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "reservationIdType", - "in": "query" + "required": false }, { - "type": "integer", - "description": "The number of nights on a reservation.", "name": "nights", - "in": "query" + "in": "query", + "required": false, + "description": "The number of nights on a reservation.", + "type": "integer" }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", "name": "arrivalEnd", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The starting value of the date range.", "name": "arrivalStart", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", "name": "departureEnd", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The starting value of the date range.", "name": "departureStart", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" }, { - "uniqueItems": true, + "name": "reservationProfileType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Guest", "Company", @@ -1651,231 +1433,260 @@ "ReservationContact", "BillingContact", "Addressee" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "name": "reservationProfileType", - "in": "query" + "required": false }, { + "name": "attachedProfileName", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Attached profile name", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Attached profile name", - "name": "attachedProfileName", - "in": "query" + "required": false }, { + "name": "attachedProfileId", + "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" }, - "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.", - "name": "attachedProfileId", - "in": "query" + "required": false }, { + "name": "attachedProfileIdContext", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "attachedProfileIdContext", - "in": "query" + "required": false }, { + "name": "attachedProfileIdType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A reference to the type of object defined by the UniqueID element.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "attachedProfileIdType", - "in": "query" + "required": false }, { - "type": "string", - "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.", "name": "resGuestId", - "in": "query" + "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" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "resGuestIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "resGuestIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "description": "Membership ID criteria.", "name": "membershipId", - "in": "query" + "in": "query", + "required": false, + "description": "Membership ID criteria.", + "type": "string" }, { + "name": "membershipLevelCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "membershipLevelCodes", - "in": "query" + "required": false }, { + "name": "membershipTypeCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "membershipTypeCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Family name, last name.", "name": "surname", - "in": "query" + "in": "query", + "required": false, + "description": "Family name, last name.", + "type": "string" }, { - "type": "string", - "description": "Given name, first name or names", "name": "givenName", - "in": "query" + "in": "query", + "required": false, + "description": "Given name, first name or names", + "type": "string" }, { - "type": "string", - "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", "name": "cityName", - "in": "query" + "in": "query", + "required": false, + "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", + "type": "string" }, { - "type": "string", - "description": "Post Office Code number.", "name": "postalCode", - "in": "query" + "in": "query", + "required": false, + "description": "Post Office Code number.", + "type": "string" }, { - "type": "string", - "description": "State or Province name (e.g., Texas).", "name": "state", - "in": "query" + "in": "query", + "required": false, + "description": "State or Province name (e.g., Texas).", + "type": "string" }, { - "type": "string", - "description": "Code for a country or a nationality.", "name": "countryCode", - "in": "query" + "in": "query", + "required": false, + "description": "Code for a country or a nationality.", + "type": "string" }, { - "type": "string", - "description": "First Line of Street Address. For profile search it matches the first Address line.", "name": "streetAddress", - "in": "query" + "in": "query", + "required": false, + "description": "First Line of Street Address. For profile search it matches the first Address line.", + "type": "string" }, { - "type": "string", - "description": "Booking Channel Code", "name": "bookingChannelCode", - "in": "query" + "in": "query", + "required": false, + "description": "Booking Channel Code", + "type": "string" }, { - "type": "string", - "description": "The Hotel Code of the Block.", "name": "blockHotelId", - "in": "query" + "in": "query", + "required": false, + "description": "The Hotel Code of the Block.", + "type": "string" }, { + "name": "blockId", + "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" }, - "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.", - "name": "blockId", - "in": "query" + "required": false }, { + "name": "blockIdContext", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "blockIdContext", - "in": "query" + "required": false }, { + "name": "blockIdType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A reference to the type of object defined by the UniqueID element.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "blockIdType", - "in": "query" + "required": false }, { - "type": "string", - "description": "GDS Record Locator for reservation.", "name": "recordLocator", - "in": "query" + "in": "query", + "required": false, + "description": "GDS Record Locator for reservation.", + "type": "string" }, { + "name": "orderByAttributeName", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { "type": "string" }, - "collectionFormat": "multi", - "name": "orderByAttributeName", - "in": "query" + "required": false }, { - "uniqueItems": true, + "name": "orderType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Asc", "Desc" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "name": "orderType", - "in": "query" + "required": false }, { - "type": "string", - "description": "Room number of the reservation to search by.", "name": "roomId", - "in": "query" + "in": "query", + "required": false, + "description": "Room number of the reservation to search by.", + "type": "string" }, { + "name": "roomType", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Room Type.", - "name": "roomType", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "uniqueItems": true, + "name": "fetchInstructions", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Reservation", "ReservationID", @@ -1889,72 +1700,80 @@ "TaxType", "GuestDeviceNotification", "RoomAssignedByAI" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction.", - "name": "fetchInstructions", - "in": "query" + "required": false }, { - "type": "boolean", - "description": "Indicates that reservations with No Post flag should not be expected from the result.", "name": "excludeNoPost", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates that reservations with No Post flag should not be expected from the result.", + "type": "boolean" }, { - "type": "boolean", - "description": "Indicates that reservations with PM room type should not be expected from the result.", "name": "excludePMRooms", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates that reservations with PM room type should not be expected from the result.", + "type": "boolean" }, { - "type": "boolean", - "description": "Indicates that only reservations with open folio should be expected from the result.", "name": "hasOpenFolio", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates that only reservations with open folio should be expected from the result.", + "type": "boolean" }, { + "name": "excludedReservationIds", + "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" }, - "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.", - "name": "excludedReservationIds", - "in": "query" + "required": false }, { + "name": "excludedReservationIdsContext", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "excludedReservationIdsContext", - "in": "query" + "required": false }, { + "name": "excludedReservationIdsType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A reference to the type of object defined by the UniqueID element.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "excludedReservationIdsType", - "in": "query" + "required": false }, { - "type": "boolean", - "description": "Indicates to exclude Advance Checked In Reservations from search result.", "name": "advanceCheckedIn", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates to exclude Advance Checked In Reservations from search result.", + "type": "boolean" }, { - "uniqueItems": true, + "name": "searchTypesSearchType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, + "description": "Represents Reservation search type Player Snapshot.", "items": { + "type": "string", "enum": [ "Any", "DayUse", @@ -1986,18 +1805,19 @@ "AutoFolioSettlement", "Routing", "PlayerSnapshot" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Represents Reservation search type Player Snapshot.", - "name": "searchTypesSearchType", - "in": "query" + "required": false }, { - "uniqueItems": true, + "name": "reservationStatus", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Reservation status type for reservations search.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Cancelled", "CheckedOut", @@ -2007,110 +1827,225 @@ "InHouse", "NoShow", "WaitList" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Reservation status type for reservations search.", - "name": "reservationStatus", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.", - "schema": { - "$ref": "#/definitions/reservationsInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } }, + "description": "Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.", + "schema": { + "$ref": "#/definitions/reservationsInfo" + }, "examples": { "application/json": { - "links": [ - { - "href": "string", - "method": "GET", - "operationId": "string", - "rel": "string", - "targetSchema": "string", - "templated": false, - "title": "string" - } - ], - "masterInfoList": [ - { - "codeInfo": [ - { - "addtionalCodeInfo": { - "code": [ - { - "name": "LongDescription", - "value": "string" - } - ] - }, - "code": "string", - "description": "string", - "hotelId": "string" - } - ], - "codeType": "Country" - } - ], "reservationInfoList": { "reservationInfo": [ { - "accessRestriction": "Change", - "advanceCheckIn": { - "advanceCheckedIn": true, - "eTRComments": "string", - "expectedReturnTime": "2020-07-14T09:58:05.725Z" - }, - "allowMobileCheckout": true, - "allowMobileViewFolio": true, - "allowedActions": [ - "Cancel" + "reservationIdList": [ + { + "id": "string", + "type": "string" + } + ], + "roomStay": { + "arrivalDate": "2020-07-14", + "departureDate": "2020-07-14", + "originalTimeSpan": { + "startDate": "2020-07-14", + "endDate": "2020-07-14", + "duration": "string" + }, + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-07-14T09:58:05.723Z", + "reservationExpectedDepartureTime": "2020-07-14T09:58:05.723Z" + }, + "adultCount": 0, + "childCount": 0, + "roomClass": "string", + "roomType": "string", + "numberOfRooms": 0, + "roomNumber": "string", + "ratePlanCode": "string", + "rateAmount": { + "amount": 0, + "currencyCode": "string" + }, + "points": { + "awardsType": "string", + "points": 0 + }, + "rateSuppressed": true, + "reservationBlock": { + "blockIdList": [ + { + "id": "string", + "type": "string" + } + ], + "blockName": "string", + "hotelId": "string" + }, + "bookingChannelCode": "string", + "partyCode": "string", + "fixedRate": true, + "totalAmount": { + "amount": 0, + "currencyCode": "string" + }, + "guarantee": { + "guaranteeCode": "string", + "shortDescription": "string", + "onHold": true + }, + "promotion": { + "promotionCode": "string", + "promotionName": "string", + "couponCode": "string" + }, + "marketCode": "string", + "sourceOfBusiness": "string", + "sourceOfBusinessDescription": "string", + "balance": { + "amount": 0, + "currencyCode": "string" + }, + "compBalance": { + "amount": 0, + "currencyCode": "string" + }, + "roomTypeCharged": "string", + "depositPayments": { + "amount": 0, + "currencyCode": "string" + }, + "guestServiceStatus": "DoNotDisturb", + "scheduledCheckoutTime": "2020-07-14", + "roomNumberLocked": true, + "pseudoRoom": true + }, + "reservationGuest": { + "membership": { + "membershipId": 0, + "programCode": "string", + "bonusCode": "string", + "membershipTypeDesc": "string", + "membershipLevelDesc": "string", + "accountId": "string", + "membershipLevel": "string", + "playerRanking": 0 + }, + "namePrefix": "string", + "givenName": "string", + "alternateGivenName": "string", + "middleName": "string", + "surnamePrefix": "string", + "surname": "string", + "alternateSurname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "fullName": "string", + "alternateFullName": "string", + "phoneNumber": "string", + "email": "string", + "birthDate": "2020-07-14", + "language": "string", + "nationality": { + "value": "string", + "code": "string" + }, + "vip": { + "vipCode": "string", + "vipDescription": "string" + }, + "address": { + "cityName": "string", + "postalCode": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "streetAddress": "string", + "excludeNoCity": true + }, + "anonymization": { + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-07-14T09:58:05.724Z" + }, + "accompanyGuests": [ + { + "firstName": "string", + "lastName": "string", + "fullName": "string", + "registrationCardNo": "string", + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ] + } + ], + "externalInfo": { + "givenName": "string", + "surname": "string" + }, + "guestLastStayInfo": { + "lastStayDate": "2020-07-14", + "lastStayRoom": "string", + "lastStayRate": { + "amount": 0, + "currencyCode": "string" + }, + "totalStay": 0 + }, + "guestRestrictedCode": "string", + "guestRestrictedReasonDesc": "string", + "guestRestricted": true, + "registrationCardNo": "string", + "nameType": "Guest", + "id": "string", + "type": "string" + }, + "sharedGuests": [ + { + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "firstName": "string", + "lastName": "string", + "fullName": "string" + } ], "attachedProfiles": [ { @@ -2124,658 +2059,519 @@ "reservationProfileType": "Company" } ], - "cancellationInfo": { - "code": "string", - "date": "2020-07-14", - "description": "string" - }, - "cashiering": { - "bedTaxReporting": { - "taxRegistrationNo": 0, - "taxableDays": 0, - "visaExpiryDate": "2020-07-14", - "visaIssueDate": "2020-07-14", - "visaNumber": "string" - }, - "billingPrivileges": { - "allowAutoCheckin": true, - "autoSettlement": true, - "autoSettlementFreq": 0, - "autoSettlementType": "string", - "creditLimitAutoPay": true, - "directBillAuthorized": true, - "folioCloseDate": "2020-07-14", - "postStayCharging": true, - "postingRestriction": true, - "preStayCharging": true, - "scheduledCheckout": true, - "scheduledCheckoutTime": "2020-07-14", - "videoCheckout": true + "reservationPaymentMethod": { + "paymentCard": { + "cardId": { + "id": "string", + "type": "string" + }, + "currentAuthorizedAmount": { + "amount": 0, + "currencyCode": "string" + }, + "approvalAmountNeeded": { + "amount": 0, + "currencyCode": "string" + }, + "cardType": "Ab", + "userDefinedCardType": "string", + "cardNumber": "string", + "cardNumberMasked": "string", + "cardNumberLast4Digits": "string", + "expirationDate": "2020-07-14", + "expirationDateMasked": "string", + "expirationDateExpired": true, + "cardHolderName": "string", + "attachCreditCardToProfile": true, + "processing": "Eft", + "swiped": true, + "cardOrToken": "CardNumber" }, - "compAccounting": { - "authorizer": "string", - "compType": "string" + "balance": { + "amount": 0, + "currencyCode": "string" }, - "financiallyResponsible": true, - "folioTexts": { - "folioText": [ - { - "row": 0, - "text": "string" - } - ] + "authorizationRule": { + "code": 0, + "amount": { + "amount": 0, + "currencyCode": "string" + }, + "percent": 0 }, - "lastRoomAndTaxPostedDate": "2020-07-14", - "periodicFolio": { - "frequency": 0, - "lastFolioDate": "2020-07-14", - "lastSettlementDate": "2020-07-14" + "emailFolioInfo": { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-07-14T09:58:05.724Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:58:05.724Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" + }, + "emailFolio": true, + "id": "string", + "type": "string" }, - "proratedBilling": true, - "reservationPreConfiguredRoutingInstruction": { - "authorizerInfo": { - "authorizerId": { + "paymentMethod": "string", + "description": "string", + "folioView": 0 + }, + "reservationFolioWindows": [ + { + "payeeInfo": { + "payeeId": { "id": "string", "type": "string" }, - "authorizerName": "string", - "authorizerRateCode": "string", - "authorizerUserName": "string", - "inheritAuthorizerRateCode": true + "payeeName": "string", + "payeeAddress": { + "address": { + "addressLine": [ + "string" + ], + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-07-14T09:58:05.724Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:58:05.724Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" + }, + "id": "string", + "type": "string" + }, + "payeeAddressCount": 0, + "payeeReferenceCurrency": "string", + "payeeAccountInfo": { + "accountName": "string", + "accountId": { + "id": "string", + "type": "string" + }, + "accountNo": "string", + "status": { + "restriction": "string", + "description": "string", + "restricted": true + } + }, + "payeeTaxNumber": "string" }, - "profileType": "Company", - "promotionCode": "string", - "ratePlanCode": "string" - }, - "revenuesAndBalances": { "balance": { "amount": 0, "currencyCode": "string" }, - "foodAndBevRevenue": { + "paymentMethod": "string", + "folioWindowNo": 0 + } + ], + "specials": "string", + "lastPrivacyPromptDate": "2020-07-14", + "displayColor": "string", + "reservationIndicators": [ + { + "indicatorName": "string", + "count": 0 + } + ], + "roomStatus": "Clean", + "searchMatches": [ + { + "attribute": "string", + "value": "string" + } + ], + "sourceOfSale": { + "sourceType": "string", + "sourceCode": "string" + }, + "waitlist": { + "reasonDescription": "string", + "priorityDescription": "string", + "description": "string", + "reasonCode": "string", + "priorityCode": "string", + "telephone": "string" + }, + "queue": { + "timeSpan": { + "startDate": "2020-07-14", + "endDate": "2020-07-14", + "duration": "string", + "durationInSeconds": 0 + }, + "guestTextInfo": { + "sentTime": "2020-07-14T09:58:05.724Z", + "sentBy": "string" + }, + "priority": 0, + "averageQueueTimeToCheckIn": 0, + "averageQueueTimeCurrentReservations": 0, + "queueDate": "2020-07-14" + }, + "housekeeping": { + "instructions": "string", + "facilityTaskInfo": { + "task": { + "description": "string", + "instructions": "string", + "facilityDepartureTask": true, + "linenChange": true, + "hotelId": "string", + "code": "string", + "sequence": 0 + }, + "supplies": [ + { + "description": "string", + "quantity": 0, + "code": "string" + } + ], + "date": "2020-07-14" + }, + "linenChange": true, + "turndownRequested": true, + "serviceTime": "2020-07-14", + "expectedServiceTime": "string", + "roomStatus": "Clean" + }, + "cashiering": { + "revenuesAndBalances": { + "totalFixedCharge": { "amount": 0, "currencyCode": "string" }, - "nonRevenue": { + "totalPayment": { "amount": 0, "currencyCode": "string" }, - "otherRevenue": { + "roomRevenue": { "amount": 0, "currencyCode": "string" }, - "roomRevenue": { + "foodAndBevRevenue": { "amount": 0, "currencyCode": "string" }, - "totalFixedCharge": { + "otherRevenue": { "amount": 0, "currencyCode": "string" }, - "totalPayment": { + "nonRevenue": { "amount": 0, "currencyCode": "string" }, "totalRevenue": { "amount": 0, "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" } }, - "reverseAdvanceCheckInAllowed": true, - "reverseCheckInAllowed": true, + "billingPrivileges": { + "postingRestriction": true, + "preStayCharging": true, + "postStayCharging": true, + "folioCloseDate": "2020-07-14", + "scheduledCheckout": true, + "scheduledCheckoutTime": "2020-07-14", + "directBillAuthorized": true, + "videoCheckout": true, + "allowAutoCheckin": true, + "autoSettlement": true, + "autoSettlementType": "string", + "autoSettlementFreq": 0, + "creditLimitAutoPay": true + }, "taxType": { + "hotelId": "string", "code": "string", - "collectingAgentTax": true, "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, + "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, + "minimumLengthOfStay": 0, "taxExemptNo": "string" }, + "bedTaxReporting": { + "taxRegistrationNo": 0, + "visaNumber": "string", + "visaIssueDate": "2020-07-14", + "visaExpiryDate": "2020-07-14", + "taxableDays": 0 + }, + "folioTexts": { + "folioText": [ + { + "text": "string", + "row": 0 + } + ] + }, + "periodicFolio": { + "lastSettlementDate": "2020-07-14", + "lastFolioDate": "2020-07-14", + "frequency": 0 + }, + "compAccounting": { + "compType": "string", + "authorizer": "string" + }, + "reservationPreConfiguredRoutingInstruction": { + "authorizerInfo": { + "authorizerId": { + "id": "string", + "type": "string" + }, + "authorizerUserName": "string", + "authorizerName": "string", + "authorizerRateCode": "string", + "inheritAuthorizerRateCode": true + }, + "ratePlanCode": "string", + "profileType": "Company", + "promotionCode": "string" + }, + "financiallyResponsible": true, + "proratedBilling": true, + "lastRoomAndTaxPostedDate": "2020-07-14", + "reverseCheckInAllowed": true, + "reverseAdvanceCheckInAllowed": true, "transactionsPosted": true }, - "commissionPayoutTo": "TravelAgent", - "computedReservationStatus": "Reserved", - "createDateTime": "2020-07-14T09:58:05.725Z", - "creatorId": "string", + "taxType": { + "hotelId": "string", + "code": "string", + "description": "string", + "collectingAgentTax": true, + "printAutoAdjust": true, + "reportExemptDays": 0, + "reportTaxPercentage": 0, + "minimumLengthOfStay": 0 + }, "deposit": { - "amountOwed": 0, - "amountPaid": 0, "amountRequired": 0, + "amountPaid": 0, + "amountOwed": 0, "dueDate": "2020-07-14", - "hasOutstanding": true, + "postingDate": "2020-07-14", "hasPaid": true, - "postingDate": "2020-07-14" + "hasOutstanding": true + }, + "allowedActions": [ + "Cancel" + ], + "revenuesAndBalances": { + "totalFixedCharge": { + "amount": 0, + "currencyCode": "string" + }, + "totalPayment": { + "amount": 0, + "currencyCode": "string" + }, + "roomRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "foodAndBevRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "otherRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "nonRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "totalRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" + } }, - "displayColor": "string", - "expectedServiceTime": "string", - "guestPreferredCurrency": "string", - "hotelId": "string", "hotelInterfaceStatusList": [ { + "roomExtension": "string", "hotelInterface": { - "activeFlag": true, - "hotelId": "string", "interfaceId": { "id": "string", "type": "string" }, + "hotelId": "string", "interfaceName": "string", "interfaceType": "Bms", "logo": "string", "machineName": "string", - "status": "Stopped" + "status": "Stopped", + "activeFlag": true }, "interfaceRights": [ { - "category": "string", - "description": "string", "right": 0, - "statusCode": "string" + "statusCode": "string", + "description": "string", + "category": "string" } - ], - "roomExtension": "string" + ] } ], - "hotelName": "string", - "housekeeping": { - "expectedServiceTime": "string", - "facilityTaskInfo": { - "date": "2020-07-14", - "supplies": [ - { - "code": "string", - "description": "string", - "quantity": 0 - } - ], - "task": { - "code": "string", - "description": "string", - "facilityDepartureTask": true, - "hotelId": "string", - "instructions": "string", - "linenChange": true, - "sequence": 0 - } - }, - "instructions": "string", - "linenChange": true, - "roomStatus": "Clean", - "serviceTime": "2020-07-14", - "turndownRequested": true + "guestPreferredCurrency": "string", + "turndownInfo": { + "allowed": true, + "status": "Required" }, - "keyCount": 0, - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:58:05.725Z", - "lastPrivacyPromptDate": "2020-07-14", "mobileNotifications": { - "checkoutMessageReceived": true, - "errorMessage": "string", + "roomReady": "Pending", "keyReady": "Pending", + "checkoutMessageReceived": true, "requiresAction": true, - "roomReady": "Pending" - }, - "openFolio": true, - "optedForCommunication": true, - "paymentMethod": "string", - "preRegistered": true, - "purgeDate": "2020-07-14", - "queue": { - "averageQueueTimeCurrentReservations": 0, - "averageQueueTimeToCheckIn": 0, - "guestTextInfo": { - "sentBy": "string", - "sentTime": "2020-07-14T09:58:05.724Z" - }, - "priority": 0, - "queueDate": "2020-07-14", - "timeSpan": { - "duration": "string", - "durationInSeconds": 0, - "endDate": "2020-07-14", - "startDate": "2020-07-14" - } + "errorMessage": "string" }, "reservationCommunication": { - "emails": { - "count": 0, - "emailInfo": [ + "telephones": { + "telephoneInfo": [ { - "email": { + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, "createDateTime": "2020-07-14T09:58:05.725Z", "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", "lastModifyDateTime": "2020-07-14T09:58:05.725Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-07-14", - "type": "string", - "typeDescription": "string" + "lastModifierId": "string", + "purgeDate": "2020-07-14" }, "id": "string", "type": "string" } ], "hasMore": true, - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "telephones": { - "count": 0, - "hasMore": true, - "telephoneInfo": [ + "emails": { + "emailInfo": [ { - "id": "string", - "telephone": { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, "createDateTime": "2020-07-14T09:58:05.725Z", "creatorId": "string", - "extension": "string", - "lastModifierId": "string", "lastModifyDateTime": "2020-07-14T09:58:05.725Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, + "lastModifierId": "string", "purgeDate": "2020-07-14" }, + "id": "string", "type": "string" } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 } }, - "reservationFolioWindows": [ - { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "folioWindowNo": 0, - "payeeInfo": { - "payeeAccountInfo": { - "accountId": { - "id": "string", - "type": "string" - }, - "accountName": "string", - "accountNo": "string", - "status": { - "description": "string", - "restricted": true, - "restriction": "string" - } - }, - "payeeAddress": { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-07-14T09:58:05.724Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:58:05.724Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-07-14", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true - }, - "id": "string", - "type": "string" - }, - "payeeAddressCount": 0, - "payeeId": { - "id": "string", - "type": "string" - }, - "payeeName": "string", - "payeeReferenceCurrency": "string", - "payeeTaxNumber": "string" - }, - "paymentMethod": "string" - } - ], - "reservationGuest": { - "accompanyGuests": [ - { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileIdList": [ - { - "id": "string", - "type": "string" - } - ], - "registrationCardNo": "string" - } - ], - "address": { - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "excludeNoCity": true, - "postalCode": "string", - "state": "string", - "streetAddress": "string" - }, - "alternateFullName": "string", - "alternateGivenName": "string", - "alternateSurname": "string", - "anonymization": { - "anonymizationDate": "2020-07-14T09:58:05.724Z", - "anonymizationStatus": "Requested" - }, - "birthDate": "2020-07-14", - "email": "string", - "externalInfo": { - "givenName": "string", - "surname": "string" - }, - "fullName": "string", - "givenName": "string", - "guestLastStayInfo": { - "lastStayDate": "2020-07-14", - "lastStayRate": { - "amount": 0, - "currencyCode": "string" - }, - "lastStayRoom": "string", - "totalStay": 0 - }, - "guestRestricted": true, - "guestRestrictedCode": "string", - "guestRestrictedReasonDesc": "string", - "id": "string", - "language": "string", - "membership": { - "accountId": "string", - "bonusCode": "string", - "membershipId": 0, - "membershipLevel": "string", - "membershipLevelDesc": "string", - "membershipTypeDesc": "string", - "playerRanking": 0, - "programCode": "string" - }, - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameType": "Guest", - "nationality": { - "code": "string", - "value": "string" - }, - "phoneNumber": "string", - "registrationCardNo": "string", - "surname": "string", - "surnamePrefix": "string", - "type": "string", - "vip": { - "vipCode": "string", - "vipDescription": "string" - } + "advanceCheckIn": { + "advanceCheckedIn": true, + "expectedReturnTime": "2020-07-14T09:58:05.725Z", + "eTRComments": "string" }, - "reservationIdList": [ - { - "id": "string", - "type": "string" - } - ], - "reservationIndicators": [ - { - "count": 0, - "indicatorName": "string" - } - ], - "reservationPaymentMethod": { - "authorizationRule": { - "amount": { - "amount": 0, - "currencyCode": "string" - }, - "code": 0, - "percent": 0 - }, - "balance": { - "amount": 0, - "currencyCode": "string" - }, + "welcomeOffer": true, + "cancellationInfo": { "description": "string", - "emailFolioInfo": { - "email": { - "createDateTime": "2020-07-14T09:58:05.724Z", - "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:58:05.724Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-07-14", - "type": "string", - "typeDescription": "string" - }, - "emailFolio": true, - "id": "string", - "type": "string" - }, - "folioView": 0, - "paymentCard": { - "approvalAmountNeeded": { - "amount": 0, - "currencyCode": "string" - }, - "attachCreditCardToProfile": true, - "cardHolderName": "string", - "cardId": { - "id": "string", - "type": "string" - }, - "cardNumber": "string", - "cardNumberLast4Digits": "string", - "cardNumberMasked": "string", - "cardOrToken": "CardNumber", - "cardType": "Ab", - "currentAuthorizedAmount": { - "amount": 0, - "currencyCode": "string" - }, - "expirationDate": "2020-07-14", - "expirationDateExpired": true, - "expirationDateMasked": "string", - "processing": "Eft", - "swiped": true, - "userDefinedCardType": "string" - }, - "paymentMethod": "string" + "code": "string", + "date": "2020-07-14" }, + "keyCount": 0, + "hotelId": "string", + "hotelName": "string", + "expectedServiceTime": "string", + "roomStayReservation": true, + "createDateTime": "2020-07-14T09:58:05.725Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:58:05.725Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14", "reservationStatus": "Reserved", - "revenuesAndBalances": { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "foodAndBevRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "nonRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "otherRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "roomRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "totalFixedCharge": { - "amount": 0, - "currencyCode": "string" - }, - "totalPayment": { - "amount": 0, - "currencyCode": "string" - }, - "totalRevenue": { - "amount": 0, - "currencyCode": "string" - } - }, - "roomStatus": "Clean", - "roomStay": { - "adultCount": 0, - "arrivalDate": "2020-07-14", - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "bookingChannelCode": "string", - "childCount": 0, - "compBalance": { - "amount": 0, - "currencyCode": "string" - }, - "departureDate": "2020-07-14", - "depositPayments": { - "amount": 0, - "currencyCode": "string" - }, - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-07-14T09:58:05.723Z", - "reservationExpectedDepartureTime": "2020-07-14T09:58:05.723Z" - }, - "fixedRate": true, - "guarantee": { - "guaranteeCode": "string", - "onHold": true, - "shortDescription": "string" - }, - "guestServiceStatus": "DoNotDisturb", - "marketCode": "string", - "numberOfRooms": 0, - "originalTimeSpan": { - "duration": "string", - "endDate": "2020-07-14", - "startDate": "2020-07-14" - }, - "partyCode": "string", - "points": { - "awardsType": "string", - "points": 0 - }, - "promotion": { - "couponCode": "string", - "promotionCode": "string", - "promotionName": "string" - }, - "pseudoRoom": true, - "rateAmount": { - "amount": 0, - "currencyCode": "string" - }, - "ratePlanCode": "string", - "rateSuppressed": true, - "reservationBlock": { - "blockIdList": [ + "computedReservationStatus": "Reserved", + "walkInIndicator": true, + "accessRestriction": "Change", + "commissionPayoutTo": "TravelAgent", + "paymentMethod": "string", + "preRegistered": true, + "openFolio": true, + "allowMobileCheckout": true, + "allowMobileViewFolio": true, + "optedForCommunication": true + } + ] + }, + "masterInfoList": [ + { + "codeInfo": [ + { + "description": "string", + "addtionalCodeInfo": { + "code": [ { - "id": "string", - "type": "string" + "name": "LongDescription", + "value": "string" } - ], - "blockName": "string", - "hotelId": "string" + ] }, - "roomClass": "string", - "roomNumber": "string", - "roomNumberLocked": true, - "roomType": "string", - "roomTypeCharged": "string", - "scheduledCheckoutTime": "2020-07-14", - "sourceOfBusiness": "string", - "sourceOfBusinessDescription": "string", - "totalAmount": { - "amount": 0, - "currencyCode": "string" - } - }, - "roomStayReservation": true, - "searchMatches": [ - { - "attribute": "string", - "value": "string" - } - ], - "sharedGuests": [ - { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - } - } - ], - "sourceOfSale": { - "sourceCode": "string", - "sourceType": "string" - }, - "specials": "string", - "taxType": { - "code": "string", - "collectingAgentTax": true, - "description": "string", "hotelId": "string", - "minimumLengthOfStay": 0, - "printAutoAdjust": true, - "reportExemptDays": 0, - "reportTaxPercentage": 0 - }, - "turndownInfo": { - "allowed": true, - "status": "Required" - }, - "waitlist": { - "description": "string", - "priorityCode": "string", - "priorityDescription": "string", - "reasonCode": "string", - "reasonDescription": "string", - "telephone": "string" - }, - "walkInIndicator": true, - "welcomeOffer": true - } - ] - } + "code": "string" + } + ], + "codeType": "Country" + } + ], + "links": [ + { + "href": "string", + "rel": "string", + "templated": false, + "method": "GET", + "targetSchema": "string", + "operationId": "string", + "title": "string" + } + ] } } }, @@ -2783,56 +2579,42 @@ "description": "ReservationsForBilling not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/commissionAgent/{commissionAgentId}/commissions": { - "put": { - "description": "OperationId:associateCommissionAgentToReservations
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2840,34 +2622,39 @@ "application/json;charset=UTF-8" ], "tags": [ - "Commissions" - ], + "FrontDeskOperations" + ] + } + }, + "/hotels/{hotelId}/commissionAgent/{commissionAgentId}/commissions": { + "put": { "summary": "Operation to associate commission agent to reservations.", + "description": "OperationId:associateCommissionAgentToReservations
", "operationId": "associateCommissionAgentToReservations", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Id of the Commission Agent.", "name": "commissionAgentId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Id of the Commission Agent." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "All reservation ids in the list must belong to this property.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "All reservation ids in the list must belong to this property." }, { - "description": "Request type for associating reservations to Travel Agent or Source Profile.", "name": "associateCommissionAgentToReservations", "in": "body", "required": true, + "description": "Request type for associating reservations to Travel Agent or Source Profile.", "schema": { "allOf": [ { @@ -2877,109 +2664,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response type for associating reservations to Travel Agent or Source Profile.", - "schema": { - "$ref": "#/definitions/associateCommissionAgentToReservationsStatus" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 type for associating reservations to Travel Agent or Source Profile.", + "schema": { + "$ref": "#/definitions/associateCommissionAgentToReservationsStatus" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "OperationId:removeCommissionAgentFromReservations
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -2988,203 +2743,180 @@ ], "tags": [ "Commissions" - ], + ] + }, + "delete": { "summary": "Operation to remove commission agent from reservations.", + "description": "OperationId:removeCommissionAgentFromReservations
", "operationId": "removeCommissionAgentFromReservations", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique Id of the Commission Agent.", "name": "commissionAgentId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique Id of the Commission Agent." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "All reservation ids in the list must belong to this property.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "All reservation ids in the list must belong to this property." }, { + "name": "commissionAgentType", + "in": "query", + "required": false, + "type": "string", + "description": "Simple type for commission agent type. Valid values are Agent and Source.", "uniqueItems": true, "enum": [ "Agent", "Source" - ], - "type": "string", - "description": "Simple type for commission agent type. Valid values are Agent and Source.", - "name": "commissionAgentType", - "in": "query" + ] }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "idExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "idContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "type", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { + "name": "reservationId", + "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" }, - "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.", - "name": "reservationId", - "in": "query" + "required": false }, { + "name": "reservationIdIdExtension", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Additional identifying value assigned by the creating system.", "items": { "type": "integer" }, - "collectionFormat": "multi", - "description": "Additional identifying value assigned by the creating system.", - "name": "reservationIdIdExtension", - "in": "query" + "required": false }, { + "name": "reservationIdIdContext", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "reservationIdIdContext", - "in": "query" + "required": false }, { + "name": "reservationIdType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A reference to the type of object defined by the UniqueID element.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "reservationIdType", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/commissionChecks": { - "delete": { - "description": "OperationId:discardCommissionChecks
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3193,179 +2925,159 @@ ], "tags": [ "Commissions" - ], + ] + } + }, + "/hotels/{hotelId}/commissionChecks": { + "delete": { "summary": "Operation to discard commission checks.", + "description": "OperationId:discardCommissionChecks
", "operationId": "discardCommissionChecks", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commission record.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commission record." }, { - "type": "string", - "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.", "name": "bankAccountId", - "in": "query" + "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" }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "idExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "idContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "type", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "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.", "name": "BatchId", - "in": "query" + "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" }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "batchIdIdExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "batchIdIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "batchIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "number", - "description": "The range start value of checks to be discarded.", "name": "fromCheck", - "in": "query" + "in": "query", + "required": false, + "description": "The range start value of checks to be discarded.", + "type": "number" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/commissionPayments": { - "put": { - "description": "OperationId:processCommissionPayments
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3374,24 +3086,29 @@ ], "tags": [ "Commissions" - ], + ] + } + }, + "/hotels/{hotelId}/commissionPayments": { + "put": { "summary": "Operation to process commission payments.", + "description": "OperationId:processCommissionPayments
", "operationId": "processCommissionPayments", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commission record.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commission record." }, { - "description": "Request type for processing commission payments.", "name": "processCommissionPayments", "in": "body", "required": true, + "description": "Request type for processing commission payments.", "schema": { "allOf": [ { @@ -3401,111 +3118,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response type for processing commission payments.", - "schema": { - "$ref": "#/definitions/processCommissionPaymentsStatus" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 type for processing commission payments.", + "schema": { + "$ref": "#/definitions/processCommissionPaymentsStatus" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/commissions": { - "get": { - "description": "OperationId:getCommissions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3514,242 +3197,235 @@ ], "tags": [ "Commissions" - ], + ] + } + }, + "/hotels/{hotelId}/commissions": { + "get": { "summary": "Operation to fetch commissions.", + "description": "OperationId:getCommissions
", "operationId": "getCommissions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commission record.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commission record." }, { - "type": "string", - "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.", "name": "bankAccountId", - "in": "query" + "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" }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "idExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "idContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "type", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "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.", "name": "agentId", - "in": "query" + "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" }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "agentIdIdExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "agentIdIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "agentIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "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.", "name": "resvNameId", - "in": "query" + "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" }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "resvNameIdIdExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "resvNameIdIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "resvNameIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "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.", "name": "commissionId", - "in": "query" + "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" }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "commissionIdIdExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "commissionIdIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "commissionIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "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.", "name": "batchId", - "in": "query" + "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" }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "batchIdIdExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "batchIdIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "batchIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Commissions for the requested account or agent id.", - "schema": { - "$ref": "#/definitions/commissionsDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Commissions for the requested account or agent id.", + "schema": { + "$ref": "#/definitions/commissionsDetails" } }, "204": { "description": "Commissions not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "OperationId:calculateCommissions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3758,24 +3434,27 @@ ], "tags": [ "Commissions" - ], + ] + }, + "put": { "summary": "Operation to calculate commissions.", + "description": "OperationId:calculateCommissions
", "operationId": "calculateCommissions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commissions to be calculated.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commissions to be calculated." }, { - "description": "Request type for calculation of commission for all Travel Agent and/or Source.", "name": "calculateCommissions", "in": "body", "required": true, + "description": "Request type for calculation of commission for all Travel Agent and/or Source.", "schema": { "allOf": [ { @@ -3785,111 +3464,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/calculateCommissionsStatus" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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/calculateCommissionsStatus" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/commissions/instructions": { - "post": { - "description": "OperationId:setProcessingInstructions
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -3898,24 +3543,29 @@ ], "tags": [ "Commissions" - ], + ] + } + }, + "/hotels/{hotelId}/commissions/instructions": { + "post": { "summary": "Operation to set processing instructions.", + "description": "OperationId:setProcessingInstructions
", "operationId": "setProcessingInstructions", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property from which the agent will be on hold for commission.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property from which the agent will be on hold for commission." }, { - "description": "Request Type for setting instructions for commission processing on Agent or Reservation level.", "name": "setProcessingInstructions", "in": "body", "required": true, + "description": "Request Type for setting instructions for commission processing on Agent or Reservation level.", "schema": { "allOf": [ { @@ -3925,111 +3575,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/commissions/{commissionId}": { - "get": { - "description": "OperationId:getCommission
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4038,149 +3654,125 @@ ], "tags": [ "Commissions" - ], + ] + } + }, + "/hotels/{hotelId}/commissions/{commissionId}": { + "get": { "summary": "Operation to fetch commission.", + "description": "OperationId:getCommission
", "operationId": "getCommission", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique id of the commission.", "name": "commissionId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique id of the commission." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commission record.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commission record." }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "idExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "idContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "type", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response type for fetch commission detail.", - "schema": { - "$ref": "#/definitions/commissionDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response type for fetch commission detail.", + "schema": { + "$ref": "#/definitions/commissionDetails" } }, "204": { "description": "Commission not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "OperationId:changeCommission
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4189,33 +3781,36 @@ ], "tags": [ "Commissions" - ], + ] + }, + "put": { "summary": "Operation to change commission.", + "description": "OperationId:changeCommission
", "operationId": "changeCommission", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique id of the commission.", "name": "commissionId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique id of the commission." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commission record.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commission record." }, { - "description": "Request type for update of commission detail.", "name": "commissionToBeChanged", "in": "body", "required": true, + "description": "Request type for update of commission detail.", "schema": { "allOf": [ { @@ -4225,109 +3820,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/commissionStatus" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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/commissionStatus" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "OperationId:removeCommission
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4336,158 +3899,131 @@ ], "tags": [ "Commissions" - ], + ] + }, + "delete": { "summary": "Operation to remove commission.", + "description": "OperationId:removeCommission
", "operationId": "removeCommission", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique id of the commission.", "name": "commissionId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique id of the commission." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commission record.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commission record." }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "idExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "idContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "type", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "description": "Used for Character Strings, length 0 to 2000.", "name": "detachDescription", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "description": "Used for Character Strings, length 0 to 2000." }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/commissions/{commissionId}/commissionCodes/{commissionCode}/recalculate": { - "put": { - "description": "OperationId:recalculateCommissionOnCodeChange
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4496,42 +4032,47 @@ ], "tags": [ "Commissions" - ], + ] + } + }, + "/hotels/{hotelId}/commissions/{commissionId}/commissionCodes/{commissionCode}/recalculate": { + "put": { "summary": "Operation to recalculate commission on code change.", + "description": "OperationId:recalculateCommissionOnCodeChange
", "operationId": "recalculateCommissionOnCodeChange", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "New commission code.", "name": "commissionCode", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "New commission code." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique id of the commission.", "name": "commissionId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique id of the commission." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property of the commission record.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property of the commission record." }, { - "description": "Request type for recalculating commission amount when commission code of unpaid commission is changed.", "name": "recalculateCommissionOnCodeChange", "in": "body", "required": true, + "description": "Request type for recalculating commission amount when commission code of unpaid commission is changed.", "schema": { "allOf": [ { @@ -4541,111 +4082,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response type for recalculating commission amount when commission code of unpaid commission is changed", - "schema": { - "$ref": "#/definitions/recalculateCommissionOnCodeChangeStatus" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 type for recalculating commission amount when commission code of unpaid commission is changed", + "schema": { + "$ref": "#/definitions/recalculateCommissionOnCodeChangeStatus" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/dailyDocket": { - "get": { - "description": "Use this API to fetch Daily Dockets.OperationId:getDailyDocket
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4653,135 +4160,111 @@ "application/json;charset=UTF-8" ], "tags": [ - "FrontDeskOperations" - ], + "Commissions" + ] + } + }, + "/hotels/{hotelId}/dailyDocket": { + "get": { "summary": "Get Daily Docket", + "description": "Use this API to fetch Daily Dockets.OperationId:getDailyDocket
", "operationId": "getDailyDocket", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "format": "date", - "description": "log book date.", "name": "docketDate", - "in": "query" + "in": "query", + "required": false, + "description": "log book date.", + "type": "string", + "format": "date" }, { - "type": "string", - "description": "Department code the log book entries belong to.", "name": "department", - "in": "query" + "in": "query", + "required": false, + "description": "Department code the log book entries belong to.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching log book entries.", - "schema": { - "$ref": "#/definitions/dailyDocket" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for fetching log book entries.", + "schema": { + "$ref": "#/definitions/dailyDocket" } }, "204": { "description": "DailyDocket not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "Use this API to change Daily Docket.OperationId:putDailyDocket
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4790,23 +4273,27 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + }, + "put": { "summary": "Change Daily Docket ", + "description": "Use this API to change Daily Docket.OperationId:putDailyDocket
", "operationId": "putDailyDocket", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Change log book entries.", "name": "dailyDocket", "in": "body", "required": true, + "description": "Change log book entries.", "schema": { "allOf": [ { @@ -4816,109 +4303,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Use this API to create a Daily Docket.OperationId:postDailyDocket
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -4927,23 +4382,27 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + }, + "post": { "summary": "Create Daily Docket ", + "description": "Use this API to create a Daily Docket.OperationId:postDailyDocket
", "operationId": "postDailyDocket", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Add log book entries.", "name": "dailyDocket", "in": "body", "required": true, + "description": "Add log book entries.", "schema": { "allOf": [ { @@ -4953,111 +4412,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/dailyDocket/{docketId}": { - "delete": { - "description": "Use this API to delete a Daily Docket.OperationId:deleteDailyDocket
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5066,132 +4491,212 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/dailyDocket/{docketId}": { + "delete": { "summary": "Delete Daily Docket ", + "description": "Use this API to delete a Daily Docket.OperationId:deleteDailyDocket
", "operationId": "deleteDailyDocket", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "docketId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "FrontDeskOperations" + ] } }, - "/hotels/{hotelId}/floorPlans": { - "get": { - "description": "Use this API to get Floor Plans for a property. Floor Plans provide a graphical layout of floors, rooms, and other physical features such as stairways, HVAC closets, elevators, and moreOperationId:getFloorPlans
", + "/hotels/{hotelId}/externalRoomKeys": { + "post": { + "summary": "Requests room key(s)", + "description": "API that manages requests for Door Lock Room Keys. This operation is used by OPERA Cloud PMS connected to external Door Lock Systems systems via Outbound Systems configuration: \n\nOPERA Cloud utilizes this operation \n\n- to request new or additional room keys - e.g. when guest checks in, or additional keys post check in.\n\n- to request to activate new keys after check on e.g. when a room key has been lost for a room.\n\n- to request a room key which is not related to a guest reservation but valid for a defined time - (for show rooms, repair) - One Shot Key.\n\n- to request to re-encode a key whereby other keys for this room remain active.\n\n- to request to read a key data from a room key and display it to the user in the PMS.\n\n- to request to modify existing key data - upon room move or change of departure date. (online key systems only!!)\n\n- to request to remove / delete a room key from a room on. Usually sent with check out of a reservation.\n\nUse this API to post a room key action to the active Door Lock System.\n\nNotes on keyType values:\n\nkeyType = New\n\nkeyType = Lost \n\nIt is expected that all previous active keys for the room will become invalid.\n\nIt is expected that partner system handles multiple keys being active in case numberOfKeys is >1.\n\nkeyType = Duplicate\n\nkeyType = ReEncode\n\nIt is expected that existing active keys for this room remain active.\n\nkeyType = OneShot\n\nIt is expected that the room key is only valid for a room for specific time (for maintenance or Show room).\n\nIt is never related to a reservation.\n\nkeyType = Read A request to the Key Card system to read Key Card information from requested Key Encoder/reader.\n\nThe Key Read functionality is of pure informational purpose. None of the received information is stored or processed in the PMS, and it is only for display to the user.\n\nkeyType = Remove\n\nIt is expected that with this request all active keys for a room or reservation will become inactive or invalid so they will not be able to open the room after defined validityEnd time.\n\nAdditional KeyType actions used by Online Door Lock Systems:\n\nOnline Key card Systems are systems which do not write guest data to the room key directly but do store guest data internally and send the information to the related door lock.\n\nkeyType = ModifyStay\n\nFor Online Door Lock Systems - Request to adjust Room key data when guest changes length of stay (validityEnd)\n\nkeyType = RoomMove\n\nFor Online Door Lock Systems - adjust Room key data when guest performs room move. \n\nOperationId: postExternalRoomKeys
", + "operationId": "postExternalRoomKeys", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel" + }, + { + "name": "roomKey", + "in": "body", + "required": true, + "description": "Request for generation of room key.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/roomKeyExternal" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "201": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + } + }, + "description": "Response from the active Door Locking System Property Interface to the post request.Note on Response messages:\n\nIt is necessary to specify both the PMS 'encoderTerminal' and the Key Service system's coder (encoderId) in cases where more than one PMS workstation may be addressing one key coder. ORACLE PMS will NOT send another Request command automatically should a negative response be received. The user sees the response and decides if another try should be made.
", + "schema": { + "$ref": "#/definitions/roomKeyExternalDetails" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5200,575 +4705,562 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/floorPlans": { + "get": { "summary": "Get floor plans", + "description": "Use this API to get Floor Plans for a property. Floor Plans provide a graphical layout of floors, rooms, and other physical features such as stairways, HVAC closets, elevators, and more
OperationId:getFloorPlans
", "operationId": "getFloorPlans", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Room filter.", "name": "room", - "in": "query" + "in": "query", + "required": false, + "description": "Room filter.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "List of suggested rooms for room assignment.", - "schema": { - "$ref": "#/definitions/floorPlans" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } }, + "description": "List of suggested rooms for room assignment.", + "schema": { + "$ref": "#/definitions/floorPlans" + }, "examples": { "application/json": { "floorPlansDetails": [ { - "hotelId": "string", - "links": [ - { - "href": "string", - "method": "GET", - "operationId": "string", - "rel": "string", - "targetSchema": "string", - "templated": false, - "title": "string" - } - ], "rooms": [ { + "roomType": { + "pseudo": true, + "suite": true, + "roomClass": "string", + "shortDescription": "string", + "houseKeeping": true, + "smokingPreference": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "minimumOccupancy": 0, + "maximumOccupancy": 0, + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "accessible": true, + "roomType": "string", + "meetingRoom": true + }, + "floor": "string", + "floorDescription": "string", + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "roomDescription": "string", + "description": { + "defaultText": "string", + "translatedTexts": { + "text": [ + { + "value": "string", + "language": "string" + } + ] + } + }, + "smokingPreference": "string", + "smokingPreferenceDescription": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", "accessible": true, + "roomId": "string", + "meetingRoom": true, + "roomSection": { + "daySectionCode": "string", + "eveningSectionCode": "string" + }, + "housekeeping": { + "roomStatus": { + "reservationStatusList": [ + "Arrival" + ], + "roomStatus": "Clean", + "frontOfficeStatus": "Vacant", + "housekeepingStatus": "Vacant" + }, + "roomPersons": { + "frontOfficePersons": 0, + "houseKeepingPersons": 0 + }, + "guestServiceRequest": "DoNotDisturb", + "cleaningPriority": { + "prioritySequence": 0 + }, + "roomCondition": { + "roomCondition": { + "code": "string", + "description": "string" + }, + "assignmentType": "Available", + "remarks": "string" + }, + "linenChange": true, + "facilityTaskCode": [ + "string" + ] + }, + "outOfOrder": [ + { + "repairRemarks": "string", + "returnStatus": "Clean", + "reasonCode": "string", + "reasonDesc": "string", + "newDateRange": { + "start": "2020-07-14", + "end": "2020-07-14" + }, + "roomStatus": "Clean", + "start": "2020-07-14", + "end": "2020-07-14" + } + ], + "discrepancy": [ + "Sleep" + ], + "sitePlanSection": { + "sectionCode": "string", + "sectionType": "string", + "linkCode": "string", + "coordinates": "string", + "description": "string" + }, + "componentRoomNumber": "string", + "connectingRooms": [ + { + "roomType": { + "pseudo": true, + "suite": true, + "roomClass": "string", + "shortDescription": "string", + "houseKeeping": true, + "smokingPreference": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "minimumOccupancy": 0, + "maximumOccupancy": 0, + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "accessible": true, + "roomType": "string", + "meetingRoom": true + }, + "floor": "string", + "floorDescription": "string", + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "roomDescription": "string", + "description": { + "defaultText": "string", + "translatedTexts": { + "text": [ + { + "value": "string", + "language": "string" + } + ] + } + }, + "smokingPreference": "string", + "smokingPreferenceDescription": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "accessible": true, + "roomId": "string", + "meetingRoom": true, + "roomCondition": { + "code": "string", + "description": "string" + } + } + ], + "componentRooms": [ + { + "roomType": { + "pseudo": true, + "suite": true, + "roomClass": "string", + "shortDescription": "string", + "houseKeeping": true, + "smokingPreference": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "minimumOccupancy": 0, + "maximumOccupancy": 0, + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "accessible": true, + "roomType": "string", + "meetingRoom": true + }, + "floor": "string", + "floorDescription": "string", + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "roomDescription": "string", + "description": { + "defaultText": "string", + "translatedTexts": { + "text": [ + { + "value": "string", + "language": "string" + } + ] + } + }, + "smokingPreference": "string", + "smokingPreferenceDescription": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "accessible": true, + "roomId": "string", + "meetingRoom": true, + "roomCondition": { + "code": "string", + "description": "string" + } + } + ], "attendant": [ { + "section": { + "hotelId": "string", + "code": "string", + "description": "string", + "sectionGroup": "string", + "targetCredits": 0, + "rooms": 0, + "roomCredits": 0, + "sequence": 0, + "inactive": true + }, + "floor": "string", + "attendantId": "string", + "attendantName": "string", + "hotelId": "string", "activeFlag": "string", + "sunday": true, + "monday": true, + "tuesday": true, + "wednesday": true, + "thursday": true, + "friday": true, + "saturday": true, "appUser": { + "hotel": { + "code": "string", + "description": "string" + }, + "appUser": "string", + "lDAPUser": "string", "actAs": "string", "actAt": "string", - "appUser": "string", + "userDefaultLanguage": "string", "appUserId": { "id": "string", "type": "string" }, - "attendantInfo": { - "attendantId": "string", - "hotelId": "string" - }, "cashierId": 0, "cashierTitle": "string", "department": "string", "departmentLocation": "string", - "disabledUntil": "2020-07-14", + "salesRepCode": "string", "expiryDate": "2020-07-14", - "hotel": { - "code": "string", - "description": "string" - }, - "lDAPUser": "string", + "disabledUntil": "2020-07-14", "passwordChangeDate": "2020-07-14", - "salesRepCode": "string", - "userDefaultLanguage": "string", "userInfo": { + "personName": { + "namePrefix": "string", + "givenName": "string", + "middleName": "string", + "surname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "nameTitleSuffix": 0, + "envelopeGreeting": "string", + "salutation": "string", + "nameType": "Primary", + "language": "string", + "externalSystem": "string" + }, + "profileId": { + "id": "string", + "type": "string" + }, "addressInfo": { "address": { "addressLine": [ "string" ], - "barCode": "string", - "cityExtension": "string", "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", "country": { - "code": "string", - "value": "string" + "value": "string", + "code": "string" }, - "county": "string", - "createDateTime": "2020-07-14T09:57:07.589Z", - "creatorId": "string", "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:57:07.589Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-07-14", - "state": "string", "type": "string", "typeDescription": "string", - "updateReservations": true + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-07-14T09:57:07.589Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:57:07.589Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" }, "id": "string", "type": "string" }, - "birthDate": "2020-07-14", - "birthDateMasked": "string", - "department": { - "code": "string", - "description": "string" - }, "emailInfo": { "email": { - "createDateTime": "2020-07-14T09:57:07.589Z", - "creatorId": "string", "emailAddress": "string", + "type": "string", + "typeDescription": "string", "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:57:07.589Z", - "orderSequence": 0, "primaryInd": true, - "purgeDate": "2020-07-14", - "type": "string", - "typeDescription": "string" + "orderSequence": 0, + "createDateTime": "2020-07-14T09:57:07.589Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:57:07.589Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" }, "id": "string", "type": "string" }, - "gender": "Male", - "personName": { - "envelopeGreeting": "string", - "externalSystem": "string", - "givenName": "string", - "language": "string", - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameTitleSuffix": 0, - "nameType": "Primary", - "salutation": "string", - "surname": "string" - }, "phoneInfo": { - "id": "string", "telephone": { - "createDateTime": "2020-07-14T09:57:07.589Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:57:07.589Z", - "orderSequence": 0, - "phoneNumber": "string", "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-07-14T09:57:07.589Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:57:07.589Z", + "lastModifierId": "string", "purgeDate": "2020-07-14" }, - "type": "string" - }, - "profileId": { "id": "string", "type": "string" - } + }, + "department": { + "code": "string", + "description": "string" + }, + "gender": "Male", + "birthDate": "2020-07-14", + "birthDateMasked": "string" }, "userSessionInfo": { "businessDate": "2020-07-14", - "cROCountryCode": "string", - "chain": "string", - "cro": { + "systemDate": "2020-07-14", + "terminal": "string", + "runningApp": "string", + "shareProfiles": true, + "hotel": { "code": "string", "description": "string" }, - "hotel": { + "cro": { "code": "string", "description": "string" }, - "parameters": [ - { - "parameterName": "string", - "parameterValue": "string" - } - ], - "runningApp": "string", + "chain": "string", + "cROCountryCode": "string", "sessionDefaults": { - "baseLanguage": "string", - "currencyCode": "string", - "currencyFormat": "string", "dbDateFormat": "string", - "defaultLanguage": "string", + "oracleDateFormat": "string", + "oracleTimeFormat": "string", "javaDateFormat": "string", "javaTimeFormat": "string", - "oracleDateFormat": "string", - "oracleTimeFormat": "string" + "currencyCode": "string", + "currencyFormat": "string", + "defaultLanguage": "string", + "baseLanguage": "string" }, - "shareProfiles": true, - "systemDate": "2020-07-14", - "terminal": "string" + "parameters": [ + { + "parameterName": "string", + "parameterValue": "string" + } + ] + }, + "attendantInfo": { + "attendantId": "string", + "hotelId": "string" } }, - "attendantId": "string", - "attendantName": "string", - "floor": "string", - "friday": true, - "hotelId": "string", - "monday": true, - "saturday": true, - "section": { - "code": "string", - "description": "string", - "hotelId": "string", - "inactive": true, - "roomCredits": 0, - "rooms": 0, - "sectionGroup": "string", - "sequence": 0, - "targetCredits": 0 - }, "startTime": "2020-07-14T09:57:07.589Z", - "status": "Standby", - "sunday": true, - "thursday": true, - "tuesday": true, - "wednesday": true + "status": "Standby" } ], - "building": "string", - "componentRoomNumber": "string", - "componentRoomNumbers": { - "roomId": [ - "string" - ] + "hold": { + "holdUntil": "2020-07-14T09:57:07.589Z", + "holdUser": "string", + "comments": "string" }, - "componentRooms": [ + "turndownInfo": { + "turndownStatusInfo": "Required" + }, + "resvInfo": [ { - "accessible": true, - "building": "string", - "description": { - "defaultText": "string", - "translatedTexts": { - "text": [ - { - "language": "string", - "value": "string" - } - ] - } - }, - "floor": "string", - "floorDescription": "string", - "meetingRoom": true, - "roomAssignmentRating": "MostImportant", - "roomCondition": { - "code": "string", - "description": "string" + "guestName": "string", + "reservationId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 }, - "roomDescription": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 + "reservationStatusInfo": "Arrival", + "stayDateInfo": { + "timeSpan": { + "startDate": "2020-07-14", + "endDate": "2020-07-14", + "duration": "string" + }, + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-07-14T09:57:07.590Z", + "reservationExpectedDepartureTime": "2020-07-14T09:57:07.590Z" } - ], - "roomId": "string", - "roomType": { - "accessible": true, - "building": "string", - "houseKeeping": true, - "maximumOccupancy": 0, - "meetingRoom": true, - "minimumOccupancy": 0, - "pseudo": true, - "roomAssignmentRating": "MostImportant", - "roomClass": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomType": "string", - "shortDescription": "string", - "smokingPreference": "string", - "suite": true }, - "smokingPreference": "string", - "smokingPreferenceDescription": "string" + "vipStatus": { + "value": "string", + "code": "string" + }, + "profileId": { + "id": "string", + "type": "string" + } } ], - "connectingRooms": [ - { - "accessible": true, - "building": "string", - "description": { - "defaultText": "string", - "translatedTexts": { - "text": [ - { - "language": "string", - "value": "string" - } - ] - } - }, - "floor": "string", - "floorDescription": "string", - "meetingRoom": true, - "roomAssignmentRating": "MostImportant", - "roomCondition": { - "code": "string", - "description": "string" - }, - "roomDescription": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomId": "string", - "roomType": { - "accessible": true, - "building": "string", - "houseKeeping": true, - "maximumOccupancy": 0, - "meetingRoom": true, - "minimumOccupancy": 0, - "pseudo": true, - "roomAssignmentRating": "MostImportant", - "roomClass": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomType": "string", - "shortDescription": "string", - "smokingPreference": "string", - "suite": true - }, - "smokingPreference": "string", - "smokingPreferenceDescription": "string" - } - ], - "description": { - "defaultText": "string", - "translatedTexts": { - "text": [ - { - "language": "string", - "value": "string" - } - ] - } - }, - "discrepancy": [ - "Sleep" - ], - "floor": "string", - "floorDescription": "string", - "guests": [ + "componentRoomNumbers": { + "roomId": [ + "string" + ] + }, + "guests": [ { + "lastName": "string", + "firstName": "string", "arrival": "2020-07-14", - "confirmationNo": "string", "departure": "2020-07-14", - "firstName": "string", - "lastName": "string", - "shareID": "string" - } - ], - "hold": { - "comments": "string", - "holdUntil": "2020-07-14T09:57:07.589Z", - "holdUser": "string" - }, - "housekeeping": { - "cleaningPriority": { - "prioritySequence": 0 - }, - "facilityTaskCode": [ - "string" - ], - "guestServiceRequest": "DoNotDisturb", - "linenChange": true, - "roomCondition": { - "assignmentType": "Available", - "remarks": "string", - "roomCondition": { - "code": "string", - "description": "string" - } - }, - "roomPersons": { - "frontOfficePersons": 0, - "houseKeepingPersons": 0 - }, - "roomStatus": { - "frontOfficeStatus": "Vacant", - "housekeepingStatus": "Vacant", - "reservationStatusList": [ - "Arrival" - ], - "roomStatus": "Clean" - } - }, - "meetingRoom": true, - "outOfOrder": [ - { - "end": "2020-07-14", - "newDateRange": { - "end": "2020-07-14", - "start": "2020-07-14" - }, - "reasonCode": "string", - "reasonDesc": "string", - "repairRemarks": "string", - "returnStatus": "Clean", - "roomStatus": "Clean", - "start": "2020-07-14" - } - ], - "resvInfo": [ - { - "guestName": "string", - "profileId": { - "id": "string", - "type": "string" - }, - "reservationId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - }, - "reservationStatusInfo": "Arrival", - "stayDateInfo": { - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-07-14T09:57:07.590Z", - "reservationExpectedDepartureTime": "2020-07-14T09:57:07.590Z" - }, - "timeSpan": { - "duration": "string", - "endDate": "2020-07-14", - "startDate": "2020-07-14" - } - }, - "vipStatus": { - "code": "string", - "value": "string" - } - } - ], - "roomAssignmentRating": "MostImportant", - "roomDescription": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 + "shareID": "string", + "confirmationNo": "string" } - ], - "roomId": "string", - "roomSection": { - "daySectionCode": "string", - "eveningSectionCode": "string" - }, - "roomType": { - "accessible": true, - "building": "string", - "houseKeeping": true, - "maximumOccupancy": 0, - "meetingRoom": true, - "minimumOccupancy": 0, - "pseudo": true, - "roomAssignmentRating": "MostImportant", - "roomClass": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomType": "string", - "shortDescription": "string", - "smokingPreference": "string", - "suite": true - }, - "sitePlanSection": { - "coordinates": "string", - "description": "string", - "linkCode": "string", - "sectionCode": "string", - "sectionType": "string" - }, - "smokingPreference": "string", - "smokingPreferenceDescription": "string", - "turndownInfo": { - "turndownStatusInfo": "Required" - } + ] } ], + "hotelId": "string", "siteCode": "string", - "siteDescription": "string" + "siteDescription": "string", + "links": [ + { + "href": "string", + "rel": "string", + "templated": false, + "method": "GET", + "targetSchema": "string", + "operationId": "string", + "title": "string" + } + ] } ], "links": [ { "href": "string", - "method": "GET", - "operationId": "string", "rel": "string", - "targetSchema": "string", "templated": false, + "method": "GET", + "targetSchema": "string", + "operationId": "string", "title": "string" } ] @@ -5779,56 +5271,42 @@ "description": "FloorPlans not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/frontOfficeStatistics/{statisticsCode}": { - "get": { - "description": "Use this API to return front office statistics for a specific hotel based on search criteria such as statisticsCode, hotelId, date, parameterNames, parameterValues, room Classes.OperationId:getFrontOfficeStatistics
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -5836,14 +5314,24 @@ "application/json;charset=UTF-8" ], "tags": [ - "FOFStats" - ], + "FrontDeskOperations" + ] + } + }, + "/hotels/{hotelId}/frontOfficeStatistics/{statisticsCode}": { + "get": { "summary": "Get front office statistics", + "description": "Use this API to return front office statistics for a specific hotel based on search criteria such as statisticsCode, hotelId, date, parameterNames, parameterValues, room Classes.OperationId:getFrontOfficeStatistics
", "operationId": "getFrontOfficeStatistics", "parameters": [ { - "maxLength": 2000, + "name": "statisticsCode", + "in": "path", + "required": true, + "type": "string", "minLength": 1, + "maxLength": 2000, + "description": "Below are the Statistics Code mapping for valid metric code.AdvanceCheckIn:
IndividualAdvanceCheckedInCurrent,BlockAdvanceCheckedInInhouse,BlockAdvanceCheckedInTotal,IndividualAdvanceCheckedInInhouse,IndividualAdvanceCheckedInTotal,BlockAdvanceCheckedInCurrent;AIRoomAssignment:
MaxPercentageOccupiedTonightRooms,ArrivalResvs,ArrivalVIPResvs,ArrivalMemberResvs,ArrivalUnallocResvs,ArrivalManualAssgnResvs,ArrivalAIAssgnResvs,ArrivalAIUpgResvs,ArrivalAIAssgnVIPResvs,ArrivalAIAssgnMemberResvs,ArrivalAIAssgnOverridden;AvailableRooms:
MinAvailableTonightRooms;CheckIns:
ArrivalsTotal,CheckedInsTotal,ExpectedCheckInsTotal,QueueRooms;CheckOuts:DeparturesTotal,CheckedOutsTotal,AdultsDeparted,ChildrenDeparted,ExpectedCheckOutsTotal,AdultsExpectedCheckedOut,ChildrenExpectedCheckedOut,ScheduledCheckOutsTotal;ComplimentaryOrHouseUse:
ComplimentaryArrivalRooms,ComplimentaryArrivalPersons,ComplimentaryArrivalVIP,ComplimentaryStayoverRooms,ComplimentaryStayoverPersons,ComplimentaryStayoverVIP,ComplimentaryDepartureRooms,ComplimentaryDeparturePersons,ComplimentaryDepartureVIP,HouseUseArrivalRooms,HouseUseArrivalPersons,HouseUseArrivalVIP,HouseUseStayoverRooms,HouseUseStayoverPersons,HouseUseStayoverVIP,HouseUseDepartureRooms,HouseUseDeparturePersons,HouseUseDepartureVIP;DailyProjection:
IndividualRooms,IndividualPersons,IndividualVIP,GroupAndBlockRooms,GroupAndBlockPersons,GroupAndBlockVIP,MaxOccupiedTonightRooms,MaxOccupiedTonightPersons,MaxOccupiedTonightVIP,BlocksNotPickedUp,MaxPercentageOccupiedTonightRooms,MinAvailableTonightRooms,RoomRevenue,TotalRevenue,AverageRoomRevenue,RevPar;HouseSummary:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,TotalRevenue,RevPar,AverageRoomRevenue;HouseSummaryMonthToDate:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,RevPar,TotalRevenue,AverageRoomRevenue;HouseSummaryYearToDate:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,RevPar,TotalRevenue,AverageRoomRevenue;InHouse:
AdultsInHouse,ChildrenInHouse,InHouseRooms,InHouse;LastHourStatus:
ArrivalsInLastHour,DeparturesInLastHour,InspectedRooms,CleanedRooms;ReservationActivity:
StayoverRooms,StayoverPersons,StayoverVIP,DeparturesExpectedRooms,DeparturesExpectedPersons,DeparturesExpectedVIP,DeparturesActualRooms,DeparturesActualPersons,DeparturesActualVIP,ArrivalsExpectedRooms,ArrivalsExpectedPersons,ArrivalsExpectedVIP,ArrivalsActualRooms,ArrivalsActualPersons,ArrivalsActualVIP,ArrivalsExpectedRoomsMadeToday,ArrivalsExpectedPersonsMadeToday,ArrivalsExpectedVIPMadeToday,ExtendedStaysRooms,ExtendedStaysPersons,ExtendedStaysVIP,EarlyDeparturesRooms,EarlyDeparturesPersons,EarlyDeparturesVIP,DayUseRooms,DayUsePersons,DayUseVIP,WalkInRooms,WalkInPersons,WalkInVIP,CanceledOnArrivalRooms,CanceledOnArrivalPersons,CanceledOnArrivalVIP,AverageCheckInTime;ReservationActivityDaily:
AdultsInHouse,ChildrenInHouse,ArrivalsTotal,TurndownRequired,DeparturesTotal,MaxOccupancyPercentage,Stayover,TotalRoomsReserved;ReservationActivityMonthToDate:
ArrivalsActualRooms,ArrivalsActualPersons,DeparturesActualRooms,DeparturesActualPersons,ExtendedStaysRooms,ExtendedStaysPersons,EarlyDeparturesRooms,EarlyDeparturesPersons,DayUseRooms,DayUsePersons;ReservationActivityYearToDate:
ArrivalsActualRooms,ArrivalsActualPersons,DeparturesActualRooms,DeparturesActualPersons,ExtendedStaysRooms,ExtendedStaysPersons,EarlyDeparturesRooms,EarlyDeparturesPersons,DayUseRooms,DayUsePersons;ReservationsCancellationsToday:
CancellationsTotal,NewReservationsTotal;ReservationStatistics:
PreRegisteredTotal,VIPPreRegisteredTotal,TurndownTotal,VIPTurndownTotal,OpenFolioTotal,ExpectedCheckOutsTotal;RoomMaintenance:
RoomMaintenanceResolvedTotal,RoomMaintenanceUnResolvedTotal;RoomStatus:
InspectedVacant,InspectedAssigned,InspectedOccupied,CleanVacant,CleanAssigned,CleanOccupied,DirtyVacant,DirtyAssigned,DirtyOccupied,PickupVacant,PickupAssigned,PickupOccupied,OutOfOrderVacant,OutOfOrderAssigned,OutOfOrderOccupied,OutOfServiceVacant,OutOfServiceAssigned,OutOfServiceOccupied,TotalOutOfOrder,TotalOutOfService,QueueRooms,CurrentAveWaitTime,SkipRooms,SleepRooms;Turndown:
TurndownRequired,TurndownNotRequired,TurndownCompletedRequired;VIPGuests:
VIPGuestsArriving,VIPGuestsDeparting;", "enum": [ "AdvanceCheckIn", "AIRoomAssignment", @@ -5868,32 +5356,34 @@ "Turndown", "VIPGuests", "CompRouting" - ], - "type": "string", - "description": "Below are the Statistics Code mapping for valid metric code.AdvanceCheckIn:
IndividualAdvanceCheckedInCurrent,BlockAdvanceCheckedInInhouse,BlockAdvanceCheckedInTotal,IndividualAdvanceCheckedInInhouse,IndividualAdvanceCheckedInTotal,BlockAdvanceCheckedInCurrent;AIRoomAssignment:
MaxPercentageOccupiedTonightRooms,ArrivalResvs,ArrivalVIPResvs,ArrivalMemberResvs,ArrivalUnallocResvs,ArrivalManualAssgnResvs,ArrivalAIAssgnResvs,ArrivalAIUpgResvs,ArrivalAIAssgnVIPResvs,ArrivalAIAssgnMemberResvs,ArrivalAIAssgnOverridden;AvailableRooms:
MinAvailableTonightRooms;CheckIns:
ArrivalsTotal,CheckedInsTotal,ExpectedCheckInsTotal,QueueRooms;CheckOuts:DeparturesTotal,CheckedOutsTotal,AdultsDeparted,ChildrenDeparted,ExpectedCheckOutsTotal,AdultsExpectedCheckedOut,ChildrenExpectedCheckedOut,ScheduledCheckOutsTotal;ComplimentaryOrHouseUse:
ComplimentaryArrivalRooms,ComplimentaryArrivalPersons,ComplimentaryArrivalVIP,ComplimentaryStayoverRooms,ComplimentaryStayoverPersons,ComplimentaryStayoverVIP,ComplimentaryDepartureRooms,ComplimentaryDeparturePersons,ComplimentaryDepartureVIP,HouseUseArrivalRooms,HouseUseArrivalPersons,HouseUseArrivalVIP,HouseUseStayoverRooms,HouseUseStayoverPersons,HouseUseStayoverVIP,HouseUseDepartureRooms,HouseUseDeparturePersons,HouseUseDepartureVIP;DailyProjection:
IndividualRooms,IndividualPersons,IndividualVIP,GroupAndBlockRooms,GroupAndBlockPersons,GroupAndBlockVIP,MaxOccupiedTonightRooms,MaxOccupiedTonightPersons,MaxOccupiedTonightVIP,BlocksNotPickedUp,MaxPercentageOccupiedTonightRooms,MinAvailableTonightRooms,RoomRevenue,TotalRevenue,AverageRoomRevenue,RevPar;HouseSummary:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,TotalRevenue,RevPar,AverageRoomRevenue;HouseSummaryMonthToDate:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,RevPar,TotalRevenue,AverageRoomRevenue;HouseSummaryYearToDate:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,RevPar,TotalRevenue,AverageRoomRevenue;InHouse:
AdultsInHouse,ChildrenInHouse,InHouseRooms,InHouse;LastHourStatus:
ArrivalsInLastHour,DeparturesInLastHour,InspectedRooms,CleanedRooms;ReservationActivity:
StayoverRooms,StayoverPersons,StayoverVIP,DeparturesExpectedRooms,DeparturesExpectedPersons,DeparturesExpectedVIP,DeparturesActualRooms,DeparturesActualPersons,DeparturesActualVIP,ArrivalsExpectedRooms,ArrivalsExpectedPersons,ArrivalsExpectedVIP,ArrivalsActualRooms,ArrivalsActualPersons,ArrivalsActualVIP,ArrivalsExpectedRoomsMadeToday,ArrivalsExpectedPersonsMadeToday,ArrivalsExpectedVIPMadeToday,ExtendedStaysRooms,ExtendedStaysPersons,ExtendedStaysVIP,EarlyDeparturesRooms,EarlyDeparturesPersons,EarlyDeparturesVIP,DayUseRooms,DayUsePersons,DayUseVIP,WalkInRooms,WalkInPersons,WalkInVIP,CanceledOnArrivalRooms,CanceledOnArrivalPersons,CanceledOnArrivalVIP,AverageCheckInTime;ReservationActivityDaily:
AdultsInHouse,ChildrenInHouse,ArrivalsTotal,TurndownRequired,DeparturesTotal,MaxOccupancyPercentage,Stayover,TotalRoomsReserved;ReservationActivityMonthToDate:
ArrivalsActualRooms,ArrivalsActualPersons,DeparturesActualRooms,DeparturesActualPersons,ExtendedStaysRooms,ExtendedStaysPersons,EarlyDeparturesRooms,EarlyDeparturesPersons,DayUseRooms,DayUsePersons;ReservationActivityYearToDate:
ArrivalsActualRooms,ArrivalsActualPersons,DeparturesActualRooms,DeparturesActualPersons,ExtendedStaysRooms,ExtendedStaysPersons,EarlyDeparturesRooms,EarlyDeparturesPersons,DayUseRooms,DayUsePersons;ReservationsCancellationsToday:
CancellationsTotal,NewReservationsTotal;ReservationStatistics:
PreRegisteredTotal,VIPPreRegisteredTotal,TurndownTotal,VIPTurndownTotal,OpenFolioTotal,ExpectedCheckOutsTotal;RoomMaintenance:
RoomMaintenanceResolvedTotal,RoomMaintenanceUnResolvedTotal;RoomStatus:
InspectedVacant,InspectedAssigned,InspectedOccupied,CleanVacant,CleanAssigned,CleanOccupied,DirtyVacant,DirtyAssigned,DirtyOccupied,PickupVacant,PickupAssigned,PickupOccupied,OutOfOrderVacant,OutOfOrderAssigned,OutOfOrderOccupied,OutOfServiceVacant,OutOfServiceAssigned,OutOfServiceOccupied,TotalOutOfOrder,TotalOutOfService,QueueRooms,CurrentAveWaitTime,SkipRooms,SleepRooms;Turndown:
TurndownRequired,TurndownNotRequired,TurndownCompletedRequired;VIPGuests:
VIPGuestsArriving,VIPGuestsDeparting;", - "name": "statisticsCode", - "in": "path", - "required": true + ] }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "format": "date", - "description": "Start date of the report.", "name": "date", - "in": "query" + "in": "query", + "required": false, + "description": "Start date of the report.", + "type": "string", + "format": "date" }, { - "uniqueItems": true, + "name": "metric", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Supported housekeeping statistical codes.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "AdultsDeparted", "AdultsExpectedCheckedOut", @@ -6048,125 +5538,104 @@ "DeclinedCompPostings", "CompRoutingInstructionsRequests", "WalkInVIP" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Supported housekeeping statistical codes.", - "name": "metric", - "in": "query" + "required": false }, { + "name": "parameterNames", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Required when statisticsCode is ReservationsCancellationsToday", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Required when statisticsCode is ReservationsCancellationsToday", - "name": "parameterNames", - "in": "query" + "required": false }, { + "name": "parameterValues", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Required when statisticsCode is ReservationsCancellationsToday", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Required when statisticsCode is ReservationsCancellationsToday", - "name": "parameterValues", - "in": "query" + "required": false }, { + "name": "roomClasses", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Room Class of the Room.", - "name": "roomClasses", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response element for housekeeping statistics.", - "schema": { - "$ref": "#/definitions/statistics" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } }, + "description": "Response element for housekeeping statistics.", + "schema": { + "$ref": "#/definitions/statistics" + }, "examples": { "application/json": { + "statisticsCode": "CheckIns", "calendarDate": "2020-05-25", "metricSet": [ { "metrics": [ { + "value": "10", "category": "Numeric", - "code": "ArrivalsTotal", - "value": "10" + "code": "ArrivalsTotal" }, { + "value": "0", "category": "Numeric", - "code": "QueueRooms", - "value": "0" + "code": "QueueRooms" }, { + "value": "5", "category": "Numeric", - "code": "CheckedInsTotal", - "value": "5" + "code": "CheckedInsTotal" }, { + "value": "10", "category": "Numeric", - "code": "ExpectedCheckInsTotal", - "value": "10" + "code": "ExpectedCheckInsTotal" } ] } - ], - "statisticsCode": "CheckIns" + ] } } }, @@ -6174,56 +5643,42 @@ "description": "FrontOfficeStatistics not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/frontOfficeStatisticsRange/{statisticsCode}": { - "get": { - "description": "This API is useful to retrieve statistics regarding front office operationsOperationId:getFrontOfficeStatisticsWithDateRange
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6232,48 +5687,61 @@ ], "tags": [ "FOFStats" - ], + ] + } + }, + "/hotels/{hotelId}/frontOfficeStatisticsRange/{statisticsCode}": { + "get": { "summary": "Get front office Statistics", + "description": "This API is useful to retrieve statistics regarding front office operationsOperationId:getFrontOfficeStatisticsWithDateRange
", "operationId": "getFrontOfficeStatisticsWithDateRange", "parameters": [ { - "maxLength": 2000, + "name": "statisticsCode", + "in": "path", + "required": true, + "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;", "enum": [ "ReservationActivityDaily" - ], - "type": "string", - "description": "Below are the Statistics Code mapping for valid metric code.ReservationActivityDaily:
AdultsInHouse,ChildrenInHouse,ArrivalsTotal,TurndownRequired,DeparturesTotal,MaxOccupancyPercentage,Stayover,TotalRoomsReserved;", - "name": "statisticsCode", - "in": "path", - "required": true + ] }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "format": "date", - "description": "End date of the report.", "name": "endDate", - "in": "query" + "in": "query", + "required": false, + "description": "End date of the report.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "Start date of the report.", "name": "date", - "in": "query" + "in": "query", + "required": false, + "description": "Start date of the report.", + "type": "string", + "format": "date" }, { - "uniqueItems": true, + "name": "metric", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Supported housekeeping statistical codes.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "AdultsDeparted", "AdultsExpectedCheckedOut", @@ -6428,150 +5896,115 @@ "DeclinedCompPostings", "CompRoutingInstructionsRequests", "WalkInVIP" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Supported housekeeping statistical codes.", - "name": "metric", - "in": "query" + "required": false }, { + "name": "parameterNames", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Required when statisticsCode is ReservationsCancellationsToday", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Required when statisticsCode is ReservationsCancellationsToday", - "name": "parameterNames", - "in": "query" + "required": false }, { + "name": "parameterValues", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Required when statisticsCode is ReservationsCancellationsToday", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Required when statisticsCode is ReservationsCancellationsToday", - "name": "parameterValues", - "in": "query" + "required": false }, { + "name": "roomClasses", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Room Class of the Room.", - "name": "roomClasses", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response element for housekeeping statistics.", - "schema": { - "$ref": "#/definitions/statistics" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response element for housekeeping statistics.", + "schema": { + "$ref": "#/definitions/statistics" } }, "204": { "description": "FrontOfficeStatisticsWithDateRange not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/fulfillmentActivityLogs": { - "get": { - "description": "You can use this API to get the fullfillment activity log.OperationId:getFulfillmentActivityLog
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6579,33 +6012,46 @@ "application/json;charset=UTF-8" ], "tags": [ - "FrontDeskOperations" - ], + "FOFStats" + ] + } + }, + "/hotels/{hotelId}/fulfillmentActivityLogs": { + "get": { "summary": "Get the fullfillment activity log", + "description": "You can use this API to get the fullfillment activity log.OperationId:getFulfillmentActivityLog
", "operationId": "getFulfillmentActivityLog", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "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.", - "name": "offset", - "in": "query" + "type": "integer" }, { + "name": "module", + "in": "query", + "required": false, + "type": "string", + "description": "Activity module.", "uniqueItems": true, "enum": [ "Reservation", @@ -6618,187 +6064,158 @@ "RateCode", "Billing", "Activity" - ], - "type": "string", - "description": "Activity module.", - "name": "module", - "in": "query" + ] }, { + "name": "parameterName", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Name of the parameter.", - "name": "parameterName", - "in": "query" + "required": false }, { + "name": "parameterValue", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Value of the parameter.", - "name": "parameterValue", - "in": "query" + "required": false }, { - "type": "string", "name": "activityGroup", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", "name": "activityType", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", - "format": "date", - "description": "Search from date for the user activity log.", "name": "fromDate", - "in": "query" + "in": "query", + "required": false, + "description": "Search from date for the user activity log.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "Search to date for the user activity log.", "name": "toDate", - "in": "query" + "in": "query", + "required": false, + "description": "Search to date for the user activity log.", + "type": "string", + "format": "date" }, { - "type": "string", - "description": "Search text for the user activity log.", "name": "searchText", - "in": "query" + "in": "query", + "required": false, + "description": "Search text for the user activity log.", + "type": "string" }, { + "name": "userByIds", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "integer" + "type": "integer", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "userByIds", - "in": "query" + "required": false }, { + "name": "userForIds", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "integer" + "type": "integer", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "userForIds", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Fulfillment activity log response.", - "schema": { - "$ref": "#/definitions/activityLog" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Fulfillment activity log response.", + "schema": { + "$ref": "#/definitions/activityLog" } }, "204": { "description": "FulfillmentActivityLog not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/houseKeepingStatistics": { - "get": { - "description": "This Api will get the housekeeping statistics for your property.OperationId:getTaskSheetStatistics
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6806,143 +6223,118 @@ "application/json;charset=UTF-8" ], "tags": [ - "FOFStats" - ], + "FrontDeskOperations" + ] + } + }, + "/hotels/{hotelId}/houseKeepingStatistics": { + "get": { "summary": "Get housekeeping statistics", + "description": "This Api will get the housekeeping statistics for your property.OperationId:getTaskSheetStatistics
", "operationId": "getTaskSheetStatistics", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "boolean", + "name": "includeAllAssignedTasks", + "in": "query", "default": true, + "required": false, "description": "This flag, if true, enables fetching statistics for all the housekeeping tasks assigned.", - "name": "includeAllAssignedTasks", - "in": "query" + "type": "boolean" }, { - "type": "boolean", - "default": false, "name": "includeTaskSheetsDetails", - "in": "query" + "in": "query", + "default": false, + "required": false, + "type": "boolean" }, { - "type": "string", - "description": "Task code of the task sheet.", "name": "taskCode", - "in": "query" + "in": "query", + "required": false, + "description": "Task code of the task sheet.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response element for housekeeping statistics.", - "schema": { - "$ref": "#/definitions/taskSheetStatistics" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response element for housekeeping statistics.", + "schema": { + "$ref": "#/definitions/taskSheetStatistics" } }, "204": { "description": "TaskSheetStatistics not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses": { - "get": { - "description": "This Api will getch the room interface status.OperationId:getRoomInterfaceStatus
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -6950,34 +6342,46 @@ "application/json;charset=UTF-8" ], "tags": [ - "FrontDeskOperations" - ], + "FOFStats" + ] + } + }, + "/hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses": { + "get": { "summary": "Get room interface status", + "description": "This Api will getch the room interface status.OperationId:getRoomInterfaceStatus
", "operationId": "getRoomInterfaceStatus", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "interfaceId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Name of the Hotel Interface", "name": "interfaceName", - "in": "query" + "in": "query", + "required": false, + "description": "Name of the Hotel Interface", + "type": "string" }, { + "name": "interfaceType", + "in": "query", + "required": false, + "type": "string", "uniqueItems": true, "enum": [ "Bms", @@ -6998,24 +6402,28 @@ "Www", "Xml" ], - "type": "string", - "description": "XML Posting Interface", - "name": "interfaceType", - "in": "query" + "description": "XML Posting Interface" }, { - "type": "string", - "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", "name": "logo", - "in": "query" + "in": "query", + "required": false, + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string" }, { - "type": "string", - "description": "Unique machine name of the running IFC.", "name": "machineName", - "in": "query" + "in": "query", + "required": false, + "description": "Unique machine name of the running IFC.", + "type": "string" }, { + "name": "status", + "in": "query", + "required": false, + "type": "string", + "description": "Status of the Hotel Interface either STOPPED or RUNNING.", "uniqueItems": true, "enum": [ "Stopped", @@ -7025,166 +6433,186 @@ "StartInitiated", "RebootInitiated", "Other" - ], - "type": "string", - "description": "Status of the Hotel Interface either STOPPED or RUNNING.", - "name": "status", - "in": "query" + ] }, { - "type": "boolean", - "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.", "name": "activeFlag", - "in": "query" + "in": "query", + "required": false, + "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.", + "type": "boolean" }, { + "name": "code", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "code", - "in": "query" + "required": false }, { - "type": "string", - "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.", "name": "blockId", - "in": "query" + "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" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "blockIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "blockIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "description": "Wild card search value for Room number", "name": "roomId", - "in": "query" + "in": "query", + "required": false, + "description": "Wild card search value for Room number", + "type": "string" }, { - "type": "string", - "description": "Wild card search value to lookup reservations with this last name", "name": "lastName", - "in": "query" + "in": "query", + "required": false, + "description": "Wild card search value to lookup reservations with this last name", + "type": "string" }, { - "type": "string", - "description": "Wild card search value to lookup reservations with this first name", "name": "firstName", - "in": "query" + "in": "query", + "required": false, + "description": "Wild card search value to lookup reservations with this first name", + "type": "string" }, { + "name": "reservationIds", + "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" }, - "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.", - "name": "reservationIds", - "in": "query" + "required": false }, { + "name": "reservationIdsContext", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "reservationIdsContext", - "in": "query" + "required": false }, { + "name": "reservationIdsType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A reference to the type of object defined by the UniqueID element.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "reservationIdsType", - "in": "query" + "required": false }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", "name": "arrivalEnd", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The starting value of the date range.", "name": "arrivalStart", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date-time", - "description": "The ending value of the time span.", "name": "expectedArrivalEndTime", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the time span.", + "type": "string", + "format": "date-time" }, { - "type": "string", - "format": "date-time", - "description": "The starting value of the time span.", "name": "expectedArrivalStartTime", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the time span.", + "type": "string", + "format": "date-time" }, { + "name": "specialCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "specialCodes", - "in": "query" + "required": false }, { + "name": "floorCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "floorCodes", - "in": "query" + "required": false }, { + "name": "roomFeatureCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "roomFeatureCodes", - "in": "query" + "required": false }, { + "name": "roomClassCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "roomClassCodes", - "in": "query" + "required": false }, { - "uniqueItems": true, + "name": "roomStatus", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Clean", "Dirty", @@ -7192,24 +6620,26 @@ "Inspected", "OutOfOrder", "OutOfService" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", - "name": "roomStatus", - "in": "query" + "required": false }, { - "type": "string", - "description": "Include reservations that have Guarantee Code(Reservation Type) only.", "name": "guaranteeCode", - "in": "query" + "in": "query", + "required": false, + "description": "Include reservations that have Guarantee Code(Reservation Type) only.", + "type": "string" }, { - "uniqueItems": true, + "name": "reservationStatus", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Reservation status type for reservations search.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Cancelled", "CheckedOut", @@ -7219,806 +6649,803 @@ "InHouse", "NoShow", "WaitList" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Reservation status type for reservations search.", - "name": "reservationStatus", - "in": "query" + "required": false }, { - "type": "boolean", - "description": "Include linked reservations.", "name": "includeLinkedReservations", - "in": "query" + "in": "query", + "required": false, + "description": "Include linked reservations.", + "type": "boolean" }, { - "type": "boolean", - "description": "Include reservations attached to a block.", "name": "includeBlocks", - "in": "query" + "in": "query", + "required": false, + "description": "Include reservations attached to a block.", + "type": "boolean" }, { + "name": "orderBy", + "in": "query", + "required": false, + "type": "string", + "description": "A collection of supported sorting for Room Interface Status search results.", "uniqueItems": true, "enum": [ "RoomNo", "Name", "ArrivalDateETR", "ArrivalDate" - ], - "type": "string", - "description": "A collection of supported sorting for Room Interface Status search results.", - "name": "orderBy", - "in": "query" + ] }, { + "name": "orderType", + "in": "query", + "required": false, + "type": "string", "uniqueItems": true, "enum": [ "Asc", "Desc" - ], - "type": "string", - "name": "orderType", - "in": "query" + ] }, { - "type": "string", - "format": "date-time", - "description": "The ending value of the time span.", "name": "expectedReturnEndTime", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the time span.", + "type": "string", + "format": "date-time" }, { - "type": "string", - "format": "date-time", - "description": "The starting value of the time span.", "name": "expectedReturnStartTime", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the time span.", + "type": "string", + "format": "date-time" }, { - "type": "boolean", - "description": "Shows whether reservation is in Advance CheckIn state.", "name": "advanceCheckedIn", - "in": "query" + "in": "query", + "required": false, + "description": "Shows whether reservation is in Advance CheckIn state.", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "guaranteeCodes", + "in": "query", + "required": false, + "description": "Fetches the reservation having Guarantee Codes(Reservation Type) supplied here. Example guaranteeCodes=6PM", + "type": "array", + "collectionFormat": "multi", + "maxItems": 100, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for fetching room interface status", - "schema": { - "$ref": "#/definitions/roomInterfaceStatus" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } }, + "description": "Response object for fetching room interface status", + "schema": { + "$ref": "#/definitions/roomInterfaceStatus" + }, "examples": { "application/json": { - "links": [ - { - "href": "string", - "method": "GET", - "operationId": "string", - "rel": "string", - "targetSchema": "string", - "templated": false, - "title": "string" - } - ], "roomInterfaceStatusList": [ { - "accessRestriction": "Change", - "advanceCheckIn": { - "advanceCheckedIn": true, - "eTRComments": "string", - "expectedReturnTime": "2020-07-14T09:52:51.965Z" - }, - "allowMobileCheckout": true, - "allowMobileViewFolio": true, - "allowedActions": [ - "Cancel" - ], - "attachedProfiles": [ + "reservationIdList": [ { - "name": "string", - "profileIdList": [ - { - "id": "string", - "type": "string" - } - ], - "reservationProfileType": "Company" + "id": "string", + "type": "string" } ], - "cancellationInfo": { - "code": "string", - "date": "2020-07-14", - "description": "string" - }, - "cashiering": { - "bedTaxReporting": { - "taxRegistrationNo": 0, - "taxableDays": 0, - "visaExpiryDate": "2020-07-14", - "visaIssueDate": "2020-07-14", - "visaNumber": "string" + "roomStay": { + "arrivalDate": "2020-07-14", + "departureDate": "2020-07-14", + "originalTimeSpan": { + "startDate": "2020-07-14", + "endDate": "2020-07-14", + "duration": "string" }, - "billingPrivileges": { - "allowAutoCheckin": true, - "autoSettlement": true, - "autoSettlementFreq": 0, - "autoSettlementType": "string", - "creditLimitAutoPay": true, - "directBillAuthorized": true, - "folioCloseDate": "2020-07-14", - "postStayCharging": true, - "postingRestriction": true, - "preStayCharging": true, - "scheduledCheckout": true, - "scheduledCheckoutTime": "2020-07-14", - "videoCheckout": true + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-07-14T09:52:51.964Z", + "reservationExpectedDepartureTime": "2020-07-14T09:52:51.964Z" }, - "compAccounting": { - "authorizer": "string", - "compType": "string" + "adultCount": 0, + "childCount": 0, + "roomClass": "string", + "roomType": "string", + "numberOfRooms": 0, + "roomNumber": "string", + "ratePlanCode": "string", + "rateAmount": { + "amount": 0, + "currencyCode": "string" }, - "financiallyResponsible": true, - "folioTexts": { - "folioText": [ + "points": { + "awardsType": "string", + "points": 0 + }, + "rateSuppressed": true, + "reservationBlock": { + "blockIdList": [ { - "row": 0, - "text": "string" + "id": "string", + "type": "string" } - ] + ], + "blockName": "string", + "hotelId": "string" }, - "lastRoomAndTaxPostedDate": "2020-07-14", - "periodicFolio": { - "frequency": 0, - "lastFolioDate": "2020-07-14", - "lastSettlementDate": "2020-07-14" + "bookingChannelCode": "string", + "partyCode": "string", + "fixedRate": true, + "totalAmount": { + "amount": 0, + "currencyCode": "string" }, - "proratedBilling": true, - "reservationPreConfiguredRoutingInstruction": { - "authorizerInfo": { - "authorizerId": { - "id": "string", - "type": "string" - }, - "authorizerName": "string", - "authorizerRateCode": "string", - "authorizerUserName": "string", - "inheritAuthorizerRateCode": true - }, - "profileType": "Company", + "guarantee": { + "guaranteeCode": "string", + "shortDescription": "string", + "onHold": true + }, + "promotion": { "promotionCode": "string", - "ratePlanCode": "string" + "promotionName": "string", + "couponCode": "string" }, - "revenuesAndBalances": { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "foodAndBevRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "nonRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "otherRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "roomRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "totalFixedCharge": { - "amount": 0, - "currencyCode": "string" - }, - "totalPayment": { - "amount": 0, - "currencyCode": "string" - }, - "totalRevenue": { - "amount": 0, - "currencyCode": "string" - } + "marketCode": "string", + "sourceOfBusiness": "string", + "sourceOfBusinessDescription": "string", + "balance": { + "amount": 0, + "currencyCode": "string" }, - "reverseAdvanceCheckInAllowed": true, - "reverseCheckInAllowed": true, - "taxType": { - "code": "string", - "collectingAgentTax": true, - "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, - "printAutoAdjust": true, - "reportExemptDays": 0, - "reportTaxPercentage": 0, - "taxExemptNo": "string" + "compBalance": { + "amount": 0, + "currencyCode": "string" }, - "transactionsPosted": true - }, - "commissionPayoutTo": "TravelAgent", - "computedReservationStatus": "Reserved", - "createDateTime": "2020-07-14T09:52:51.965Z", - "creatorId": "string", - "deposit": { - "amountOwed": 0, - "amountPaid": 0, - "amountRequired": 0, - "dueDate": "2020-07-14", - "hasOutstanding": true, - "hasPaid": true, - "postingDate": "2020-07-14" - }, - "displayColor": "string", - "expectedServiceTime": "string", - "guestPreferredCurrency": "string", - "hotelId": "string", - "hotelInterfaceStatusList": [ - { - "hotelInterface": { - "activeFlag": true, - "hotelId": "string", - "interfaceId": { - "id": "string", - "type": "string" - }, - "interfaceName": "string", - "interfaceType": "Bms", - "logo": "string", - "machineName": "string", - "status": "Stopped" - }, - "interfaceRights": [ - { - "category": "string", - "description": "string", - "right": 0, - "statusCode": "string" - } - ], - "roomExtension": "string" - } - ], - "hotelName": "string", - "housekeeping": { - "expectedServiceTime": "string", - "facilityTaskInfo": { - "date": "2020-07-14", - "supplies": [ - { - "code": "string", - "description": "string", - "quantity": 0 - } - ], - "task": { - "code": "string", - "description": "string", - "facilityDepartureTask": true, - "hotelId": "string", - "instructions": "string", - "linenChange": true, - "sequence": 0 - } + "roomTypeCharged": "string", + "depositPayments": { + "amount": 0, + "currencyCode": "string" }, - "instructions": "string", - "linenChange": true, - "roomStatus": "Clean", - "serviceTime": "2020-07-14", - "turndownRequested": true - }, - "keyCount": 0, - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:52:51.965Z", - "lastPrivacyPromptDate": "2020-07-14", - "mobileNotifications": { - "checkoutMessageReceived": true, - "errorMessage": "string", - "keyReady": "Pending", - "requiresAction": true, - "roomReady": "Pending" + "guestServiceStatus": "DoNotDisturb", + "scheduledCheckoutTime": "2020-07-14", + "roomNumberLocked": true, + "pseudoRoom": true }, - "openFolio": true, - "optedForCommunication": true, - "paymentMethod": "string", - "preRegistered": true, - "purgeDate": "2020-07-14", - "queue": { - "averageQueueTimeCurrentReservations": 0, - "averageQueueTimeToCheckIn": 0, - "guestTextInfo": { - "sentBy": "string", - "sentTime": "2020-07-14T09:52:51.965Z" + "reservationGuest": { + "membership": { + "membershipId": 0, + "programCode": "string", + "bonusCode": "string", + "membershipTypeDesc": "string", + "membershipLevelDesc": "string", + "accountId": "string", + "membershipLevel": "string", + "playerRanking": 0 }, - "priority": 0, - "queueDate": "2020-07-14", - "timeSpan": { - "duration": "string", - "durationInSeconds": 0, - "endDate": "2020-07-14", - "startDate": "2020-07-14" - } - }, - "reservationCommunication": { - "emails": { - "count": 0, - "emailInfo": [ - { - "email": { - "createDateTime": "2020-07-14T09:52:51.965Z", - "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:52:51.965Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-07-14", - "type": "string", - "typeDescription": "string" - }, - "id": "string", - "type": "string" - } - ], - "hasMore": true, - "totalResults": 0 + "namePrefix": "string", + "givenName": "string", + "alternateGivenName": "string", + "middleName": "string", + "surnamePrefix": "string", + "surname": "string", + "alternateSurname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "fullName": "string", + "alternateFullName": "string", + "phoneNumber": "string", + "email": "string", + "birthDate": "2020-07-14", + "language": "string", + "nationality": { + "value": "string", + "code": "string" }, - "telephones": { - "count": 0, - "hasMore": true, - "telephoneInfo": [ - { - "id": "string", - "telephone": { - "createDateTime": "2020-07-14T09:52:51.965Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:52:51.965Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-07-14" - }, - "type": "string" - } - ], - "totalResults": 0 - } - }, - "reservationFolioWindows": [ - { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "folioWindowNo": 0, - "payeeInfo": { - "payeeAccountInfo": { - "accountId": { - "id": "string", - "type": "string" - }, - "accountName": "string", - "accountNo": "string", - "status": { - "description": "string", - "restricted": true, - "restriction": "string" - } - }, - "payeeAddress": { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-07-14T09:52:51.965Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:52:51.965Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-07-14", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true - }, - "id": "string", - "type": "string" - }, - "payeeAddressCount": 0, - "payeeId": { - "id": "string", - "type": "string" - }, - "payeeName": "string", - "payeeReferenceCurrency": "string", - "payeeTaxNumber": "string" + "vip": { + "vipCode": "string", + "vipDescription": "string" + }, + "address": { + "cityName": "string", + "postalCode": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" }, - "paymentMethod": "string" - } - ], - "reservationGuest": { + "streetAddress": "string", + "excludeNoCity": true + }, + "anonymization": { + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-07-14T09:52:51.964Z" + }, "accompanyGuests": [ { "firstName": "string", - "fullName": "string", "lastName": "string", + "fullName": "string", + "registrationCardNo": "string", "profileIdList": [ { "id": "string", "type": "string" } - ], - "registrationCardNo": "string" + ] } ], - "address": { - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "excludeNoCity": true, - "postalCode": "string", - "state": "string", - "streetAddress": "string" - }, - "alternateFullName": "string", - "alternateGivenName": "string", - "alternateSurname": "string", - "anonymization": { - "anonymizationDate": "2020-07-14T09:52:51.964Z", - "anonymizationStatus": "Requested" - }, - "birthDate": "2020-07-14", - "email": "string", "externalInfo": { "givenName": "string", "surname": "string" }, - "fullName": "string", - "givenName": "string", "guestLastStayInfo": { "lastStayDate": "2020-07-14", + "lastStayRoom": "string", "lastStayRate": { "amount": 0, "currencyCode": "string" }, - "lastStayRoom": "string", "totalStay": 0 }, - "guestRestricted": true, "guestRestrictedCode": "string", "guestRestrictedReasonDesc": "string", - "id": "string", - "language": "string", - "membership": { - "accountId": "string", - "bonusCode": "string", - "membershipId": 0, - "membershipLevel": "string", - "membershipLevelDesc": "string", - "membershipTypeDesc": "string", - "playerRanking": 0, - "programCode": "string" - }, - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameType": "Guest", - "nationality": { - "code": "string", - "value": "string" - }, - "phoneNumber": "string", + "guestRestricted": true, "registrationCardNo": "string", - "surname": "string", - "surnamePrefix": "string", - "type": "string", - "vip": { - "vipCode": "string", - "vipDescription": "string" - } + "nameType": "Guest", + "id": "string", + "type": "string" }, - "reservationIdList": [ + "sharedGuests": [ { - "id": "string", - "type": "string" + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "firstName": "string", + "lastName": "string", + "fullName": "string" } ], - "reservationIndicators": [ + "attachedProfiles": [ { - "count": 0, - "indicatorName": "string" + "name": "string", + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ], + "reservationProfileType": "Company" } ], "reservationPaymentMethod": { - "authorizationRule": { - "amount": { + "paymentCard": { + "cardId": { + "id": "string", + "type": "string" + }, + "currentAuthorizedAmount": { "amount": 0, "currencyCode": "string" }, - "code": 0, - "percent": 0 + "approvalAmountNeeded": { + "amount": 0, + "currencyCode": "string" + }, + "cardType": "Ab", + "userDefinedCardType": "string", + "cardNumber": "string", + "cardNumberMasked": "string", + "cardNumberLast4Digits": "string", + "expirationDate": "2020-07-14", + "expirationDateMasked": "string", + "expirationDateExpired": true, + "cardHolderName": "string", + "attachCreditCardToProfile": true, + "processing": "Eft", + "swiped": true, + "cardOrToken": "CardNumber" }, "balance": { "amount": 0, "currencyCode": "string" }, - "description": "string", + "authorizationRule": { + "code": 0, + "amount": { + "amount": 0, + "currencyCode": "string" + }, + "percent": 0 + }, "emailFolioInfo": { "email": { - "createDateTime": "2020-07-14T09:52:51.965Z", - "creatorId": "string", "emailAddress": "string", + "type": "string", + "typeDescription": "string", "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:52:51.965Z", - "orderSequence": 0, "primaryInd": true, - "purgeDate": "2020-07-14", - "type": "string", - "typeDescription": "string" + "orderSequence": 0, + "createDateTime": "2020-07-14T09:52:51.965Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:52:51.965Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" }, "emailFolio": true, "id": "string", "type": "string" }, - "folioView": 0, - "paymentCard": { - "approvalAmountNeeded": { - "amount": 0, - "currencyCode": "string" - }, - "attachCreditCardToProfile": true, - "cardHolderName": "string", - "cardId": { - "id": "string", - "type": "string" + "paymentMethod": "string", + "description": "string", + "folioView": 0 + }, + "reservationFolioWindows": [ + { + "payeeInfo": { + "payeeId": { + "id": "string", + "type": "string" + }, + "payeeName": "string", + "payeeAddress": { + "address": { + "addressLine": [ + "string" + ], + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-07-14T09:52:51.965Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:52:51.965Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" + }, + "id": "string", + "type": "string" + }, + "payeeAddressCount": 0, + "payeeReferenceCurrency": "string", + "payeeAccountInfo": { + "accountName": "string", + "accountId": { + "id": "string", + "type": "string" + }, + "accountNo": "string", + "status": { + "restriction": "string", + "description": "string", + "restricted": true + } + }, + "payeeTaxNumber": "string" }, - "cardNumber": "string", - "cardNumberLast4Digits": "string", - "cardNumberMasked": "string", - "cardOrToken": "CardNumber", - "cardType": "Ab", - "currentAuthorizedAmount": { + "balance": { "amount": 0, "currencyCode": "string" }, - "expirationDate": "2020-07-14", - "expirationDateExpired": true, - "expirationDateMasked": "string", - "processing": "Eft", - "swiped": true, - "userDefinedCardType": "string" - }, - "paymentMethod": "string" - }, - "reservationStatus": "Reserved", - "revenuesAndBalances": { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "foodAndBevRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "nonRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "otherRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "roomRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "totalFixedCharge": { - "amount": 0, - "currencyCode": "string" - }, - "totalPayment": { - "amount": 0, - "currencyCode": "string" - }, - "totalRevenue": { - "amount": 0, - "currencyCode": "string" + "paymentMethod": "string", + "folioWindowNo": 0 } - }, + ], + "specials": "string", + "lastPrivacyPromptDate": "2020-07-14", + "displayColor": "string", + "reservationIndicators": [ + { + "indicatorName": "string", + "count": 0 + } + ], "roomStatus": "Clean", - "roomStay": { - "adultCount": 0, - "arrivalDate": "2020-07-14", - "balance": { - "amount": 0, - "currencyCode": "string" + "searchMatches": [ + { + "attribute": "string", + "value": "string" + } + ], + "sourceOfSale": { + "sourceType": "string", + "sourceCode": "string" + }, + "waitlist": { + "reasonDescription": "string", + "priorityDescription": "string", + "description": "string", + "reasonCode": "string", + "priorityCode": "string", + "telephone": "string" + }, + "queue": { + "timeSpan": { + "startDate": "2020-07-14", + "endDate": "2020-07-14", + "duration": "string", + "durationInSeconds": 0 }, - "bookingChannelCode": "string", - "childCount": 0, - "compBalance": { - "amount": 0, - "currencyCode": "string" + "guestTextInfo": { + "sentTime": "2020-07-14T09:52:51.965Z", + "sentBy": "string" }, - "departureDate": "2020-07-14", - "depositPayments": { - "amount": 0, - "currencyCode": "string" + "priority": 0, + "averageQueueTimeToCheckIn": 0, + "averageQueueTimeCurrentReservations": 0, + "queueDate": "2020-07-14" + }, + "housekeeping": { + "instructions": "string", + "facilityTaskInfo": { + "task": { + "description": "string", + "instructions": "string", + "facilityDepartureTask": true, + "linenChange": true, + "hotelId": "string", + "code": "string", + "sequence": 0 + }, + "supplies": [ + { + "description": "string", + "quantity": 0, + "code": "string" + } + ], + "date": "2020-07-14" }, - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-07-14T09:52:51.964Z", - "reservationExpectedDepartureTime": "2020-07-14T09:52:51.964Z" + "linenChange": true, + "turndownRequested": true, + "serviceTime": "2020-07-14", + "expectedServiceTime": "string", + "roomStatus": "Clean" + }, + "cashiering": { + "revenuesAndBalances": { + "totalFixedCharge": { + "amount": 0, + "currencyCode": "string" + }, + "totalPayment": { + "amount": 0, + "currencyCode": "string" + }, + "roomRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "foodAndBevRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "otherRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "nonRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "totalRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" + } }, - "fixedRate": true, - "guarantee": { - "guaranteeCode": "string", - "onHold": true, - "shortDescription": "string" + "billingPrivileges": { + "postingRestriction": true, + "preStayCharging": true, + "postStayCharging": true, + "folioCloseDate": "2020-07-14", + "scheduledCheckout": true, + "scheduledCheckoutTime": "2020-07-14", + "directBillAuthorized": true, + "videoCheckout": true, + "allowAutoCheckin": true, + "autoSettlement": true, + "autoSettlementType": "string", + "autoSettlementFreq": 0, + "creditLimitAutoPay": true }, - "guestServiceStatus": "DoNotDisturb", - "marketCode": "string", - "numberOfRooms": 0, - "originalTimeSpan": { - "duration": "string", - "endDate": "2020-07-14", - "startDate": "2020-07-14" + "taxType": { + "hotelId": "string", + "code": "string", + "description": "string", + "collectingAgentTax": true, + "printAutoAdjust": true, + "reportExemptDays": 0, + "reportTaxPercentage": 0, + "minimumLengthOfStay": 0, + "taxExemptNo": "string" }, - "partyCode": "string", - "points": { - "awardsType": "string", - "points": 0 + "bedTaxReporting": { + "taxRegistrationNo": 0, + "visaNumber": "string", + "visaIssueDate": "2020-07-14", + "visaExpiryDate": "2020-07-14", + "taxableDays": 0 }, - "promotion": { - "couponCode": "string", - "promotionCode": "string", - "promotionName": "string" + "folioTexts": { + "folioText": [ + { + "text": "string", + "row": 0 + } + ] }, - "pseudoRoom": true, - "rateAmount": { - "amount": 0, - "currencyCode": "string" + "periodicFolio": { + "lastSettlementDate": "2020-07-14", + "lastFolioDate": "2020-07-14", + "frequency": 0 }, - "ratePlanCode": "string", - "rateSuppressed": true, - "reservationBlock": { - "blockIdList": [ - { + "compAccounting": { + "compType": "string", + "authorizer": "string" + }, + "reservationPreConfiguredRoutingInstruction": { + "authorizerInfo": { + "authorizerId": { "id": "string", "type": "string" - } - ], - "blockName": "string", - "hotelId": "string" + }, + "authorizerUserName": "string", + "authorizerName": "string", + "authorizerRateCode": "string", + "inheritAuthorizerRateCode": true + }, + "ratePlanCode": "string", + "profileType": "Company", + "promotionCode": "string" }, - "roomClass": "string", - "roomNumber": "string", - "roomNumberLocked": true, - "roomType": "string", - "roomTypeCharged": "string", - "scheduledCheckoutTime": "2020-07-14", - "sourceOfBusiness": "string", - "sourceOfBusinessDescription": "string", - "totalAmount": { - "amount": 0, - "currencyCode": "string" - } - }, - "roomStayReservation": true, - "searchMatches": [ - { - "attribute": "string", - "value": "string" - } - ], - "sharedGuests": [ - { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - } - } - ], - "sourceOfSale": { - "sourceCode": "string", - "sourceType": "string" + "financiallyResponsible": true, + "proratedBilling": true, + "lastRoomAndTaxPostedDate": "2020-07-14", + "reverseCheckInAllowed": true, + "reverseAdvanceCheckInAllowed": true, + "transactionsPosted": true }, - "specials": "string", "taxType": { + "hotelId": "string", "code": "string", - "collectingAgentTax": true, "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, + "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, - "reportTaxPercentage": 0 + "reportTaxPercentage": 0, + "minimumLengthOfStay": 0 + }, + "deposit": { + "amountRequired": 0, + "amountPaid": 0, + "amountOwed": 0, + "dueDate": "2020-07-14", + "postingDate": "2020-07-14", + "hasPaid": true, + "hasOutstanding": true + }, + "allowedActions": [ + "Cancel" + ], + "revenuesAndBalances": { + "totalFixedCharge": { + "amount": 0, + "currencyCode": "string" + }, + "totalPayment": { + "amount": 0, + "currencyCode": "string" + }, + "roomRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "foodAndBevRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "otherRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "nonRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "totalRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" + } }, + "hotelInterfaceStatusList": [ + { + "roomExtension": "string", + "hotelInterface": { + "interfaceId": { + "id": "string", + "type": "string" + }, + "hotelId": "string", + "interfaceName": "string", + "interfaceType": "Bms", + "logo": "string", + "machineName": "string", + "status": "Stopped", + "activeFlag": true + }, + "interfaceRights": [ + { + "right": 0, + "statusCode": "string", + "description": "string", + "category": "string" + } + ] + } + ], + "guestPreferredCurrency": "string", "turndownInfo": { "allowed": true, "status": "Required" }, - "waitlist": { + "mobileNotifications": { + "roomReady": "Pending", + "keyReady": "Pending", + "checkoutMessageReceived": true, + "requiresAction": true, + "errorMessage": "string" + }, + "reservationCommunication": { + "telephones": { + "telephoneInfo": [ + { + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-07-14T09:52:51.965Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:52:51.965Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" + }, + "id": "string", + "type": "string" + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "emails": { + "emailInfo": [ + { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-07-14T09:52:51.965Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:52:51.965Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" + }, + "id": "string", + "type": "string" + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 + } + }, + "advanceCheckIn": { + "advanceCheckedIn": true, + "expectedReturnTime": "2020-07-14T09:52:51.965Z", + "eTRComments": "string" + }, + "welcomeOffer": true, + "cancellationInfo": { "description": "string", - "priorityCode": "string", - "priorityDescription": "string", - "reasonCode": "string", - "reasonDescription": "string", - "telephone": "string" + "code": "string", + "date": "2020-07-14" }, + "keyCount": 0, + "hotelId": "string", + "hotelName": "string", + "expectedServiceTime": "string", + "roomStayReservation": true, + "createDateTime": "2020-07-14T09:52:51.965Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:52:51.965Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14", + "reservationStatus": "Reserved", + "computedReservationStatus": "Reserved", "walkInIndicator": true, - "welcomeOffer": true + "accessRestriction": "Change", + "commissionPayoutTo": "TravelAgent", + "paymentMethod": "string", + "preRegistered": true, + "openFolio": true, + "allowMobileCheckout": true, + "allowMobileViewFolio": true, + "optedForCommunication": true + } + ], + "links": [ + { + "href": "string", + "rel": "string", + "templated": false, + "method": "GET", + "targetSchema": "string", + "operationId": "string", + "title": "string" } ] } @@ -8028,54 +7455,42 @@ "description": "RoomInterfaceStatus not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "You can use this API to change room interface status.OperationId:putRoomInterfaceStatus
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8084,31 +7499,36 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + }, + "put": { "summary": "Change room interface status", + "description": "You can use this API to change room interface status.OperationId:putRoomInterfaceStatus
", "operationId": "putRoomInterfaceStatus", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "interfaceId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to change the interface status for a reservation.", "name": "reservationInterface", "in": "body", "required": true, + "description": "Request to change the interface status for a reservation.", "schema": { "allOf": [ { @@ -8118,111 +7538,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/keyInterfaces": { - "get": { - "description": "You can use thie API to get key encoder interface configuration details.OperationId:getRoomKeyInterfaceDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8231,133 +7617,115 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/keyInterfaces": { + "get": { "summary": "Get key encoder interface configuration details", + "description": "You can use thie API to get key encoder interface configuration details.OperationId:getRoomKeyInterfaceDetails
", "operationId": "getRoomKeyInterfaceDetails", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { + "name": "roomNumbersCode", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "roomNumbersCode", - "in": "query" + "required": false }, { + "name": "interfaceId", + "in": "query", + "required": false, "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "minLength": 1, + "maxLength": 2000, + "description": "Unique DB internal number of a Hotel Interface record." }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response with the configuration details of active room key interfaces including the available key encoders.", - "schema": { - "$ref": "#/definitions/roomKeyInterfaceDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response with the configuration details of active room key interfaces including the available key encoders.", + "schema": { + "$ref": "#/definitions/roomKeyInterfaceDetails" } }, "204": { "description": "RoomKeyInterfaceDetails not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/queueReservationsStatistics": { - "get": { - "description": "Use this API to return reservation queue statistics for a specific property.OperationId:getReservationQueueStatistics
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8365,124 +7733,96 @@ "application/json;charset=UTF-8" ], "tags": [ - "FOFStats" - ], + "FrontDeskOperations" + ] + } + }, + "/hotels/{hotelId}/queueReservationsStatistics": { + "get": { "summary": "Get hotel reservation queue statistics", + "description": "Use this API to return reservation queue statistics for a specific property.OperationId:getReservationQueueStatistics
", "operationId": "getReservationQueueStatistics", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response for the fetch of current Reservations In Queue statistics. Contains the statistic information.", - "schema": { - "$ref": "#/definitions/reservationQueueStatistics" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response for the fetch of current Reservations In Queue statistics. Contains the statistic information.", + "schema": { + "$ref": "#/definitions/reservationQueueStatistics" } }, "204": { "description": "ReservationQueueStatistics not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/queuedReservations": { - "get": { - "description": "Fetch all current reservations that are Queued Reservations. These reservations are guests that have arrived at the hotel, but their room isn't ready, so they're sitting in a queue.OperationId:getReservationsInQueue
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -8490,129 +7830,276 @@ "application/json;charset=UTF-8" ], "tags": [ - "FrontDeskOperations" - ], + "FOFStats" + ] + } + }, + "/hotels/{hotelId}/queuedReservations": { + "get": { "summary": "Get the reservation in queue", + "description": "Fetch all current reservations that are Queued Reservations. These reservations are guests that have arrived at the hotel, but their room isn't ready, so they're sitting in a queue.OperationId:getReservationsInQueue
", "operationId": "getReservationsInQueue", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { + "name": "roomClassCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "roomClassCodes", - "in": "query" + "required": false }, { + "name": "roomTypeCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "roomTypeCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Wildcard search of reservations in queue by Room Number.", "name": "roomNumberWildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search of reservations in queue by Room Number.", + "type": "string" }, { - "type": "string", - "description": "Wildcard search of reservations in queue by Guest Name.", "name": "guestNameWildCard", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard search of reservations in queue by Guest Name.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response for the operation to fetch Reservations in Queue", - "schema": { - "$ref": "#/definitions/reservationsInQueue" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } }, + "description": "Response for the operation to fetch Reservations in Queue", + "schema": { + "$ref": "#/definitions/reservationsInQueue" + }, "examples": { "application/json": { - "links": [ - { - "href": "string", - "method": "GET", - "operationId": "string", - "rel": "string", - "targetSchema": "string", - "templated": false, - "title": "string" - } - ], "reservations": { - "count": 0, - "hasMore": true, "reservationInfo": [ { - "accessRestriction": "Change", - "advanceCheckIn": { - "advanceCheckedIn": true, - "eTRComments": "string", - "expectedReturnTime": "2020-07-14T10:05:39.353Z" + "reservationIdList": [ + { + "id": "string", + "type": "string" + } + ], + "roomStay": { + "arrivalDate": "2020-07-14", + "departureDate": "2020-07-14", + "originalTimeSpan": { + "startDate": "2020-07-14", + "endDate": "2020-07-14", + "duration": "string" + }, + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-07-14T10:05:39.352Z", + "reservationExpectedDepartureTime": "2020-07-14T10:05:39.352Z" + }, + "adultCount": 0, + "childCount": 0, + "roomClass": "string", + "roomType": "string", + "numberOfRooms": 0, + "roomNumber": "string", + "ratePlanCode": "string", + "rateAmount": { + "amount": 0, + "currencyCode": "string" + }, + "points": { + "awardsType": "string", + "points": 0 + }, + "rateSuppressed": true, + "reservationBlock": { + "blockIdList": [ + { + "id": "string", + "type": "string" + } + ], + "blockName": "string", + "hotelId": "string" + }, + "bookingChannelCode": "string", + "partyCode": "string", + "fixedRate": true, + "totalAmount": { + "amount": 0, + "currencyCode": "string" + }, + "guarantee": { + "guaranteeCode": "string", + "shortDescription": "string", + "onHold": true + }, + "promotion": { + "promotionCode": "string", + "promotionName": "string", + "couponCode": "string" + }, + "marketCode": "string", + "sourceOfBusiness": "string", + "sourceOfBusinessDescription": "string", + "balance": { + "amount": 0, + "currencyCode": "string" + }, + "compBalance": { + "amount": 0, + "currencyCode": "string" + }, + "roomTypeCharged": "string", + "depositPayments": { + "amount": 0, + "currencyCode": "string" + }, + "guestServiceStatus": "DoNotDisturb", + "scheduledCheckoutTime": "2020-07-14", + "roomNumberLocked": true, + "pseudoRoom": true }, - "allowMobileCheckout": true, - "allowMobileViewFolio": true, - "allowedActions": [ - "Cancel" + "reservationGuest": { + "membership": { + "membershipId": 0, + "programCode": "string", + "bonusCode": "string", + "membershipTypeDesc": "string", + "membershipLevelDesc": "string", + "accountId": "string", + "membershipLevel": "string", + "playerRanking": 0 + }, + "namePrefix": "string", + "givenName": "string", + "alternateGivenName": "string", + "middleName": "string", + "surnamePrefix": "string", + "surname": "string", + "alternateSurname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "fullName": "string", + "alternateFullName": "string", + "phoneNumber": "string", + "email": "string", + "birthDate": "2020-07-14", + "language": "string", + "nationality": { + "value": "string", + "code": "string" + }, + "vip": { + "vipCode": "string", + "vipDescription": "string" + }, + "address": { + "cityName": "string", + "postalCode": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "streetAddress": "string", + "excludeNoCity": true + }, + "anonymization": { + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-07-14T10:05:39.352Z" + }, + "accompanyGuests": [ + { + "firstName": "string", + "lastName": "string", + "fullName": "string", + "registrationCardNo": "string", + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ] + } + ], + "externalInfo": { + "givenName": "string", + "surname": "string" + }, + "guestLastStayInfo": { + "lastStayDate": "2020-07-14", + "lastStayRoom": "string", + "lastStayRate": { + "amount": 0, + "currencyCode": "string" + }, + "totalStay": 0 + }, + "guestRestrictedCode": "string", + "guestRestrictedReasonDesc": "string", + "guestRestricted": true, + "registrationCardNo": "string", + "nameType": "Guest", + "id": "string", + "type": "string" + }, + "sharedGuests": [ + { + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 + }, + "firstName": "string", + "lastName": "string", + "fullName": "string" + } ], "attachedProfiles": [ { @@ -8626,1125 +8113,968 @@ "reservationProfileType": "Company" } ], - "cancellationInfo": { - "code": "string", - "date": "2020-07-14", - "description": "string" - }, - "cashiering": { - "bedTaxReporting": { - "taxRegistrationNo": 0, - "taxableDays": 0, - "visaExpiryDate": "2020-07-14", - "visaIssueDate": "2020-07-14", - "visaNumber": "string" - }, - "billingPrivileges": { - "allowAutoCheckin": true, - "autoSettlement": true, - "autoSettlementFreq": 0, - "autoSettlementType": "string", - "creditLimitAutoPay": true, - "directBillAuthorized": true, - "folioCloseDate": "2020-07-14", - "postStayCharging": true, - "postingRestriction": true, - "preStayCharging": true, - "scheduledCheckout": true, - "scheduledCheckoutTime": "2020-07-14", - "videoCheckout": true + "reservationPaymentMethod": { + "paymentCard": { + "cardId": { + "id": "string", + "type": "string" + }, + "currentAuthorizedAmount": { + "amount": 0, + "currencyCode": "string" + }, + "approvalAmountNeeded": { + "amount": 0, + "currencyCode": "string" + }, + "cardType": "Ab", + "userDefinedCardType": "string", + "cardNumber": "string", + "cardNumberMasked": "string", + "cardNumberLast4Digits": "string", + "expirationDate": "2020-07-14", + "expirationDateMasked": "string", + "expirationDateExpired": true, + "cardHolderName": "string", + "attachCreditCardToProfile": true, + "processing": "Eft", + "swiped": true, + "cardOrToken": "CardNumber" }, - "compAccounting": { - "authorizer": "string", - "compType": "string" + "balance": { + "amount": 0, + "currencyCode": "string" }, - "financiallyResponsible": true, - "folioTexts": { - "folioText": [ - { - "row": 0, - "text": "string" - } - ] + "authorizationRule": { + "code": 0, + "amount": { + "amount": 0, + "currencyCode": "string" + }, + "percent": 0 }, - "lastRoomAndTaxPostedDate": "2020-07-14", - "periodicFolio": { - "frequency": 0, - "lastFolioDate": "2020-07-14", - "lastSettlementDate": "2020-07-14" + "emailFolioInfo": { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-07-14T10:05:39.352Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T10:05:39.352Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" + }, + "emailFolio": true, + "id": "string", + "type": "string" }, - "proratedBilling": true, - "reservationPreConfiguredRoutingInstruction": { - "authorizerInfo": { - "authorizerId": { + "paymentMethod": "string", + "description": "string", + "folioView": 0 + }, + "reservationFolioWindows": [ + { + "payeeInfo": { + "payeeId": { "id": "string", "type": "string" }, - "authorizerName": "string", - "authorizerRateCode": "string", - "authorizerUserName": "string", - "inheritAuthorizerRateCode": true + "payeeName": "string", + "payeeAddress": { + "address": { + "addressLine": [ + "string" + ], + "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" + }, + "language": "string", + "type": "string", + "typeDescription": "string", + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-07-14T10:05:39.352Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T10:05:39.352Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" + }, + "id": "string", + "type": "string" + }, + "payeeAddressCount": 0, + "payeeReferenceCurrency": "string", + "payeeAccountInfo": { + "accountName": "string", + "accountId": { + "id": "string", + "type": "string" + }, + "accountNo": "string", + "status": { + "restriction": "string", + "description": "string", + "restricted": true + } + }, + "payeeTaxNumber": "string" }, - "profileType": "Company", - "promotionCode": "string", - "ratePlanCode": "string" - }, - "revenuesAndBalances": { "balance": { "amount": 0, "currencyCode": "string" }, - "foodAndBevRevenue": { + "paymentMethod": "string", + "folioWindowNo": 0 + } + ], + "specials": "string", + "lastPrivacyPromptDate": "2020-07-14", + "displayColor": "string", + "reservationIndicators": [ + { + "indicatorName": "string", + "count": 0 + } + ], + "roomStatus": "Clean", + "searchMatches": [ + { + "attribute": "string", + "value": "string" + } + ], + "sourceOfSale": { + "sourceType": "string", + "sourceCode": "string" + }, + "waitlist": { + "reasonDescription": "string", + "priorityDescription": "string", + "description": "string", + "reasonCode": "string", + "priorityCode": "string", + "telephone": "string" + }, + "queue": { + "timeSpan": { + "startDate": "2020-07-14", + "endDate": "2020-07-14", + "duration": "string", + "durationInSeconds": 0 + }, + "guestTextInfo": { + "sentTime": "2020-07-14T10:05:39.352Z", + "sentBy": "string" + }, + "priority": 0, + "averageQueueTimeToCheckIn": 0, + "averageQueueTimeCurrentReservations": 0, + "queueDate": "2020-07-14" + }, + "housekeeping": { + "instructions": "string", + "facilityTaskInfo": { + "task": { + "description": "string", + "instructions": "string", + "facilityDepartureTask": true, + "linenChange": true, + "hotelId": "string", + "code": "string", + "sequence": 0 + }, + "supplies": [ + { + "description": "string", + "quantity": 0, + "code": "string" + } + ], + "date": "2020-07-14" + }, + "linenChange": true, + "turndownRequested": true, + "serviceTime": "2020-07-14", + "expectedServiceTime": "string", + "roomStatus": "Clean" + }, + "cashiering": { + "revenuesAndBalances": { + "totalFixedCharge": { "amount": 0, "currencyCode": "string" }, - "nonRevenue": { + "totalPayment": { "amount": 0, "currencyCode": "string" }, - "otherRevenue": { + "roomRevenue": { "amount": 0, "currencyCode": "string" }, - "roomRevenue": { + "foodAndBevRevenue": { "amount": 0, "currencyCode": "string" }, - "totalFixedCharge": { + "otherRevenue": { "amount": 0, "currencyCode": "string" }, - "totalPayment": { + "nonRevenue": { "amount": 0, "currencyCode": "string" }, "totalRevenue": { "amount": 0, "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" } }, - "reverseAdvanceCheckInAllowed": true, - "reverseCheckInAllowed": true, + "billingPrivileges": { + "postingRestriction": true, + "preStayCharging": true, + "postStayCharging": true, + "folioCloseDate": "2020-07-14", + "scheduledCheckout": true, + "scheduledCheckoutTime": "2020-07-14", + "directBillAuthorized": true, + "videoCheckout": true, + "allowAutoCheckin": true, + "autoSettlement": true, + "autoSettlementType": "string", + "autoSettlementFreq": 0, + "creditLimitAutoPay": true + }, "taxType": { + "hotelId": "string", "code": "string", - "collectingAgentTax": true, "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, + "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, + "minimumLengthOfStay": 0, "taxExemptNo": "string" }, - "transactionsPosted": true - }, - "commissionPayoutTo": "TravelAgent", - "computedReservationStatus": "Reserved", - "createDateTime": "2020-07-14T10:05:39.353Z", - "creatorId": "string", - "deposit": { - "amountOwed": 0, - "amountPaid": 0, - "amountRequired": 0, - "dueDate": "2020-07-14", - "hasOutstanding": true, - "hasPaid": true, - "postingDate": "2020-07-14" - }, - "displayColor": "string", - "expectedServiceTime": "string", - "guestPreferredCurrency": "string", - "hotelId": "string", - "hotelInterfaceStatusList": [ - { - "hotelInterface": { - "activeFlag": true, - "hotelId": "string", - "interfaceId": { + "bedTaxReporting": { + "taxRegistrationNo": 0, + "visaNumber": "string", + "visaIssueDate": "2020-07-14", + "visaExpiryDate": "2020-07-14", + "taxableDays": 0 + }, + "folioTexts": { + "folioText": [ + { + "text": "string", + "row": 0 + } + ] + }, + "periodicFolio": { + "lastSettlementDate": "2020-07-14", + "lastFolioDate": "2020-07-14", + "frequency": 0 + }, + "compAccounting": { + "compType": "string", + "authorizer": "string" + }, + "reservationPreConfiguredRoutingInstruction": { + "authorizerInfo": { + "authorizerId": { "id": "string", "type": "string" }, - "interfaceName": "string", - "interfaceType": "Bms", - "logo": "string", - "machineName": "string", - "status": "Stopped" - }, + "authorizerUserName": "string", + "authorizerName": "string", + "authorizerRateCode": "string", + "inheritAuthorizerRateCode": true + }, + "ratePlanCode": "string", + "profileType": "Company", + "promotionCode": "string" + }, + "financiallyResponsible": true, + "proratedBilling": true, + "lastRoomAndTaxPostedDate": "2020-07-14", + "reverseCheckInAllowed": true, + "reverseAdvanceCheckInAllowed": true, + "transactionsPosted": true + }, + "taxType": { + "hotelId": "string", + "code": "string", + "description": "string", + "collectingAgentTax": true, + "printAutoAdjust": true, + "reportExemptDays": 0, + "reportTaxPercentage": 0, + "minimumLengthOfStay": 0 + }, + "deposit": { + "amountRequired": 0, + "amountPaid": 0, + "amountOwed": 0, + "dueDate": "2020-07-14", + "postingDate": "2020-07-14", + "hasPaid": true, + "hasOutstanding": true + }, + "allowedActions": [ + "Cancel" + ], + "revenuesAndBalances": { + "totalFixedCharge": { + "amount": 0, + "currencyCode": "string" + }, + "totalPayment": { + "amount": 0, + "currencyCode": "string" + }, + "roomRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "foodAndBevRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "otherRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "nonRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "totalRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" + } + }, + "hotelInterfaceStatusList": [ + { + "roomExtension": "string", + "hotelInterface": { + "interfaceId": { + "id": "string", + "type": "string" + }, + "hotelId": "string", + "interfaceName": "string", + "interfaceType": "Bms", + "logo": "string", + "machineName": "string", + "status": "Stopped", + "activeFlag": true + }, "interfaceRights": [ { - "category": "string", - "description": "string", "right": 0, - "statusCode": "string" + "statusCode": "string", + "description": "string", + "category": "string" } - ], - "roomExtension": "string" + ] } ], - "hotelName": "string", - "housekeeping": { - "expectedServiceTime": "string", - "facilityTaskInfo": { - "date": "2020-07-14", - "supplies": [ - { - "code": "string", - "description": "string", - "quantity": 0 - } - ], - "task": { - "code": "string", - "description": "string", - "facilityDepartureTask": true, - "hotelId": "string", - "instructions": "string", - "linenChange": true, - "sequence": 0 - } - }, - "instructions": "string", - "linenChange": true, - "roomStatus": "Clean", - "serviceTime": "2020-07-14", - "turndownRequested": true + "guestPreferredCurrency": "string", + "turndownInfo": { + "allowed": true, + "status": "Required" }, - "keyCount": 0, - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T10:05:39.353Z", - "lastPrivacyPromptDate": "2020-07-14", "mobileNotifications": { - "checkoutMessageReceived": true, - "errorMessage": "string", + "roomReady": "Pending", "keyReady": "Pending", + "checkoutMessageReceived": true, "requiresAction": true, - "roomReady": "Pending" - }, - "openFolio": true, - "optedForCommunication": true, - "paymentMethod": "string", - "preRegistered": true, - "purgeDate": "2020-07-14", - "queue": { - "averageQueueTimeCurrentReservations": 0, - "averageQueueTimeToCheckIn": 0, - "guestTextInfo": { - "sentBy": "string", - "sentTime": "2020-07-14T10:05:39.352Z" - }, - "priority": 0, - "queueDate": "2020-07-14", - "timeSpan": { - "duration": "string", - "durationInSeconds": 0, - "endDate": "2020-07-14", - "startDate": "2020-07-14" - } + "errorMessage": "string" }, "reservationCommunication": { - "emails": { - "count": 0, - "emailInfo": [ + "telephones": { + "telephoneInfo": [ { - "email": { + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, "createDateTime": "2020-07-14T10:05:39.353Z", "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", "lastModifyDateTime": "2020-07-14T10:05:39.353Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-07-14", - "type": "string", - "typeDescription": "string" + "lastModifierId": "string", + "purgeDate": "2020-07-14" }, "id": "string", "type": "string" } ], "hasMore": true, - "totalResults": 0 + "totalResults": 0, + "count": 0 }, - "telephones": { - "count": 0, - "hasMore": true, - "telephoneInfo": [ + "emails": { + "emailInfo": [ { - "id": "string", - "telephone": { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, "createDateTime": "2020-07-14T10:05:39.353Z", "creatorId": "string", - "extension": "string", - "lastModifierId": "string", "lastModifyDateTime": "2020-07-14T10:05:39.353Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, + "lastModifierId": "string", "purgeDate": "2020-07-14" }, + "id": "string", "type": "string" } ], - "totalResults": 0 + "hasMore": true, + "totalResults": 0, + "count": 0 } }, - "reservationFolioWindows": [ - { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "folioWindowNo": 0, - "payeeInfo": { - "payeeAccountInfo": { - "accountId": { - "id": "string", - "type": "string" - }, - "accountName": "string", - "accountNo": "string", - "status": { - "description": "string", - "restricted": true, - "restriction": "string" - } - }, - "payeeAddress": { - "address": { - "addressLine": [ - "string" - ], - "barCode": "string", - "cityExtension": "string", - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "county": "string", - "createDateTime": "2020-07-14T10:05:39.352Z", - "creatorId": "string", - "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T10:05:39.352Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-07-14", - "state": "string", - "type": "string", - "typeDescription": "string", - "updateReservations": true - }, - "id": "string", - "type": "string" - }, - "payeeAddressCount": 0, - "payeeId": { - "id": "string", - "type": "string" - }, - "payeeName": "string", - "payeeReferenceCurrency": "string", - "payeeTaxNumber": "string" - }, - "paymentMethod": "string" - } - ], - "reservationGuest": { - "accompanyGuests": [ + "advanceCheckIn": { + "advanceCheckedIn": true, + "expectedReturnTime": "2020-07-14T10:05:39.353Z", + "eTRComments": "string" + }, + "welcomeOffer": true, + "cancellationInfo": { + "description": "string", + "code": "string", + "date": "2020-07-14" + }, + "keyCount": 0, + "hotelId": "string", + "hotelName": "string", + "expectedServiceTime": "string", + "roomStayReservation": true, + "createDateTime": "2020-07-14T10:05:39.353Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T10:05:39.353Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14", + "reservationStatus": "Reserved", + "computedReservationStatus": "Reserved", + "walkInIndicator": true, + "accessRestriction": "Change", + "commissionPayoutTo": "TravelAgent", + "paymentMethod": "string", + "preRegistered": true, + "openFolio": true, + "allowMobileCheckout": true, + "allowMobileViewFolio": true, + "optedForCommunication": true + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "roomStatusInfo": { + "room": [ + { + "roomType": { + "pseudo": true, + "suite": true, + "roomClass": "string", + "shortDescription": "string", + "houseKeeping": true, + "smokingPreference": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "minimumOccupancy": 0, + "maximumOccupancy": 0, + "roomFeatures": [ { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileIdList": [ - { - "id": "string", - "type": "string" - } - ], - "registrationCardNo": "string" + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 } ], - "address": { - "cityName": "string", - "country": { - "code": "string", - "value": "string" - }, - "excludeNoCity": true, - "postalCode": "string", - "state": "string", - "streetAddress": "string" - }, - "alternateFullName": "string", - "alternateGivenName": "string", - "alternateSurname": "string", - "anonymization": { - "anonymizationDate": "2020-07-14T10:05:39.352Z", - "anonymizationStatus": "Requested" - }, - "birthDate": "2020-07-14", - "email": "string", - "externalInfo": { - "givenName": "string", - "surname": "string" - }, - "fullName": "string", - "givenName": "string", - "guestLastStayInfo": { - "lastStayDate": "2020-07-14", - "lastStayRate": { - "amount": 0, - "currencyCode": "string" - }, - "lastStayRoom": "string", - "totalStay": 0 - }, - "guestRestricted": true, - "guestRestrictedCode": "string", - "guestRestrictedReasonDesc": "string", - "id": "string", - "language": "string", - "membership": { - "accountId": "string", - "bonusCode": "string", - "membershipId": 0, - "membershipLevel": "string", - "membershipLevelDesc": "string", - "membershipTypeDesc": "string", - "playerRanking": 0, - "programCode": "string" - }, - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameType": "Guest", - "nationality": { - "code": "string", - "value": "string" - }, - "phoneNumber": "string", - "registrationCardNo": "string", - "surname": "string", - "surnamePrefix": "string", - "type": "string", - "vip": { - "vipCode": "string", - "vipDescription": "string" - } + "accessible": true, + "roomType": "string", + "meetingRoom": true }, - "reservationIdList": [ + "floor": "string", + "floorDescription": "string", + "roomFeatures": [ { - "id": "string", - "type": "string" + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 } ], - "reservationIndicators": [ - { - "count": 0, - "indicatorName": "string" + "roomDescription": "string", + "description": { + "defaultText": "string", + "translatedTexts": { + "text": [ + { + "value": "string", + "language": "string" + } + ] } - ], - "reservationPaymentMethod": { - "authorizationRule": { - "amount": { - "amount": 0, - "currencyCode": "string" - }, - "code": 0, - "percent": 0 + }, + "smokingPreference": "string", + "smokingPreferenceDescription": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "accessible": true, + "roomId": "string", + "meetingRoom": true, + "roomSection": { + "daySectionCode": "string", + "eveningSectionCode": "string" + }, + "housekeeping": { + "roomStatus": { + "reservationStatusList": [ + "Arrival" + ], + "roomStatus": "Clean", + "frontOfficeStatus": "Vacant", + "housekeepingStatus": "Vacant" }, - "balance": { - "amount": 0, - "currencyCode": "string" + "roomPersons": { + "frontOfficePersons": 0, + "houseKeepingPersons": 0 }, - "description": "string", - "emailFolioInfo": { - "email": { - "createDateTime": "2020-07-14T10:05:39.352Z", - "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T10:05:39.352Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-07-14", - "type": "string", - "typeDescription": "string" - }, - "emailFolio": true, - "id": "string", - "type": "string" + "guestServiceRequest": "DoNotDisturb", + "cleaningPriority": { + "prioritySequence": 0 }, - "folioView": 0, - "paymentCard": { - "approvalAmountNeeded": { - "amount": 0, - "currencyCode": "string" - }, - "attachCreditCardToProfile": true, - "cardHolderName": "string", - "cardId": { - "id": "string", - "type": "string" - }, - "cardNumber": "string", - "cardNumberLast4Digits": "string", - "cardNumberMasked": "string", - "cardOrToken": "CardNumber", - "cardType": "Ab", - "currentAuthorizedAmount": { - "amount": 0, - "currencyCode": "string" + "roomCondition": { + "roomCondition": { + "code": "string", + "description": "string" }, - "expirationDate": "2020-07-14", - "expirationDateExpired": true, - "expirationDateMasked": "string", - "processing": "Eft", - "swiped": true, - "userDefinedCardType": "string" + "assignmentType": "Available", + "remarks": "string" }, - "paymentMethod": "string" + "linenChange": true, + "facilityTaskCode": [ + "string" + ] }, - "reservationStatus": "Reserved", - "revenuesAndBalances": { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "foodAndBevRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "nonRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "otherRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "roomRevenue": { - "amount": 0, - "currencyCode": "string" - }, - "totalFixedCharge": { - "amount": 0, - "currencyCode": "string" - }, - "totalPayment": { - "amount": 0, - "currencyCode": "string" - }, - "totalRevenue": { - "amount": 0, - "currencyCode": "string" + "outOfOrder": [ + { + "repairRemarks": "string", + "returnStatus": "Clean", + "reasonCode": "string", + "reasonDesc": "string", + "newDateRange": { + "start": "2020-07-14", + "end": "2020-07-14" + }, + "roomStatus": "Clean", + "start": "2020-07-14", + "end": "2020-07-14" } + ], + "discrepancy": [ + "Sleep" + ], + "sitePlanSection": { + "sectionCode": "string", + "sectionType": "string", + "linkCode": "string", + "coordinates": "string", + "description": "string" }, - "roomStatus": "Clean", - "roomStay": { - "adultCount": 0, - "arrivalDate": "2020-07-14", - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "bookingChannelCode": "string", - "childCount": 0, - "compBalance": { - "amount": 0, - "currencyCode": "string" - }, - "departureDate": "2020-07-14", - "depositPayments": { - "amount": 0, - "currencyCode": "string" - }, - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-07-14T10:05:39.352Z", - "reservationExpectedDepartureTime": "2020-07-14T10:05:39.352Z" - }, - "fixedRate": true, - "guarantee": { - "guaranteeCode": "string", - "onHold": true, - "shortDescription": "string" - }, - "guestServiceStatus": "DoNotDisturb", - "marketCode": "string", - "numberOfRooms": 0, - "originalTimeSpan": { - "duration": "string", - "endDate": "2020-07-14", - "startDate": "2020-07-14" - }, - "partyCode": "string", - "points": { - "awardsType": "string", - "points": 0 - }, - "promotion": { - "couponCode": "string", - "promotionCode": "string", - "promotionName": "string" - }, - "pseudoRoom": true, - "rateAmount": { - "amount": 0, - "currencyCode": "string" - }, - "ratePlanCode": "string", - "rateSuppressed": true, - "reservationBlock": { - "blockIdList": [ + "componentRoomNumber": "string", + "connectingRooms": [ + { + "roomType": { + "pseudo": true, + "suite": true, + "roomClass": "string", + "shortDescription": "string", + "houseKeeping": true, + "smokingPreference": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "minimumOccupancy": 0, + "maximumOccupancy": 0, + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "accessible": true, + "roomType": "string", + "meetingRoom": true + }, + "floor": "string", + "floorDescription": "string", + "roomFeatures": [ { - "id": "string", - "type": "string" + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 } ], - "blockName": "string", - "hotelId": "string" - }, - "roomClass": "string", - "roomNumber": "string", - "roomNumberLocked": true, - "roomType": "string", - "roomTypeCharged": "string", - "scheduledCheckoutTime": "2020-07-14", - "sourceOfBusiness": "string", - "sourceOfBusinessDescription": "string", - "totalAmount": { - "amount": 0, - "currencyCode": "string" - } - }, - "roomStayReservation": true, - "searchMatches": [ - { - "attribute": "string", - "value": "string" + "roomDescription": "string", + "description": { + "defaultText": "string", + "translatedTexts": { + "text": [ + { + "value": "string", + "language": "string" + } + ] + } + }, + "smokingPreference": "string", + "smokingPreferenceDescription": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "accessible": true, + "roomId": "string", + "meetingRoom": true, + "roomCondition": { + "code": "string", + "description": "string" + } } ], - "sharedGuests": [ + "componentRooms": [ { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" + "roomType": { + "pseudo": true, + "suite": true, + "roomClass": "string", + "shortDescription": "string", + "houseKeeping": true, + "smokingPreference": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "minimumOccupancy": 0, + "maximumOccupancy": 0, + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "accessible": true, + "roomType": "string", + "meetingRoom": true + }, + "floor": "string", + "floorDescription": "string", + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "roomDescription": "string", + "description": { + "defaultText": "string", + "translatedTexts": { + "text": [ + { + "value": "string", + "language": "string" + } + ] + } + }, + "smokingPreference": "string", + "smokingPreferenceDescription": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "accessible": true, + "roomId": "string", + "meetingRoom": true, + "roomCondition": { + "code": "string", + "description": "string" } } ], - "sourceOfSale": { - "sourceCode": "string", - "sourceType": "string" - }, - "specials": "string", - "taxType": { - "code": "string", - "collectingAgentTax": true, - "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, - "printAutoAdjust": true, - "reportExemptDays": 0, - "reportTaxPercentage": 0 - }, - "turndownInfo": { - "allowed": true, - "status": "Required" - }, - "waitlist": { - "description": "string", - "priorityCode": "string", - "priorityDescription": "string", - "reasonCode": "string", - "reasonDescription": "string", - "telephone": "string" - }, - "walkInIndicator": true, - "welcomeOffer": true - } - ], - "totalResults": 0 - }, - "roomStatusInfo": { - "hotelId": "string", - "room": [ - { - "accessible": true, "attendant": [ { + "section": { + "hotelId": "string", + "code": "string", + "description": "string", + "sectionGroup": "string", + "targetCredits": 0, + "rooms": 0, + "roomCredits": 0, + "sequence": 0, + "inactive": true + }, + "floor": "string", + "attendantId": "string", + "attendantName": "string", + "hotelId": "string", "activeFlag": "string", + "sunday": true, + "monday": true, + "tuesday": true, + "wednesday": true, + "thursday": true, + "friday": true, + "saturday": true, "appUser": { + "hotel": { + "code": "string", + "description": "string" + }, + "appUser": "string", + "lDAPUser": "string", "actAs": "string", "actAt": "string", - "appUser": "string", + "userDefaultLanguage": "string", "appUserId": { "id": "string", "type": "string" }, - "attendantInfo": { - "attendantId": "string", - "hotelId": "string" - }, "cashierId": 0, "cashierTitle": "string", "department": "string", "departmentLocation": "string", - "disabledUntil": "2020-07-14", + "salesRepCode": "string", "expiryDate": "2020-07-14", - "hotel": { - "code": "string", - "description": "string" - }, - "lDAPUser": "string", + "disabledUntil": "2020-07-14", "passwordChangeDate": "2020-07-14", - "salesRepCode": "string", - "userDefaultLanguage": "string", "userInfo": { + "personName": { + "namePrefix": "string", + "givenName": "string", + "middleName": "string", + "surname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "nameTitleSuffix": 0, + "envelopeGreeting": "string", + "salutation": "string", + "nameType": "Primary", + "language": "string", + "externalSystem": "string" + }, + "profileId": { + "id": "string", + "type": "string" + }, "addressInfo": { "address": { "addressLine": [ "string" ], - "barCode": "string", - "cityExtension": "string", "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", "country": { - "code": "string", - "value": "string" + "value": "string", + "code": "string" }, - "county": "string", - "createDateTime": "2020-07-14T10:05:39.354Z", - "creatorId": "string", "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T10:05:39.354Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-07-14", - "state": "string", "type": "string", "typeDescription": "string", - "updateReservations": true + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-07-14T10:05:39.354Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T10:05:39.354Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" }, "id": "string", "type": "string" }, - "birthDate": "2020-07-14", - "birthDateMasked": "string", - "department": { - "code": "string", - "description": "string" - }, "emailInfo": { "email": { - "createDateTime": "2020-07-14T10:05:39.354Z", - "creatorId": "string", "emailAddress": "string", + "type": "string", + "typeDescription": "string", "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T10:05:39.354Z", - "orderSequence": 0, "primaryInd": true, - "purgeDate": "2020-07-14", - "type": "string", - "typeDescription": "string" + "orderSequence": 0, + "createDateTime": "2020-07-14T10:05:39.354Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T10:05:39.354Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" }, "id": "string", "type": "string" }, - "gender": "Male", - "personName": { - "envelopeGreeting": "string", - "externalSystem": "string", - "givenName": "string", - "language": "string", - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameTitleSuffix": 0, - "nameType": "Primary", - "salutation": "string", - "surname": "string" - }, "phoneInfo": { - "id": "string", "telephone": { - "createDateTime": "2020-07-14T10:05:39.354Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T10:05:39.354Z", - "orderSequence": 0, - "phoneNumber": "string", "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-07-14T10:05:39.354Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T10:05:39.354Z", + "lastModifierId": "string", "purgeDate": "2020-07-14" }, - "type": "string" - }, - "profileId": { "id": "string", "type": "string" - } + }, + "department": { + "code": "string", + "description": "string" + }, + "gender": "Male", + "birthDate": "2020-07-14", + "birthDateMasked": "string" }, "userSessionInfo": { "businessDate": "2020-07-14", - "cROCountryCode": "string", - "chain": "string", - "cro": { + "systemDate": "2020-07-14", + "terminal": "string", + "runningApp": "string", + "shareProfiles": true, + "hotel": { "code": "string", "description": "string" }, - "hotel": { + "cro": { "code": "string", "description": "string" }, - "parameters": [ - { - "parameterName": "string", - "parameterValue": "string" - } - ], - "runningApp": "string", + "chain": "string", + "cROCountryCode": "string", "sessionDefaults": { - "baseLanguage": "string", - "currencyCode": "string", - "currencyFormat": "string", "dbDateFormat": "string", - "defaultLanguage": "string", + "oracleDateFormat": "string", + "oracleTimeFormat": "string", "javaDateFormat": "string", "javaTimeFormat": "string", - "oracleDateFormat": "string", - "oracleTimeFormat": "string" + "currencyCode": "string", + "currencyFormat": "string", + "defaultLanguage": "string", + "baseLanguage": "string" }, - "shareProfiles": true, - "systemDate": "2020-07-14", - "terminal": "string" + "parameters": [ + { + "parameterName": "string", + "parameterValue": "string" + } + ] + }, + "attendantInfo": { + "attendantId": "string", + "hotelId": "string" } }, - "attendantId": "string", - "attendantName": "string", - "floor": "string", - "friday": true, - "hotelId": "string", - "monday": true, - "saturday": true, - "section": { - "code": "string", - "description": "string", - "hotelId": "string", - "inactive": true, - "roomCredits": 0, - "rooms": 0, - "sectionGroup": "string", - "sequence": 0, - "targetCredits": 0 - }, "startTime": "2020-07-14T10:05:39.354Z", - "status": "Standby", - "sunday": true, - "thursday": true, - "tuesday": true, - "wednesday": true + "status": "Standby" } ], - "building": "string", - "componentRoomNumber": "string", - "componentRoomNumbers": { - "roomId": [ - "string" - ] + "hold": { + "holdUntil": "2020-07-14T10:05:39.354Z", + "holdUser": "string", + "comments": "string" }, - "componentRooms": [ + "turndownInfo": { + "turndownStatusInfo": "Required" + }, + "resvInfo": [ { - "accessible": true, - "building": "string", - "description": { - "defaultText": "string", - "translatedTexts": { - "text": [ - { - "language": "string", - "value": "string" - } - ] - } - }, - "floor": "string", - "floorDescription": "string", - "meetingRoom": true, - "roomAssignmentRating": "MostImportant", - "roomCondition": { - "code": "string", - "description": "string" + "guestName": "string", + "reservationId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 }, - "roomDescription": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 + "reservationStatusInfo": "Arrival", + "stayDateInfo": { + "timeSpan": { + "startDate": "2020-07-14", + "endDate": "2020-07-14", + "duration": "string" + }, + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-07-14T10:05:39.354Z", + "reservationExpectedDepartureTime": "2020-07-14T10:05:39.354Z" } - ], - "roomId": "string", - "roomType": { - "accessible": true, - "building": "string", - "houseKeeping": true, - "maximumOccupancy": 0, - "meetingRoom": true, - "minimumOccupancy": 0, - "pseudo": true, - "roomAssignmentRating": "MostImportant", - "roomClass": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomType": "string", - "shortDescription": "string", - "smokingPreference": "string", - "suite": true }, - "smokingPreference": "string", - "smokingPreferenceDescription": "string" + "vipStatus": { + "value": "string", + "code": "string" + }, + "profileId": { + "id": "string", + "type": "string" + } } ], - "connectingRooms": [ - { - "accessible": true, - "building": "string", - "description": { - "defaultText": "string", - "translatedTexts": { - "text": [ - { - "language": "string", - "value": "string" - } - ] - } - }, - "floor": "string", - "floorDescription": "string", - "meetingRoom": true, - "roomAssignmentRating": "MostImportant", - "roomCondition": { - "code": "string", - "description": "string" - }, - "roomDescription": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomId": "string", - "roomType": { - "accessible": true, - "building": "string", - "houseKeeping": true, - "maximumOccupancy": 0, - "meetingRoom": true, - "minimumOccupancy": 0, - "pseudo": true, - "roomAssignmentRating": "MostImportant", - "roomClass": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomType": "string", - "shortDescription": "string", - "smokingPreference": "string", - "suite": true - }, - "smokingPreference": "string", - "smokingPreferenceDescription": "string" - } - ], - "description": { - "defaultText": "string", - "translatedTexts": { - "text": [ - { - "language": "string", - "value": "string" - } - ] - } - }, - "discrepancy": [ - "Sleep" - ], - "floor": "string", - "floorDescription": "string", - "hold": { - "comments": "string", - "holdUntil": "2020-07-14T10:05:39.354Z", - "holdUser": "string" - }, - "housekeeping": { - "cleaningPriority": { - "prioritySequence": 0 - }, - "facilityTaskCode": [ + "componentRoomNumbers": { + "roomId": [ "string" - ], - "guestServiceRequest": "DoNotDisturb", - "linenChange": true, - "roomCondition": { - "assignmentType": "Available", - "remarks": "string", - "roomCondition": { - "code": "string", - "description": "string" - } - }, - "roomPersons": { - "frontOfficePersons": 0, - "houseKeepingPersons": 0 - }, - "roomStatus": { - "frontOfficeStatus": "Vacant", - "housekeepingStatus": "Vacant", - "reservationStatusList": [ - "Arrival" - ], - "roomStatus": "Clean" - } - }, - "meetingRoom": true, - "outOfOrder": [ - { - "end": "2020-07-14", - "newDateRange": { - "end": "2020-07-14", - "start": "2020-07-14" - }, - "reasonCode": "string", - "reasonDesc": "string", - "repairRemarks": "string", - "returnStatus": "Clean", - "roomStatus": "Clean", - "start": "2020-07-14" - } - ], - "resvInfo": [ - { - "guestName": "string", - "profileId": { - "id": "string", - "type": "string" - }, - "reservationId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - }, - "reservationStatusInfo": "Arrival", - "stayDateInfo": { - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-07-14T10:05:39.354Z", - "reservationExpectedDepartureTime": "2020-07-14T10:05:39.354Z" - }, - "timeSpan": { - "duration": "string", - "endDate": "2020-07-14", - "startDate": "2020-07-14" - } - }, - "vipStatus": { - "code": "string", - "value": "string" - } - } - ], - "roomAssignmentRating": "MostImportant", - "roomDescription": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomId": "string", - "roomSection": { - "daySectionCode": "string", - "eveningSectionCode": "string" - }, - "roomType": { - "accessible": true, - "building": "string", - "houseKeeping": true, - "maximumOccupancy": 0, - "meetingRoom": true, - "minimumOccupancy": 0, - "pseudo": true, - "roomAssignmentRating": "MostImportant", - "roomClass": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomType": "string", - "shortDescription": "string", - "smokingPreference": "string", - "suite": true - }, - "sitePlanSection": { - "coordinates": "string", - "description": "string", - "linkCode": "string", - "sectionCode": "string", - "sectionType": "string" - }, - "smokingPreference": "string", - "smokingPreferenceDescription": "string", - "turndownInfo": { - "turndownStatusInfo": "Required" + ] } } - ] - } + ], + "hotelId": "string" + }, + "links": [ + { + "href": "string", + "rel": "string", + "templated": false, + "method": "GET", + "targetSchema": "string", + "operationId": "string", + "title": "string" + } + ] } } }, @@ -9752,56 +9082,42 @@ "description": "ReservationsInQueue not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/queuedReservations/{reservationId}": { - "put": { - "description": "Using this API you can assign reservations to the reservation queue if the guest's room is not ready for assignment or if there are no available rooms of the room type attached to the reservation. Housekeeping staff can use the Queue Rooms functionality to determine if there are guests waiting to check in to a particular room or type of room; if there are, the queue list can provide guidance in determining which rooms need attention first.OperationId:addReservationToQueue
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9810,31 +9126,38 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/queuedReservations/{reservationId}": { + "put": { "summary": "Add reservation to queue", + "description": "Using this API you can assign reservations to the reservation queue if the guest's room is not ready for assignment or if there are no available rooms of the room type attached to the reservation. Housekeeping staff can use the Queue Rooms functionality to determine if there are guests waiting to check in to a particular room or type of room; if there are, the queue list can provide guidance in determining which rooms need attention first.OperationId:addReservationToQueue
", "operationId": "addReservationToQueue", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to add a reservation to the Queue for Check-In. A reservation can be added to the queue prior to Check-In on the day of arrival.", "name": "queueReservation", "in": "body", "required": true, + "description": "Request to add a reservation to the Queue for Check-In. A reservation can be added to the queue prior to Check-In on the day of arrival.", "schema": { "allOf": [ { @@ -9844,109 +9167,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response to the request to add a reservation to the Queue for Check-In.", - "schema": { - "$ref": "#/definitions/reservationQueuePriority" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 to the request to add a reservation to the Queue for Check-In.", + "schema": { + "$ref": "#/definitions/reservationQueuePriority" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to remove a reservation that is already set as a Queued Reservation.OperationId:deleteReservationFromQueue
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -9955,132 +9246,103 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + }, + "delete": { "summary": "Delete reservation from queue", + "description": "Use this API to remove a reservation that is already set as a Queued Reservation.OperationId:deleteReservationFromQueue
", "operationId": "deleteReservationFromQueue", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservationStatusStatistics": { - "get": { - "description": "This API will fetch reservation statistics for the given status per room type.OperationId:getReservationStatusStatistics
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10088,137 +9350,108 @@ "application/json;charset=UTF-8" ], "tags": [ - "FOFStats" - ], + "FrontDeskOperations" + ] + } + }, + "/hotels/{hotelId}/reservationStatusStatistics": { + "get": { "summary": "Get Reservation Status Statistics", + "description": "This API will fetch reservation statistics for the given status per room type.OperationId:getReservationStatusStatistics
", "operationId": "getReservationStatusStatistics", "parameters": [ { - "type": "string", - "description": "Hotel Code", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "description": "Hotel Code" }, { + "name": "reservationStatus", + "in": "query", + "collectionFormat": "multi", + "required": true, "type": "array", + "description": "Reservation statuses to fetch statistics for", "items": { + "type": "string", "enum": [ "DueIn", "DueOut", "CheckedIn", "CheckedOut" - ], - "type": "string" - }, - "collectionFormat": "multi", - "description": "Reservation statuses to fetch statistics for", - "name": "reservationStatus", - "in": "query", - "required": true + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response of get Reservation Status Statistics.", - "schema": { - "$ref": "#/definitions/reservationStatusStatisticsResponseType" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response of get Reservation Status Statistics.", + "schema": { + "$ref": "#/definitions/reservationStatusStatisticsResponseType" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservationSummaries": { - "get": { - "description": "Use this API to return reservation summaries for a specific property based on search criteria such as reservationId, blockId, arrivalStart, membershipNumber, roomId, etc.OperationId:getReservationSummaries
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -10226,20 +9459,30 @@ "application/json;charset=UTF-8" ], "tags": [ - "FrontDeskOperations" - ], + "FOFStats" + ] + } + }, + "/hotels/{hotelId}/reservationSummaries": { + "get": { "summary": "Get hotel reservation summaries", + "description": "Use this API to return reservation summaries for a specific property based on search criteria such as reservationId, blockId, arrivalStart, membershipNumber, roomId, etc.OperationId:getReservationSummaries
", "operationId": "getReservationSummaries", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { + "name": "searchType", + "in": "query", + "required": false, + "type": "string", "uniqueItems": true, "enum": [ "Any", @@ -10273,263 +9516,298 @@ "Routing", "PlayerSnapshot" ], - "type": "string", - "description": "Represents Reservation search type Player Snapshot.", - "name": "searchType", - "in": "query" + "description": "Represents Reservation search type Player Snapshot." }, { + "name": "reservationId", + "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" }, - "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.", - "name": "reservationId", - "in": "query" + "required": false }, { + "name": "reservationIdContext", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "reservationIdContext", - "in": "query" + "required": false }, { + "name": "reservationIdType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A reference to the type of object defined by the UniqueID element.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "reservationIdType", - "in": "query" + "required": false }, { + "name": "blockId", + "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" }, - "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.", - "name": "blockId", - "in": "query" + "required": false }, { + "name": "blockIdContext", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "blockIdContext", - "in": "query" + "required": false }, { + "name": "blockIdType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A reference to the type of object defined by the UniqueID element.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "blockIdType", - "in": "query" + "required": false }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", "name": "arrivalEnd", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The starting value of the date range.", "name": "arrivalStart", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", "name": "departureEnd", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The starting value of the date range.", "name": "departureStart", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", "name": "stayOnEnd", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The starting value of the date range.", "name": "stayOnStart", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", "name": "createdOnEnd", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The starting value of the date range.", "name": "createOnStart", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", "name": "depositDateEnd", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The starting value of the date range.", "name": "depositDateStart", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date-time", - "description": "The ending value of the time span.", "name": "dateCriteriaExpectedArrivalEndTime", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the time span.", + "type": "string", + "format": "date-time" }, { - "type": "string", - "format": "date-time", - "description": "The starting value of the time span.", "name": "dateCriteriaExpectedArrivalStartTime", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the time span.", + "type": "string", + "format": "date-time" }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", "name": "depositDueDateEnd", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The starting value of the date range.", "name": "depositDueDateStart", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date-time", - "description": "The ending value of the time span.", "name": "expectedReturnEndTime", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the time span.", + "type": "string", + "format": "date-time" }, { - "type": "string", - "format": "date-time", - "description": "The starting value of the time span.", "name": "expectedReturnStartTime", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the time span.", + "type": "string", + "format": "date-time" }, { - "type": "string", - "description": "Lookup reservations with this membership number.", "name": "membershipNumber", - "in": "query" + "in": "query", + "required": false, + "description": "Lookup reservations with this membership number.", + "type": "string" }, { - "type": "boolean", - "description": "VIP status of the customer.", "name": "anyVIPStatus", - "in": "query" - }, + "in": "query", + "required": false, + "description": "VIP status of the customer.", + "type": "boolean" + }, { + "name": "vipStatusCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "VIP status of the customer.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "VIP status of the customer.", - "name": "vipStatusCodes", - "in": "query" + "required": false }, { - "type": "string", - "description": "Wildcard Search value to lookup reservation with this room number.", "name": "roomId", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard Search value to lookup reservation with this room number.", + "type": "string" }, { - "type": "string", - "description": "Wildcard Search value to lookup reservations with this Last Name.", "name": "lastName", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard Search value to lookup reservations with this Last Name.", + "type": "string" }, { - "type": "string", - "description": "Wildcard Search value to lookup reservations with this First Name.", "name": "firstName", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard Search value to lookup reservations with this First Name.", + "type": "string" }, { - "type": "string", - "description": "Wildcard Search value to lookup reservation with this block code.", "name": "blockCode", - "in": "query" + "in": "query", + "required": false, + "description": "Wildcard Search value to lookup reservation with this block code.", + "type": "string" }, { - "type": "string", - "description": "Lookup reservations with this company name.", "name": "companyName", - "in": "query" + "in": "query", + "required": false, + "description": "Lookup reservations with this company name.", + "type": "string" }, { - "type": "string", - "description": "Lookup reservations with this travel agent name.", "name": "travelAgentName", - "in": "query" + "in": "query", + "required": false, + "description": "Lookup reservations with this travel agent name.", + "type": "string" }, { - "type": "string", - "description": "Lookup reservations which has this credit card attached.", "name": "creditCardNumber", - "in": "query" + "in": "query", + "required": false, + "description": "Lookup reservations which has this credit card attached.", + "type": "string" }, { - "type": "string", - "description": "Lookup reservations with this custom reference number.", "name": "customReference", - "in": "query" + "in": "query", + "required": false, + "description": "Lookup reservations with this custom reference number.", + "type": "string" }, { - "type": "string", - "description": "Lookup reservations with this external reference id.", "name": "externalReference", - "in": "query" + "in": "query", + "required": false, + "description": "Lookup reservations with this external reference id.", + "type": "string" }, { - "uniqueItems": true, + "name": "attributeName", + "in": "query", "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Room", "Name", @@ -10537,56 +9815,62 @@ "DepartureTime", "ArrivalDate", "DepartureDate" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "name": "attributeName", - "in": "query" + "required": false }, { - "uniqueItems": true, + "name": "orderType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Asc", "Desc" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "name": "orderType", - "in": "query" + "required": false }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", "name": "expectedArrivalEndTime", - "in": "query" + "in": "query", + "required": false, + "description": "The ending value of the date range.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "The starting value of the date range.", "name": "expectedArrivalStartTime", - "in": "query" + "in": "query", + "required": false, + "description": "The starting value of the date range.", + "type": "string", + "format": "date" }, { + "name": "roomTypes", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Room Type.", - "name": "roomTypes", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "uniqueItems": true, + "name": "roomStatuses", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Clean", "Dirty", @@ -10594,28 +9878,30 @@ "Inspected", "OutOfOrder", "OutOfService" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", - "name": "roomStatuses", - "in": "query" + "required": false }, { + "name": "paymentMethod", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Payment Method to search the reservation.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Payment Method to search the reservation.", - "name": "paymentMethod", - "in": "query" + "required": false }, { - "uniqueItems": true, + "name": "indicator", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Simple type that corresponds to reservation indicators.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Package", "Message", @@ -10656,34 +9942,36 @@ "Communication", "PrepaidCards", "WebRegistrationCards" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Simple type that corresponds to reservation indicators.", - "name": "indicator", - "in": "query" + "required": false }, { - "uniqueItems": true, + "name": "fetchSummaryInstructions", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Simple type for reservation summary instructions that can be used in requests to fetch summary.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "ReservationPaymentMethods", "RoomDetails", "BlockReservationDetails" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Simple type for reservation summary instructions that can be used in requests to fetch summary.", - "name": "fetchSummaryInstructions", - "in": "query" + "required": false }, { - "uniqueItems": true, + "name": "allowedAction", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Cancel", "Move", @@ -10699,610 +9987,562 @@ "HouseKeeping", "EnrollToPrimaryMembership", "EnrollInProgress" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.", - "name": "allowedAction", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response of fetch room keys operation.", - "schema": { - "$ref": "#/definitions/shortReservation" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } }, + "description": "Response of fetch room keys operation.", + "schema": { + "$ref": "#/definitions/shortReservation" + }, "examples": { "application/json": { - "links": [ - { - "href": "string", - "method": "GET", - "operationId": "string", - "rel": "string", - "targetSchema": "string", - "templated": false, - "title": "string" - } - ], "reservationInfoList": [ { - "accessRestriction": "Change", - "advanceCheckIn": { - "advanceCheckedIn": true, - "eTRComments": "string", - "expectedReturnTime": "2020-07-14T09:50:47.985Z" - }, - "allowMobileCheckout": true, - "allowMobileViewFolio": true, - "allowedActions": [ - "Cancel" - ], - "attachedProfiles": [ + "reservationIdList": [ { - "name": "string", - "profileIdList": [ - { - "id": "string", - "type": "string" - } - ], - "reservationProfileType": "Company" + "id": "string", + "type": "string" } ], - "cancellationInfo": { - "code": "string", - "date": "2020-07-14", - "description": "string" - }, - "cashiering": { - "bedTaxReporting": { - "taxRegistrationNo": 0, - "taxableDays": 0, - "visaExpiryDate": "2020-07-14", - "visaIssueDate": "2020-07-14", - "visaNumber": "string" + "roomStay": { + "arrivalDate": "2020-07-14", + "departureDate": "2020-07-14", + "originalTimeSpan": { + "startDate": "2020-07-14", + "endDate": "2020-07-14", + "duration": "string" }, - "billingPrivileges": { - "allowAutoCheckin": true, - "autoSettlement": true, - "autoSettlementFreq": 0, - "autoSettlementType": "string", - "creditLimitAutoPay": true, - "directBillAuthorized": true, - "folioCloseDate": "2020-07-14", - "postStayCharging": true, - "postingRestriction": true, - "preStayCharging": true, - "scheduledCheckout": true, - "scheduledCheckoutTime": "2020-07-14", - "videoCheckout": true + "expectedTimes": { + "reservationExpectedArrivalTime": "2020-07-14T09:50:47.983Z", + "reservationExpectedDepartureTime": "2020-07-14T09:50:47.983Z" }, - "compAccounting": { - "authorizer": "string", - "compType": "string" + "adultCount": 0, + "childCount": 0, + "roomClass": "string", + "roomType": "string", + "numberOfRooms": 0, + "roomNumber": "string", + "ratePlanCode": "string", + "rateAmount": { + "amount": 0, + "currencyCode": "string" }, - "financiallyResponsible": true, - "folioTexts": { - "folioText": [ + "points": { + "awardsType": "string", + "points": 0 + }, + "rateSuppressed": true, + "reservationBlock": { + "blockIdList": [ { - "row": 0, - "text": "string" + "id": "string", + "type": "string" } - ] + ], + "blockName": "string", + "hotelId": "string" }, - "lastRoomAndTaxPostedDate": "2020-07-14", - "periodicFolio": { - "frequency": 0, - "lastFolioDate": "2020-07-14", - "lastSettlementDate": "2020-07-14" + "bookingChannelCode": "string", + "partyCode": "string", + "fixedRate": true, + "totalAmount": { + "amount": 0, + "currencyCode": "string" }, - "proratedBilling": true, - "reservationPreConfiguredRoutingInstruction": { - "authorizerInfo": { - "authorizerId": { - "id": "string", - "type": "string" - }, - "authorizerName": "string", - "authorizerRateCode": "string", - "authorizerUserName": "string", - "inheritAuthorizerRateCode": true - }, - "profileType": "Company", + "guarantee": { + "guaranteeCode": "string", + "shortDescription": "string", + "onHold": true + }, + "promotion": { "promotionCode": "string", - "ratePlanCode": "string" + "promotionName": "string", + "couponCode": "string" }, - "revenuesAndBalances": { - "balance": { - "amount": 0, - "currencyCode": "string" + "marketCode": "string", + "sourceOfBusiness": "string", + "sourceOfBusinessDescription": "string", + "balance": { + "amount": 0, + "currencyCode": "string" + }, + "compBalance": { + "amount": 0, + "currencyCode": "string" + }, + "roomTypeCharged": "string", + "depositPayments": { + "amount": 0, + "currencyCode": "string" + }, + "guestServiceStatus": "DoNotDisturb", + "scheduledCheckoutTime": "2020-07-14", + "roomNumberLocked": true, + "pseudoRoom": true + }, + "reservationGuest": { + "membership": { + "membershipId": 0, + "programCode": "string", + "bonusCode": "string", + "membershipTypeDesc": "string", + "membershipLevelDesc": "string", + "accountId": "string", + "membershipLevel": "string", + "playerRanking": 0 + }, + "namePrefix": "string", + "givenName": "string", + "alternateGivenName": "string", + "middleName": "string", + "surnamePrefix": "string", + "surname": "string", + "alternateSurname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "fullName": "string", + "alternateFullName": "string", + "phoneNumber": "string", + "email": "string", + "birthDate": "2020-07-14", + "language": "string", + "nationality": { + "value": "string", + "code": "string" + }, + "vip": { + "vipCode": "string", + "vipDescription": "string" + }, + "address": { + "cityName": "string", + "postalCode": "string", + "state": "string", + "country": { + "value": "string", + "code": "string" }, - "foodAndBevRevenue": { + "streetAddress": "string", + "excludeNoCity": true + }, + "anonymization": { + "anonymizationStatus": "Requested", + "anonymizationDate": "2020-07-14T09:50:47.984Z" + }, + "accompanyGuests": [ + { + "firstName": "string", + "lastName": "string", + "fullName": "string", + "registrationCardNo": "string", + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ] + } + ], + "externalInfo": { + "givenName": "string", + "surname": "string" + }, + "guestLastStayInfo": { + "lastStayDate": "2020-07-14", + "lastStayRoom": "string", + "lastStayRate": { "amount": 0, "currencyCode": "string" }, - "nonRevenue": { - "amount": 0, - "currencyCode": "string" + "totalStay": 0 + }, + "guestRestrictedCode": "string", + "guestRestrictedReasonDesc": "string", + "guestRestricted": true, + "registrationCardNo": "string", + "nameType": "Guest", + "id": "string", + "type": "string" + }, + "sharedGuests": [ + { + "profileId": { + "url": "string", + "type": "string", + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 }, - "otherRevenue": { - "amount": 0, - "currencyCode": "string" + "firstName": "string", + "lastName": "string", + "fullName": "string" + } + ], + "attachedProfiles": [ + { + "name": "string", + "profileIdList": [ + { + "id": "string", + "type": "string" + } + ], + "reservationProfileType": "Company" + } + ], + "reservationPaymentMethod": { + "paymentCard": { + "cardId": { + "id": "string", + "type": "string" }, - "roomRevenue": { + "currentAuthorizedAmount": { "amount": 0, "currencyCode": "string" }, - "totalFixedCharge": { + "approvalAmountNeeded": { "amount": 0, "currencyCode": "string" }, - "totalPayment": { + "cardType": "Ab", + "userDefinedCardType": "string", + "cardNumber": "string", + "cardNumberMasked": "string", + "cardNumberLast4Digits": "string", + "expirationDate": "2020-07-14", + "expirationDateMasked": "string", + "expirationDateExpired": true, + "cardHolderName": "string", + "attachCreditCardToProfile": true, + "processing": "Eft", + "swiped": true, + "cardOrToken": "CardNumber" + }, + "balance": { + "amount": 0, + "currencyCode": "string" + }, + "authorizationRule": { + "code": 0, + "amount": { "amount": 0, "currencyCode": "string" }, - "totalRevenue": { - "amount": 0, - "currencyCode": "string" - } + "percent": 0 }, - "reverseAdvanceCheckInAllowed": true, - "reverseCheckInAllowed": true, - "taxType": { - "code": "string", - "collectingAgentTax": true, - "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, - "printAutoAdjust": true, - "reportExemptDays": 0, - "reportTaxPercentage": 0, - "taxExemptNo": "string" + "emailFolioInfo": { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-07-14T09:50:47.984Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:50:47.984Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" + }, + "emailFolio": true, + "id": "string", + "type": "string" }, - "transactionsPosted": true - }, - "commissionPayoutTo": "TravelAgent", - "computedReservationStatus": "Reserved", - "createDateTime": "2020-07-14T09:50:47.985Z", - "creatorId": "string", - "deposit": { - "amountOwed": 0, - "amountPaid": 0, - "amountRequired": 0, - "dueDate": "2020-07-14", - "hasOutstanding": true, - "hasPaid": true, - "postingDate": "2020-07-14" + "paymentMethod": "string", + "description": "string", + "folioView": 0 }, - "displayColor": "string", - "expectedServiceTime": "string", - "guestPreferredCurrency": "string", - "hotelId": "string", - "hotelInterfaceStatusList": [ + "reservationFolioWindows": [ { - "hotelInterface": { - "activeFlag": true, - "hotelId": "string", - "interfaceId": { + "payeeInfo": { + "payeeId": { "id": "string", "type": "string" }, - "interfaceName": "string", - "interfaceType": "Bms", - "logo": "string", - "machineName": "string", - "status": "Stopped" - }, - "interfaceRights": [ - { - "category": "string", - "description": "string", - "right": 0, - "statusCode": "string" - } - ], - "roomExtension": "string" - } - ], - "hotelName": "string", - "housekeeping": { - "expectedServiceTime": "string", - "facilityTaskInfo": { - "date": "2020-07-14", - "supplies": [ - { - "code": "string", - "description": "string", - "quantity": 0 - } - ], - "task": { - "code": "string", - "description": "string", - "facilityDepartureTask": true, - "hotelId": "string", - "instructions": "string", - "linenChange": true, - "sequence": 0 - } - }, - "instructions": "string", - "linenChange": true, - "roomStatus": "Clean", - "serviceTime": "2020-07-14", - "turndownRequested": true - }, - "keyCount": 0, - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:50:47.985Z", - "lastPrivacyPromptDate": "2020-07-14", - "mobileNotifications": { - "checkoutMessageReceived": true, - "errorMessage": "string", - "keyReady": "Pending", - "requiresAction": true, - "roomReady": "Pending" - }, - "openFolio": true, - "optedForCommunication": true, - "paymentMethod": "string", - "preRegistered": true, - "purgeDate": "2020-07-14", - "queue": { - "averageQueueTimeCurrentReservations": 0, - "averageQueueTimeToCheckIn": 0, - "guestTextInfo": { - "sentBy": "string", - "sentTime": "2020-07-14T09:50:47.984Z" - }, - "priority": 0, - "queueDate": "2020-07-14", - "timeSpan": { - "duration": "string", - "durationInSeconds": 0, - "endDate": "2020-07-14", - "startDate": "2020-07-14" - } - }, - "reservationCommunication": { - "emails": { - "count": 0, - "emailInfo": [ - { - "email": { - "createDateTime": "2020-07-14T09:50:47.985Z", - "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:50:47.985Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-07-14", - "type": "string", - "typeDescription": "string" - }, - "id": "string", - "type": "string" - } - ], - "hasMore": true, - "totalResults": 0 - }, - "telephones": { - "count": 0, - "hasMore": true, - "telephoneInfo": [ - { - "id": "string", - "telephone": { - "createDateTime": "2020-07-14T09:50:47.985Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:50:47.985Z", - "orderSequence": 0, - "phoneNumber": "string", - "phoneTechType": "string", - "phoneUseType": "string", - "phoneUseTypeDescription": "string", - "primaryInd": true, - "purgeDate": "2020-07-14" - }, - "type": "string" - } - ], - "totalResults": 0 - } - }, - "reservationFolioWindows": [ - { - "balance": { - "amount": 0, - "currencyCode": "string" - }, - "folioWindowNo": 0, - "payeeInfo": { - "payeeAccountInfo": { - "accountId": { - "id": "string", - "type": "string" - }, - "accountName": "string", - "accountNo": "string", - "status": { - "description": "string", - "restricted": true, - "restriction": "string" - } - }, + "payeeName": "string", "payeeAddress": { "address": { "addressLine": [ "string" ], - "barCode": "string", - "cityExtension": "string", "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", "country": { - "code": "string", - "value": "string" + "value": "string", + "code": "string" }, - "county": "string", - "createDateTime": "2020-07-14T09:50:47.984Z", - "creatorId": "string", "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:50:47.984Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-07-14", - "state": "string", "type": "string", "typeDescription": "string", - "updateReservations": true + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-07-14T09:50:47.984Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:50:47.984Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" }, "id": "string", "type": "string" }, "payeeAddressCount": 0, - "payeeId": { - "id": "string", - "type": "string" - }, - "payeeName": "string", "payeeReferenceCurrency": "string", - "payeeTaxNumber": "string" - }, - "paymentMethod": "string" - } - ], - "reservationGuest": { - "accompanyGuests": [ - { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileIdList": [ - { + "payeeAccountInfo": { + "accountName": "string", + "accountId": { "id": "string", "type": "string" + }, + "accountNo": "string", + "status": { + "restriction": "string", + "description": "string", + "restricted": true } - ], - "registrationCardNo": "string" - } - ], - "address": { - "cityName": "string", - "country": { - "code": "string", - "value": "string" + }, + "payeeTaxNumber": "string" }, - "excludeNoCity": true, - "postalCode": "string", - "state": "string", - "streetAddress": "string" - }, - "alternateFullName": "string", - "alternateGivenName": "string", - "alternateSurname": "string", - "anonymization": { - "anonymizationDate": "2020-07-14T09:50:47.984Z", - "anonymizationStatus": "Requested" - }, - "birthDate": "2020-07-14", - "email": "string", - "externalInfo": { - "givenName": "string", - "surname": "string" - }, - "fullName": "string", - "givenName": "string", - "guestLastStayInfo": { - "lastStayDate": "2020-07-14", - "lastStayRate": { + "balance": { "amount": 0, "currencyCode": "string" }, - "lastStayRoom": "string", - "totalStay": 0 - }, - "guestRestricted": true, - "guestRestrictedCode": "string", - "guestRestrictedReasonDesc": "string", - "id": "string", - "language": "string", - "membership": { - "accountId": "string", - "bonusCode": "string", - "membershipId": 0, - "membershipLevel": "string", - "membershipLevelDesc": "string", - "membershipTypeDesc": "string", - "playerRanking": 0, - "programCode": "string" - }, - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameType": "Guest", - "nationality": { - "code": "string", - "value": "string" - }, - "phoneNumber": "string", - "registrationCardNo": "string", - "surname": "string", - "surnamePrefix": "string", - "type": "string", - "vip": { - "vipCode": "string", - "vipDescription": "string" + "paymentMethod": "string", + "folioWindowNo": 0 } - }, - "reservationIdList": [ + ], + "specials": "string", + "lastPrivacyPromptDate": "2020-07-14", + "displayColor": "string", + "reservationIndicators": [ { - "id": "string", - "type": "string" + "indicatorName": "string", + "count": 0 } ], - "reservationIndicators": [ + "roomStatus": "Clean", + "searchMatches": [ { - "count": 0, - "indicatorName": "string" + "attribute": "string", + "value": "string" } ], - "reservationPaymentMethod": { - "authorizationRule": { - "amount": { - "amount": 0, - "currencyCode": "string" - }, - "code": 0, - "percent": 0 + "sourceOfSale": { + "sourceType": "string", + "sourceCode": "string" + }, + "waitlist": { + "reasonDescription": "string", + "priorityDescription": "string", + "description": "string", + "reasonCode": "string", + "priorityCode": "string", + "telephone": "string" + }, + "queue": { + "timeSpan": { + "startDate": "2020-07-14", + "endDate": "2020-07-14", + "duration": "string", + "durationInSeconds": 0 }, - "balance": { - "amount": 0, - "currencyCode": "string" + "guestTextInfo": { + "sentTime": "2020-07-14T09:50:47.984Z", + "sentBy": "string" }, - "description": "string", - "emailFolioInfo": { - "email": { - "createDateTime": "2020-07-14T09:50:47.984Z", - "creatorId": "string", - "emailAddress": "string", - "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:50:47.984Z", - "orderSequence": 0, - "primaryInd": true, - "purgeDate": "2020-07-14", - "type": "string", - "typeDescription": "string" + "priority": 0, + "averageQueueTimeToCheckIn": 0, + "averageQueueTimeCurrentReservations": 0, + "queueDate": "2020-07-14" + }, + "housekeeping": { + "instructions": "string", + "facilityTaskInfo": { + "task": { + "description": "string", + "instructions": "string", + "facilityDepartureTask": true, + "linenChange": true, + "hotelId": "string", + "code": "string", + "sequence": 0 }, - "emailFolio": true, - "id": "string", - "type": "string" + "supplies": [ + { + "description": "string", + "quantity": 0, + "code": "string" + } + ], + "date": "2020-07-14" }, - "folioView": 0, - "paymentCard": { - "approvalAmountNeeded": { + "linenChange": true, + "turndownRequested": true, + "serviceTime": "2020-07-14", + "expectedServiceTime": "string", + "roomStatus": "Clean" + }, + "cashiering": { + "revenuesAndBalances": { + "totalFixedCharge": { "amount": 0, "currencyCode": "string" }, - "attachCreditCardToProfile": true, - "cardHolderName": "string", - "cardId": { - "id": "string", - "type": "string" + "totalPayment": { + "amount": 0, + "currencyCode": "string" }, - "cardNumber": "string", - "cardNumberLast4Digits": "string", - "cardNumberMasked": "string", - "cardOrToken": "CardNumber", - "cardType": "Ab", - "currentAuthorizedAmount": { + "roomRevenue": { "amount": 0, "currencyCode": "string" }, - "expirationDate": "2020-07-14", - "expirationDateExpired": true, - "expirationDateMasked": "string", - "processing": "Eft", - "swiped": true, - "userDefinedCardType": "string" + "foodAndBevRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "otherRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "nonRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "totalRevenue": { + "amount": 0, + "currencyCode": "string" + }, + "balance": { + "amount": 0, + "currencyCode": "string" + } }, - "paymentMethod": "string" - }, - "reservationStatus": "Reserved", - "revenuesAndBalances": { - "balance": { - "amount": 0, - "currencyCode": "string" + "billingPrivileges": { + "postingRestriction": true, + "preStayCharging": true, + "postStayCharging": true, + "folioCloseDate": "2020-07-14", + "scheduledCheckout": true, + "scheduledCheckoutTime": "2020-07-14", + "directBillAuthorized": true, + "videoCheckout": true, + "allowAutoCheckin": true, + "autoSettlement": true, + "autoSettlementType": "string", + "autoSettlementFreq": 0, + "creditLimitAutoPay": true }, - "foodAndBevRevenue": { - "amount": 0, - "currencyCode": "string" + "taxType": { + "hotelId": "string", + "code": "string", + "description": "string", + "collectingAgentTax": true, + "printAutoAdjust": true, + "reportExemptDays": 0, + "reportTaxPercentage": 0, + "minimumLengthOfStay": 0, + "taxExemptNo": "string" }, - "nonRevenue": { - "amount": 0, - "currencyCode": "string" + "bedTaxReporting": { + "taxRegistrationNo": 0, + "visaNumber": "string", + "visaIssueDate": "2020-07-14", + "visaExpiryDate": "2020-07-14", + "taxableDays": 0 }, - "otherRevenue": { - "amount": 0, - "currencyCode": "string" + "folioTexts": { + "folioText": [ + { + "text": "string", + "row": 0 + } + ] }, - "roomRevenue": { - "amount": 0, - "currencyCode": "string" + "periodicFolio": { + "lastSettlementDate": "2020-07-14", + "lastFolioDate": "2020-07-14", + "frequency": 0 + }, + "compAccounting": { + "compType": "string", + "authorizer": "string" + }, + "reservationPreConfiguredRoutingInstruction": { + "authorizerInfo": { + "authorizerId": { + "id": "string", + "type": "string" + }, + "authorizerUserName": "string", + "authorizerName": "string", + "authorizerRateCode": "string", + "inheritAuthorizerRateCode": true + }, + "ratePlanCode": "string", + "profileType": "Company", + "promotionCode": "string" }, + "financiallyResponsible": true, + "proratedBilling": true, + "lastRoomAndTaxPostedDate": "2020-07-14", + "reverseCheckInAllowed": true, + "reverseAdvanceCheckInAllowed": true, + "transactionsPosted": true + }, + "taxType": { + "hotelId": "string", + "code": "string", + "description": "string", + "collectingAgentTax": true, + "printAutoAdjust": true, + "reportExemptDays": 0, + "reportTaxPercentage": 0, + "minimumLengthOfStay": 0 + }, + "deposit": { + "amountRequired": 0, + "amountPaid": 0, + "amountOwed": 0, + "dueDate": "2020-07-14", + "postingDate": "2020-07-14", + "hasPaid": true, + "hasOutstanding": true + }, + "allowedActions": [ + "Cancel" + ], + "revenuesAndBalances": { "totalFixedCharge": { "amount": 0, "currencyCode": "string" @@ -11311,149 +10551,155 @@ "amount": 0, "currencyCode": "string" }, - "totalRevenue": { + "roomRevenue": { "amount": 0, "currencyCode": "string" - } - }, - "roomStatus": "Clean", - "roomStay": { - "adultCount": 0, - "arrivalDate": "2020-07-14", - "balance": { + }, + "foodAndBevRevenue": { "amount": 0, "currencyCode": "string" }, - "bookingChannelCode": "string", - "childCount": 0, - "compBalance": { + "otherRevenue": { "amount": 0, "currencyCode": "string" }, - "departureDate": "2020-07-14", - "depositPayments": { + "nonRevenue": { "amount": 0, "currencyCode": "string" }, - "expectedTimes": { - "reservationExpectedArrivalTime": "2020-07-14T09:50:47.983Z", - "reservationExpectedDepartureTime": "2020-07-14T09:50:47.983Z" - }, - "fixedRate": true, - "guarantee": { - "guaranteeCode": "string", - "onHold": true, - "shortDescription": "string" - }, - "guestServiceStatus": "DoNotDisturb", - "marketCode": "string", - "numberOfRooms": 0, - "originalTimeSpan": { - "duration": "string", - "endDate": "2020-07-14", - "startDate": "2020-07-14" - }, - "partyCode": "string", - "points": { - "awardsType": "string", - "points": 0 - }, - "promotion": { - "couponCode": "string", - "promotionCode": "string", - "promotionName": "string" - }, - "pseudoRoom": true, - "rateAmount": { + "totalRevenue": { "amount": 0, "currencyCode": "string" }, - "ratePlanCode": "string", - "rateSuppressed": true, - "reservationBlock": { - "blockIdList": [ - { - "id": "string", - "type": "string" - } - ], - "blockName": "string", - "hotelId": "string" - }, - "roomClass": "string", - "roomNumber": "string", - "roomNumberLocked": true, - "roomType": "string", - "roomTypeCharged": "string", - "scheduledCheckoutTime": "2020-07-14", - "sourceOfBusiness": "string", - "sourceOfBusinessDescription": "string", - "totalAmount": { + "balance": { "amount": 0, "currencyCode": "string" } }, - "roomStayReservation": true, - "searchMatches": [ - { - "attribute": "string", - "value": "string" - } - ], - "sharedGuests": [ + "hotelInterfaceStatusList": [ { - "firstName": "string", - "fullName": "string", - "lastName": "string", - "profileId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", - "type": "string", - "url": "string" - } + "roomExtension": "string", + "hotelInterface": { + "interfaceId": { + "id": "string", + "type": "string" + }, + "hotelId": "string", + "interfaceName": "string", + "interfaceType": "Bms", + "logo": "string", + "machineName": "string", + "status": "Stopped", + "activeFlag": true + }, + "interfaceRights": [ + { + "right": 0, + "statusCode": "string", + "description": "string", + "category": "string" + } + ] } ], - "sourceOfSale": { - "sourceCode": "string", - "sourceType": "string" - }, - "specials": "string", - "taxType": { - "code": "string", - "collectingAgentTax": true, - "description": "string", - "hotelId": "string", - "minimumLengthOfStay": 0, - "printAutoAdjust": true, - "reportExemptDays": 0, - "reportTaxPercentage": 0 - }, + "guestPreferredCurrency": "string", "turndownInfo": { "allowed": true, "status": "Required" }, - "waitlist": { + "mobileNotifications": { + "roomReady": "Pending", + "keyReady": "Pending", + "checkoutMessageReceived": true, + "requiresAction": true, + "errorMessage": "string" + }, + "reservationCommunication": { + "telephones": { + "telephoneInfo": [ + { + "telephone": { + "phoneTechType": "string", + "phoneUseType": "string", + "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-07-14T09:50:47.985Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:50:47.985Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" + }, + "id": "string", + "type": "string" + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 + }, + "emails": { + "emailInfo": [ + { + "email": { + "emailAddress": "string", + "type": "string", + "typeDescription": "string", + "emailFormat": "Html", + "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-07-14T09:50:47.985Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:50:47.985Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" + }, + "id": "string", + "type": "string" + } + ], + "hasMore": true, + "totalResults": 0, + "count": 0 + } + }, + "advanceCheckIn": { + "advanceCheckedIn": true, + "expectedReturnTime": "2020-07-14T09:50:47.985Z", + "eTRComments": "string" + }, + "welcomeOffer": true, + "cancellationInfo": { "description": "string", - "priorityCode": "string", - "priorityDescription": "string", - "reasonCode": "string", - "reasonDescription": "string", - "telephone": "string" + "code": "string", + "date": "2020-07-14" }, + "keyCount": 0, + "hotelId": "string", + "hotelName": "string", + "expectedServiceTime": "string", + "roomStayReservation": true, + "createDateTime": "2020-07-14T09:50:47.985Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:50:47.985Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14", + "reservationStatus": "Reserved", + "computedReservationStatus": "Reserved", "walkInIndicator": true, - "welcomeOffer": true + "accessRestriction": "Change", + "commissionPayoutTo": "TravelAgent", + "paymentMethod": "string", + "preRegistered": true, + "openFolio": true, + "allowMobileCheckout": true, + "allowMobileViewFolio": true, + "optedForCommunication": true } ], "reservationsSummary": { - "blockSummary": { - "totalReservations": 0 - }, - "paymentMethodSummary": { - "establishedCount": "string", - "unestablishedCount": "string" - }, "roomSummary": { "assignedRooms": { "count": "string" @@ -11461,8 +10707,26 @@ "unassignedRooms": { "count": "string" } + }, + "paymentMethodSummary": { + "establishedCount": "string", + "unestablishedCount": "string" + }, + "blockSummary": { + "totalReservations": 0 } - } + }, + "links": [ + { + "href": "string", + "rel": "string", + "templated": false, + "method": "GET", + "targetSchema": "string", + "operationId": "string", + "title": "string" + } + ] } } }, @@ -11470,56 +10734,42 @@ "description": "ReservationSummaries not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/ai/rooms": { - "get": { - "description": "This API fetches the last run status of an Automated Intelligence Room Assignment.OperationId:fetchAiraLastRunStatus
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11528,124 +10778,109 @@ ], "tags": [ "FrontDeskOperations" - ], - "summary": "Automated Intelligence Room Assignment last run status", - "operationId": "fetchAiraLastRunStatus", + ] + } + }, + "/hotels/{hotelId}/reservations/ai/rooms": { + "post": { + "summary": "AI Assign Rooms", + "description": "This API runs AI Room Assignment and allocates rooms to incoming reservations.OperationId:assignRoomsAI
", + "operationId": "assignRoomsAI", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "roomsAI", + "in": "body", + "required": true, + "description": "Request to run AI Room Assignment and allocate rooms to incoming reservations.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/roomsAI" + } + ] + } }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "Response of last execution for AI Room Assignment", - "schema": { - "$ref": "#/definitions/airaLastRunStatusInfo" - }, + "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": "Audience language" + "description": "Location of newly created resource" } }, - "examples": { - "application/json": {} + "description": "HATEOAS links which help the consumer to navigate to resources", + "schema": { + "$ref": "#/definitions/status" } }, - "204": { - "description": "Room Reservations not found." - }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "This API runs AI Room Assignment and allocates rooms to incoming reservations.OperationId:assignRoomsAI
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11654,137 +10889,96 @@ ], "tags": [ "FrontDeskOperations" - ], - "summary": "AI Assign Rooms", - "operationId": "assignRoomsAI", + ] + }, + "get": { + "summary": "Automated Intelligence Room Assignment last run status", + "description": "This API fetches the last run status of an Automated Intelligence Room Assignment.OperationId:getAiraLastRunStatus
", + "operationId": "getAiraLastRunStatus", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true - }, - { - "description": "Request to run AI Room Assignment and allocate rooms to incoming reservations.", - "name": "roomsAI", - "in": "body", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/roomsAI" - } - ] - } + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", - "type": "string", - "description": "Audience language" - }, - "Location": { "type": "string", - "description": "Location of newly created resource" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response of last execution for AI Room Assignment", + "schema": { + "$ref": "#/definitions/airaLastRunStatusInfo" + }, + "examples": { + "application/json": {} } }, + "204": { + "description": "Room Reservations not found." + }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/autoRoomAssignments": { - "post": { - "description": "This API can be used to assign the room automatically.OperationId:autoAssignRoom
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11793,23 +10987,29 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/autoRoomAssignments": { + "post": { "summary": "Assign the room automatically", + "description": "This API can be used to assign the room automatically.OperationId:autoAssignRoom
", "operationId": "autoAssignRoom", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request for auto assignment of rooms to reservations.", "name": "autoAssignRoom", "in": "body", "required": true, + "description": "Request for auto assignment of rooms to reservations.", "schema": { "allOf": [ { @@ -11819,109 +11019,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "Collection of result set which is made of reservation id, error and warning.", - "schema": { - "$ref": "#/definitions/autoAssignedRoom" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Collection of result set which is made of reservation id, error and warning.", + "schema": { + "$ref": "#/definitions/autoAssignedRoom" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "This API can be used to auto unassign a room.OperationId:autoUnAssignRoom
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -11930,88 +11098,106 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + }, + "delete": { "summary": "Auto unassign room", + "description": "This API can be used to auto unassign a room.OperationId:autoUnAssignRoom
", "operationId": "autoUnAssignRoom", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "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" }, - "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.", - "name": "id", - "in": "query" + "required": false }, { + "name": "idExtension", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Additional identifying value assigned by the creating system.", "items": { "type": "integer" }, - "collectionFormat": "multi", - "description": "Additional identifying value assigned by the creating system.", - "name": "idExtension", - "in": "query" + "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" }, - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "type", - "in": "query" + "required": false }, { - "type": "boolean", - "description": "Indicates if departure rooms are to be included in the auto unassignment.", "name": "includeDepartureRooms", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates if departure rooms are to be included in the auto unassignment.", + "type": "boolean" }, { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "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.", - "name": "offset", - "in": "query" + "type": "integer" }, { - "type": "string", "name": "roomNumberWildcard", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "boolean", - "description": "If the AI ROOM ASSIGNMENT application parameter is set to Y, this flag when set to true will use the AI Room Assignment algorithm to fetch the results in order of suitability.", "name": "useAIRoomAssignment", - "in": "query" + "in": "query", + "required": false, + "description": "If the AI ROOM ASSIGNMENT application parameter is set to Y, this flag when set to true will use the AI Room Assignment algorithm to fetch the results in order of suitability.", + "type": "boolean" }, { - "type": "boolean", - "description": "Indicates if preferences on the profile associated to the reservation should be used to determine the room type. The preferences for FLOOR, SMOKING and ROOM FEATURES will be used.", "name": "useAssociatedProfilePreferences", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates if preferences on the profile associated to the reservation should be used to determine the room type. The preferences for FLOOR, SMOKING and ROOM FEATURES will be used.", + "type": "boolean" }, { - "uniqueItems": true, + "name": "hotelRoomStatus", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Clean", "Dirty", @@ -12019,310 +11205,299 @@ "Inspected", "OutOfOrder", "OutOfService" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", - "name": "hotelRoomStatus", - "in": "query" + "required": false }, { - "uniqueItems": true, + "name": "hotelFORoomStatus", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Vacant", "Occupied" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.", - "name": "hotelFORoomStatus", - "in": "query" + "required": false }, { - "type": "string", "name": "fromRoomNumber", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", "name": "toRoomNumber", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", - "format": "date", "name": "startDate", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", "name": "endDate", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "format": "date" }, { - "type": "string", "name": "duration", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { + "name": "roomType", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "The room types of hotel rooms to be fetched.", - "name": "roomType", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "The room class of hotel rooms to be fetched.", "name": "roomClass", - "in": "query" + "in": "query", + "required": false, + "description": "The room class of hotel rooms to be fetched.", + "type": "string" }, { - "type": "string", - "description": "The floor of room to be fetched.", "name": "floor", - "in": "query" + "in": "query", + "required": false, + "description": "The floor of room to be fetched.", + "type": "string" }, { - "type": "boolean", - "description": "This flag when set to true will include rooms assigned to due out reservations.", "name": "includeDueOut", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will include rooms assigned to due out reservations.", + "type": "boolean" }, { - "type": "string", - "format": "date-time", - "description": "When IncludeDueOut is enable,it is the departure time before which to search.", "name": "departureTime", - "in": "query" + "in": "query", + "required": false, + "description": "When IncludeDueOut is enable,it is the departure time before which to search.", + "type": "string", + "format": "date-time" }, { + "name": "code", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A code representing a room feature.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A code representing a room feature.", - "name": "code", - "in": "query" + "required": false }, { + "name": "description", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A code representing a room feature.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A code representing a room feature.", - "name": "description", - "in": "query" + "required": false }, { + "name": "orderSequence", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Display Order sequence.", "items": { "type": "number" }, - "collectionFormat": "multi", - "description": "Display Order sequence.", - "name": "orderSequence", - "in": "query" + "required": false }, { + "name": "quantity", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Indicates quantity.", "items": { "type": "integer" }, - "collectionFormat": "multi", - "description": "Indicates quantity.", - "name": "quantity", - "in": "query" + "required": false }, { - "type": "string", - "description": "The smoking preference of room to be fetched.", "name": "smokingPreference", - "in": "query" + "in": "query", + "required": false, + "description": "The smoking preference of room to be fetched.", + "type": "string" }, { - "type": "boolean", - "description": "This flag when set to true will include all room conditions, when set to false then room with \"General Assignment\" condition type will be excluded from the result.", "name": "includeAllRoomConditions", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will include all room conditions, when set to false then room with \"General Assignment\" condition type will be excluded from the result.", + "type": "boolean" }, { - "type": "boolean", - "description": "This flag when set to true will include all component rooms", "name": "includeComponentRooms", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will include all component rooms", + "type": "boolean" }, { - "type": "boolean", - "description": "This flag when set to true will include all pseudo rooms", "name": "includePseudoRooms", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will include all pseudo rooms", + "type": "boolean" }, { - "type": "boolean", - "description": "This flag when set to true will work for Available Rooms functionality", "name": "includeOORoomCheck", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will work for Available Rooms functionality", + "type": "boolean" }, { - "type": "boolean", - "description": "This flag when set to true will include only connecting rooms.", "name": "connectingRoomsOnly", - "in": "query" - }, + "in": "query", + "required": false, + "description": "This flag when set to true will include only connecting rooms.", + "type": "boolean" + }, { - "type": "string", - "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.", "name": "reservationIdId", - "in": "query" + "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" }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "reservationIdIdExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "idContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "reservationIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "boolean", - "description": "This flag when set to true will include only pseudo rooms", "name": "pseudoRoomsOnly", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will include only pseudo rooms", + "type": "boolean" }, { - "type": "boolean", - "description": "This flag when set to true will includes attendent in Rooms", "name": "includeAttendentInRoom", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will includes attendent in Rooms", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/massAdvanceCheckIns": { - "post": { - "description": "Use this API to perform a mass advance checkin for reservations.OperationId:postMassAdvanceCheckIn
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12331,23 +11506,29 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/massAdvanceCheckIns": { + "post": { "summary": "Mass Advance Check in Reservations", + "description": "Use this API to perform a mass advance checkin for reservations.OperationId:postMassAdvanceCheckIn
", "operationId": "postMassAdvanceCheckIn", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request object to Submit Batch job for Mass Advance Check In of Reservations.", "name": "massAdvanceCheckInReservations", "in": "body", "required": true, + "description": "Request object to Submit Batch job for Mass Advance Check In of Reservations.", "schema": { "allOf": [ { @@ -12357,111 +11538,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/massCheckIns": { - "post": { - "description": "Use this API to perform a mass Checkin for reservations.OperationId:postMassCheckIn
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12470,23 +11617,29 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/massCheckIns": { + "post": { "summary": "Mass checkin reservations", + "description": "Use this API to perform a mass Checkin for reservations.OperationId:postMassCheckIn
", "operationId": "postMassCheckIn", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request object to Submit Batch job for Mass Checkin of Reservations.", "name": "massCheckInReservations", "in": "body", "required": true, + "description": "Request object to Submit Batch job for Mass Checkin of Reservations.", "schema": { "allOf": [ { @@ -12496,111 +11649,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/advanceCheckIns": { - "post": { - "description": "At times, when guests arrive to the property prior to a room being ready, you can flag a reservation as Advance Checked In for arrivals due in on the current business date. This enables guests to post charges to their reservation folio prior to check in, and helps the rooms management team prioritize room cleaning and assignment. Individual reservations (including Walk In reservations, Pre Registered reservations, and reservations that are in Queue) and group block reservations can be Advance Checked In.OperationId:postAdvanceCheckIn
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12609,31 +11728,38 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/advanceCheckIns": { + "post": { "summary": "Advance checkin a reservation", + "description": "At times, when guests arrive to the property prior to a room being ready, you can flag a reservation as Advance Checked In for arrivals due in on the current business date. This enables guests to post charges to their reservation folio prior to check in, and helps the rooms management team prioritize room cleaning and assignment. Individual reservations (including Walk In reservations, Pre Registered reservations, and reservations that are in Queue) and group block reservations can be Advance Checked In.OperationId:postAdvanceCheckIn
", "operationId": "postAdvanceCheckIn", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request object to perform Advance Check In of a Reservation.", "name": "advanceCheckInReservation", "in": "body", "required": true, + "description": "Request object to perform Advance Check In of a Reservation.", "schema": { "allOf": [ { @@ -12643,109 +11769,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Reverse an advance check in for a reservation.OperationId:deleteAdvanceCheckIn
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12754,132 +11848,103 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + }, + "delete": { "summary": "Reverse Advance Checkin ", + "description": "Reverse an advance check in for a reservation.OperationId:deleteAdvanceCheckIn
", "operationId": "deleteAdvanceCheckIn", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/checkIns": { - "post": { - "description": "Use this API to check in a guest reservation. The reservation needs to be 'due in' status. The API also provides an option to select an available room.OperationId:postCheckIn
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -12888,159 +11953,128 @@ ], "tags": [ "FrontDeskOperations" - ], - "summary": "Checks in a guest", - "operationId": "postCheckIn", + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/checkIns": { + "delete": { + "summary": "Revert a checked-in Reservation", + "description": "Use this API to revert a reservation that has been checked in. This will return the reservation to a Due in/Arrival status.OperationId:deleteCheckin
", + "operationId": "deleteCheckin", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "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": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of the hotel where reservation is being booked", "name": "hotelId", "in": "path", - "required": true - }, - { - "description": "Validation checks includes the following: - Reservation is not valid to be checked in. - Split is still required before the reservation can be checked in. - Room information is missing. - Payment information is missing. - The status of the room needs to be reviewed. - Sharers was impacted. The check-in process affected the reservation details of shared guests on the reservation. - Sharers was not impacted. The check-in process has not affected the reservation details of shared guests on the reservation.", - "name": "reservation", - "in": "body", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/reservation" - }, - { - "example": { - "fetchReservationInstruction": [ - "ReservationDetail" - ], - "includeNotifications": true, - "reservation": { - "ignoreWarnings": true, - "printRegistration": true, - "roomId": "D209", - "stopCheckin": false - } - } - } - ] - } + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { + "name": "roomStatus", + "in": "query", + "required": false, "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", + "uniqueItems": true, + "enum": [ + "Clean", + "Dirty", + "Pickup", + "Inspected", + "OutOfOrder", + "OutOfService" + ] }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "unassignRoom", + "in": "query", + "required": false, + "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" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "CheckIn response will commonly be errors over warnings. If a check has to be done before checking a reservation to a hotel, then the VerifyCheckinReservation operation can be utilized.", - "schema": { - "$ref": "#/definitions/checkedinReservation" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to revert a reservation that has been checked in. This will return the reservation to a Due in/Arrival status.OperationId:deleteCheckin
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13049,153 +12083,130 @@ ], "tags": [ "FrontDeskOperations" - ], - "summary": "Revert a checked-in Reservation", - "operationId": "deleteCheckin", + ] + }, + "post": { + "summary": "Checks in a guest", + "description": "Use this API to check in a guest reservation. The reservation needs to be 'due in' status. The API also provides an option to select an available room.OperationId:postCheckIn
", + "operationId": "postCheckIn", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "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." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true - }, - { - "uniqueItems": true, - "enum": [ - "Clean", - "Dirty", - "Pickup", - "Inspected", - "OutOfOrder", - "OutOfService" - ], + "required": true, "type": "string", - "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", - "name": "roomStatus", - "in": "query" + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel where reservation is being booked" }, { - "type": "boolean", - "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.", - "name": "unassignRoom", - "in": "query" + "name": "reservation", + "in": "body", + "required": true, + "description": "Validation checks includes the following: - Reservation is not valid to be checked in. - Split is still required before the reservation can be checked in. - Room information is missing. - Payment information is missing. - The status of the room needs to be reviewed. - Sharers was impacted. The check-in process affected the reservation details of shared guests on the reservation. - Sharers was not impacted. The check-in process has not affected the reservation details of shared guests on the reservation.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/reservation" + }, + { + "example": { + "reservation": { + "roomId": "D209", + "ignoreWarnings": true, + "stopCheckin": false, + "printRegistration": true + }, + "fetchReservationInstruction": [ + "ReservationDetail" + ], + "includeNotifications": true + } + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "CheckIn response will commonly be errors over warnings. If a check has to be done before checking a reservation to a hotel, then the VerifyCheckinReservation operation can be utilized.", + "schema": { + "$ref": "#/definitions/checkedinReservation" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/commissionNotes": { - "get": { - "description": "OperationId:getCommissionNotes
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13203,152 +12214,126 @@ "application/json;charset=UTF-8" ], "tags": [ - "Commissions" - ], + "FrontDeskOperations" + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/commissionNotes": { + "get": { "summary": "Operation to fetch commission notes.", + "description": "OperationId:getCommissionNotes
", "operationId": "getCommissionNotes", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Reservation Id for which the commission notes are to be fetched.", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Reservation Id for which the commission notes are to be fetched." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property code against which commissions notes are to be fetched.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property code against which commissions notes are to be fetched." }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "idExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "idContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "type", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response type for fetching commission notes.", - "schema": { - "$ref": "#/definitions/commissionNotesDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response type for fetching commission notes.", + "schema": { + "$ref": "#/definitions/commissionNotesDetails" } }, "204": { "description": "CommissionNotes not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/commissionPaymentDetails": { - "get": { - "description": "You can use this API to fetch commission payment details.OperationId:getCommissionPaymentDetails
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13357,134 +12342,210 @@ ], "tags": [ "Commissions" - ], - "summary": "Fetch Commission Payment Details", - "operationId": "getCommissionPaymentDetails", + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/commissionPaymentDetails": { + "get": { + "summary": "Fetch Commission Payment Details", + "description": "You can use this API to fetch commission payment details.OperationId:getCommissionPaymentDetails
", + "operationId": "getCommissionPaymentDetails", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "x-example": "", - "description": "Unique ID of the hotel", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique ID of the reservation", "name": "reservationId", "in": "path", - "required": true + "required": true, + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the reservation", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response to the request to fetch commission payment details", - "schema": { - "$ref": "#/definitions/commissionPaymentDetails" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response to the request to fetch commission payment details", + "schema": { + "$ref": "#/definitions/commissionPaymentDetails" } }, "204": { "description": "Commission Payment Details not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "Commissions" + ] } }, - "/hotels/{hotelId}/reservations/{reservationId}/linked": { + "/hotels/{hotelId}/reservations/{reservationId}/keyOptions": { "get": { - "description": "Use this API to view the reservations that are linked to the specified reservation.OperationId:getLinkedReservations
", + "summary": "Fetch the keysOptions", + "description": "This API is used to retrieve the key options attached to the room, reservation and profile. 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": "getKeyOptions", + "parameters": [ + { + "name": "reservationId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique identifier of the reservation" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Name of the resort." + }, + { + "$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/keyOptionsInfo" + } + }, + "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" ], @@ -13493,161 +12554,137 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/linked": { + "get": { "summary": "Get linked reservations", + "description": "Use this API to view the reservations that are linked to the specified reservation.OperationId:getLinkedReservations
", "operationId": "getLinkedReservations", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { + "name": "additionalReservationId", + "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" }, - "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.", - "name": "additionalReservationId", - "in": "query" + "required": false }, { + "name": "additionalReservationIdContext", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "name": "additionalReservationIdContext", - "in": "query" + "required": false }, { + "name": "additionalReservationIdType", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A reference to the type of object defined by the UniqueID element.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A reference to the type of object defined by the UniqueID element.", - "name": "additionalReservationIdType", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response of fetch room keys operation.", - "schema": { - "$ref": "#/definitions/linkedReservations" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response of fetch room keys operation.", + "schema": { + "$ref": "#/definitions/linkedReservations" } }, "204": { "description": "LinkedReservations not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/priority": { - "put": { - "description": "This API can be used to change the resrevations Queue Priority.OperationId:putReservationQueuePriority
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13656,31 +12693,38 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/priority": { + "put": { "summary": "Change the reservation queue priority", + "description": "This API can be used to change the resrevations Queue Priority.OperationId:putReservationQueuePriority
", "operationId": "putReservationQueuePriority", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to change the current priority of a reservation in Queue for Check-In.", "name": "reservationQueuePriorityNumber", "in": "body", "required": true, + "description": "Request to change the current priority of a reservation in Queue for Check-In.", "schema": { "allOf": [ { @@ -13690,111 +12734,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response for the Change Queue Priority request.", - "schema": { - "$ref": "#/definitions/reservationQueuePriority" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 Change Queue Priority request.", + "schema": { + "$ref": "#/definitions/reservationQueuePriority" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/roomAssignments": { - "post": { - "description": "This API will allow you to assign a room to a reservation in reserved status. Override instructions are available to assign a room despite warnings returned in the response message.OperationId:postRoomAssignment
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13803,31 +12813,38 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/roomAssignments": { + "post": { "summary": "Assign a Room to a Reservation", + "description": "This API will allow you to assign a room to a reservation in reserved status. Override instructions are available to assign a room despite warnings returned in the response message.OperationId:postRoomAssignment
", "operationId": "postRoomAssignment", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "The reservation must still be reserved to use this operation.", "name": "room", "in": "body", "required": true, + "description": "The reservation must still be reserved to use this operation.", "schema": { "allOf": [ { @@ -13837,111 +12854,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "Possible errors that the operation will generate: The reservation is not in Reserved state. The room being requested does not exist.", - "schema": { - "$ref": "#/definitions/assignedRoom" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Possible errors that the operation will generate: The reservation is not in Reserved state. The room being requested does not exist.", + "schema": { + "$ref": "#/definitions/assignedRoom" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/roomKeys": { - "get": { - "description": "You can use this API to retrieve any existing room key information for a reservation.OperationId:getRoomKeys
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -13950,129 +12933,111 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/roomKeys": { + "get": { "summary": "Fetch the room keys", + "description": "You can use this API to retrieve any existing room key information for a reservation.OperationId:getRoomKeys
", "operationId": "getRoomKeys", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "includeInactiveRoomKeys", + "in": "query", + "required": false, + "description": "Setting this to true will include inactive rooms keys details. This is supported when OPERA Control Multiple Guest Room Key is active.", + "type": "boolean" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response of fetch room keys operation.", - "schema": { - "$ref": "#/definitions/roomKeyInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response of fetch room keys operation.", + "schema": { + "$ref": "#/definitions/roomKeyInfo" } }, "204": { "description": "RoomKeys not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "When MUTIPLE_GUEST_KEY is active this methods can be used to update information on the room keys such as balance amount and keyOptions. reservationId and hotelId are required path parameters. The body parameter roomKeys includes information about the encoder, room, key type, key validity, key options and guests information for multiple keys", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14081,142 +13046,116 @@ ], "tags": [ "FrontDeskOperations" - ], - "summary": "Update room keys.", - "operationId": "putRoomKeys", + ] + }, + "post": { + "summary": "Requests room key(s)", + "description": "You can use this API to create a room key request for a reservation to the active Door Locking System Property Interface.OperationId:postRoomKey
", + "operationId": "postRoomKey", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Room key information", - "name": "roomKeys", + "name": "roomKey", "in": "body", "required": true, + "description": "Request for generation of room key.", "schema": { - "$ref": "#/definitions/roomKeyMultipleGuests" + "allOf": [ + { + "$ref": "#/definitions/roomKey" + } + ] } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "OperationId:postRoomKey
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14225,143 +13164,103 @@ ], "tags": [ "FrontDeskOperations" - ], - "summary": "Requests room key(s)", - "operationId": "postRoomKey", + ] + }, + "delete": { + "summary": "Delete room key", + "description": "This API will delete room keys on a reservation.OperationId:deleteRoomKey
", + "operationId": "deleteRoomKey", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true - }, - { - "description": "Request for generation of room key.", - "name": "roomKey", - "in": "body", "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/roomKey" - } - ] - } + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "Response for room key creation.", - "schema": { - "$ref": "#/definitions/roomKeyDetails" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "This API will delete room keys on a reservation.OperationId:deleteRoomKey
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14370,132 +13269,112 @@ ], "tags": [ "FrontDeskOperations" - ], - "summary": "Delete room key", - "operationId": "deleteRoomKey", + ] + }, + "put": { + "summary": "Update room keys.", + "description": "When MUTIPLE_GUEST_KEY is active this methods can be used to update information on the room keys such as balance amount and keyOptions. reservationId and hotelId are required path parameters. The body parameter roomKeys includes information about the encoder, room, key type, key validity, key options and guests information for multiple keys", + "operationId": "putRoomKeys", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true - }, - { + "required": true, "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "name": "roomKeys", + "in": "body", + "required": true, + "description": "Room key information", + "schema": { + "$ref": "#/definitions/roomKeyMultipleGuests" + } }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Location of updated resource" } + }, + "description": "OperationId:getRoomMoveHistory
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14504,143 +13383,118 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/roomMoveHistory": { + "get": { "summary": "Get room move history of a reservation", + "description": "This API will return the history of room change/room moves for a specified reservation.OperationId:getRoomMoveHistory
", "operationId": "getRoomMoveHistory", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "reservationIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "reservationIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response for the fetch room move history of a reservation.", - "schema": { - "$ref": "#/definitions/roomMoveHistory" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response for the fetch room move history of a reservation.", + "schema": { + "$ref": "#/definitions/roomMoveHistory" } }, "204": { "description": "RoomMoveHistory not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/rooms": { - "put": { - "description": "This API will allow you to remove an assigned room from a reservation in reserved status.OperationId:deleteAssignRoom
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14649,31 +13503,38 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/rooms": { + "put": { "summary": "Remove an assigned room", + "description": "This API will allow you to remove an assigned room from a reservation in reserved status.OperationId:deleteAssignRoom
", "operationId": "deleteAssignRoom", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to the remove a room(unassign) from a reserved reservation.", "name": "unAssignRoomCriteria", "in": "body", "required": true, + "description": "Request to the remove a room(unassign) from a reserved reservation.", "schema": { "allOf": [ { @@ -14683,111 +13544,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/unAssignedRoom" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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/unAssignedRoom" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/rooms/{roomId}/roomMoves": { - "put": { - "description": "This API will allow you to change rooms for an in-house guest.OperationId:moveInHouseGuest
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14796,39 +13623,47 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/rooms/{roomId}/roomMoves": { + "put": { "summary": "Move in-house guest", + "description": "This API will allow you to change rooms for an in-house guest.OperationId:moveInHouseGuest
", "operationId": "moveInHouseGuest", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "roomId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "To move a reservation, the reservation needs to be in Checked-In state.", "name": "moveInHouseGuest", "in": "body", "required": true, + "description": "To move a reservation, the reservation needs to be in Checked-In state.", "schema": { "allOf": [ { @@ -14838,111 +13673,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room's occupancy level has been compromised. - The room's pricing is NOT available.", - "schema": { - "$ref": "#/definitions/movedInHouseGuest" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room's occupancy level has been compromised. - The room's pricing is NOT available.", + "schema": { + "$ref": "#/definitions/movedInHouseGuest" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/suggestedRooms": { - "get": { - "description": "You can use this API to fetch the suggested rooms.OperationId:getSuggestedRooms
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -14951,166 +13752,141 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/suggestedRooms": { + "get": { "summary": "Get Suggested Rooms", + "description": "You can use this API to fetch the suggested rooms.OperationId:getSuggestedRooms
", "operationId": "getSuggestedRooms", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Unique reservation identifier for the reservation.", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique reservation identifier for the reservation." }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", - "description": "Property where the reservation exists.", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Property where the reservation exists." }, { - "type": "string", - "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.", "name": "roomType", - "in": "query" + "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." }, { - "type": "string", - "format": "date", - "description": "Date of arrival.", "name": "startDate", - "in": "query" + "in": "query", + "required": false, + "description": "Date of arrival.", + "type": "string", + "format": "date" }, { - "type": "integer", - "description": "Number of nights that guest will be staying.", "name": "nights", - "in": "query" + "in": "query", + "required": false, + "description": "Number of nights that guest will be staying.", + "type": "integer" }, { - "uniqueItems": true, + "name": "suggestedRoomsInstructions", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Instruction to include commponent room.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "ComponentRoom" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Instruction to include commponent room.", - "name": "suggestedRoomsInstructions", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "List of suggested rooms for room assignment.", - "schema": { - "$ref": "#/definitions/suggestedRooms" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "List of suggested rooms for room assignment.", + "schema": { + "$ref": "#/definitions/suggestedRooms" } }, "204": { "description": "SuggestedRooms not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/textMessages/{messageType}": { - "put": { - "description": "This API will deliver Queue rooms text message.OperationId:deliverQueueRoomsTextMessage
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15119,39 +13895,47 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/textMessages/{messageType}": { + "put": { "summary": "Deliver Queue rooms text message", + "description": "This API will deliver Queue rooms text message.OperationId:deliverQueueRoomsTextMessage
", "operationId": "deliverQueueRoomsTextMessage", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "messageType", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to deliver a text message via Queue Reservations (for a guest) or Queue Rush (for housekeeping).", "name": "deliverQueueRoomsTextMessage", "in": "body", "required": true, + "description": "Request to deliver a text message via Queue Reservations (for a guest) or Queue Rush (for housekeeping).", "schema": { "allOf": [ { @@ -15161,111 +13945,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response for delivering a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).", - "schema": { - "$ref": "#/definitions/QueueRoomsTextMessage" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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 delivering a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).", + "schema": { + "$ref": "#/definitions/QueueRoomsTextMessage" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/verifyCheckIns": { - "get": { - "description": "Use this API to verify checkin reservations.OperationId:verifyCheckinReservation
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15274,146 +14024,122 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/reservations/{reservationId}/verifyCheckIns": { + "get": { "summary": "Verify checkin reservation", + "description": "Use this API to verify checkin reservations.OperationId:verifyCheckinReservation
", "operationId": "verifyCheckinReservation", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "uniqueItems": true, + "name": "verifyCheckinInstructions", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Instructions for including in the request when retrieving reservation information. Voucher - indicates to generate vouchers,if reservation matches voucher rule.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "AuthorizationInfo", - "ExcludeRoomSuggestion" - ], - "type": "string" + "ExcludeRoomSuggestion", + "Keys", + "Voucher" + ] }, - "collectionFormat": "multi", - "description": "Instruction to exclude suggested rooms.", - "name": "verifyCheckinInstructions", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Reservation record showing the current state of the reservation.", - "schema": { - "$ref": "#/definitions/verifiedCheckinReservation" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Reservation record showing the current state of the reservation.", + "schema": { + "$ref": "#/definitions/verifiedCheckinReservation" } }, "204": { "description": "verifyCheckinReservation not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls": { - "get": { - "description": "Use thisAPI to get existing wake up call on an in-house reservation.OperationId:getWakeUpCall
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15422,222 +14148,211 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/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
", "operationId": "getWakeUpCall", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "boolean", - "description": "Specifies whether we should fetch wake up calls with pending status.", "name": "fetchCancelled", - "in": "query" + "in": "query", + "required": false, + "description": "Specifies whether we should fetch wake up calls with pending status.", + "type": "boolean" }, { - "type": "boolean", - "description": "Specifies whether we should fetch wake up calls with pending status.", "name": "fetchCompleted", - "in": "query" + "in": "query", + "required": false, + "description": "Specifies whether we should fetch wake up calls with pending status.", + "type": "boolean" }, { - "type": "boolean", - "description": "Specifies whether we should fetch wake up calls with pending status.", "name": "fetchNoAnswer", - "in": "query" + "in": "query", + "required": false, + "description": "Specifies whether we should fetch wake up calls with pending status.", + "type": "boolean" }, { - "type": "boolean", - "description": "Specifies whether we should fetch wake up calls with pending status.", "name": "fetchPending", - "in": "query" + "in": "query", + "required": false, + "description": "Specifies whether we should fetch wake up calls with pending status.", + "type": "boolean" }, { - "type": "integer", - "description": "Additional identifying value assigned by the creating system.", "name": "idExtension", - "in": "query" + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "reservationIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "reservationIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "format": "date", - "description": "Begin date from which to start fetching wake up calls.", "name": "beginDate", - "in": "query" + "in": "query", + "required": false, + "description": "Begin date from which to start fetching wake up calls.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", - "description": "End date from which to start fetching wake up calls.", "name": "endDate", - "in": "query" + "in": "query", + "required": false, + "description": "End date from which to start fetching wake up calls.", + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date-time", - "description": "Begin time from which to start fetching wake up calls.", "name": "beginTime", - "in": "query" + "in": "query", + "required": false, + "description": "Begin time from which to start fetching wake up calls.", + "type": "string", + "format": "date-time" }, { - "type": "string", - "format": "date-time", - "description": "End time from which to start fetching wake up calls.", "name": "endTime", - "in": "query" + "in": "query", + "required": false, + "description": "End time from which to start fetching wake up calls.", + "type": "string", + "format": "date-time" }, { + "name": "room", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "Hotel room(s) for which wake up calls are to be fetched.", - "name": "room", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "Block code for which wake up calls are to be fetched.", "name": "blockId", - "in": "query" + "in": "query", + "required": false, + "description": "Block code for which wake up calls are to be fetched.", + "type": "string" }, { - "type": "string", - "description": "Name with which wake up call may be associated.", "name": "guestName", - "in": "query" + "in": "query", + "required": false, + "description": "Name with which wake up call may be associated.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Fetch wake up calls response.", - "schema": { - "$ref": "#/definitions/wakeUpCalls" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Fetch wake up calls response.", + "schema": { + "$ref": "#/definitions/wakeUpCalls" } }, "204": { "description": "WakeUpCall not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "Update an existing wake up call. Wake up call can only be added to in-house reservations.OperationId:putWakeUpCall
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15646,31 +14361,36 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + }, + "put": { "summary": "Change Wake Up Call", + "description": "Update an existing wake up call. Wake up call can only be added to in-house reservations.OperationId:putWakeUpCall
", "operationId": "putWakeUpCall", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to change a wake up call.", "name": "wakeUpCalls", "in": "body", "required": true, + "description": "Request to change a wake up call.", "schema": { "allOf": [ { @@ -15680,109 +14400,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/changedWakeUpCalls" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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/changedWakeUpCalls" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "You can set, view, and cancel wake up call for individual reservations. The reservation must be in-house (checked-in) status to set a wake up call.OperationId:postWakeUpCall
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15791,143 +14479,158 @@ ], "tags": [ "FrontDeskOperations" - ], - "summary": "Create Wake Up Call", - "operationId": "postWakeUpCall", + ] + }, + "delete": { + "summary": "Delete Wake Up Call", + "description": "Use this API to cancel a wake up call on a reservation.OperationId:deleteWakeUpCall
", + "operationId": "deleteWakeUpCall", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to create a wake up call.", - "name": "wakeUpCalls", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/wakeUpCalls" - } - ] - } + "name": "callTime", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Time on which wake up call is set.", + "items": { + "type": "string", + "format": "date-time" + }, + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "followUpCallTime", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Follow up call time.", + "items": { + "type": "string", + "format": "date-time" + }, + "required": false }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", + "name": "startDate", + "in": "query", + "required": false, "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "format": "date" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "name": "newCallTime", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "New Time on which wake up call is set. Used to change the Followup Call time", + "items": { + "type": "string", + "format": "date-time" + }, + "required": false }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "name": "newFollowUpCallTime", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "New Follow up call time.Used to change the Followup Call time.", + "items": { + "type": "string", + "format": "date-time" + }, + "required": false }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "200": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "delete": { - "description": "Use this API to cancel a wake up call on a reservation.OperationId:deleteWakeUpCall
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -15936,182 +14639,116 @@ ], "tags": [ "FrontDeskOperations" - ], - "summary": "Delete Wake Up Call", - "operationId": "deleteWakeUpCall", + ] + }, + "post": { + "summary": "Create Wake Up Call", + "description": "You can set, view, and cancel wake up call for individual reservations. The reservation must be in-house (checked-in) status to set a wake up call.OperationId:postWakeUpCall
", + "operationId": "postWakeUpCall", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "reservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true - }, - { - "type": "array", - "items": { - "type": "string", - "format": "date-time" - }, - "collectionFormat": "multi", - "description": "Time on which wake up call is set.", - "name": "callTime", - "in": "query" - }, - { - "type": "array", - "items": { - "type": "string", - "format": "date-time" - }, - "collectionFormat": "multi", - "description": "Follow up call time.", - "name": "followUpCallTime", - "in": "query" - }, - { + "required": true, "type": "string", - "format": "date", - "name": "startDate", - "in": "query" - }, - { - "type": "array", - "items": { - "type": "string", - "format": "date-time" - }, - "collectionFormat": "multi", - "description": "New Time on which wake up call is set. Used to change the Followup Call time", - "name": "newCallTime", - "in": "query" + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "array", - "items": { - "type": "string", - "format": "date-time" - }, - "collectionFormat": "multi", - "description": "New Follow up call time.Used to change the Followup Call time.", - "name": "newFollowUpCallTime", - "in": "query" + "name": "wakeUpCalls", + "in": "body", + "required": true, + "description": "Request to create a wake up call.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/wakeUpCalls" + } + ] + } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, + "201": { "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/roomKeysDetails": { - "get": { - "description": "This API can be used to read the Room Key.OperationId:readRoomKey
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16120,146 +14757,131 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/roomKeysDetails": { + "get": { "summary": "Read room key", + "description": "This API can be used to read the Room Key.OperationId:readRoomKey
", "operationId": "readRoomKey", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", "name": "encoderTerminal", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { + "name": "interfaceId", + "in": "query", + "required": false, "type": "string", - "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.", + "minLength": 1, + "maxLength": 2000, + "description": "Unique DB internal number of a Hotel Interface record." + }, + { "name": "encoderId", - "in": "query" + "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" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "encoderIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "encoderIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Respose for the reading of room key.", - "schema": { - "$ref": "#/definitions/roomKeyStatus" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Respose for the reading of room key.", + "schema": { + "$ref": "#/definitions/roomKeyStatus" } }, "204": { "description": "readRoomKey not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/roomStatusStatistics": { - "get": { - "description": "For current business date, rooms are grouped by the roomClass and roomType to display their housekeeping roomStatus.", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16267,98 +14889,92 @@ "application/json;charset=UTF-8" ], "tags": [ - "FOFStats" - ], + "FrontDeskOperations" + ] + } + }, + "/hotels/{hotelId}/roomStatusStatistics": { + "get": { "summary": "Get counts of rooms by housekeeping status and front office status.", + "description": "For current business date, rooms are grouped by the roomClass and roomType to display their housekeeping roomStatus.", "operationId": "getRoomsByRoomStatus", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { + "name": "frontOfficeStatus", + "in": "query", + "required": false, + "description": "Filter by frontOfficeStatus. If nothing is passed, we fetch all.", + "type": "string", "enum": [ "Vacant", "Occupied" - ], - "type": "string", - "description": "Filter by frontOfficeStatus. If nothing is passed, we fetch all.", - "name": "frontOfficeStatus", - "in": "query" + ] } ], "responses": { "200": { - "description": "Response element for housekeeping statistics.", - "schema": { - "$ref": "#/definitions/roomStatusStatisticsListType" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response element for housekeeping statistics.", + "schema": { + "$ref": "#/definitions/roomStatusStatisticsListType" } }, "204": { "description": "RoomStatusStatistics not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/rooms": { - "get": { - "description": "Use this API to return available rooms based on search criteria such as hotelId, hotelRoomStatus, roomType, roomFeatureCode,etc.OperationId:getHotelRooms
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -16366,41 +14982,55 @@ "application/json;charset=UTF-8" ], "tags": [ - "FrontDeskOperations" - ], + "FOFStats" + ] + } + }, + "/hotels/{hotelId}/rooms": { + "get": { "summary": "Get hotel available rooms", + "description": "Use this API to return available rooms based on search criteria such as hotelId, hotelRoomStatus, roomType, roomFeatureCode,etc.OperationId:getHotelRooms
", "operationId": "getHotelRooms", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "integer", - "description": "Indicates maximum number of records a Web Service should return.", "name": "limit", - "in": "query" + "in": "query", + "required": false, + "description": "Indicates maximum number of records a Web Service should return.", + "type": "integer" }, { - "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.", - "name": "offset", - "in": "query" + "type": "integer" }, { - "type": "string", "name": "roomNumberWildcard", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "uniqueItems": true, + "name": "hotelRoomStatus", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Clean", "Dirty", @@ -16408,809 +15038,820 @@ "Inspected", "OutOfOrder", "OutOfService" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", - "name": "hotelRoomStatus", - "in": "query" + "required": false }, { - "uniqueItems": true, + "name": "hotelFORoomStatus", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Vacant", "Occupied" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.", - "name": "hotelFORoomStatus", - "in": "query" + "required": false }, { - "type": "string", "name": "fromRoomNumber", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", "name": "toRoomNumber", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { - "type": "string", - "format": "date", "name": "hotelRoomStartDate", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "format": "date" }, { - "type": "string", - "format": "date", "name": "hotelRoomEndDate", - "in": "query" + "in": "query", + "required": false, + "type": "string", + "format": "date" }, { - "type": "string", "name": "duration", - "in": "query" + "in": "query", + "required": false, + "type": "string" }, { + "name": "roomType", + "in": "query", "type": "array", - "items": { - "maxItems": 4000, - "type": "string" - }, "collectionFormat": "multi", "description": "The room types of hotel rooms to be fetched.", - "name": "roomType", - "in": "query" + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false }, { - "type": "string", - "description": "The room class of hotel rooms to be fetched.", "name": "roomClass", - "in": "query" + "in": "query", + "required": false, + "description": "The room class of hotel rooms to be fetched.", + "type": "string" }, { - "type": "string", - "description": "The floor of room to be fetched.", "name": "floor", - "in": "query" + "in": "query", + "required": false, + "description": "The floor of room to be fetched.", + "type": "string" }, { - "type": "boolean", - "description": "This flag when set to true will include rooms assigned to due out reservations.", "name": "includeDueOut", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will include rooms assigned to due out reservations.", + "type": "boolean" }, { - "type": "string", - "format": "date-time", - "description": "When IncludeDueOut is enable,it is the departure time before which to search.", "name": "departureTime", - "in": "query" + "in": "query", + "required": false, + "description": "When IncludeDueOut is enable,it is the departure time before which to search.", + "type": "string", + "format": "date-time" }, { + "name": "roomFeatureCode", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A code representing a room feature.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A code representing a room feature.", - "name": "roomFeatureCode", - "in": "query" + "required": false }, { + "name": "description", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "A code representing a room feature.", "items": { "type": "string" }, - "collectionFormat": "multi", - "description": "A code representing a room feature.", - "name": "description", - "in": "query" + "required": false }, { + "name": "orderSequence", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Display Order sequence.", "items": { "type": "number" }, - "collectionFormat": "multi", - "description": "Display Order sequence.", - "name": "orderSequence", - "in": "query" + "required": false }, { + "name": "quantity", + "in": "query", "type": "array", + "collectionFormat": "multi", + "description": "Indicates quantity.", "items": { "type": "integer" }, - "collectionFormat": "multi", - "description": "Indicates quantity.", - "name": "quantity", - "in": "query" + "required": false }, { - "type": "string", - "description": "The smoking preference of room to be fetched.", "name": "smokingPreference", - "in": "query" + "in": "query", + "required": false, + "description": "The smoking preference of room to be fetched.", + "type": "string" }, { - "type": "boolean", - "description": "This flag when set to true will include all room conditions, when set to false then room with \"General Assignment\" condition type will be excluded from the result.", "name": "includeAllRoomConditions", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will include all room conditions, when set to false then room with \"General Assignment\" condition type will be excluded from the result.", + "type": "boolean" }, { - "type": "boolean", - "description": "This flag when set to true will include all component rooms", "name": "includeComponentRooms", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will include all component rooms", + "type": "boolean" }, { - "type": "boolean", - "description": "This flag when set to true will include all pseudo rooms", "name": "includePseudoRooms", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will include all pseudo rooms", + "type": "boolean" }, { - "type": "boolean", - "description": "This flag when set to true will work for Available Rooms functionality", "name": "includeOORoomCheck", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will work for Available Rooms functionality", + "type": "boolean" }, { - "type": "boolean", - "description": "This flag when set to true will include only connecting rooms.", "name": "connectingRoomsOnly", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will include only connecting rooms.", + "type": "boolean" }, { - "type": "string", - "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.", "name": "reservationId", - "in": "query" + "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" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "reservationIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "reservationIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "boolean", - "description": "This flag when set to true will include only pseudo rooms", "name": "pseudoRoomsOnly", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will include only pseudo rooms", + "type": "boolean" }, { - "type": "boolean", - "description": "This flag when set to true will includes attendent in Rooms", "name": "includeAttendentInRoom", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will includes attendent in Rooms", + "type": "boolean" }, { - "type": "boolean", - "description": "This flag when set to true will return the rotation room when room roation parameter is active and the room type is configured for rotation.", "name": "includeRotationRoom", - "in": "query" + "in": "query", + "required": false, + "description": "This flag when set to true will return the rotation room when room roation parameter is active and the room type is configured for rotation.", + "type": "boolean" }, { - "type": "boolean", - "description": "When this flag is set to true, this API will fetch rooms which are contracted with owner profiles. This is supported when OPERA Control Room Rotation is active.", "name": "ownerRoomsOnly", - "in": "query" + "in": "query", + "required": false, + "description": "When this flag is set to true, this API will fetch rooms which are contracted with owner profiles. This is supported when OPERA Control Room Rotation is active.", + "type": "boolean" }, { - "type": "boolean", - "description": "When this flag is set to true, this API will fetch rooms can only be used by the reservation's profile (owner) of the room. This is supported when OPERA Control Room Rotation is active.", "name": "ownerExclusiveRoomsOnly", - "in": "query" + "in": "query", + "required": false, + "description": "When this flag is set to true, this API will fetch rooms can only be used by the reservation's profile (owner) of the room. This is supported when OPERA Control Room Rotation is active.", + "type": "boolean" }, { - "type": "boolean", - "description": "When this flag is set to true, this API will fetch only those rooms that have exactly Y nights free with the reservation guest?s points. This query parameter is supported when OPERA Control Room Rotation and Forecast Rotation Points are active.", "name": "perfectFitRoomsOnly", - "in": "query" + "in": "query", + "required": false, + "description": "When this flag is set to true, this API will fetch only those rooms that have exactly Y nights free with the reservation guest(s) points.", + "type": "boolean" }, { + "name": "orderBy", + "in": "query", + "type": "string", + "description": "A collection of supported sorting for available rooms search results.", "uniqueItems": true, "enum": [ "ForecastRotationPoints" ], - "type": "string", - "description": "A collection of supported sorting for available rooms search results.", - "name": "orderBy", - "in": "query" + "required": false }, { + "name": "unitGradeCodes", + "in": "query", "type": "array", - "items": { - "type": "string" - }, "collectionFormat": "multi", + "required": false, "description": "Fetches rooms that matches requested unit grade codes. Only returns when Room Rotation and Unit Grade are active.", - "name": "unitGradeCodes", - "in": "query" + "items": { + "type": "string" + } }, { - "type": "string", - "description": ": This OPERA profile?s internal Id will be used with ownerExclusiveRoomOnly flag to return the room which own by this profile. This query parameter is supported when OPERA Control Room Rotation is active.", "name": "ownerExclusiveRoomProfileId", - "in": "query" + "in": "query", + "required": false, + "description": ": This OPERA profile?s internal Id will be used with ownerExclusiveRoomOnly flag to return the room which own by this profile. This query parameter is supported when OPERA Control Room Rotation is active.", + "type": "string" }, { - "maxItems": 4000, + "name": "excludeRoomFeatures", + "in": "query", "type": "array", + "maxItems": 4000, + "collectionFormat": "multi", + "description": "It indicates to exclude rooms with the selected Room Feature(s).It allows alphanumeric values(e.g.,TUB,BOLCONY,MV)", "items": { - "maxLength": 20, + "type": "string", "minLength": 0, - "type": "string" + "maxLength": 20 }, - "collectionFormat": "multi", - "description": "It indicates to exclude rooms with the selected Room Feature(s).It allows alphanumeric values(e.g.,TUB,BOLCONY,MV)", - "name": "excludeRoomFeatures", - "in": "query" + "required": false }, { - "maxItems": 4000, + "name": "excludeFloorPreferences", + "in": "query", "type": "array", + "maxItems": 4000, + "collectionFormat": "multi", + "description": "It indicates to exclude rooms with the selected Floor(s) which are comma separated values.It allows alphanumeric values(e.g.,01,02,03,GROUND,five)", "items": { - "maxLength": 20, + "type": "string", "minLength": 0, - "type": "string" + "maxLength": 20 }, - "collectionFormat": "multi", - "description": "It indicates to exclude rooms with the selected Floor(s) which are comma separated values.It allows alphanumeric values(e.g.,01,02,03,GROUND,five)", - "name": "excludeFloorPreferences", - "in": "query" + "required": false }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "List of suggested rooms for room assignment.", - "schema": { - "$ref": "#/definitions/hotelRooms" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } }, + "description": "List of suggested rooms for room assignment.", + "schema": { + "$ref": "#/definitions/hotelRooms" + }, "examples": { "application/json": { - "count": 0, - "hasMore": true, "hotelRoomsDetails": { - "hotelId": "string", "room": [ { + "roomType": { + "pseudo": true, + "suite": true, + "roomClass": "string", + "shortDescription": "string", + "houseKeeping": true, + "smokingPreference": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "minimumOccupancy": 0, + "maximumOccupancy": 0, + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "accessible": true, + "roomType": "string", + "meetingRoom": true + }, + "floor": "string", + "floorDescription": "string", + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "roomDescription": "string", + "description": { + "defaultText": "string", + "translatedTexts": { + "text": [ + { + "value": "string", + "language": "string" + } + ] + } + }, + "smokingPreference": "string", + "smokingPreferenceDescription": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", "accessible": true, + "roomId": "string", + "meetingRoom": true, + "roomSection": { + "daySectionCode": "string", + "eveningSectionCode": "string" + }, + "housekeeping": { + "roomStatus": { + "reservationStatusList": [ + "Arrival" + ], + "roomStatus": "Clean", + "frontOfficeStatus": "Vacant", + "housekeepingStatus": "Vacant" + }, + "roomPersons": { + "frontOfficePersons": 0, + "houseKeepingPersons": 0 + }, + "guestServiceRequest": "DoNotDisturb", + "cleaningPriority": { + "prioritySequence": 0 + }, + "roomCondition": { + "roomCondition": { + "code": "string", + "description": "string" + }, + "assignmentType": "Available", + "remarks": "string" + }, + "linenChange": true, + "facilityTaskCode": [ + "string" + ] + }, + "outOfOrder": [ + { + "repairRemarks": "string", + "returnStatus": "Clean", + "reasonCode": "string", + "reasonDesc": "string", + "newDateRange": { + "start": "2020-07-14", + "end": "2020-07-14" + }, + "roomStatus": "Clean", + "start": "2020-07-14", + "end": "2020-07-14" + } + ], + "discrepancy": [ + "Sleep" + ], + "sitePlanSection": { + "sectionCode": "string", + "sectionType": "string", + "linkCode": "string", + "coordinates": "string", + "description": "string" + }, + "componentRoomNumber": "string", + "connectingRooms": [ + { + "roomType": { + "pseudo": true, + "suite": true, + "roomClass": "string", + "shortDescription": "string", + "houseKeeping": true, + "smokingPreference": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "minimumOccupancy": 0, + "maximumOccupancy": 0, + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "accessible": true, + "roomType": "string", + "meetingRoom": true + }, + "floor": "string", + "floorDescription": "string", + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "roomDescription": "string", + "description": { + "defaultText": "string", + "translatedTexts": { + "text": [ + { + "value": "string", + "language": "string" + } + ] + } + }, + "smokingPreference": "string", + "smokingPreferenceDescription": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "accessible": true, + "roomId": "string", + "meetingRoom": true, + "roomCondition": { + "code": "string", + "description": "string" + } + } + ], + "componentRooms": [ + { + "roomType": { + "pseudo": true, + "suite": true, + "roomClass": "string", + "shortDescription": "string", + "houseKeeping": true, + "smokingPreference": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "minimumOccupancy": 0, + "maximumOccupancy": 0, + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "accessible": true, + "roomType": "string", + "meetingRoom": true + }, + "floor": "string", + "floorDescription": "string", + "roomFeatures": [ + { + "code": "string", + "description": "string", + "orderSequence": 0, + "quantity": 0 + } + ], + "roomDescription": "string", + "description": { + "defaultText": "string", + "translatedTexts": { + "text": [ + { + "value": "string", + "language": "string" + } + ] + } + }, + "smokingPreference": "string", + "smokingPreferenceDescription": "string", + "building": "string", + "roomAssignmentRating": "MostImportant", + "accessible": true, + "roomId": "string", + "meetingRoom": true, + "roomCondition": { + "code": "string", + "description": "string" + } + } + ], "attendant": [ { + "section": { + "hotelId": "string", + "code": "string", + "description": "string", + "sectionGroup": "string", + "targetCredits": 0, + "rooms": 0, + "roomCredits": 0, + "sequence": 0, + "inactive": true + }, + "floor": "string", + "attendantId": "string", + "attendantName": "string", + "hotelId": "string", "activeFlag": "string", + "sunday": true, + "monday": true, + "tuesday": true, + "wednesday": true, + "thursday": true, + "friday": true, + "saturday": true, "appUser": { + "hotel": { + "code": "string", + "description": "string" + }, + "appUser": "string", + "lDAPUser": "string", "actAs": "string", "actAt": "string", - "appUser": "string", + "userDefaultLanguage": "string", "appUserId": { "id": "string", "type": "string" }, - "attendantInfo": { - "attendantId": "string", - "hotelId": "string" - }, "cashierId": 0, "cashierTitle": "string", "department": "string", "departmentLocation": "string", - "disabledUntil": "2020-07-14", + "salesRepCode": "string", "expiryDate": "2020-07-14", - "hotel": { - "code": "string", - "description": "string" - }, - "lDAPUser": "string", + "disabledUntil": "2020-07-14", "passwordChangeDate": "2020-07-14", - "salesRepCode": "string", - "userDefaultLanguage": "string", "userInfo": { + "personName": { + "namePrefix": "string", + "givenName": "string", + "middleName": "string", + "surname": "string", + "nameSuffix": "string", + "nameTitle": "string", + "nameTitleSuffix": 0, + "envelopeGreeting": "string", + "salutation": "string", + "nameType": "Primary", + "language": "string", + "externalSystem": "string" + }, + "profileId": { + "id": "string", + "type": "string" + }, "addressInfo": { "address": { "addressLine": [ "string" ], - "barCode": "string", - "cityExtension": "string", "cityName": "string", + "postalCode": "string", + "cityExtension": "string", + "county": "string", + "state": "string", "country": { - "code": "string", - "value": "string" + "value": "string", + "code": "string" }, - "county": "string", - "createDateTime": "2020-07-14T09:54:54.236Z", - "creatorId": "string", "language": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:54:54.236Z", - "postalCode": "string", - "primaryInd": true, - "purgeDate": "2020-07-14", - "state": "string", "type": "string", "typeDescription": "string", - "updateReservations": true + "primaryInd": true, + "updateReservations": true, + "barCode": "string", + "createDateTime": "2020-07-14T09:54:54.236Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:54:54.236Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" }, "id": "string", "type": "string" }, - "birthDate": "2020-07-14", - "birthDateMasked": "string", - "department": { - "code": "string", - "description": "string" - }, "emailInfo": { "email": { - "createDateTime": "2020-07-14T09:54:54.236Z", - "creatorId": "string", "emailAddress": "string", + "type": "string", + "typeDescription": "string", "emailFormat": "Html", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:54:54.236Z", - "orderSequence": 0, "primaryInd": true, - "purgeDate": "2020-07-14", - "type": "string", - "typeDescription": "string" + "orderSequence": 0, + "createDateTime": "2020-07-14T09:54:54.236Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:54:54.236Z", + "lastModifierId": "string", + "purgeDate": "2020-07-14" }, "id": "string", "type": "string" }, - "gender": "Male", - "personName": { - "envelopeGreeting": "string", - "externalSystem": "string", - "givenName": "string", - "language": "string", - "middleName": "string", - "namePrefix": "string", - "nameSuffix": "string", - "nameTitle": "string", - "nameTitleSuffix": 0, - "nameType": "Primary", - "salutation": "string", - "surname": "string" - }, "phoneInfo": { - "id": "string", "telephone": { - "createDateTime": "2020-07-14T09:54:54.236Z", - "creatorId": "string", - "extension": "string", - "lastModifierId": "string", - "lastModifyDateTime": "2020-07-14T09:54:54.236Z", - "orderSequence": 0, - "phoneNumber": "string", "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", + "phoneNumber": "string", + "extension": "string", "primaryInd": true, + "orderSequence": 0, + "createDateTime": "2020-07-14T09:54:54.236Z", + "creatorId": "string", + "lastModifyDateTime": "2020-07-14T09:54:54.236Z", + "lastModifierId": "string", "purgeDate": "2020-07-14" }, - "type": "string" - }, - "profileId": { "id": "string", "type": "string" - } + }, + "department": { + "code": "string", + "description": "string" + }, + "gender": "Male", + "birthDate": "2020-07-14", + "birthDateMasked": "string" }, "userSessionInfo": { "businessDate": "2020-07-14", - "cROCountryCode": "string", - "chain": "string", - "cro": { + "systemDate": "2020-07-14", + "terminal": "string", + "runningApp": "string", + "shareProfiles": true, + "hotel": { "code": "string", "description": "string" }, - "hotel": { + "cro": { "code": "string", "description": "string" }, - "parameters": [ - { - "parameterName": "string", - "parameterValue": "string" - } - ], - "runningApp": "string", + "chain": "string", + "cROCountryCode": "string", "sessionDefaults": { - "baseLanguage": "string", - "currencyCode": "string", - "currencyFormat": "string", "dbDateFormat": "string", - "defaultLanguage": "string", + "oracleDateFormat": "string", + "oracleTimeFormat": "string", "javaDateFormat": "string", "javaTimeFormat": "string", - "oracleDateFormat": "string", - "oracleTimeFormat": "string" + "currencyCode": "string", + "currencyFormat": "string", + "defaultLanguage": "string", + "baseLanguage": "string" }, - "shareProfiles": true, - "systemDate": "2020-07-14", - "terminal": "string" - } - }, - "attendantId": "string", - "attendantName": "string", - "floor": "string", - "friday": true, - "hotelId": "string", - "monday": true, - "saturday": true, - "section": { - "code": "string", - "description": "string", - "hotelId": "string", - "inactive": true, - "roomCredits": 0, - "rooms": 0, - "sectionGroup": "string", - "sequence": 0, - "targetCredits": 0 - }, - "startTime": "2020-07-14T09:54:54.236Z", - "status": "Standby", - "sunday": true, - "thursday": true, - "tuesday": true, - "wednesday": true - } - ], - "building": "string", - "componentRoomNumber": "string", - "componentRoomNumbers": { - "roomId": [ - "string" - ] - }, - "componentRooms": [ - { - "accessible": true, - "building": "string", - "description": { - "defaultText": "string", - "translatedTexts": { - "text": [ - { - "language": "string", - "value": "string" - } - ] - } - }, - "floor": "string", - "floorDescription": "string", - "meetingRoom": true, - "roomAssignmentRating": "MostImportant", - "roomCondition": { - "code": "string", - "description": "string" - }, - "roomDescription": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomId": "string", - "roomType": { - "accessible": true, - "building": "string", - "houseKeeping": true, - "maximumOccupancy": 0, - "meetingRoom": true, - "minimumOccupancy": 0, - "pseudo": true, - "roomAssignmentRating": "MostImportant", - "roomClass": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomType": "string", - "shortDescription": "string", - "smokingPreference": "string", - "suite": true - }, - "smokingPreference": "string", - "smokingPreferenceDescription": "string" - } - ], - "connectingRooms": [ - { - "accessible": true, - "building": "string", - "description": { - "defaultText": "string", - "translatedTexts": { - "text": [ + "parameters": [ { - "language": "string", - "value": "string" + "parameterName": "string", + "parameterValue": "string" } ] + }, + "attendantInfo": { + "attendantId": "string", + "hotelId": "string" } }, - "floor": "string", - "floorDescription": "string", - "meetingRoom": true, - "roomAssignmentRating": "MostImportant", - "roomCondition": { - "code": "string", - "description": "string" - }, - "roomDescription": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomId": "string", - "roomType": { - "accessible": true, - "building": "string", - "houseKeeping": true, - "maximumOccupancy": 0, - "meetingRoom": true, - "minimumOccupancy": 0, - "pseudo": true, - "roomAssignmentRating": "MostImportant", - "roomClass": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomType": "string", - "shortDescription": "string", - "smokingPreference": "string", - "suite": true - }, - "smokingPreference": "string", - "smokingPreferenceDescription": "string" - } - ], - "description": { - "defaultText": "string", - "translatedTexts": { - "text": [ - { - "language": "string", - "value": "string" - } - ] + "startTime": "2020-07-14T09:54:54.236Z", + "status": "Standby" } - }, - "discrepancy": [ - "Sleep" ], - "floor": "string", - "floorDescription": "string", "hold": { - "comments": "string", "holdUntil": "2020-07-14T09:54:54.236Z", - "holdUser": "string" + "holdUser": "string", + "comments": "string" }, - "housekeeping": { - "cleaningPriority": { - "prioritySequence": 0 - }, - "facilityTaskCode": [ - "string" - ], - "guestServiceRequest": "DoNotDisturb", - "linenChange": true, - "roomCondition": { - "assignmentType": "Available", - "remarks": "string", - "roomCondition": { - "code": "string", - "description": "string" - } - }, - "roomPersons": { - "frontOfficePersons": 0, - "houseKeepingPersons": 0 - }, - "roomStatus": { - "frontOfficeStatus": "Vacant", - "housekeepingStatus": "Vacant", - "reservationStatusList": [ - "Arrival" - ], - "roomStatus": "Clean" - } + "turndownInfo": { + "turndownStatusInfo": "Required" }, - "meetingRoom": true, - "outOfOrder": [ - { - "end": "2020-07-14", - "newDateRange": { - "end": "2020-07-14", - "start": "2020-07-14" - }, - "reasonCode": "string", - "reasonDesc": "string", - "repairRemarks": "string", - "returnStatus": "Clean", - "roomStatus": "Clean", - "start": "2020-07-14" - } - ], "resvInfo": [ { "guestName": "string", - "profileId": { - "id": "string", - "type": "string" - }, "reservationId": { - "id": "string", - "idContext": "string", - "idExtension": 0, - "instance": "string", + "url": "string", "type": "string", - "url": "string" + "instance": "string", + "idContext": "string", + "id": "string", + "idExtension": 0 }, "reservationStatusInfo": "Arrival", "stayDateInfo": { + "timeSpan": { + "startDate": "2020-07-14", + "endDate": "2020-07-14", + "duration": "string" + }, "expectedTimes": { "reservationExpectedArrivalTime": "2020-07-14T09:54:54.236Z", "reservationExpectedDepartureTime": "2020-07-14T09:54:54.236Z" - }, - "timeSpan": { - "duration": "string", - "endDate": "2020-07-14", - "startDate": "2020-07-14" } }, "vipStatus": { - "code": "string", - "value": "string" + "value": "string", + "code": "string" + }, + "profileId": { + "id": "string", + "type": "string" } } ], - "roomAssignmentRating": "MostImportant", - "roomDescription": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomId": "string", - "roomSection": { - "daySectionCode": "string", - "eveningSectionCode": "string" - }, - "roomType": { - "accessible": true, - "building": "string", - "houseKeeping": true, - "maximumOccupancy": 0, - "meetingRoom": true, - "minimumOccupancy": 0, - "pseudo": true, - "roomAssignmentRating": "MostImportant", - "roomClass": "string", - "roomFeatures": [ - { - "code": "string", - "description": "string", - "orderSequence": 0, - "quantity": 0 - } - ], - "roomType": "string", - "shortDescription": "string", - "smokingPreference": "string", - "suite": true - }, - "sitePlanSection": { - "coordinates": "string", - "description": "string", - "linkCode": "string", - "sectionCode": "string", - "sectionType": "string" - }, - "smokingPreference": "string", - "smokingPreferenceDescription": "string", - "turndownInfo": { - "turndownStatusInfo": "Required" + "componentRoomNumbers": { + "roomId": [ + "string" + ] } } - ] + ], + "hotelId": "string" }, + "totalPages": 0, + "offset": 0, "limit": 0, + "hasMore": true, + "totalResults": 0, + "count": 0, "links": [ { "href": "string", - "method": "GET", - "operationId": "string", "rel": "string", - "targetSchema": "string", "templated": false, + "method": "GET", + "targetSchema": "string", + "operationId": "string", "title": "string" } - ], - "offset": 0, - "totalPages": 0, - "totalResults": 0 + ] } } }, @@ -17218,56 +15859,42 @@ "description": "HotelRooms not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/rooms/onHold": { - "post": { - "description": "You can use this API to place Rooms On Hold.OperationId:placeRoomsOnHold
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17276,23 +15903,29 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/rooms/onHold": { + "post": { "summary": "Place Rooms On Hold", + "description": "You can use this API to place Rooms On Hold.OperationId:placeRoomsOnHold
", "operationId": "placeRoomsOnHold", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to place rooms on hold.", "name": "holdRooms", "in": "body", "required": true, + "description": "Request to place rooms on hold.", "schema": { "allOf": [ { @@ -17302,111 +15935,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/rooms/onHold/release": { - "post": { - "description": "You can use this API to release Rooms On Hold.OperationId:releaseRoomsOnHold
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17415,23 +16014,29 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/rooms/onHold/release": { + "post": { "summary": "Release Rooms On Hold", + "description": "You can use this API to release Rooms On Hold.OperationId:releaseRoomsOnHold
", "operationId": "releaseRoomsOnHold", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to release rooms from being held.", "name": "holdRooms", "in": "body", "required": true, + "description": "Request to release rooms from being held.", "schema": { "allOf": [ { @@ -17441,111 +16046,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/serviceRequests": { - "get": { - "description": "Use this API to retrieve any service requests that exist on a reservation.OperationId:getServiceRequests
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17554,248 +16125,238 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/serviceRequests": { + "get": { "summary": "Get Service Requests", + "description": "Use this API to retrieve any service requests that exist on a reservation.OperationId:getServiceRequests
", "operationId": "getServiceRequests", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { + "name": "hotelIds", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "hotelIds", - "in": "query" + "required": false }, { + "name": "code", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "code", - "in": "query" + "required": false }, { - "uniqueItems": true, + "name": "status", + "in": "query", "type": "array", + "collectionFormat": "multi", + "uniqueItems": true, "items": { + "type": "string", "enum": [ "Open", "PendingFollowUp", "Closed", "DoNotDisturb", "MakeUpRoom" - ], - "type": "string" + ] }, - "collectionFormat": "multi", - "name": "status", - "in": "query" + "required": false }, { + "name": "priorityCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "priorityCodes", - "in": "query" + "required": false }, { + "name": "departmentCodes", + "in": "query", "type": "array", + "collectionFormat": "multi", "items": { - "maxItems": 4000, - "type": "string" + "type": "string", + "maxItems": 4000 }, - "collectionFormat": "multi", - "name": "departmentCodes", - "in": "query" + "required": false }, { - "type": "string", - "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.", "name": "reservationId", - "in": "query" + "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" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "reservationIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "reservationIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "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.", "name": "profileId", - "in": "query" + "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" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "profileIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "profileIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "description": "The room number in which the service request was created.", "name": "room", - "in": "query" + "in": "query", + "required": false, + "description": "The room number in which the service request was created.", + "type": "string" }, { - "type": "string", - "format": "date", - "description": "The ending value of the date range.", "name": "creationEndDate", - "in": "query" - }, - { + "in": "query", + "required": false, + "description": "The ending value of the date range.", "type": "string", - "format": "date", - "description": "The starting value of the date range.", - "name": "creationStartDate", - "in": "query" + "format": "date" }, { + "name": "creationStartDate", + "in": "query", + "required": false, + "description": "The starting value of the date range.", "type": "string", - "format": "date", - "description": "The ending value of the date range.", - "name": "closedEndDate", - "in": "query" + "format": "date" }, { + "name": "closedEndDate", + "in": "query", + "required": false, + "description": "The ending value of the date range.", "type": "string", - "format": "date", - "description": "The starting value of the date range.", - "name": "closedStartDate", - "in": "query" + "format": "date" }, { + "name": "closedStartDate", + "in": "query", + "required": false, + "description": "The starting value of the date range.", "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "format": "date" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-hotelid" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object for service requests.", - "schema": { - "$ref": "#/definitions/serviceRequestsInfo" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object for service requests.", + "schema": { + "$ref": "#/definitions/serviceRequestsInfo" } }, "204": { "description": "ServiceRequests not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "put": { - "description": "Use this API to modify any service requests that exist on a reservation.OperationId:putServiceRequests
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17804,23 +16365,27 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + }, + "put": { "summary": "Change Service Requests", + "description": "Use this API to modify any service requests that exist on a reservation.OperationId:putServiceRequests
", "operationId": "putServiceRequests", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Change service requests.", "name": "serviceRequestsInfo", "in": "body", "required": true, + "description": "Change service requests.", "schema": { "allOf": [ { @@ -17830,109 +16395,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Existing Operations Responses will eventually be modified to be extended from this type.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - }, - "post": { - "description": "Service Request functionality provides the ability to define, track and report Service Requests on a reservation. They go through a preset flow including creating the request, completing it and then following up on the resolution with the guest.OperationId:postServiceRequests
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -17941,23 +16474,27 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + }, + "post": { "summary": "Create Service Requests", + "description": "Service Request functionality provides the ability to define, track and report Service Requests on a reservation. They go through a preset flow including creating the request, completing it and then following up on the resolution with the guest.OperationId:postServiceRequests
", "operationId": "postServiceRequests", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Add new service request.", "name": "serviceRequestsInfo", "in": "body", "required": true, + "description": "Add new service request.", "schema": { "allOf": [ { @@ -17967,111 +16504,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/serviceRequests/{serviceRequestId}": { - "delete": { - "description": "Use this API to delete any service requests that exist on a reservation.OperationId:deleteServiceRequests
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18080,132 +16583,105 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/serviceRequests/{serviceRequestId}": { + "delete": { "summary": "Delete Service Requests", + "description": "Use this API to delete any service requests that exist on a reservation.OperationId:deleteServiceRequests
", "operationId": "deleteServiceRequests", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "serviceRequestId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "HATEOAS links which help the consumer to navigate to resources", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/shiftRooms": { - "put": { - "description": "This API will allow you to quickly shift rooms for two reservations.OperationId:shiftRooms
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18214,39 +16690,47 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/shiftRooms": { + "put": { "summary": "Operation for Shift Rooms between two reservations", + "description": "This API will allow you to quickly shift rooms for two reservations.OperationId:shiftRooms
", "operationId": "shiftRooms", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "sourceReservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "targetReservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to Shift Rooms between two selected reservations (from the same property), that are for the same arrival date and room type.", "name": "shiftRooms", "in": "body", "required": true, + "description": "Request to Shift Rooms between two selected reservations (from the same property), that are for the same arrival date and room type.", "schema": { "allOf": [ { @@ -18256,111 +16740,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room's occupancy level has been compromised. - The room's pricing is NOT available.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room's occupancy level has been compromised. - The room's pricing is NOT available.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/swapRooms": { - "put": { - "description": "This API will allow you to quickly swap rooms for two reservations.OperationId:swapRooms
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18369,39 +16819,47 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/swapRooms": { + "put": { "summary": "Operation for Swap/Shift Rooms between two reservations", + "description": "This API will allow you to quickly swap rooms for two reservations.OperationId:swapRooms
", "operationId": "swapRooms", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "sourceReservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "targetReservationId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "description": "Request to Swap Rooms between two selected reservations (from the same property), that are for the same arrival date and room type.", "name": "swapRooms", "in": "body", "required": true, + "description": "Request to Swap Rooms between two selected reservations (from the same property), that are for the same arrival date and room type.", "schema": { "allOf": [ { @@ -18411,111 +16869,77 @@ } }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room's occupancy level has been compromised. - The room's pricing is NOT available.", - "schema": { - "$ref": "#/definitions/status" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "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": "Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room's occupancy level has been compromised. - The room's pricing is NOT available.", + "schema": { + "$ref": "#/definitions/status" } }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } - } - }, - "/hotels/{hotelId}/textMessages/{messageType}": { - "get": { - "description": "You can use this API to get Queue room text message.OperationId:getQueueRoomsTextMessage
", + }, "consumes": [ "application/json;charset=UTF-8" ], @@ -18524,157 +16948,148 @@ ], "tags": [ "FrontDeskOperations" - ], + ] + } + }, + "/hotels/{hotelId}/textMessages/{messageType}": { + "get": { "summary": "Get Queue room text message", + "description": "You can use this API to get Queue room text message.OperationId:getQueueRoomsTextMessage
", "operationId": "getQueueRoomsTextMessage", "parameters": [ { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "messageType", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "maxLength": 2000, - "minLength": 1, - "type": "string", "name": "hotelId", "in": "path", - "required": true + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "" }, { - "type": "string", - "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.", "name": "reservationId", - "in": "query" + "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" }, { - "type": "string", - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", "name": "reservationIdContext", - "in": "query" + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string" }, { - "type": "string", - "description": "A reference to the type of object defined by the UniqueID element.", "name": "reservationIdType", - "in": "query" + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" }, { - "type": "string", - "description": "Mobile number that the text message will be delivered to.", "name": "mobileNumber", - "in": "query" + "in": "query", + "required": false, + "description": "Mobile number that the text message will be delivered to.", + "type": "string" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response for retrieving a predefined text message, for Queue Reservations or Queue Rush.", - "schema": { - "$ref": "#/definitions/queuedRoomsTextMessage" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response for retrieving a predefined text message, for Queue Reservations or Queue Rush.", + "schema": { + "$ref": "#/definitions/queuedRoomsTextMessage" } }, "204": { "description": "QueueRoomsTextMessage not found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "FrontDeskOperations" + ] } }, - "/hotels/{hotelId}/externalRoomKeys": { - "post": { - "summary": "Requests room key(s)", - "description": "API that manages requests for Door Lock Room Keys. This operation is used by OPERA Cloud PMS connected to external Door Lock Systems systems via Outbound Systems configuration: \n\nOPERA Cloud utilizes this operation \n\n- to request new or additional room keys - e.g. when guest checks in, or additional keys post check in.\n\n- to request to activate new keys after check on e.g. when a room key has been lost for a room.\n\n- to request a room key which is not related to a guest reservation but valid for a defined time - (for show rooms, repair) - One Shot Key.\n\n- to request to re-encode a key whereby other keys for this room remain active.\n\n- to request to read a key data from a room key and display it to the user in the PMS.\n\n- to request to modify existing key data - upon room move or change of departure date. (online key systems only!!)\n\n- to request to remove / delete a room key from a room on. Usually sent with check out of a reservation.\n\nUse this API to post a room key action to the active Door Lock System.\n\nNotes on keyType values:\n\nkeyType = New\n\nkeyType = Lost \n\nIt is expected that all previous active keys for the room will become invalid.\n\nIt is expected that partner system handles multiple keys being active in case numberOfKeys is >1.\n\nkeyType = Duplicate\n\nkeyType = ReEncode\n\nIt is expected that existing active keys for this room remain active.\n\nkeyType = OneShot\n\nIt is expected that the room key is only valid for a room for specific time (for maintenance or Show room).\n\nIt is never related to a reservation.\n\nkeyType = Read A request to the Key Card system to read Key Card information from requested Key Encoder/reader.\n\nThe Key Read functionality is of pure informational purpose. None of the received information is stored or processed in the PMS, and it is only for display to the user.\n\nkeyType = Remove\n\nIt is expected that with this request all active keys for a room or reservation will become inactive or invalid so they will not be able to open the room after defined validityEnd time.\n\nAdditional KeyType actions used by Online Door Lock Systems:\n\nOnline Key card Systems are systems which do not write guest data to the room key directly but do store guest data internally and send the information to the related door lock.\n\nkeyType = ModifyStay\n\nFor Online Door Lock Systems - Request to adjust Room key data when guest changes length of stay (validityEnd)\n\nkeyType = RoomMove\n\nFor Online Door Lock Systems - adjust Room key data when guest performs room move. \n\nOperationId: postExternalRoomKeys
", - "operationId": "postExternalRoomKeys", + "/hotels/{hotelId}/wakeUpCalls": { + "get": { + "summary": "Get Wake Up Calls", + "description": "Use thisAPI to get existing wake up calls on an in-house reservation.OperationId:getWakeUpCalls
", + "operationId": "getWakeUpCalls", "parameters": [ { "name": "hotelId", @@ -18683,60 +17098,140 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Unique ID of the hotel" + "description": "" }, { - "name": "roomKey", - "in": "body", - "required": true, - "description": "Request for generation of room key.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/roomKeyExternal" - } - ] - } + "name": "fetchCancelled", + "in": "query", + "required": false, + "description": "Specifies whether we should fetch wake up calls with pending status.", + "type": "boolean" }, { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "name": "fetchCompleted", + "in": "query", + "required": false, + "description": "Specifies whether we should fetch wake up calls with pending status.", + "type": "boolean" + }, + { + "name": "fetchNoAnswer", + "in": "query", + "required": false, + "description": "Specifies whether we should fetch wake up calls with pending status.", + "type": "boolean" + }, + { + "name": "fetchPending", + "in": "query", + "required": false, + "description": "Specifies whether we should fetch wake up calls with pending status.", + "type": "boolean" + }, + { + "name": "reservationId", + "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": "idExtension", + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" + }, + { + "name": "reservationIdContext", + "in": "query", + "required": false, + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "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}$", + "name": "reservationIdType", + "in": "query", + "required": false, + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string" + }, + { + "name": "beginDate", + "in": "query", + "required": false, + "description": "Begin date from which to start fetching wake up calls.", "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "format": "date" }, { + "name": "endDate", + "in": "query", + "required": false, + "description": "End date from which to start fetching wake up calls.", "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "format": "date" }, { - "maxLength": 80, + "name": "beginTime", + "in": "query", + "required": false, + "description": "Begin time from which to start fetching wake up calls.", "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "format": "date-time" }, { + "name": "endTime", + "in": "query", + "required": false, + "description": "End time from which to start fetching wake up calls.", "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "format": "date-time" + }, + { + "name": "room", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Hotel room(s) for which wake up calls are to be fetched.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "blockId", + "in": "query", + "required": false, + "description": "Block code for which wake up calls are to be fetched.", + "type": "string" + }, + { + "name": "guestName", + "in": "query", + "required": false, + "description": "Name with which wake up call may be associated.", + "type": "string" + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" } ], "responses": { - "201": { + "200": { "headers": { "Content-Language": { "type": "string", @@ -18745,10 +17240,49 @@ "x-example": "en-GB" } }, - "description": "Response from the active Door Locking System Property Interface to the post request.Note on Response messages:\n\nIt is necessary to specify both the PMS 'encoderTerminal' and the Key Service system's coder (encoderId) in cases where more than one PMS workstation may be addressing one key coder. ORACLE PMS will NOT send another Request command automatically should a negative response be received. The user sees the response and decides if another try should be made.
",
+ "description": "Fetch wake up calls response.",
"schema": {
- "$ref": "#/definitions/roomKeyExternalDetails"
+ "$ref": "#/definitions/wakeUpCalls"
}
+ },
+ "204": {
+ "description": "WakeUpCalls 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": [
@@ -18763,14 +17297,107 @@
}
}
},
- "definitions": {
- "QueueRoomsTextMessage": {
- "description": "Response for delivering a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).",
- "type": "object",
+ "parameters": {
+ "authKey": {
+ "name": "authorization",
+ "description": "Bearer token that needs to be passed which is generated post user authentication",
+ "type": "string",
+ "in": "header",
+ "required": true
+ },
+ "x-app-key": {
+ "name": "x-app-key",
+ "description": "Client or Partner's Application Key",
+ "type": "string",
+ "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$",
+ "in": "header",
+ "required": true
+ },
+ "x-hotelid": {
+ "name": "x-hotelid",
+ "type": "string",
+ "description": "Mandatory parameter to identify the hotel code where the end user is logged in",
+ "in": "header",
+ "required": true
+ },
+ "x-externalsystem": {
+ "name": "x-externalsystem",
+ "type": "string",
+ "maxLength": 80,
+ "description": "External system code.",
+ "in": "header",
+ "x-example": "EXTERNALSYSTEMCODE"
+ },
+ "Accept-Language": {
+ "name": "Accept-Language",
+ "type": "string",
+ "description": "Language code",
+ "in": "header"
+ },
+ "x-hubid": {
+ "name": "x-hubid",
+ "type": "string",
+ "description": "x-hubid is a logical grouping of multiple properties that allows api consumers to manage data from a group of properties. This x-hubid is a valid list of hub codes configured in OPERA to which the user has access. Rest APIs without hotelId in the operation path can support hub level integration using x-hubid",
+ "in": "header"
+ }
+ },
+ "responses": {
+ "400": {
+ "description": "Bad Request",
+ "schema": {
+ "$ref": "#/definitions/exceptionDetailType"
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Resource not found",
+ "schema": {
+ "$ref": "#/definitions/exceptionDetailType"
+ }
+ },
+ "405": {
+ "description": "Method not allowed"
+ },
+ "406": {
+ "description": "Not acceptable."
+ },
+ "413": {
+ "description": "Request Entity Too Large"
+ },
+ "414": {
+ "description": "Request URI Too Large"
+ },
+ "415": {
+ "description": "Unsupported Media Type"
+ },
+ "500": {
+ "description": "System Error",
+ "schema": {
+ "$ref": "#/definitions/exceptionDetailType"
+ }
+ },
+ "502": {
+ "description": "Bad Gateway"
+ },
+ "503": {
+ "description": "Service Unavailable"
+ }
+ },
+ "definitions": {
+ "resvForBatchCCAut": {
+ "type": "object",
+ "description": "Response which contains a listing of reservations, and associated payment methods, that require credit card authorization.",
"properties": {
- "guestTextInfo": {
- "description": "Information regarding the message sent to guest.",
- "$ref": "#/definitions/queueTextInfoType"
+ "hotelId": {
+ "$ref": "#/definitions/codeType"
+ },
+ "reservations": {
+ "$ref": "#/definitions/reservationsForCCAuthType"
},
"links": {
"$ref": "#/definitions/links"
@@ -18780,1233 +17407,897 @@
}
}
},
- "aRAccountShortInfoType": {
- "description": "Accounts Receivabales Account details type charged for batched posting.",
+ "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
+ },
+ "reservationsForCCAuthType": {
+ "type": "array",
+ "description": "List of reservations with their payment methods.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationForCCAuthType"
+ }
+ },
+ "reservationForCCAuthType": {
"type": "object",
+ "description": "Reservation details, including a list of the associated payment methods.",
"properties": {
- "accountId": {
- "description": "The unique ID for the Account.",
+ "guestName": {
+ "description": "Guest name that is registered for the reservation.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "reservationId": {
+ "$ref": "#/definitions/reservationId"
+ },
+ "reservationStatusInfo": {
+ "$ref": "#/definitions/housekeepingRoomReservationStatusType"
+ },
+ "stayDateInfo": {
+ "$ref": "#/definitions/stayDateInfoType"
+ },
+ "vipStatus": {
+ "description": "VIP status of the guest.",
+ "$ref": "#/definitions/vIPStatusType"
+ },
+ "profileId": {
+ "description": "ProfileId of the guest.",
"$ref": "#/definitions/uniqueID_Type"
},
- "accountName": {
- "description": "Name of the AR Account.",
+ "guestFirstName": {
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "accountNo": {
- "description": "The Account Number for the Account.",
+ "room": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "status": {
- "description": "The status of the account.",
- "$ref": "#/definitions/aRAccountStatusType"
+ "paymentMethods": {
+ "$ref": "#/definitions/reservationPaymentMethodsType"
}
}
},
- "aRAccountStatusType": {
- "description": "Type for the Account Status. Status can be restricted and a message/description added to the Account.",
+ "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": {
- "description": {
- "description": "User defined status message on the Account.",
+ "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",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "restricted": {
- "description": "Flag to indicate if the Account is restricted.",
- "type": "boolean"
+ "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
},
- "restriction": {
- "description": "The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON.",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "idExtension": {
+ "description": "Additional identifying value assigned by the creating system.",
+ "type": "integer"
}
}
},
- "actionStatusType": {
- "description": "Action status of the Track It item(Open, Closed).",
+ "housekeepingRoomReservationStatusType": {
"type": "string",
+ "description": "Room Reservation status types used in housekeeping. These may be different from the actual reservation statuses as these relate to the current reservation for the room.",
"enum": [
- "Open",
- "Closed"
+ "Arrival",
+ "Arrived",
+ "DayUse",
+ "DueOut",
+ "Departed",
+ "NotReserved",
+ "StayOver"
]
},
- "activityList": {
- "description": "A collection of Activity objects.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "description": "Represents a single instance of a scheduled activity.",
- "type": "object",
- "properties": {
- "activityIds": {
- "description": "A collection of reference ID values that identify this uniquely scheduled activity instance. May contain one ID per external system plus an internal identifier.",
- "$ref": "#/definitions/uniqueIDListType"
- },
- "amount": {
- "description": "The amount charged for the activity.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "deposit": {
- "description": "A monetary value expressed with a currency code.",
- "type": "object",
- "properties": {
- "amount": {
- "description": "A monetary amount.",
- "type": "number"
- },
- "collectedBy": {
- "type": "string",
- "enum": [
- "Vendor",
- "Agent",
- "Other"
- ]
- },
- "currencyCode": {
- "description": "Provides a currency code to reflect the currency in which an amount may be expressed.",
- "type": "string",
- "maxLength": 3,
- "minLength": 3
- }
- }
- },
- "description": {
- "description": "Description of the activity",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- }
- },
- "duration": {
- "description": "The time span of the activity falls",
- "$ref": "#/definitions/dateTimeSpanType"
- },
- "extensions": {
- "description": "Vendor extensions to the activity record.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string"
- }
- },
- "groupCode": {
- "description": "Any Block code associated with the activity if its a Group booking.",
- "type": "string"
- },
- "inactiveDate": {
- "description": "The Date by which the activity is deemed Cancelled/Deleted.",
- "type": "string",
- "format": "date-time"
- },
- "link": {
- "description": "When true indicates that activity link only needs to be inserted or deleted for this record.",
- "type": "boolean"
- },
- "location": {
- "description": "The Location where the activity takes place. Eg: Salon",
- "type": "string"
- },
- "name": {
- "description": "Name of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- }
- },
- "note": {
- "description": "Any additional notes or comments regarding the scheduled activity.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- }
- },
- "numberOfPersons": {
- "description": "The total number of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons",
- "type": "integer"
- },
- "participants": {
- "description": "The names of the participants.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/personNameType"
- }
- },
- "status": {
- "description": "Activity reservation status. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.",
- "type": "string"
- },
- "statusDescription": {
- "description": "Activity reservation status description. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.",
- "type": "string"
- },
- "timeSpan": {
- "description": "The time with-in which an activity falls (Starts/Ends/Spans)",
- "$ref": "#/definitions/dateTimeSpanType"
- },
- "type": {
- "description": "The Type of the activity. Eg: SPA, Golf etc.",
- "type": "string"
- },
- "uRLLink": {
- "description": "The URL link to launch the Activity Reservation System to view or edit full details of this activity.",
- "type": "string"
- }
- }
- }
- },
- "activityLog": {
- "description": "Fulfillment activity log response.",
+ "stayDateInfoType": {
"type": "object",
+ "description": "Room attached with stay detail information",
"properties": {
- "activityLogDetails": {
- "description": "List of activity log entries.",
- "$ref": "#/definitions/activityLogListType"
- },
- "links": {
- "$ref": "#/definitions/links"
+ "timeSpan": {
+ "$ref": "#/definitions/timeSpanType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "expectedTimes": {
+ "$ref": "#/definitions/resExpectedTimesType"
}
}
},
- "activityLogListType": {
+ "timeSpanType": {
"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": {
- "activityLog": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/activityLogType"
- }
- },
- "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"
- },
- "limit": {
- "description": "Indicates maximum number of records a Web Service should return.",
- "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"
+ "startDate": {
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "totalPages": {
- "description": "Evaluated total page count based on the requested max fetch count.",
- "type": "integer"
+ "endDate": {
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
+ "duration": {
+ "type": "string"
}
}
},
- "activityLogType": {
+ "resExpectedTimesType": {
"type": "object",
+ "description": "Holds the Arrival and Departure Time Information",
"properties": {
- "actionDescription": {
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "actionType": {
- "type": "string",
- "maxLength": 100,
- "minLength": 0
- },
- "croCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "hotelId": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "iPAddress": {
- "description": "The IP Address of the machine that performed the activity",
+ "reservationExpectedArrivalTime": {
+ "description": "Arrival Time",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "format": "date-time"
},
- "logDate": {
+ "reservationExpectedDepartureTime": {
+ "description": "Departure Time",
"type": "string",
"format": "date-time"
- },
- "logUserId": {
- "type": "integer"
- },
- "logUserName": {
- "type": "string"
- },
- "machineStation": {
- "type": "string"
- },
- "module": {
- "type": "string"
- },
- "refActionId": {
- "type": "number"
}
}
},
- "activityLookUpList": {
- "description": "Criteria for fetching Activity Bookings.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/fetchActivityBookingsType"
- }
- },
- "additionalGuestAmountType": {
+ "vIPStatusType": {
"type": "object",
+ "description": "VIP status of the customer.",
"properties": {
- "ageQualifyingCode": {
+ "value": {
"type": "string",
- "enum": [
- "ADULT",
- "CHILD",
- "OTHER",
- "CHILDBUCKET1",
- "CHILDBUCKET2",
- "CHILDBUCKET3",
- "CHILDBUCKET4",
- "CHILDBUCKET5"
- ]
+ "description": "Used for Character Strings, length 0 to 2000.",
+ "minLength": 0,
+ "maxLength": 2000
},
- "amount": {
- "$ref": "#/definitions/totalType"
+ "code": {
+ "description": "VIP status of the customer.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "addressInfoType": {
- "description": "Provides address information.",
+ "uniqueID_Type": {
"type": "object",
+ "description": "An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).",
"properties": {
- "address": {
- "description": "Address details for the profile.",
- "$ref": "#/definitions/addressType"
- },
"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",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
"type": {
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "addressSearchType": {
- "description": "Address Details such as city, state, country, postal code etc.",
+ "reservationPaymentMethodsType": {
+ "type": "array",
+ "description": "Defines reservation payment methods.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationPaymentMethodType"
+ }
+ },
+ "reservationPaymentMethodType": {
"type": "object",
"properties": {
- "cityName": {
- "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "paymentCard": {
+ "$ref": "#/definitions/resPaymentCardType"
},
- "country": {
- "description": "Country name (e.g., Ireland).",
- "$ref": "#/definitions/countryNameType"
+ "balance": {
+ "$ref": "#/definitions/currencyAmountType"
},
- "excludeNoCity": {
- "description": "When true indicates that only profiles with city will be fetched.",
- "type": "boolean"
+ "authorizationRule": {
+ "$ref": "#/definitions/authorizationRuleType"
},
- "postalCode": {
- "description": "Post Office Code number.",
- "type": "string",
- "maxLength": 15,
- "minLength": 0
+ "emailFolioInfo": {
+ "description": "Information on an email for the customer.",
+ "type": "object",
+ "properties": {
+ "email": {
+ "description": "eMail deatils for the profile.",
+ "$ref": "#/definitions/emailType"
+ },
+ "emailFolio": {
+ "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
+ }
+ }
},
- "state": {
- "description": "State or Province name (e.g., Texas).",
+ "paymentMethod": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "streetAddress": {
- "description": "First Line of Street Address. For profile search it matches the first Address line.",
+ "description": {
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "folioView": {
+ "type": "integer"
}
}
},
- "addressType": {
- "description": "Provides address information.",
+ "resPaymentCardType": {
"type": "object",
+ "description": "Information on a credit card for the customer.",
"properties": {
- "addressLine": {
- "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.",
- "type": "array",
- "maxItems": 4,
- "items": {
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- }
+ "cardId": {
+ "description": "credit card id",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "barCode": {
- "description": "The postal barcode for the address.",
- "type": "string",
- "maxLength": 100,
- "minLength": 0
+ "currentAuthorizedAmount": {
+ "$ref": "#/definitions/currencyAmountType"
},
- "cityExtension": {
- "description": "Post Office City Extension Code number. City Extension mainly used for UK addresses.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "approvalAmountNeeded": {
+ "$ref": "#/definitions/currencyAmountType"
},
- "cityName": {
- "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).",
+ "approvalCode": {
+ "description": "Approval code sent by the credit card company on a successful authorization.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "country": {
- "description": "Country name (e.g., Ireland).",
- "$ref": "#/definitions/countryNameType"
+ "cardType": {
+ "description": "Indicates the type of credit card from a defined list",
+ "$ref": "#/definitions/cardTypeType"
},
- "county": {
- "description": "County or District Name (e.g., Fairfax). This is read only.",
+ "userDefinedCardType": {
+ "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2
},
- "createDateTime": {
- "description": "Time stamp of the creation.",
+ "cardNumber": {
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 80
},
- "creatorId": {
- "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.",
+ "cardNumberMasked": {
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "isValidated": {
- "description": "Indicator to define if the Address is validated by the Address Validation System.",
- "type": "boolean"
+ "cardNumberLast4Digits": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "language": {
- "description": "Language identification.",
+ "expirationDate": {
+ "description": "Expiration date of the credit card",
"type": "string",
- "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
+ "format": "date",
+ "maxLength": 8
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "expirationDateMasked": {
+ "description": "Masked Expiration date of the credit card",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
- "type": "string",
- "format": "date-time"
+ "expirationDateExpired": {
+ "type": "boolean"
},
- "postalCode": {
- "description": "Post Office Code number.",
+ "cardHolderName": {
"type": "string",
- "maxLength": 15,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "primaryInd": {
- "description": "When true, indicates a primary information.",
+ "attachCreditCardToProfile": {
+ "description": "Attach the credit card to profile.",
"type": "boolean"
},
- "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
+ "processing": {
+ "description": "This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type.",
+ "$ref": "#/definitions/cardProcessingType"
},
- "state": {
- "description": "State or Province name (e.g., Texas).",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "swiped": {
+ "type": "boolean"
},
- "type": {
- "description": "Defines the type of address (e.g. home, business, other).",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "cardPresent": {
+ "description": "Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.",
+ "type": "boolean"
},
- "typeDescription": {
- "description": "Describes the type code",
- "type": "string"
+ "cardOrToken": {
+ "description": "This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type.",
+ "$ref": "#/definitions/cardNumberTypeType"
},
- "updateReservations": {
- "description": "Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.",
- "type": "boolean"
+ "citId": {
+ "description": "Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 30
}
}
},
- "addtionalCodeInfoType": {
- "description": "Holds name of additional code information",
- "type": "array",
- "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",
- "maxLength": 2000,
- "minLength": 0
- }
+ "currencyAmountType": {
+ "type": "object",
+ "description": "A monetary value expressed with a currency code.",
+ "properties": {
+ "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
}
}
},
- "advanceCheckInReservation": {
- "description": "Request object to perform Advance Check In of a Reservation.",
+ "cardTypeType": {
+ "type": "string",
+ "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.",
+ "enum": [
+ "Ab",
+ "Am",
+ "Ax",
+ "Cb",
+ "Dc",
+ "Ds",
+ "Dt",
+ "Ec",
+ "Er",
+ "Jc",
+ "Jl",
+ "Mc",
+ "Nb",
+ "So",
+ "St",
+ "Sw",
+ "Va",
+ "Xy",
+ "Zz",
+ "Cp",
+ "Cu"
+ ]
+ },
+ "cardProcessingType": {
+ "type": "string",
+ "enum": [
+ "Eft",
+ "Manual"
+ ]
+ },
+ "cardNumberTypeType": {
+ "type": "string",
+ "description": "Simple type for indicating if credit card number is tokenized.",
+ "enum": [
+ "CardNumber",
+ "Token"
+ ]
+ },
+ "authorizationRuleType": {
"type": "object",
+ "description": "Configured rule for computing the amount to authorize.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "code": {
+ "description": "The authorization rule code.",
+ "type": "integer",
+ "pattern": "[0-9]{1,9}"
},
- "reservation": {
- "description": "Information required for performing Advance Check In.",
- "$ref": "#/definitions/advanceCheckInReservationType"
+ "amount": {
+ "description": "The amount applicable to the authorization rule.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "percent": {
+ "description": "A percentage value if the authorization rule is percentage based.",
+ "type": "number"
}
}
},
- "advanceCheckInReservationType": {
- "description": "Information needed to perform Advance Check In of a Reservation",
+ "emailType": {
"type": "object",
+ "description": "Information on an email for the customer.",
"properties": {
- "eTRComments": {
- "description": "Comments relating to the Advance Checked In guest's return to the property",
+ "emailAddress": {
+ "description": "Defines the e-mail address.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "expectedReturnTime": {
- "description": "Time when the guest is expected to return to perform Check In",
+ "type": {
+ "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve).",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 20
},
- "hotelId": {
- "description": "Resort to which the Reservation belongs.",
+ "typeDescription": {
+ "description": "Describes the Type code",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "optedForCommunication": {
- "description": "Indicates if the guest has opted for communications pertaining to this reservation.",
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 2000
},
- "reservationCommunication": {
- "description": "Collection of Reservation communication information such as phone numbers and email addresses.",
- "$ref": "#/definitions/resCommunicationType"
+ "emailFormat": {
+ "description": "Supported Email format.",
+ "type": "string",
+ "enum": [
+ "Html",
+ "Text"
+ ]
},
- "reservationId": {
- "description": "ID of the Reservation that is being Advance Checked In",
- "$ref": "#/definitions/reservationId"
- }
- }
- },
- "advanceCheckInType": {
- "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return",
- "type": "object",
- "properties": {
- "advanceCheckedIn": {
- "description": "Indicates if the reservation is marked as Advance Checked In",
+ "primaryInd": {
+ "description": "When true, indicates a primary information.",
"type": "boolean"
},
- "eTRComments": {
- "description": "ETR Comments",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "orderSequence": {
+ "description": "Display Order sequence.",
+ "type": "number"
},
- "expectedReturnTime": {
- "description": "Expected Return Time",
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
"type": "string",
"format": "date-time"
- }
- }
- },
- "agentInfoType": {
- "description": "Agent or source commission information.",
- "type": "object",
- "properties": {
- "agentId": {
- "description": "Unique ID of the travel agent or source.",
- "$ref": "#/definitions/uniqueID_Type"
},
- "alternateName": {
- "description": "Alternate name of the agent or source 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",
- "maxLength": 40,
- "minLength": 0
- },
- "bankAccountId": {
- "description": "Unique bank account ID.",
- "$ref": "#/definitions/uniqueID_Type"
+ "minLength": 0,
+ "maxLength": 200
},
- "city": {
- "description": "City of the travel agency or source profile.",
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "commissionAmount": {
- "description": "Amount of the commission payment to be generated for that agent or source.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "commissionCode": {
- "description": "Profile's commission code.",
- "$ref": "#/definitions/commissionCodeType"
- },
- "holdReason": {
- "description": "Hold code and description reason if all the reservations associated to the agent is on hold for commission.",
- "$ref": "#/definitions/codeDescriptionType"
- },
- "iATANo": {
- "description": "Travel agent's IATA number.",
- "$ref": "#/definitions/uniqueID_Type"
+ "format": "date-time"
},
- "name": {
- "description": "Travel agent or source profile name.",
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "onCommission": {
- "description": "Whether this agent/source has been paid or will be paid for commission.",
- "type": "boolean"
- },
- "onHold": {
- "description": "When set to true, commission for all the reservations associated with this agent is flagged as on hold.",
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 200
},
- "profileType": {
- "description": "Whether travel agent or source profile.",
- "$ref": "#/definitions/profileTypeType"
+ "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
}
}
},
- "airaLastRunStatusInfo": {
- "description": "Response of last execution status for AI Room Assignment",
+ "links": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/instanceLink"
+ }
+ },
+ "instanceLink": {
"type": "object",
+ "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.",
"properties": {
- "actionValue": {
- "description": "Actual run status of an AI room assignment",
+ "href": {
+ "description": "URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
"type": "string"
},
- "insertDate": {
- "description": "When the AI Room Assignment starts execution",
- "type": "string",
- "format": "date-time",
- "maxLength": 8
+ "rel": {
+ "description": "Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
+ "type": "string"
},
- "links": {
- "$ref": "#/definitions/links"
+ "templated": {
+ "description": "Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
+ "type": "boolean",
+ "default": false
},
- "updateDate": {
- "description": "Date time of updated status of an executions",
+ "method": {
+ "description": "HTTP method for requesting the target of the link.",
"type": "string",
- "format": "date-time"
+ "enum": [
+ "GET",
+ "POST",
+ "PUT",
+ "DELETE",
+ "PATCH",
+ "OPTIONS",
+ "HEAD"
+ ]
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "targetSchema": {
+ "description": "Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Exact copy of the \"summary\" field on the linked operation.",
+ "type": "string"
}
}
},
- "alertAreaType": {
- "type": "string",
- "enum": [
- "CheckIn",
- "CheckOut",
- "Reservation",
- "Billing",
- "InHouse"
- ]
+ "warningsType": {
+ "type": "array",
+ "description": "Used in conjunction with the Success element to define a business error.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/warningType"
+ }
},
- "alertGuestInfoType": {
+ "warningType": {
"type": "object",
+ "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.",
"properties": {
- "birthDate": {
- "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.",
+ "value": {
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "birthDateMasked": {
- "description": "Indicates the date of birth as masked.",
- "type": "string"
- },
- "comments": {
- "description": "Additional alert information regarding the membership of the guest.",
- "type": "string"
+ "description": "Property Value"
},
- "guestName": {
- "description": "Guest Name.",
+ "shortText": {
+ "description": "An abbreviated version of the error in textual format.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "guestPreferredLanguage": {
- "description": "Holds the language preferred by the guest.",
- "$ref": "#/definitions/languageType"
+ "maxLength": 2000
},
- "lastHotelCode": {
- "description": "Hotel code of the last stay location of the guest.",
+ "code": {
+ "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "lastStayDate": {
- "description": "Last stay date at the property.",
+ "docURL": {
+ "description": "If present, this URL refers to an online description of the error that occurred.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "maxLength": 2000
},
- "membership": {
- "description": "Membership information of the guest.",
- "$ref": "#/definitions/membershipType"
+ "status": {
+ "description": "If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.",
+ "type": "string",
+ "maxLength": 2000
},
- "preference": {
- "description": "Additional alert information regarding the guest.",
- "type": "string"
+ "tag": {
+ "description": "If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].",
+ "type": "string",
+ "maxLength": 2000
},
- "preference2": {
- "description": "Additional mandatory alert information regarding the guest preferences.",
- "type": "string"
+ "recordId": {
+ "description": "If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.",
+ "type": "string",
+ "maxLength": 2000
},
- "totalBrandStay": {
- "description": "Holds total number of days that the guest have stayed in the properties for the same brand.",
- "type": "integer"
+ "type": {
+ "description": "The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "totalStay": {
- "description": "Holds total number of days that the guest have stayed in the property.",
- "type": "integer"
+ "language": {
+ "description": "Language identification.",
+ "type": "string",
+ "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
},
- "vipStatus": {
- "description": "VIP status of the guest.",
- "$ref": "#/definitions/vIPStatusType"
+ "rph": {
+ "description": "Reference Place Holder used as an index for this warning.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 8
}
}
},
- "alertType": {
+ "exceptionDetailType": {
+ "title": "Error Detail",
+ "description": "Complex type that contains error details for a REST call.",
"type": "object",
"properties": {
- "area": {
- "description": "The Area where the alert will be attached and shown.",
- "$ref": "#/definitions/alertAreaType"
- },
- "code": {
- "description": "Code identifying the type of alert.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "createDateTime": {
- "description": "Time stamp of the creation.",
+ "type": {
"type": "string",
- "format": "date-time"
+ "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)."
},
- "creatorId": {
- "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.",
+ "title": {
"type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "description": {
- "description": "The alert message.",
- "type": "string"
- },
- "global": {
- "description": "Indicate whether the alert is a global that is automatically and dynamically attached to all reservations that meet the alert criteria.",
- "type": "boolean"
+ "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization."
},
- "guestInfo": {
- "description": "Contains information regarding the guest.",
- "$ref": "#/definitions/alertGuestInfoType"
+ "status": {
+ "type": "integer",
+ "description": "HTTP status code for this occurrence of the problem, set by the origin server."
},
- "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.",
+ "detail": {
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "description": "Human-readable description specific to this occurrence of the problem."
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "instance": {
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced."
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "o:errorCode": {
+ "type": "string",
+ "description": "Application error code, which is different from HTTP error code."
},
- "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.",
+ "o:errorPath": {
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "description": "Path to the problem at the resource or property level."
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "o:errorDetails": {
+ "description": "Details of the error message, consisting of a hierarchical tree structure.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/errorInstance"
+ }
+ },
+ "links": {
+ "$ref": "#/definitions/links"
+ }
+ },
+ "required": [
+ "type",
+ "title"
+ ]
+ },
+ "errorInstance": {
+ "title": "Error Instance Details",
+ "description": "Complex type that contains error instance details for a REST call.",
+ "type": "object",
+ "properties": {
+ "type": {
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)."
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
+ "title": {
"type": "string",
- "format": "date-time"
+ "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization."
},
- "printerName": {
- "description": "Printer used to print the alert notification.",
- "type": "string"
+ "status": {
+ "type": "integer",
+ "description": "HTTP status code for this occurrence of the problem, set by the origin server."
},
- "printerNotification": {
- "description": "Notify by sending the message to the printer.",
- "type": "boolean"
+ "detail": {
+ "type": "string",
+ "description": "Human-readable description specific to this occurrence of the problem."
},
- "purgeDate": {
- "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
+ "instance": {
"type": "string",
- "format": "date",
- "maxLength": 8
+ "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced."
},
- "reportDescription": {
- "description": "Report description. Mainly used for as a parameter for printing the alerts.",
+ "o:errorCode": {
"type": "string",
- "maxLength": 1000,
- "minLength": 0
+ "description": "Application error code, which is different from HTTP error code."
},
- "reportId": {
- "description": "The module id of the report. This is used to printer the alert.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "reportName": {
- "description": "Report name of the report type.",
- "type": "string"
- },
- "screenNotification": {
- "description": "Notify by showing the alert on the screen",
- "type": "boolean"
- },
- "stopCheckInCheckOut": {
- "description": "Indicates the Reservation Stop Check In/Check Out Global Alert.",
- "type": "boolean"
- },
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
- },
- "userDefinedFields": {
- "description": "Collections of user defined fields.",
- "$ref": "#/definitions/userDefinedFieldsType"
- },
- "welcomeOffer": {
- "description": "Contains information regarding welcome offer.",
- "$ref": "#/definitions/welcomeOfferType"
- }
- }
- },
- "alertsType": {
- "description": "List of alerts.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/alertType"
- }
- },
- "alienInfoType": {
- "description": "immigration/visa information of a foreign person.",
- "type": "object",
- "properties": {
- "alienRegistrationNo": {
- "description": "Alien Registration Number.",
- "type": "string"
- },
- "immigrationStatus": {
- "description": "Immigration Status on an Alien.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "visaValidityType": {
- "description": "Visa Type of an Alien.",
+ "o:errorPath": {
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "description": "Path to the problem at the resource or property level."
}
- }
- },
- "amountDeterminationType": {
- "description": "Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.",
- "type": "string",
- "enum": [
- "Inclusive",
- "Exclusive"
+ },
+ "required": [
+ "type",
+ "title"
]
},
- "amountType": {
- "description": "Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description.",
+ "bankAccountsDetails": {
"type": "object",
+ "description": "Returns bank accounts that match the request criteria.",
"properties": {
- "additionalGuestAmounts": {
- "description": "Collection of incremental charges per age qualifying code for additional guests. Amount charged for additional occupant is with respect to age group of the base guests.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/additionalGuestAmountType"
- }
- },
- "base": {
- "description": "The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements.",
- "$ref": "#/definitions/totalType"
- },
- "discount": {
- "description": "Discount percentage and/or Amount, code and textual reason for discount",
- "$ref": "#/definitions/discountType"
- },
- "effectiveRate": {
- "description": "The reservation effective amount charged for the accommodation or service (i.e. base amount + amount for Add to Rate Combine Line packages) per unit of time",
- "$ref": "#/definitions/totalType"
- },
- "end": {
- "description": "The ending value of the date range.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "requiredPoints": {
- "description": "The Points contains the number of points required to book a particular room type.",
- "$ref": "#/definitions/pointsType"
- },
- "shareDistributionInstruction": {
- "description": "Last rate share distribution instruction applied on share reservation daily rate segment.",
- "$ref": "#/definitions/shareDistributionInstructionType"
- },
- "shareRatePercentage": {
- "description": "Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.",
- "type": "number",
- "maximum": 100,
- "minimum": 0
+ "bankAccounts": {
+ "$ref": "#/definitions/bankAccountsType"
},
- "start": {
- "description": "The starting value of the date range.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "links": {
+ "$ref": "#/definitions/links"
},
- "total": {
- "description": "The total amount charged for this rate including additional occupant amounts and fees.",
- "$ref": "#/definitions/totalType"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "anonymizationStatusType": {
- "description": "Guest has been anonymized.",
- "type": "string",
- "enum": [
- "Requested",
- "Anonymized"
- ]
- },
- "anonymizationType": {
- "description": "Provides information about guest's anonymization status.",
- "type": "object",
- "properties": {
- "anonymizationDate": {
- "description": "Date and Time when the guest was anonymized.",
- "type": "string",
- "format": "date-time"
- },
- "anonymizationStatus": {
- "description": "Status of anonymization such as Requested or Anonymized.",
- "$ref": "#/definitions/anonymizationStatusType"
- }
+ "bankAccountsType": {
+ "type": "array",
+ "description": "List of bank accounts.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/bankAccountType"
}
},
- "applicationUserType": {
+ "bankAccountType": {
"type": "object",
+ "description": "Bank account information like Account ID, Bank Name, Currency, etc.",
"properties": {
- "actAs": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "actAt": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "appUser": {
+ "hotelId": {
+ "description": "Property of the bank account.",
"type": "string",
- "maxLength": 60,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "appUserId": {
+ "bankAccountId": {
+ "description": "Bank account ID.",
"$ref": "#/definitions/uniqueID_Type"
},
- "attendantInfo": {
- "$ref": "#/definitions/attendantType"
- },
- "cashierId": {
- "type": "integer"
- },
- "cashierTitle": {
- "description": "Cashier title.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "department": {
+ "bankAccountNo": {
+ "description": "Account number at the bank.",
"type": "string",
- "maxLength": 60,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "departmentLocation": {
+ "bankCode": {
+ "description": "Unique code of the bank account.",
"type": "string",
- "maxLength": 60,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "disabledUntil": {
+ "branchCode": {
+ "description": "Code for the branch of the bank.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "expiryDate": {
+ "bankName": {
+ "description": "Name of the bank account.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 2000
},
- "hotel": {
- "description": "Hotel where user belongs.",
- "$ref": "#/definitions/codeDescriptionType"
+ "paymentMethod": {
+ "description": "Type of payment associated with the bank account.",
+ "$ref": "#/definitions/commissionPaymentMethodType"
},
- "lDAPUser": {
+ "checkFormat": {
+ "description": "Type of format for Payment Method.",
"type": "string",
- "maxLength": 60,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "passwordChangeDate": {
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "currency": {
+ "description": "Currency associated with the bank account.",
+ "$ref": "#/definitions/codeDescriptionType"
},
- "salesRepCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "currentCheckNo": {
+ "description": "Current check no of the bank account.",
+ "type": "number"
},
- "userDefaultLanguage": {
+ "hotelName": {
+ "description": "Property name of the bank account.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "userInfo": {
- "$ref": "#/definitions/employeeInfoType"
+ "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"
},
- "userSessionInfo": {
- "description": "This is only used during log-in.",
- "$ref": "#/definitions/userSessionInfoType"
+ "linkedToProfile": {
+ "description": "Whether this bank account is associated with the travel agent or source.",
+ "type": "boolean"
}
}
},
- "articleInfoType": {
- "description": "Information regarding an article.",
+ "commissionPaymentMethodType": {
"type": "object",
+ "description": "This contains a generic code and description information.",
"properties": {
- "articleCode": {
- "description": "Unique code of the article.",
+ "code": {
+ "description": "Code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
"description": {
- "description": "Description of the article.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "hotelId": {
- "description": "Hotel code to which the article belongs.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "inactive": {
- "description": "Indicates whether the article is inactive or not.",
- "type": "boolean"
- },
- "orderSequence": {
- "description": "Display Order sequence.",
- "type": "number"
- },
- "postIt": {
- "description": "Post it information of the article.",
- "$ref": "#/definitions/articlePostItType"
- },
- "price": {
- "description": "Default price of the article.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "transactionCode": {
- "description": "Transaction code to which the article belongs.",
+ "description": "description.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "universalProductCode": {
- "description": "Unique Universal product code of the article.",
+ "format": {
+ "description": "Payment format if the payment method is EFT.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 3
}
}
},
- "articlePostItType": {
- "description": "Post it information of an article.",
+ "codeDescriptionType": {
"type": "object",
+ "description": "This contains a generic code and description information.",
"properties": {
- "availableForPostIt": {
- "description": "Indicates whether the article is available for post it.",
- "type": "boolean"
+ "code": {
+ "description": "Code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "color": {
- "description": "Color indicator which is only configurable if article is available for post it.",
- "$ref": "#/definitions/colorType"
+ "description": {
+ "description": "description.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "assignedRoom": {
- "description": "Possible errors that the operation will generate: The reservation is not in Reserved state. The room being requested does not exist.",
+ "commissionCheckToBeChanged": {
"type": "object",
+ "description": "Request type for updating commission check.",
"properties": {
- "effectiveRates": {
- "description": "Collection of effective rates per stay dates per guest to be applied on reservation including its shares.",
- "$ref": "#/definitions/effectiveRatesType"
+ "criteria": {
+ "description": "Contains criteria for updating check payment",
+ "$ref": "#/definitions/changeCommissionCheckCriteriaType"
},
"links": {
"$ref": "#/definitions/links"
},
- "newRates": {
- "description": "Collection of new room rate information on a daily basis.",
- "$ref": "#/definitions/dailyRatesType"
- },
- "oldRates": {
- "description": "Collection of old room rate information on a daily basis.",
- "$ref": "#/definitions/dailyRatesType"
- },
"warnings": {
"$ref": "#/definitions/warningsType"
}
}
},
- "assignedRoomsSummaryType": {
- "description": "Indicates summary of the assigned rooms.",
- "type": "object",
- "properties": {
- "count": {
- "description": "Number of reservations with assigned rooms.",
- "type": "string",
- "maxLength": 4,
- "minLength": 4
- }
- }
- },
- "assignedTaskType": {
- "description": "Holds the assigned task code for a tasksheet.",
+ "changeCommissionCheckCriteriaType": {
"type": "object",
+ "description": "Base type for payment activity information",
"properties": {
- "taskCode": {
- "description": "The Code for the task.",
+ "hotelId": {
+ "description": "Property of the commission record.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "bankAccountId": {
+ "description": "Unique id of bank account.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "batchId": {
+ "description": "Batch id of the commission payments.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "checkNo": {
+ "description": "New check no of commission check.",
+ "type": "number"
+ },
+ "paymentId": {
+ "description": "Unique payment id of the commission check.",
+ "$ref": "#/definitions/uniqueID_Type"
}
}
},
- "assignedTasksType": {
- "description": "Holds the assigned task codes for a tasksheet.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/assignedTaskType"
- }
- },
- "associateCommissionAgentToReservations": {
- "description": "Request type for associating reservations to Travel Agent or Source Profile.",
+ "commissionCheckStatus": {
"type": "object",
+ "description": "Response Body.",
"properties": {
- "commissionAgent": {
- "description": "Contains the id and type of the travel agent or source profile to be associated with the reservation.",
- "$ref": "#/definitions/commissionAgentIDType"
- },
- "instructions": {
- "description": "List of commission reservation instructions.",
- "$ref": "#/definitions/commissionReservationInstructionsType"
- },
"links": {
"$ref": "#/definitions/links"
},
- "reservations": {
- "description": "Contains list of reservation ids that will be associated to a travel agent or source profile.",
- "$ref": "#/definitions/hotelReservationsIDType"
- },
"warnings": {
"$ref": "#/definitions/warningsType"
}
}
},
- "associateCommissionAgentToReservationsStatus": {
- "description": "Response type for associating reservations to Travel Agent or Source Profile.",
+ "commissionPaymentsActivityDetails": {
"type": "object",
+ "description": "Response type for commission payments activity.",
"properties": {
- "commissionReservationFailures": {
- "description": "List of reservations that wasn't successfully associated with the agent.",
- "$ref": "#/definitions/commissionReservationFailuresType"
+ "paymentsActivity": {
+ "description": "List of payment activity information",
+ "$ref": "#/definitions/commissionPaymentsActivityType"
},
"links": {
"$ref": "#/definitions/links"
@@ -20016,168 +18307,186 @@
}
}
},
- "associatedResType": {
- "description": "Information regarding associated reservations to the reservation.",
- "type": "object",
- "properties": {
- "originalMultiRoomRes": {
- "description": "Stores Unique ID of the original multi room reservation from which this reservation is split off.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "parentReservation": {
- "description": "Stores Unique ID of the parent reservation.",
- "$ref": "#/definitions/uniqueID_Type"
- }
+ "commissionPaymentsActivityType": {
+ "type": "array",
+ "description": "List of payment activity information",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/commissionPaymentActivityType"
}
},
- "attachmentType": {
- "description": "Attached files.",
+ "commissionPaymentActivityType": {
"type": "object",
+ "description": "Base type for payment activity information",
"properties": {
- "description": {
- "description": "Description for the file.",
+ "hotelId": {
+ "description": "Property of the commission record.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "fileName": {
- "description": "Name of the file.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "bankAccountId": {
+ "description": "Unique id of bank account.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "fileSize": {
- "description": "Size of the file.",
- "type": "integer"
+ "batchId": {
+ "description": "Batch id of the commission payments.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "global": {
- "description": "Flag to say if attachment is available across properties.",
- "type": "boolean"
+ "paymentId": {
+ "description": "Unique payment id of the commission check.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "history": {
- "description": "History data associated with Attachment.",
- "$ref": "#/definitions/dateTimeStampGroupType"
+ "agentId": {
+ "description": "Unique travel agent or source profile ID.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "hotelId": {
- "description": "Hotel Code.",
+ "paymentDate": {
+ "description": "Payment date of commission",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "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",
- "maxLength": 80,
- "minLength": 0
+ "checkNo": {
+ "description": "Check no of payment.",
+ "type": "number"
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "fileName": {
+ "description": "File name if payment method is EFT.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "status": {
+ "description": "Payment activity status.",
+ "$ref": "#/definitions/commissionPaymentActivityStatusType"
},
- "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.",
+ "payee": {
+ "description": "Payee of commission",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 100
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "commissionAmount": {
+ "description": "Commission amount payment.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "statusDate": {
+ "description": "Status date of payment activity",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "onCommission": {
+ "description": "Whether this payment batch has related commission records. Commission records could be unlinked for check payments when it is reprinted.",
+ "type": "boolean"
}
}
},
- "attachmentsType": {
- "description": "Attachment List.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/attachmentType"
- }
+ "commissionPaymentActivityStatusType": {
+ "type": "string",
+ "description": "Simple type for payment activity status type. Valid values are Outstanding, Reconciled, Unpresented and Void.",
+ "enum": [
+ "Outstanding",
+ "Reconciled",
+ "Unpresented",
+ "Void",
+ "Failed"
+ ]
},
- "attendantType": {
+ "commissionPaymentActivityByRangeToBeChanged": {
"type": "object",
+ "description": "Request type for updating a range of payments activity.",
"properties": {
- "attendantId": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "criteria": {
+ "description": "Contains criteria for updating a range of payments activity",
+ "$ref": "#/definitions/changeCommissionPaymentActivityRangeCriteriaType"
},
- "hotelId": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "authorizationRuleType": {
- "description": "Configured rule for computing the amount to authorize.",
+ "changeCommissionPaymentActivityRangeCriteriaType": {
"type": "object",
+ "description": "Base type for payment activity information",
"properties": {
- "amount": {
- "description": "The amount applicable to the authorization rule.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "code": {
- "description": "The authorization rule code.",
- "type": "integer",
- "pattern": "[0-9]{1,9}"
+ "hotelId": {
+ "description": "Property of the commission record.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "percent": {
- "description": "A percentage value if the authorization rule is percentage based.",
- "type": "number"
+ "bankAccountId": {
+ "description": "Unique id of bank account.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "batchId": {
+ "description": "Batch id of the commission payments.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "paymentActivityRange": {
+ "description": "Batch or Check range numbers.",
+ "$ref": "#/definitions/numberRangeType"
+ },
+ "paymentActivityStatus": {
+ "description": "Criteria for updating status of a range payment activity.",
+ "$ref": "#/definitions/commissionPaymentActivityStatusCriteriaType"
}
}
},
- "authorizerInfoType": {
- "description": "Authorizer Information",
+ "numberRangeType": {
"type": "object",
+ "description": "Date Range with Start and End dates.",
"properties": {
- "authorizerId": {
- "$ref": "#/definitions/uniqueID_Type"
- },
- "authorizerName": {
- "description": "Full name of the authorizer.",
- "type": "string",
- "maxLength": 100,
- "minLength": 0
+ "from": {
+ "description": "The starting value of the range of number",
+ "type": "integer"
},
- "authorizerRateCode": {
- "description": "Rate code of the authorizer.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "to": {
+ "description": "The ending value of the range of number",
+ "type": "integer"
+ }
+ }
+ },
+ "commissionPaymentActivityStatusCriteriaType": {
+ "type": "object",
+ "description": "Criteria for updating status of a range of payment activity .",
+ "properties": {
+ "status": {
+ "description": "New status for payment activity.",
+ "$ref": "#/definitions/commissionPaymentActivityStatusType"
},
- "authorizerUserName": {
- "description": "Application user name of the authorizer",
+ "statusDate": {
+ "description": "Date applied when new status is applied. Used in Unpresented and Reconcile.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
+ }
+ }
+ },
+ "commissionPaymentActivityByRangeStatus": {
+ "type": "object",
+ "description": "Response Body.",
+ "properties": {
+ "links": {
+ "$ref": "#/definitions/links"
},
- "inheritAuthorizerRateCode": {
- "description": "Indicates whether user has the choice to have reservation inherit rate code from the authorizer.",
- "type": "boolean"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "autoAssignRoom": {
- "description": "Request for auto assignment of rooms to reservations.",
+ "reprintCommissionCheckByRange": {
"type": "object",
+ "description": "Request type for reprinting a range of check payments.",
"properties": {
"criteria": {
- "description": "Criteria for auto assignment of rooms to reservations.",
- "$ref": "#/definitions/reservationAutoRoomAssignRequestType"
+ "description": "Contains criteria for reprinting a range of check payments",
+ "$ref": "#/definitions/reprintCommissionCheckRangeCriteriaType"
},
"links": {
"$ref": "#/definitions/links"
@@ -20187,242 +18496,361 @@
}
}
},
- "autoAssignedRoom": {
- "description": "Collection of result set which is made of reservation id, error and warning.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/autoRoomAssignType"
- }
- },
- "autoRoomAssignType": {
- "description": "Collection of error and warning if any.",
+ "reprintCommissionCheckRangeCriteriaType": {
"type": "object",
+ "description": "Base type for payment activity information",
"properties": {
- "arrivalDate": {
- "description": "Arrival date of the reservation.",
+ "hotelId": {
+ "description": "Property of the commission record.",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 20
},
- "confirmationNo": {
- "description": "Reservation confirmation number.",
+ "bankAccountId": {
+ "description": "Unique id of bank account.",
"$ref": "#/definitions/uniqueID_Type"
},
- "departureDate": {
- "description": "Departure date of the reservation.",
- "type": "string",
- "format": "date-time"
+ "batchId": {
+ "description": "Batch id of the commission payments.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "errors": {
- "description": "Details of the errors.",
- "$ref": "#/definitions/errorsType"
+ "checkRange": {
+ "description": "Check range.",
+ "$ref": "#/definitions/numberRangeType"
},
- "guestName": {
- "description": "Guest name associated to the reservation.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "startCheckNo": {
+ "description": "Start check no of commission to be applied to the set.",
+ "type": "number"
},
- "reservationId": {
- "description": "Unique identifiers for the reservation for auto assign room.",
- "$ref": "#/definitions/reservationId"
+ "allowExistingCheckNo": {
+ "description": "Set to true if an existing check number can be used as the starting check number for reprint.",
+ "type": "boolean"
+ }
+ }
+ },
+ "reprintCommissionCheckByRangeStatus": {
+ "type": "object",
+ "description": "Response type for reprinting a range of check payments.",
+ "properties": {
+ "reprintCheckReport": {
+ "description": "Contains report id and batch id",
+ "$ref": "#/definitions/commissionPaymentReportType"
},
- "roomId": {
- "description": "Room number associated to the reservation.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
"warnings": {
- "description": "Details of the warnings.",
"$ref": "#/definitions/warningsType"
}
}
},
- "awardId": {
- "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).",
+ "commissionPaymentReportType": {
"type": "object",
+ "description": "Contains report id, batch id (for check payments) or export file (for eft payments)",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
+ "reportId": {
+ "description": "The report instance ID.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "batchId": {
+ "description": "Batch id of the commission payments.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "batchName": {
+ "description": "If payment method is EFT, batch name of the payments.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "exportFile": {
+ "description": "If payment method is EFT, file location of the file generated.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
+ "exportBlobFile": {
+ "description": "If payment method is EFT, Export BLOB file from database in base64 binary format.",
+ "type": "string",
+ "format": "byte"
+ }
+ }
+ },
+ "batchCCAuth": {
+ "type": "object",
+ "description": "Request to start a batch job that will process a list of reservation, and their associated payment methods, that require credit card authorizations.",
+ "properties": {
+ "hotelId": {
+ "$ref": "#/definitions/codeType"
+ },
+ "reservations": {
+ "$ref": "#/definitions/reservationsForCCAuthType"
+ },
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "batchCCAuthToProcess": {
+ "type": "object",
+ "description": "Response for starting a credit card authorization batch job, which contains the batch ID upon success.",
+ "properties": {
+ "batchId": {
"type": "integer"
},
- "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",
- "maxLength": 80,
- "minLength": 0
+ "processId": {
+ "$ref": "#/definitions/stringLength200"
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "awardKindType": {
- "description": "Indicates that this is electronic certificate.",
+ "stringLength200": {
"type": "string",
- "enum": [
- "Paper",
- "ECertificate"
- ]
+ "description": "Used for Character Strings, length 0 to 200.",
+ "maxLength": 200,
+ "minLength": 0
},
- "awardStatusType": {
- "description": "Indicates that certificate is in use.",
- "type": "string",
- "enum": [
- "Available",
- "NotAvailable",
- "InUse"
- ]
+ "reservationsInfo": {
+ "type": "object",
+ "description": "Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.",
+ "properties": {
+ "reservationInfoList": {
+ "description": "Collection of Reservations and their information.",
+ "type": "object",
+ "properties": {
+ "reservationInfo": {
+ "description": "Contains details of the reservation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/reservationInfoType"
+ }
+ }
+ }
+ },
+ "masterInfoList": {
+ "description": "Refer to Generic common types document",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/masterInfoType"
+ }
+ },
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
},
- "awardType": {
- "description": "Detailed information of the awards.",
+ "reservationInfoType": {
"type": "object",
+ "description": "The Reservation class contains the current reservation being created or altered.",
"properties": {
- "awardCode": {
- "description": "Award category.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "reservationIdList": {
+ "description": "Unique identifiers for the reservation for both internal and external systems",
+ "$ref": "#/definitions/reservationIdList"
},
- "awardType": {
- "description": "Can be P (Paper) or E (E-Certificate).",
- "$ref": "#/definitions/awardKindType"
+ "externalReferences": {
+ "description": "External Reference information for Reservation.",
+ "$ref": "#/definitions/externalReferencesType"
},
- "categoryValid": {
- "description": "Indicates whether the category of certificate is valid or not for this resort.",
- "type": "boolean"
+ "roomStay": {
+ "description": "Collection of room stays.",
+ "$ref": "#/definitions/stayInfoType"
},
- "certificateNo": {
- "description": "Certificate No.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "reservationGuest": {
+ "description": "Collection of guests associated with the reservation.",
+ "$ref": "#/definitions/resGuestInfoType"
},
- "createDateTime": {
- "description": "Time stamp of the creation.",
- "type": "string",
- "format": "date-time"
+ "sharedGuests": {
+ "description": "Collection of guests who share this reservation.",
+ "$ref": "#/definitions/resSharedGuestListType"
},
- "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",
- "maxLength": 200,
- "minLength": 0
+ "attachedProfiles": {
+ "description": "List of attached profiles",
+ "$ref": "#/definitions/resAttachedProfileListType"
},
- "description": {
- "description": "Description of the award/certificate.",
- "type": "string"
+ "reservationPaymentMethod": {
+ "description": "Payment method used for this reservation",
+ "$ref": "#/definitions/reservationPaymentMethodType"
},
- "detailedCertificate": {
- "description": "Indicates if this certificate is detailed or not.",
- "type": "boolean"
+ "reservationFolioWindows": {
+ "description": "Collection of reservation folio windows.",
+ "$ref": "#/definitions/reservationFolioWindowsType"
},
- "displaySequence": {
- "description": "Indicates the order in which the certificates received from MRW.",
- "type": "number"
+ "specials": {
+ "description": "Set of reservation preferences which belongs to the Specials group.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
},
- "expirationDate": {
- "description": "Expiration Date.",
+ "lastPrivacyPromptDate": {
+ "description": "Last Privacy Prompt Date",
"type": "string",
"format": "date",
"maxLength": 8
},
- "externalConfirmationNo": {
- "description": "Confirmation Number given by a CRS application for this reservation.",
+ "displayColor": {
+ "description": "Color setting of the reservation.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "externalHotelCode": {
- "description": "Hotel Code of the CRS application that this certificate belongs to.",
+ "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"
+ },
+ "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"
+ }
+ },
+ "guestPreferredCurrency": {
+ "description": "Currency code preferred by guest.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "fBAInfo": {
- "description": "FBA related fields.",
- "$ref": "#/definitions/fBAInfoType"
+ "turndownInfo": {
+ "description": "Currency code preferred by guest.",
+ "$ref": "#/definitions/reservationTurndownInfoType"
},
- "gift": {
- "description": "Signifies whether award is gift or not.",
+ "mobileNotifications": {
+ "description": "Denotes the status of Room Ready, Key Ready messages.",
+ "$ref": "#/definitions/resMobileNotificationsType"
+ },
+ "reservationCommunication": {
+ "description": "Collection of reservation communication details.",
+ "$ref": "#/definitions/resCommunicationType"
+ },
+ "advanceCheckIn": {
+ "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return",
+ "$ref": "#/definitions/advanceCheckInType"
+ },
+ "welcomeOffer": {
+ "description": "This flag will determine wheather the reservation is eligible for Welcome Offer or not.",
"type": "boolean"
},
- "hotelCategory": {
- "description": "Indicates the lowest hotel category for which the certificate is valid.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "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
+ }
+ }
+ },
+ "keyCount": {
+ "description": "Number of keys created for the reservation.",
+ "type": "integer"
},
"hotelId": {
- "description": "Hotel Code for which the routing instructions are provided for a profile.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "instantlyRedeemable": {
- "description": "Indicates if the award is an Instant Redemption award.",
+ "hotelName": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "expectedServiceTime": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "roomStayReservation": {
+ "description": "Boolean True if this reservation is reserving rooms. False if it is only reserving services.",
"type": "boolean"
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "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"
},
- "masterCertificiateNo": {
- "description": "Master Certificate No.",
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "membershipNo": {
- "description": "Membership No.",
- "type": "string"
- },
- "nights": {
- "description": "Award Nights.",
- "type": "integer"
- },
- "package": {
- "description": "Signifies whether upgrade is package or not.",
- "type": "boolean"
- },
- "paidUpgrade": {
- "description": "Indicates if this certificate was ordered using the \"Paid Upgrade\" option in the E-Certs screen.",
- "type": "boolean"
- },
- "points": {
- "description": "No. of points used to order this award.",
- "type": "number"
- },
- "profileId": {
- "description": "Unique profile identifier requested to be fetched.",
- "$ref": "#/definitions/profileId"
+ "minLength": 0,
+ "maxLength": 200
},
"purgeDate": {
"description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
@@ -20430,3108 +18858,3096 @@
"format": "date",
"maxLength": 8
},
- "quantity": {
- "description": "Quantity of such awards needed to be ordered.",
- "type": "integer"
+ "reservationStatus": {
+ "description": "Indicates the status of the reservation.",
+ "$ref": "#/definitions/pMS_ResStatusType"
},
- "reservationCertificateType": {
- "description": "[R]=Reward, [I]=Incentive.",
- "$ref": "#/definitions/reservationCertificateType"
+ "computedReservationStatus": {
+ "description": "Indicates the status of the reservation.",
+ "$ref": "#/definitions/pMS_ResStatusType"
},
- "reservationId": {
- "description": "Reservation IDs will be empty if award is not attached.",
- "$ref": "#/definitions/reservationId"
+ "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"
},
- "rewardCertificateType": {
- "description": "[RE]=Regular Certificate, [SA]=Stay Anytime Certificate, [PS]=Point Saver Certificate.",
- "$ref": "#/definitions/rewardCertificateType"
+ "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"
},
- "sourceType": {
- "description": "MRW : From MRW MAN:Entered manually.",
- "type": "string"
+ "commissionPayoutTo": {
+ "description": "If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.",
+ "$ref": "#/definitions/commissionPayoutToType"
},
- "status": {
- "description": "Status of the award aka available.",
- "$ref": "#/definitions/awardStatusType"
+ "paymentMethod": {
+ "description": "Payment Method.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "upgrade": {
- "description": "Signifies whether upgrade award or not.",
+ "preRegistered": {
+ "description": "Defines if the reservation is pre-registered or not.",
+ "type": "boolean"
+ },
+ "openFolio": {
+ "description": "Returns true when reservation has an open folio.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "allowMobileViewFolio": {
+ "description": "Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.",
+ "type": "boolean"
+ },
+ "optedForCommunication": {
+ "description": "Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.",
"type": "boolean"
}
}
},
- "awardVouchersType": {
- "description": "This stores the Membership Awards code applied on the reservation.",
+ "reservationIdList": {
"type": "array",
- "maxItems": 5,
+ "description": "Unique Id that references an object uniquely in the system.",
+ "maxItems": 4000,
"items": {
- "type": "object",
- "properties": {
- "awardCode": {
- "description": "Membership Award code applied on the reservation.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "voucherNo": {
- "description": "Membership Award number.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- }
- }
+ "$ref": "#/definitions/uniqueID_Type"
}
},
- "awardsType": {
- "description": "List of awards.",
+ "externalReferencesType": {
"type": "array",
+ "description": "This type contains unique information of external reference.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/awardType"
+ "$ref": "#/definitions/externalReferenceType"
}
},
- "bankAccountType": {
- "description": "Bank account information like Account ID, Bank Name, Currency, etc.",
+ "externalReferenceType": {
"type": "object",
+ "description": "This type contains unique information of external reference.",
"properties": {
- "bankAccountId": {
- "description": "Bank account ID.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "bankAccountNo": {
- "description": "Account number at the bank.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "bankCode": {
- "description": "Unique code of the bank account.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "bankName": {
- "description": "Name of the bank account.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "branchCode": {
- "description": "Code for the branch of the bank.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "checkFormat": {
- "description": "Type of format for Payment Method.",
+ "id": {
+ "description": "Unique ID of external reference.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "currency": {
- "description": "Currency associated with the bank account.",
- "$ref": "#/definitions/codeDescriptionType"
- },
- "currentCheckNo": {
- "description": "Current check no of the bank account.",
- "type": "number"
- },
- "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"
+ "minLength": 0,
+ "maxLength": 80
},
- "hotelId": {
- "description": "Property of the bank account.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "idExtension": {
+ "description": "ID extension for external reference.",
+ "type": "integer"
},
- "hotelName": {
- "description": "Property name of the bank account.",
+ "idContext": {
+ "description": "ID context for external reference.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "linkedToProfile": {
- "description": "Whether this bank account is associated with the travel agent or source.",
- "type": "boolean"
- },
- "paymentMethod": {
- "description": "Type of payment associated with the bank account.",
- "$ref": "#/definitions/commissionPaymentMethodType"
+ "minLength": 0,
+ "maxLength": 80
}
}
},
- "bankAccountsDetails": {
- "description": "Returns bank accounts that match the request criteria.",
+ "stayInfoType": {
"type": "object",
+ "description": "Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.",
"properties": {
- "bankAccounts": {
- "$ref": "#/definitions/bankAccountsType"
+ "arrivalDate": {
+ "type": "string",
+ "format": "date"
},
- "links": {
- "$ref": "#/definitions/links"
+ "departureDate": {
+ "type": "string",
+ "format": "date"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "bankAccountsType": {
- "description": "List of bank accounts.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/bankAccountType"
- }
- },
- "basicEmailType": {
- "description": "Email address",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "batchCCAuth": {
- "description": "Request to start a batch job that will process a list of reservation, and their associated payment methods, that require credit card authorizations.",
- "type": "object",
- "properties": {
- "hotelId": {
- "$ref": "#/definitions/codeType"
+ "originalTimeSpan": {
+ "description": "The Original Time Span covers the Room Stay dates of the original reservation.",
+ "$ref": "#/definitions/timeSpanType"
},
- "links": {
- "$ref": "#/definitions/links"
+ "expectedTimes": {
+ "description": "The expected arrival, return and departure times of the guest.",
+ "$ref": "#/definitions/resExpectedTimesType"
},
- "reservations": {
- "$ref": "#/definitions/reservationsForCCAuthType"
+ "adultCount": {
+ "description": "A collection of Guest Counts associated with Room Stay.",
+ "type": "integer"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "batchCCAuthToProcess": {
- "description": "Response for starting a credit card authorization batch job, which contains the batch ID upon success.",
- "type": "object",
- "properties": {
- "batchId": {
+ "childCount": {
+ "description": "A collection of Child Counts associated with Room Stay.",
"type": "integer"
},
- "links": {
- "$ref": "#/definitions/links"
+ "roomClass": {
+ "description": "Room class code",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "processId": {
- "$ref": "#/definitions/stringLength200"
+ "roomType": {
+ "description": "Room type code",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "bedTaxReportingType": {
- "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.",
- "type": "object",
- "properties": {
- "taxRegistrationNo": {
- "description": "Tax Registration Number for Maldives Bed Tax Reporting.",
- "type": "number"
+ "componentRoomType": {
+ "description": "True indicates room type is a component type.",
+ "type": "boolean"
},
- "taxableDays": {
- "description": "Number of days for which the Maldives tax is applicable.",
+ "numberOfRooms": {
+ "description": "Room Id",
"type": "integer"
},
- "visaExpiryDate": {
- "description": "Visa Expiration Date used for Maldives Bed Tax Reporting",
+ "roomId": {
+ "description": "Room Id",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "visaIssueDate": {
- "description": "Visa Issue Date used for Maldives Bed Tax Reporting.",
+ "ratePlanCode": {
+ "description": "Rate plan code",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "visaNumber": {
- "description": "Visa number used for Maldives Bed Tax Reporting",
+ "rateAmount": {
+ "description": "Rate amount",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "points": {
+ "description": "The Points contains the number of points used to book a particular room type.",
+ "$ref": "#/definitions/pointsType"
+ },
+ "rateSuppressed": {
+ "description": "Whether this rate should be suppressed from view",
+ "type": "boolean"
+ },
+ "reservationBlock": {
+ "description": "Key information about the block for this reservation.",
+ "$ref": "#/definitions/reservationBlockType"
+ },
+ "bookingChannelCode": {
+ "description": "Booking channel code",
"type": "string",
- "maxLength": 40,
- "minLength": 0
- }
- }
- },
- "benefitType": {
- "description": "Basic information about membership benefit.",
- "type": "object",
- "properties": {
- "code": {
- "description": "Benefit code associated with a membership.",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "linkCode": {
+ "description": "Party code",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "maxLength": 2000
},
- "inactive": {
- "description": "Indicates whether membership benefit is active or inactive.",
+ "fixedRate": {
+ "description": "True if the rate is a fixed rate, otherwise false",
"type": "boolean"
},
- "message": {
- "description": "Processing message for membership benefit.",
- "type": "string",
- "maxLength": 4000,
- "minLength": 0
- }
- }
- },
- "benefitsType": {
- "description": "Basic information about membership benefit.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/benefitType"
- }
- },
- "billingInstructionType": {
- "description": "Configured Billing Instruction which represents a set of Transaction Codes.",
- "type": "object",
- "properties": {
- "billingCode": {
- "description": "Unique identifier for the Billing Instruction.",
+ "totalAmount": {
+ "description": "The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "guarantee": {
+ "description": "The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.",
+ "$ref": "#/definitions/resGuaranteeType"
+ },
+ "promotion": {
+ "description": "Promotion Codes",
+ "$ref": "#/definitions/promotionType"
+ },
+ "marketCode": {
+ "description": "Market code",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "desc": {
- "description": "Billing Instruction code description.",
+ "marketDescription": {
+ "description": "Description of Market code",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 4000
},
- "hotelId": {
- "description": "Hotel context of the Billing Instruction.",
+ "sourceCode": {
+ "description": "Source of business",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "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"
- }
- }
- },
- "billingInstructionsType": {
- "description": "Set of Billing Instruction codes.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/billingInstructionType"
- }
- },
- "billingPrivilegesType": {
- "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.",
- "type": "object",
- "properties": {
- "allowAutoCheckin": {
- "description": "Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.",
- "type": "boolean"
+ "sourceCodeDescription": {
+ "description": "Description of the source of business.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
},
- "autoSettlement": {
- "description": "Indicates if the is a candidate for auto folio settlement.",
- "type": "boolean"
+ "balance": {
+ "description": "Balance amount",
+ "$ref": "#/definitions/currencyAmountType"
},
- "autoSettlementFreq": {
- "description": "The interval of days between each auto folio settlement.",
- "type": "integer"
+ "compBalance": {
+ "description": "Comp Balance amount",
+ "$ref": "#/definitions/currencyAmountType"
},
- "autoSettlementType": {
- "description": "The folio settlement type for auto folio settlement.",
+ "roomTypeCharged": {
+ "description": "Room type code that was charged",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "creditLimitAutoPay": {
- "description": "Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results.",
- "type": "boolean"
+ "depositPayments": {
+ "description": "A collection of deposit and/or payments for the Room Stay.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "directBillAuthorized": {
- "description": "If Direct bill is authorized this will hold User ID who authorized it.",
- "type": "boolean"
+ "guestServiceStatus": {
+ "description": "Service Status of In House guest like DND or MUP",
+ "$ref": "#/definitions/guestHousekeepingServiceRequestType"
},
- "folioCloseDate": {
- "description": "Date when folio was closed. This works with PostStayCharging flag.",
+ "scheduledCheckoutTime": {
+ "description": "Indicates that this reservation is scheduled for automated check out.",
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "postStayCharging": {
- "description": "Indicates if the reservation has charging privileges after checkout.",
- "type": "boolean"
+ "format": "date"
},
- "postingRestriction": {
- "description": "Flag used by interface program during check in.",
+ "roomNumberLocked": {
+ "description": "When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.",
"type": "boolean"
},
- "preStayCharging": {
- "description": "Indicates if the reservation has charging privileges before arrival.",
+ "pseudoRoom": {
+ "description": "True indicates as pseudo room type. This is usually used for a posting master reservation.",
"type": "boolean"
},
- "scheduledCheckout": {
- "description": "Indicates if the guest is scheduled for automatic check out.",
+ "assignedByAI": {
+ "description": "Represents the room was assigned by AI Room Assignment.",
"type": "boolean"
},
- "scheduledCheckoutTime": {
- "description": "Time of automatic check out if guest is schedule for automatic check out.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "videoCheckout": {
- "description": "Indicates if the guest can do video checkout",
+ "upgradedByAI": {
+ "description": "Represents the room was assigned by AI Room Assignment.",
"type": "boolean"
}
}
},
- "blockId": {
- "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).",
+ "pointsType": {
"type": "object",
+ "description": "The Redeem Points contains the number of points required to book a room type.",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "awardsType": {
+ "description": "Awards type for the award type rate code.",
+ "type": "string"
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
+ "points": {
+ "description": "No of points required to book this Room Stay.",
"type": "integer"
+ }
+ }
+ },
+ "reservationBlockType": {
+ "type": "object",
+ "description": "Key information about the block for a reservation.",
+ "properties": {
+ "blockIdList": {
+ "description": "Collection of unique block identifiers for the reservation.",
+ "$ref": "#/definitions/blockIdList"
},
- "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.",
+ "blockName": {
+ "description": "The Name of the block that is attached to the reservation.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "hotelId": {
+ "description": "This is the HotelCode of the Block.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "minLength": 0,
+ "maxLength": 20
}
}
},
"blockIdList": {
- "description": "Unique Id that references an object uniquely in the system.",
"type": "array",
+ "description": "Unique Id that references an object uniquely in the system.",
"maxItems": 4000,
"items": {
"$ref": "#/definitions/uniqueID_Type"
}
},
- "blockResvSummaryType": {
- "description": "Indicates summary of the Total reservations for the block.",
- "type": "object",
- "properties": {
- "totalReservations": {
- "description": "Number of reservations with block.",
- "type": "integer"
- }
- }
- },
- "calculateCommissions": {
- "description": "Request type for calculation of commission for all Travel Agent and/or Source.",
+ "resGuaranteeType": {
"type": "object",
+ "description": "Validations type record returned after Validations are done.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "guaranteeCode": {
+ "description": "Guarantee Code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "shortDescription": {
+ "description": "Guarantee Code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "onHold": {
+ "description": "Guarantee Code.",
+ "type": "boolean"
}
}
},
- "calculateCommissionsStatus": {
- "description": "Existing Operations Responses will eventually be modified to be extended from this type.",
+ "promotionType": {
"type": "object",
+ "description": "Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "promotionCode": {
+ "description": "Promotion code associated with the rate plan.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "promotionName": {
+ "description": "Promotion code Name associated with the rate plan.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "couponCode": {
+ "description": "Promotion Coupon Code when promotion is setup to have a valid coupon code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "callHistoryType": {
- "description": "Holds call information.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/callType"
- }
+ "guestHousekeepingServiceRequestType": {
+ "type": "string",
+ "description": "Possible values for the Guest Service Status.",
+ "enum": [
+ "DoNotDisturb",
+ "MakeUpRoom",
+ "NoStatusSelected"
+ ]
},
- "callType": {
- "description": "Holds call information.",
+ "resGuestInfoType": {
"type": "object",
+ "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.",
"properties": {
- "caller": {
- "description": "Holds caller information.",
- "$ref": "#/definitions/callerType"
+ "membership": {
+ "description": "The Membership object identifying the frequent customer reward program.",
+ "$ref": "#/definitions/membershipInfoType"
},
- "comments": {
- "description": "Call comments.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "namePrefix": {
+ "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)",
+ "$ref": "#/definitions/namePrefixType"
},
- "dateTimeSpan": {
- "description": "Call Time Span. Start Date and End Date is used for the Call duration.",
- "$ref": "#/definitions/dateTimeSpanType"
+ "givenName": {
+ "description": "Given name, first name or names",
+ "$ref": "#/definitions/givenNameType"
},
- "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.",
+ "alternateGivenName": {
+ "description": "Alternate given name, first name or names",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "middleName": {
+ "description": "The middle name of the person name",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
- },
- "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.",
+ "surnamePrefix": {
+ "description": "e.g \"van der\", \"von\", \"de\"",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "reservation": {
- "description": "Holds Reservation Id and Hotel Code.",
- "type": "object",
- "properties": {
- "hotelId": {
- "description": "Holds Hotel Code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "reservationIdList": {
- "description": "Holds Reservation related Ids.",
- "$ref": "#/definitions/reservationIdList"
- }
- }
+ "surname": {
+ "description": "Family name, last name.",
+ "$ref": "#/definitions/surnameType"
},
- "turnawayCode": {
- "description": "Call turn away code.",
+ "alternateSurname": {
+ "description": "Alternate family name, last name.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "nameSuffix": {
+ "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "nameTitle": {
+ "description": "Degree or honors (e.g., Ph.D., M.D.)",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "fullName": {
+ "description": "Full display name",
"type": "string"
- }
- }
- },
- "callerType": {
- "description": "Holds caller information.",
- "type": "object",
- "properties": {
+ },
+ "alternateFullName": {
+ "description": "Altername full display name",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "Phone number",
+ "$ref": "#/definitions/phoneNumberType"
+ },
"email": {
- "description": "Caller Email.",
+ "description": "Email address",
+ "$ref": "#/definitions/basicEmailType"
+ },
+ "birthDate": {
+ "description": "Date of birth",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "fax": {
- "description": "Caller Fax Number.",
+ "language": {
+ "description": "Language identification.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
},
- "givenName": {
- "description": "Caller First Name.",
+ "nationality": {
+ "description": "Affiliation or ethnicity to a particular country.",
+ "$ref": "#/definitions/countryNameType"
+ },
+ "vip": {
+ "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).",
+ "$ref": "#/definitions/vIPType"
+ },
+ "address": {
+ "description": "Address information that is attached to the reservation guest",
+ "$ref": "#/definitions/addressSearchType"
+ },
+ "anonymization": {
+ "description": "Provides information about the guest's anonymization status",
+ "$ref": "#/definitions/anonymizationType"
+ },
+ "accompanyGuests": {
+ "description": "List of guest names that are accompanying the reservation guest",
+ "$ref": "#/definitions/resAccompanyGuestListType"
+ },
+ "externalInfo": {
+ "description": "External information about the guest associated with the reservation.",
+ "$ref": "#/definitions/resGuestExternalInfoType"
+ },
+ "guestLastStayInfo": {
+ "description": "Contains information regarding the last stay of this guest.",
+ "$ref": "#/definitions/guestLastStayInfoType"
+ },
+ "guestRestrictedCode": {
+ "description": "Guest profile restricted reason code",
+ "type": "string"
+ },
+ "guestRestrictedReasonDesc": {
+ "description": "Guest profile restricted reason description",
+ "type": "string"
+ },
+ "guestRestricted": {
+ "description": "True indicates there are restrictions associated with the current profile.",
+ "type": "boolean"
+ },
+ "registrationCardNo": {
+ "description": "Unique identifier of the police registration card number.",
"type": "string",
- "maxLength": 280,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "nameType": {
+ "$ref": "#/definitions/nameTypeType"
},
"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",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
+ }
+ }
+ },
+ "membershipInfoType": {
+ "type": "object",
+ "description": "The Membership object identifies the frequent customer reward program.",
+ "properties": {
+ "membershipId": {
+ "description": "Membership ID (Unique ID from the memberships table).",
+ "type": "number"
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "programCode": {
+ "description": "The code or name of the membership program ('Hertz', 'AAdvantage', etc.).",
+ "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.",
+ "bonusCode": {
+ "description": "The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "phone": {
- "description": "Caller Phone Number.",
+ "membershipTypeDesc": {
+ "description": "The description of the ProgramCode.(Delta Previlige for code DP)",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "surname": {
- "description": "Caller Last Name.",
+ "membershipLevelDesc": {
+ "description": "The description of the Bonus Code.(Platinum for code P)",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "accountId": {
+ "description": "The account identification number for this particular member in this particular program.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 50
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "membershipLevel": {
+ "description": "The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "playerRanking": {
+ "description": "Ranking assigned to the Player Profile by the Gaming system.",
+ "type": "integer"
}
}
},
- "cardNumberTypeType": {
- "description": "Simple type for indicating if credit card number is tokenized.",
+ "namePrefixType": {
"type": "string",
- "enum": [
- "CardNumber",
- "Token"
- ]
+ "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)",
+ "minLength": 0,
+ "maxLength": 40
},
- "cardProcessingType": {
+ "givenNameType": {
"type": "string",
- "enum": [
- "Eft",
- "Manual"
- ]
+ "description": "Given name, first name or names",
+ "minLength": 0,
+ "maxLength": 40
},
- "cardReIssueType": {
- "description": "Request to re issue a new card.",
+ "surnameType": {
"type": "string",
- "enum": [
- "Pending",
- "NotApplicable",
- "Requested"
- ]
+ "description": "Family name, last name.",
+ "minLength": 0,
+ "maxLength": 80
},
- "cardTypeType": {
- "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.",
+ "phoneNumberType": {
"type": "string",
- "enum": [
- "Ab",
- "Am",
- "Ax",
- "Cb",
- "Dc",
- "Ds",
- "Dt",
- "Ec",
- "Er",
- "Jc",
- "Jl",
- "Mc",
- "Nb",
- "So",
- "St",
- "Sw",
- "Va",
- "Xy",
- "Zz",
- "Cp",
- "Cu"
- ]
+ "description": "Phone number",
+ "minLength": 0,
+ "maxLength": 40
},
- "cateringResInfoType": {
- "description": "Information regarding catering event and catering revenue type associated to the reservation.",
- "type": "object",
- "properties": {
- "eventId": {
- "description": "Unique ID on a catering event associated to the reservation.",
- "$ref": "#/definitions/eventId"
- },
- "revenueType": {
- "description": "Catering revenue type associated to the reservation.",
- "type": "string"
- }
- }
+ "basicEmailType": {
+ "type": "string",
+ "description": "Email address",
+ "minLength": 0,
+ "maxLength": 2000
},
- "changeCommissionCheckCriteriaType": {
- "description": "Base type for payment activity information",
+ "countryNameType": {
"type": "object",
+ "description": "Code for a country or a nationality.",
"properties": {
- "bankAccountId": {
- "description": "Unique id of bank account.",
- "$ref": "#/definitions/uniqueID_Type"
+ "value": {
+ "type": "string",
+ "description": "Used for Character Strings, length 0 to 200 - It indicates country/nationality description.",
+ "minLength": 0,
+ "maxLength": 200
},
- "batchId": {
- "description": "Batch id of the commission payments.",
- "$ref": "#/definitions/uniqueID_Type"
+ "code": {
+ "description": "Code for a country or a nationality.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "checkNo": {
- "description": "New check no of commission check.",
- "type": "number"
+ "displayCountryFlag": {
+ "description": "Setting this to true will display the guest profile's country flag in the OPERA Cloud user interface, if it is configured.",
+ "type": "boolean"
},
- "hotelId": {
- "description": "Property of the commission record.",
+ "isoCode": {
+ "description": "ISO standard code for country.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "paymentId": {
- "description": "Unique payment id of the commission check.",
- "$ref": "#/definitions/uniqueID_Type"
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "changeCommissionPaymentActivityRangeCriteriaType": {
- "description": "Base type for payment activity information",
+ "vIPType": {
"type": "object",
+ "description": "The supplier's ranking of the customer.",
"properties": {
- "bankAccountId": {
- "description": "Unique id of bank account.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "batchId": {
- "description": "Batch id of the commission payments.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "hotelId": {
- "description": "Property of the commission record.",
+ "vipCode": {
+ "description": "VIP Code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "paymentActivityRange": {
- "description": "Batch or Check range numbers.",
- "$ref": "#/definitions/numberRangeType"
+ "minLength": 0,
+ "maxLength": 20
},
- "paymentActivityStatus": {
- "description": "Criteria for updating status of a range payment activity.",
- "$ref": "#/definitions/commissionPaymentActivityStatusCriteriaType"
+ "vipDescription": {
+ "description": "VIP Description.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
}
}
},
- "changeHistoryType": {
- "description": "Creation date time, Creator Id, last modification date time and last Modifier Id.",
+ "addressSearchType": {
"type": "object",
+ "description": "Address Details such as city, state, country, postal code etc.",
"properties": {
- "createDateTime": {
- "description": "Time stamp of the creation.",
+ "cityName": {
+ "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 40
},
- "creatorId": {
- "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.",
+ "postalCode": {
+ "description": "Post Office Code number.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 15
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "state": {
+ "description": "State or Province name (e.g., Texas).",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
- "type": "string",
- "format": "date-time"
+ "country": {
+ "description": "Country name (e.g., Ireland).",
+ "$ref": "#/definitions/countryNameType"
},
- "purgeDate": {
- "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
+ "streetAddress": {
+ "description": "First Line of Street Address. For profile search it matches the first Address line.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "excludeNoCity": {
+ "description": "When true indicates that only profiles with city will be fetched.",
+ "type": "boolean"
}
}
},
- "changeInterfaceStatusType": {
- "description": "This will contain reservation id and corresponding interface information for which the interface status needs to be updated.",
+ "anonymizationType": {
"type": "object",
+ "description": "Provides information about guest's anonymization status.",
"properties": {
- "interfaceRights": {
- "description": "Contains a list of status/rights for the various services under this interface",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/interfaceRightsStatusType"
- }
- },
- "reservationId": {
- "description": "Unique identifier of the reservation.",
- "$ref": "#/definitions/reservationId"
+ "anonymizationStatus": {
+ "description": "Status of anonymization such as Requested or Anonymized.",
+ "$ref": "#/definitions/anonymizationStatusType"
},
- "roomExtension": {
- "description": "Unique identifier for the room extension",
+ "anonymizationDate": {
+ "description": "Date and Time when the guest was anonymized.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
}
}
},
- "changeRelationsType": {
- "description": "Detailed information regarding the changes made to relationships for the profile.",
+ "anonymizationStatusType": {
+ "type": "string",
+ "description": "Guest has been anonymized.",
+ "enum": [
+ "Requested",
+ "Anonymized"
+ ]
+ },
+ "resAccompanyGuestListType": {
+ "type": "array",
+ "description": "Collection of accompany guests",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/resAccompanyGuestInfoType"
+ }
+ },
+ "resAccompanyGuestInfoType": {
"type": "object",
"properties": {
- "id": {
- "description": "Relationship identifier.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "firstName": {
+ "description": "Given name, first name or names",
+ "type": "string"
},
- "relation": {
- "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "lastName": {
+ "description": "Family name, last name.",
+ "type": "string"
},
- "relationDescription": {
- "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "fullName": {
+ "description": "String representation of the full name",
+ "type": "string"
},
- "targetRelation": {
- "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).",
+ "registrationCardNo": {
+ "description": "Unique identifier of the police registration card number.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "targetRelationDescription": {
- "description": "Displays the description of the target relation(Target Profile).",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "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"
}
}
},
- "changedWakeUpCalls": {
- "description": "Existing Operations Responses will eventually be modified to be extended from this type.",
+ "profileIdList": {
+ "type": "array",
+ "description": "Unique Id that references an object uniquely in the system.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/uniqueID_Type"
+ }
+ },
+ "resGuestExternalInfoType": {
"type": "object",
+ "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "givenName": {
+ "description": "Given name, first name or names",
+ "$ref": "#/definitions/givenNameType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "surname": {
+ "description": "Family name, last name.",
+ "$ref": "#/definitions/surnameType"
}
}
},
- "characterUDFType": {
- "description": "Used to hold user defined field of Character/String Type.",
+ "guestLastStayInfoType": {
"type": "object",
+ "description": "Contains last stay related details of the guest.",
"properties": {
- "alternateName": {
- "description": "Label of user defined field used by vendors or customers.",
+ "lastStayDate": {
+ "description": "Guest's last stay date.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "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.",
+ "lastStayRoom": {
+ "description": "Room Number where the guest stayed.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "value": {
- "description": "Value of user defined field.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "lastStayRate": {
+ "description": "The Rate amount of the guest's last stay.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "totalStay": {
+ "description": "The total number of previous stay of the guest.",
+ "type": "integer"
}
}
},
- "characterUDFsType": {
- "description": "Used to hold collection of user defined fields of Character/String Type.",
+ "nameTypeType": {
+ "type": "string",
+ "enum": [
+ "Guest",
+ "Company",
+ "Agent",
+ "Contact",
+ "Source",
+ "Group",
+ "Employee",
+ "Hotel",
+ "Purge"
+ ]
+ },
+ "resSharedGuestListType": {
"type": "array",
+ "description": "Collection of shared guest reservations.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/characterUDFType"
+ "$ref": "#/definitions/resSharedGuestInfoType"
}
},
- "checkedInReservationInstructionType": {
- "description": "Fetch Instruction to indicate if any automatically generated folios information should be returned in the response. For example, in a scenario when automatic credit bills are generated during check-in for the deposits, this instruction can be used to get the credit bill folios which can be used for printing/previewing the folios.",
- "type": "string",
- "enum": [
- "ReservationDetail",
- "AutoFolios",
- "ExcludeRoomSuggestion"
- ]
- },
- "checkedinReservation": {
- "description": "CheckIn response will commonly be errors over warnings. If a check has to be done before checking a reservation to a hotel, then the VerifyCheckinReservation operation can be utilized.",
+ "resSharedGuestInfoType": {
"type": "object",
+ "description": "Contains information regarding the share reservation.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "profileId": {
+ "$ref": "#/definitions/profileId"
},
- "reservation": {
- "description": "Reservation record showing the current state of the reservation.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/hotelReservationType"
- }
+ "firstName": {
+ "description": "Given name, first name or names",
+ "type": "string"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "lastName": {
+ "description": "Family name, last name.",
+ "type": "string"
+ },
+ "fullName": {
+ "description": "String representation of the full name",
+ "type": "string"
}
}
},
- "childAgeType": {
- "description": "Defines Child's Age.",
+ "profileId": {
"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": {
- "age": {
- "description": "Age of a child in years.",
+ "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"
}
}
},
- "childAgesType": {
- "description": "Age of a child in years.",
+ "resAttachedProfileListType": {
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/childAgeType"
+ "$ref": "#/definitions/resAttachedProfileType"
}
},
- "childBucketsType": {
- "description": "Defines children counts with Age Qualifying Group(Child Bucket) classification.",
+ "resAttachedProfileType": {
"type": "object",
"properties": {
- "bucket1Count": {
- "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1).",
- "type": "integer"
- },
- "bucket2Count": {
- "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2).",
- "type": "integer"
- },
- "bucket3Count": {
- "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3).",
- "type": "integer"
+ "name": {
+ "description": "Attached profile name",
+ "type": "string"
},
- "bucket4Count": {
- "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).",
- "type": "integer"
+ "profileIdList": {
+ "description": "Collection of unique profile identifiers",
+ "$ref": "#/definitions/profileIdList"
},
- "bucket5Count": {
- "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).",
- "type": "integer"
+ "reservationProfileType": {
+ "$ref": "#/definitions/resProfileTypeType"
}
}
},
- "codeDescriptionType": {
- "description": "This contains a generic code and description information.",
+ "resProfileTypeType": {
+ "type": "string",
+ "enum": [
+ "Guest",
+ "Company",
+ "Group",
+ "TravelAgent",
+ "Source",
+ "ReservationContact",
+ "BillingContact",
+ "Addressee"
+ ]
+ },
+ "reservationFolioWindowsType": {
+ "type": "array",
+ "description": "Collection of reservation folio windows.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationFolioWindowType"
+ }
+ },
+ "reservationFolioWindowType": {
"type": "object",
+ "description": "Folio window view which holds the set of folios for a reservation.",
"properties": {
- "code": {
- "description": "Code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "payeeInfo": {
+ "description": "The window's configured payee information.",
+ "$ref": "#/definitions/payeeInfoType"
},
- "description": {
- "description": "description.",
+ "balance": {
+ "description": "Running balance of the window.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "paymentMethod": {
+ "description": "Payment Method Type",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "folioWindowNo": {
+ "type": "integer"
}
}
},
- "codeInfoType": {
+ "payeeInfoType": {
"type": "object",
+ "description": "Payee information.",
"properties": {
- "addtionalCodeInfo": {
- "$ref": "#/definitions/addtionalCodeInfoType"
+ "payeeId": {
+ "description": "Opera name id of the payee.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "code": {
+ "payeeName": {
+ "description": "Name of the payee.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "description": {
+ "payeeAddress": {
+ "description": "Address of the payee.",
+ "$ref": "#/definitions/addressInfoType"
+ },
+ "payeeAddressCount": {
+ "description": "Payee multiple address count.",
+ "type": "integer"
+ },
+ "payeeReferenceCurrency": {
+ "description": "Reference currency of the payee.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "hotelId": {
+ "payeeAccountInfo": {
+ "description": "AR account short info of the payee.",
+ "$ref": "#/definitions/aRAccountShortInfoType"
+ },
+ "payeeTaxNumber": {
+ "description": "The tax number of the payee.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "codeListType": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- },
- "codeType": {
- "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "colorDefinitionType": {
- "description": "Color definition type. This color definition type is used to determine the defintion of color ",
- "type": "string",
- "enum": [
- "RESERVATION",
- "MARKET_CODE",
- "VIP_LEVEL",
- "MEMBERSHIP_LEVEL"
- ]
- },
- "colorType": {
- "description": "Color configuration type. This color configuration provides a visual category of entities.",
- "type": "string",
- "enum": [
- "Red",
- "DarkRed",
- "Green",
- "DarkGreen",
- "LightGreen",
- "Orange",
- "White",
- "Yellow",
- "DarkYellow",
- "Purple",
- "Brown",
- "Gray",
- "Aqua",
- "Chocolate",
- "Blue",
- "LightBlue",
- "DarkBlue",
- "Cyan",
- "DarkCyan",
- "Magenta",
- "DarkMagenta",
- "Black"
- ]
- },
- "commentInfoType": {
- "description": "Comment related to the profile/reservation.",
+ "addressInfoType": {
"type": "object",
+ "description": "Provides address information.",
"properties": {
- "comment": {
- "description": "Comment details for the comment. It will be empty in case of delete comment.",
- "$ref": "#/definitions/commentType"
- },
- "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",
- "maxLength": 200,
- "minLength": 0
+ "address": {
+ "description": "Address details for the profile.",
+ "$ref": "#/definitions/addressType"
},
"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",
- "maxLength": 80,
- "minLength": 0
- },
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
- "type": "string",
- "format": "date-time"
- },
- "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
+ "minLength": 0,
+ "maxLength": 80
},
"type": {
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "commentType": {
- "description": "An indication of a new paragraph for a sub-section of a formatted text message.",
+ "addressType": {
"type": "object",
+ "description": "Provides address information.",
"properties": {
- "actionDate": {
- "description": "Indicates at which date an action described in the comment must be taken.",
+ "isValidated": {
+ "description": "Indicator to define if the Address is validated by the Address Validation System.",
+ "type": "boolean"
+ },
+ "addressLine": {
+ "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.",
+ "type": "array",
+ "maxItems": 4,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ }
+ },
+ "cityName": {
+ "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 40
},
- "actionType": {
- "description": "Specifies type of action described in the comments.",
+ "postalCode": {
+ "description": "Post Office Code number.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 15
},
- "commentTitle": {
- "description": "Specifies Comment's Title.",
+ "cityExtension": {
+ "description": "Post Office City Extension Code number. City Extension mainly used for UK addresses.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "confidential": {
- "description": "When true, the comment may be confidential.",
- "type": "boolean"
+ "county": {
+ "description": "County or District Name (e.g., Fairfax). This is read only.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "createDateTime": {
- "description": "Time stamp of the creation.",
+ "state": {
+ "description": "State or Province name (e.g., Texas).",
"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.",
+ "country": {
+ "description": "Country name (e.g., Ireland).",
+ "$ref": "#/definitions/countryNameType"
+ },
+ "language": {
+ "description": "Language identification.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
},
- "hotelId": {
- "description": "If specified comment belongs to the Hotel, otherwise it is a global comment.",
+ "type": {
+ "description": "Defines the type of address (e.g. home, business, other).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "image": {
- "description": "An image for this paragraph.",
+ "typeDescription": {
+ "description": "Describes the type code",
"type": "string"
},
- "internal": {
- "description": "When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.",
+ "primaryInd": {
+ "description": "When true, indicates a primary information.",
"type": "boolean"
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "updateReservations": {
+ "description": "Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.",
+ "type": "boolean"
+ },
+ "barCode": {
+ "description": "The postal barcode for the address.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 100
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
"type": "string",
"format": "date-time"
},
- "notificationLocation": {
- "description": "Notification Location associated with the Note.",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "overrideInternal": {
- "description": "When true, the note internal could be modified.",
- "type": "boolean"
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
+ "type": "string",
+ "format": "date-time"
},
- "protectDescription": {
- "description": "When true, the note title will be populated from the note type description and couldn't be modified.",
- "type": "boolean"
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
"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
- },
- "text": {
- "description": "Formatted text content.",
- "$ref": "#/definitions/formattedTextTextType"
- },
- "type": {
- "description": "Specifies type of the comment.",
+ }
+ }
+ },
+ "aRAccountShortInfoType": {
+ "type": "object",
+ "description": "Accounts Receivabales Account details type charged for batched posting.",
+ "properties": {
+ "accountName": {
+ "description": "Name of the AR Account.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "typeDescription": {
- "description": "Comment type Description.",
+ "accountId": {
+ "description": "The unique ID for the Account.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "accountNo": {
+ "description": "The Account Number for the Account.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "url": {
- "description": "A URL for this paragraph.",
- "type": "string"
+ "status": {
+ "description": "The status of the account.",
+ "$ref": "#/definitions/aRAccountStatusType"
}
}
},
- "commissionAgentIDType": {
- "description": "Type which contains the Commission Agent id and its type.",
+ "aRAccountStatusType": {
"type": "object",
+ "description": "Type for the Account Status. Status can be restricted and a message/description added to the Account.",
"properties": {
- "commissionAgentType": {
- "description": "Type of Commission Agent. Either Agent or Source.",
- "$ref": "#/definitions/commissionAgentTypeType"
- },
- "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.",
+ "restriction": {
+ "description": "The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "description": {
+ "description": "User defined status message on the Account.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "restricted": {
+ "description": "Flag to indicate if the Account is restricted.",
+ "type": "boolean"
}
}
},
- "commissionAgentType": {
- "description": "Agent or source information along with their commission details.",
+ "indicatorsType": {
+ "type": "array",
+ "description": "Collection of lamp indicators.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/indicatorType"
+ }
+ },
+ "indicatorType": {
"type": "object",
+ "description": "Lamp indicator Type.",
"properties": {
- "agentInfo": {
- "$ref": "#/definitions/agentInfoType"
+ "indicatorName": {
+ "description": "Name of the indicator.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "commissionDetails": {
- "$ref": "#/definitions/commissionDetailsType"
+ "count": {
+ "description": "Indicates number of occurrences of the indicator.",
+ "type": "integer"
}
}
},
- "commissionAgentTypeType": {
- "description": "Simple type for commission agent type. Valid values are Agent and Source.",
+ "housekeepingRoomStatusType": {
"type": "string",
+ "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.",
"enum": [
- "Agent",
- "Source"
+ "Clean",
+ "Dirty",
+ "Pickup",
+ "Inspected",
+ "OutOfOrder",
+ "OutOfService"
]
},
- "commissionAgentsType": {
- "description": "Agent or source profiles that were returned by the search.",
+ "searchMatchesType": {
"type": "array",
+ "description": "List of Generic Name-Value-Pair Parameters used for super search matches.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/commissionAgentType"
+ "$ref": "#/definitions/searchMatchType"
}
},
- "commissionBaseDetailType": {
- "description": "Criteria for updating a commission record.",
+ "searchMatchType": {
"type": "object",
+ "description": "Search match indicating attribute and the matching value.",
"properties": {
- "commissionAmount": {
- "description": "Commission amount owed to the agent/source for this stay.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "commissionCode": {
- "description": "Commission code that was used to determine the commission amount.",
- "$ref": "#/definitions/commissionCodeType"
- },
- "commissionId": {
- "description": "Unique ID of the commission.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "commissionTaxAmount": {
- "description": "Tax amount of the commission.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "prepaidCommissionAmount": {
- "description": "Pre paid amount for the reservation.",
- "$ref": "#/definitions/currencyAmountType"
+ "attribute": {
+ "description": "Search match attribute.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "remarks": {
- "description": "Remarks for the commission record.",
+ "value": {
+ "description": "Search match value.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "commissionCheckStatus": {
- "description": "Existing Operations Responses will eventually be modified to be extended from this type.",
+ "sourceOfSaleType": {
"type": "object",
+ "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "sourceType": {
+ "description": "Type of entity/channel who made the reservation..",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "sourceCode": {
+ "description": "The entity/channel who made the reservation.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "commissionCheckToBeChanged": {
- "description": "Request type for updating commission check.",
+ "waitlistResType": {
"type": "object",
+ "description": "Information regarding why reservation is being /has been waitlisted.",
"properties": {
- "criteria": {
- "description": "Contains criteria for updating check payment",
- "$ref": "#/definitions/changeCommissionCheckCriteriaType"
+ "reasonDescription": {
+ "description": "Waitlist Reason Description.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "links": {
- "$ref": "#/definitions/links"
+ "priorityDescription": {
+ "description": "Waitlist priority Description.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "commissionCodeType": {
- "description": "Type for commission code info.",
- "type": "object",
- "properties": {
- "code": {
- "description": "Commission code.",
+ "description": {
+ "description": "Description why the reservation is being /has been waitlisted.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "vatPercentage": {
- "description": "Total commission that will be paid.",
- "type": "number"
- }
- }
- },
- "commissionDetailType": {
- "description": "Criteria for updating a commission record.",
- "type": "object",
- "properties": {
- "aROffset": {
- "description": "When set to true, commission for this reservation is flagged to offset AR.",
- "type": "boolean"
- },
- "aROffsetAmount": {
- "description": "Amount settled to AR",
- "$ref": "#/definitions/currencyAmountType"
- },
- "adjustmentNotes": {
- "description": "System generated logs to indicate changes of commission record.",
+ "reasonCode": {
+ "description": "Waitlist Reason Code.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "blockCode": {
- "description": "Block code of the reservation.",
+ "priorityCode": {
+ "description": "Waitlist Priority Code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "commissionAmount": {
- "description": "Commission amount owed to the agent/source for this stay.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "commissionCode": {
- "description": "Commission code that was used to determine the commission amount.",
- "$ref": "#/definitions/commissionCodeType"
- },
- "commissionId": {
- "description": "Unique ID of the commission.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "commissionRevenue": {
- "description": "Commissionable revenue in local currency.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "commissionRevenueTaxAmount": {
- "description": "Tax amount of the revenue.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "commissionStatus": {
- "description": "Commission status.",
- "$ref": "#/definitions/commissionStatusType"
- },
- "commissionTaxAmount": {
- "description": "Tax amount of the commission.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "exchangeRate": {
- "description": "Exchange rate of the currency.",
- "type": "number"
- },
- "guestInfo": {
- "description": "Guest name on the reservation that generated the commission.",
- "$ref": "#/definitions/resGuestInfoType"
+ "minLength": 0,
+ "maxLength": 20
},
- "holdReason": {
- "description": "Hold code and description reason if the reservation is on hold for commission.",
- "$ref": "#/definitions/codeDescriptionType"
+ "telephone": {
+ "description": "Guest telephone number.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
+ }
+ }
+ },
+ "reservationQueueInformationType": {
+ "type": "object",
+ "description": "Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.",
+ "properties": {
+ "timeSpan": {
+ "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.",
+ "type": "object",
+ "properties": {
+ "startDate": {
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "endDate": {
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "duration": {
+ "type": "string"
+ },
+ "durationInSeconds": {
+ "description": "The total duration, in seconds, the reservation is on Queue.",
+ "type": "integer"
+ }
+ }
},
- "onHold": {
- "description": "When set to true, commission for this reservation is flagged as on hold.",
- "type": "boolean"
+ "guestTextInfo": {
+ "description": "Information for the message sent to the user",
+ "$ref": "#/definitions/queueTextInfoType"
},
- "prepaid": {
- "description": "When set to true, commission for this reservation is flagged as prepaid.",
- "type": "boolean"
+ "priority": {
+ "description": "The Queue Priority given to this reservation.",
+ "type": "integer"
},
- "prepaidCommissionAmount": {
- "description": "Pre paid amount for the reservation.",
- "$ref": "#/definitions/currencyAmountType"
+ "averageQueueTimeToCheckIn": {
+ "description": "The average time, in seconds, a reservation was on queue prior to Check-In.",
+ "type": "integer"
},
- "rateAmount": {
- "description": "Rate amount",
- "$ref": "#/definitions/currencyAmountType"
+ "averageQueueTimeCurrentReservations": {
+ "description": "The average time, in seconds, of the reservations currently in queue.",
+ "type": "integer"
},
- "rateCode": {
- "description": "Rate code of the reservation",
+ "queueDate": {
+ "description": "The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "recordLocator": {
- "description": "TA Record locator",
+ "format": "date",
+ "maxLength": 8
+ }
+ }
+ },
+ "queueTextInfoType": {
+ "type": "object",
+ "description": "Information regarding the message sent to guest.",
+ "properties": {
+ "sentTime": {
+ "description": "Time the text was last sent to the user.",
"type": "string",
- "maxLength": 240,
- "minLength": 0
+ "format": "date-time"
},
- "remarks": {
- "description": "Remarks for the commission record.",
+ "sentBy": {
+ "description": "User name of the user who sent message.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "reservationIdList": {
- "description": "Used to provide PMS and/or CRS identifiers.",
- "$ref": "#/definitions/reservationIdList"
- },
- "reservationStatus": {
- "description": "Reservation status.",
+ "minLength": 0,
+ "maxLength": 40
+ }
+ }
+ },
+ "resHousekeepingType": {
+ "type": "object",
+ "description": "Holds housekeeping turndown service information for the room.",
+ "properties": {
+ "instructions": {
+ "description": "Turndown instructions for the room.",
"type": "string"
},
- "roomId": {
- "description": "Room number assigned to the reservation",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "facilityTaskInfo": {
+ "description": "The facility task applicable for the current day. This will be information only and not used for any updates.",
+ "$ref": "#/definitions/facilityTaskType"
},
- "roomType": {
- "description": "Room type code of the reservation.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "linenChange": {
+ "description": "Indicates if a linen change is necessary.",
+ "type": "boolean"
},
- "routing": {
- "description": "When set to true, commission for this reservation is flagged as routing.",
+ "turndownRequested": {
+ "description": "Indicates whether guest wants turndown facility or not.",
"type": "boolean"
},
- "timeSpan": {
- "description": "Stay arrival and departure dates.",
- "$ref": "#/definitions/timeSpanType"
+ "serviceTime": {
+ "description": "This is the Turndown room service time.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "totalCommission": {
- "description": "Total commission that will be paid.",
- "$ref": "#/definitions/currencyAmountType"
+ "expectedServiceTime": {
+ "description": "Expected Start Time for housekeeping task(s).",
+ "type": "string"
+ },
+ "roomStatus": {
+ "description": "Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house.",
+ "$ref": "#/definitions/housekeepingRoomStatusType"
}
}
},
- "commissionDetails": {
- "description": "Response type for fetch commission detail.",
+ "facilityTaskType": {
"type": "object",
+ "description": "Information regarding facility task on a reservation.",
"properties": {
- "commissionDetail": {
- "description": "Contains reservation detail information and computed commission amount like gross, tax, prepaid, total.",
- "$ref": "#/definitions/commissionDetailType"
+ "task": {
+ "description": "The Task Code.",
+ "$ref": "#/definitions/housekeepingTaskCodeType"
},
- "links": {
- "$ref": "#/definitions/links"
+ "supplies": {
+ "description": "Supplies associated with the task.",
+ "$ref": "#/definitions/facilityCodesType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "date": {
+ "description": "The Date on which the task is applicable.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
}
}
},
- "commissionDetailsType": {
- "description": "Commission details related to the stays for which the agent or source is eligible to receive commissions.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/commissionDetailType"
- }
- },
- "commissionInfoListType": {
- "description": "List of commission info.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/commissionInfoType"
- }
- },
- "commissionInfoType": {
- "description": "Commission processing information including related bank, agents or source and funds details.",
+ "housekeepingTaskCodeType": {
"type": "object",
+ "description": "Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.",
"properties": {
- "bankAccount": {
- "$ref": "#/definitions/bankAccountType"
+ "description": {
+ "description": "Description of the Task Code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "commissionAgents": {
- "$ref": "#/definitions/commissionAgentsType"
+ "instructions": {
+ "description": "Instructions for this Task Code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "commissionSummary": {
- "$ref": "#/definitions/commissionSummaryType"
- }
- }
- },
- "commissionNotesDetails": {
- "description": "Response type for fetching commission notes.",
- "type": "object",
- "properties": {
- "commissionNotesList": {
- "description": "List of commission notes for reservation.",
- "$ref": "#/definitions/commissionNotesListType"
+ "facilityDepartureTask": {
+ "description": "Indicates if this task code is the default departure task for Facility Tasks. This requires",
+ "type": "boolean"
},
- "hotelId": {
- "description": "Property code against which commissions notes are fetched.",
- "$ref": "#/definitions/codeType"
+ "linenChange": {
+ "description": "Indicates if a linen change is necessary.",
+ "type": "boolean"
},
- "links": {
- "$ref": "#/definitions/links"
+ "hotelId": {
+ "description": "Property where this task code is configured.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "reservationId": {
- "description": "Reservation Id for which the commission notes are fetched.",
- "$ref": "#/definitions/reservationId"
+ "code": {
+ "description": "The Code for the task.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "sequence": {
+ "description": "Ordering sequence for display.",
+ "type": "integer"
}
}
},
- "commissionNotesListType": {
- "description": "Commission Note for the reservation.",
+ "facilityCodesType": {
"type": "array",
+ "description": "List of the facility codes.",
"maxItems": 4000,
"items": {
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- }
- },
- "commissionPaymentActivityByRangeStatus": {
- "description": "Existing Operations Responses will eventually be modified to be extended from this type.",
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/definitions/links"
- },
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
+ "$ref": "#/definitions/facilityCodeType"
}
},
- "commissionPaymentActivityByRangeToBeChanged": {
- "description": "Request type for updating a range of payments activity.",
+ "facilityCodeType": {
"type": "object",
+ "description": "Facility Housekeeping Code, its description and quantity.",
"properties": {
- "criteria": {
- "description": "Contains criteria for updating a range of payments activity",
- "$ref": "#/definitions/changeCommissionPaymentActivityRangeCriteriaType"
- },
- "links": {
- "$ref": "#/definitions/links"
+ "description": {
+ "description": "Facility Code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "commissionPaymentActivityStatusCriteriaType": {
- "description": "Criteria for updating status of a range of payment activity .",
- "type": "object",
- "properties": {
- "status": {
- "description": "New status for payment activity.",
- "$ref": "#/definitions/commissionPaymentActivityStatusType"
+ "quantity": {
+ "description": "Signifies the quantity.",
+ "type": "integer"
},
- "statusDate": {
- "description": "Date applied when new status is applied. Used in Unpresented and Reconcile.",
+ "code": {
+ "description": "Facility code value.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "commissionPaymentActivityStatusType": {
- "description": "Simple type for payment activity status type. Valid values are Outstanding, Reconciled, Unpresented and Void.",
- "type": "string",
- "enum": [
- "Outstanding",
- "Reconciled",
- "Unpresented",
- "Void",
- "Failed"
- ]
- },
- "commissionPaymentActivityType": {
- "description": "Base type for payment activity information",
+ "resCashieringType": {
"type": "object",
+ "description": "Cashiering Information for the reservation.",
"properties": {
- "agentId": {
- "description": "Unique travel agent or source profile ID.",
- "$ref": "#/definitions/uniqueID_Type"
+ "revenuesAndBalances": {
+ "description": "Revenues and Balances Amount summary for the reservation.",
+ "$ref": "#/definitions/resRevenueBalanceType"
},
- "bankAccountId": {
- "description": "Unique id of bank account.",
- "$ref": "#/definitions/uniqueID_Type"
+ "billingPrivileges": {
+ "description": "Billing privileges set on the reservation.",
+ "$ref": "#/definitions/billingPrivilegesType"
},
- "batchId": {
- "description": "Batch id of the commission payments.",
- "$ref": "#/definitions/uniqueID_Type"
+ "taxType": {
+ "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.",
+ "$ref": "#/definitions/reservationTaxTypeInfo"
},
- "checkNo": {
- "description": "Check no of payment.",
- "type": "number"
+ "bedTaxReporting": {
+ "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.",
+ "$ref": "#/definitions/bedTaxReportingType"
},
- "commissionAmount": {
- "description": "Commission amount payment.",
- "$ref": "#/definitions/currencyAmountType"
+ "folioTexts": {
+ "description": "Additional text fields to display on the folio.",
+ "$ref": "#/definitions/folioTextsType"
},
- "fileName": {
- "description": "File name if payment method is EFT.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "periodicFolio": {
+ "description": "Information regarding periodic folios set on the reservation.",
+ "$ref": "#/definitions/resPeriodicFolioType"
},
- "hotelId": {
- "description": "Property of the commission record.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "compAccounting": {
+ "description": "Information regarding comp accounting on the reservation.",
+ "$ref": "#/definitions/resCompAccountingType"
},
- "onCommission": {
- "description": "Whether this payment batch has related commission records. Commission records could be unlinked for check payments when it is reprinted.",
+ "reservationPreConfiguredRoutingInstruction": {
+ "description": "Information regarding the selected preconfigured routing instruction on the reservation.",
+ "$ref": "#/definitions/resPreConfiguredRoutingInstrType"
+ },
+ "financiallyResponsible": {
+ "description": "The guest from whom payment has to be recovered (direct guest).",
"type": "boolean"
},
- "payee": {
- "description": "Payee of commission",
- "type": "string",
- "maxLength": 100,
- "minLength": 0
+ "proratedBilling": {
+ "description": "In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate.",
+ "type": "boolean"
},
- "paymentDate": {
- "description": "Payment date of commission",
+ "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
},
- "paymentId": {
- "description": "Unique payment id of the commission check.",
- "$ref": "#/definitions/uniqueID_Type"
+ "reverseCheckInAllowed": {
+ "description": "This attribute is to verify if reverse check-in is allowed for the reservation.",
+ "type": "boolean"
},
- "status": {
- "description": "Payment activity status.",
- "$ref": "#/definitions/commissionPaymentActivityStatusType"
+ "reverseAdvanceCheckInAllowed": {
+ "description": "This attribute is to verify if reverse advance check-in is allowed for the reservation.",
+ "type": "boolean"
},
- "statusDate": {
- "description": "Status date of payment activity",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "transactionsPosted": {
+ "description": "Specifies whether reservation has a financial transaction associated with it.",
+ "type": "boolean"
}
}
},
- "commissionPaymentDetails": {
- "description": "Response to get the commission payment details.",
+ "resRevenueBalanceType": {
"type": "object",
+ "description": "Revenue and Balance Amount summary for the reservation.",
"properties": {
- "commissionPaymentInfoList": {
- "description": "Defines list of commission payment info.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/commissionPaymentInfo"
- }
+ "totalFixedCharge": {
+ "description": "Total Fixed Charges on the reservation.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "links": {
- "$ref": "#/definitions/links"
+ "totalPayment": {
+ "description": "Total payment received for the reservation.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "roomRevenue": {
+ "description": "Room Revenue generated by the reservation.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "foodAndBevRevenue": {
+ "description": "Food and Beverage Revenue generated by the reservation.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "otherRevenue": {
+ "description": "Other Revenue generated by the reservation.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "nonRevenue": {
+ "description": "Total Non Revenue posted on the reservation.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "totalRevenue": {
+ "description": "Total Revenue generated by the reservation.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "balance": {
+ "description": "Balance amount on the reservation.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "compBalance": {
+ "description": "Comp Balance amount",
+ "$ref": "#/definitions/currencyAmountType"
}
}
},
- "commissionPaymentInfo": {
- "description": "Information on a commission payment for a reservation.",
+ "billingPrivilegesType": {
"type": "object",
+ "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.",
"properties": {
- "batchId": {
- "description": "Batch Id for commission payment.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "postingRestriction": {
+ "description": "Flag used by interface program during check in.",
+ "type": "boolean"
},
- "checkNo": {
- "description": "Check number for the payment.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "preStayCharging": {
+ "description": "Indicates if the reservation has charging privileges before arrival.",
+ "type": "boolean"
},
- "commissionAmount": {
- "description": "Commission amount",
- "type": "number"
+ "postStayCharging": {
+ "description": "Indicates if the reservation has charging privileges after checkout.",
+ "type": "boolean"
},
- "commissionStatus": {
- "description": "Commission status",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "paymentDate": {
- "description": "The payment date",
+ "folioCloseDate": {
+ "description": "Date when folio was closed. This works with PostStayCharging flag.",
"type": "string",
"format": "date",
"maxLength": 8
},
- "paymentId": {
- "description": "Payment id ",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "scheduledCheckout": {
+ "description": "Indicates if the guest is scheduled for automatic check out.",
+ "type": "boolean"
},
- "paymentMethod": {
- "description": "Payment Method",
+ "scheduledCheckoutTime": {
+ "description": "Time of automatic check out if guest is schedule for automatic check out.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "remarks": {
- "description": "Remarks for the commission.",
+ "directBillAuthorized": {
+ "description": "If Direct bill is authorized this will hold User ID who authorized it.",
+ "type": "boolean"
+ },
+ "videoCheckout": {
+ "description": "Indicates if the guest can do video checkout",
+ "type": "boolean"
+ },
+ "allowAutoCheckin": {
+ "description": "Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.",
+ "type": "boolean"
+ },
+ "autoSettlement": {
+ "description": "Indicates if the is a candidate for auto folio settlement.",
+ "type": "boolean"
+ },
+ "autoSettlementType": {
+ "description": "The folio settlement type for auto folio settlement.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "autoSettlementFreq": {
+ "description": "The interval of days between each auto folio settlement.",
+ "type": "integer"
+ },
+ "creditLimitAutoPay": {
+ "description": "Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results.",
+ "type": "boolean"
}
}
},
- "commissionPaymentMethodType": {
- "description": "This contains a generic code and description information.",
+ "reservationTaxTypeInfo": {
"type": "object",
+ "description": "Provides information about the Tax Type.",
"properties": {
+ "hotelId": {
+ "description": "Code of the Hotel.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
"code": {
- "description": "Code.",
+ "description": "Code of the Tax Type.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
"description": {
- "description": "description.",
+ "description": "Description of the Tax Type.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "format": {
- "description": "Payment format if the payment method is EFT.",
+ "collectingAgentTax": {
+ "description": "A boolean flag for Collecting Agent Tax",
+ "type": "boolean"
+ },
+ "printAutoAdjust": {
+ "description": "Print auto adjust information for this tax type on the tax exempt report.",
+ "type": "boolean"
+ },
+ "reportExemptDays": {
+ "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.",
+ "type": "integer"
+ },
+ "reportTaxPercentage": {
+ "description": "Tax percentage. Only used for tax exempt report.",
+ "type": "number",
+ "minimum": 0,
+ "maximum": 100
+ },
+ "minimumLengthOfStay": {
+ "description": "Minimun Length of Stay.",
+ "type": "integer"
+ },
+ "taxExemptNo": {
+ "description": "Tax exempt number on the profile.",
"type": "string",
- "maxLength": 3,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "commissionPaymentMethods": {
- "description": "Check",
- "type": "string",
- "enum": [
- "Cent",
- "Eft",
- "Chk"
- ]
- },
- "commissionPaymentReportType": {
- "description": "Contains report id, batch id (for check payments) or export file (for eft payments)",
+ "bedTaxReportingType": {
"type": "object",
+ "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.",
"properties": {
- "batchId": {
- "description": "Batch id of the commission payments.",
- "$ref": "#/definitions/uniqueID_Type"
+ "taxRegistrationNo": {
+ "description": "Tax Registration Number for Maldives Bed Tax Reporting.",
+ "type": "number"
},
- "batchName": {
- "description": "If payment method is EFT, batch name of the payments.",
+ "visaNumber": {
+ "description": "Visa number used for Maldives Bed Tax Reporting",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "exportBlobFile": {
- "description": "If payment method is EFT, Export BLOB file from database in base64 binary format.",
+ "visaIssueDate": {
+ "description": "Visa Issue Date used for Maldives Bed Tax Reporting.",
"type": "string",
- "format": "byte"
+ "format": "date",
+ "maxLength": 8
},
- "exportFile": {
- "description": "If payment method is EFT, file location of the file generated.",
+ "visaExpiryDate": {
+ "description": "Visa Expiration Date used for Maldives Bed Tax Reporting",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "reportId": {
- "description": "The report instance ID.",
- "$ref": "#/definitions/uniqueID_Type"
+ "taxableDays": {
+ "description": "Number of days for which the Maldives tax is applicable.",
+ "type": "integer"
}
}
},
- "commissionPaymentsActivityDetails": {
- "description": "Response type for commission payments activity.",
+ "folioTextsType": {
+ "type": "array",
+ "description": "This stores the description for the type of tax calculation especially with tax exemption, etc.",
+ "maxItems": 2,
+ "items": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "Additional text field to display on the folio.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 50
+ },
+ "row": {
+ "description": "Row number of the additional text.",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "resPeriodicFolioType": {
"type": "object",
+ "description": "Information regarding periodic folios set on the reservation.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "lastSettlementDate": {
+ "description": "Latest date when a direct bill settlement was automatically done using the \"Direct Bill Batch Folios\" option.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "paymentsActivity": {
- "description": "List of payment activity information",
- "$ref": "#/definitions/commissionPaymentsActivityType"
+ "lastFolioDate": {
+ "description": "Latest date when a folio was printed using the \"Periodic Batch Folios\" option",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "frequency": {
+ "description": "Frequency in number of days when folios should be printed for this reservation.",
+ "type": "integer"
}
}
},
- "commissionPaymentsActivityType": {
- "description": "List of payment activity information",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/commissionPaymentActivityType"
- }
- },
- "commissionPayoutToType": {
- "type": "string",
- "enum": [
- "TravelAgent",
- "Source",
- "TravelAgentSource",
- "None"
- ]
- },
- "commissionProcessingAgentType": {
- "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).",
+ "resCompAccountingType": {
"type": "object",
+ "description": "Information regarding comp accounting on the reservation.",
"properties": {
- "hotelId": {
- "description": "Property from which the agent will be on hold for commission.",
+ "compType": {
+ "description": "Code used to identify the casino comp type and ranking of a guest.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "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.",
+ "authorizer": {
+ "description": "ID of the employee who will act as the host for this guest.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "compPostings": {
+ "description": "Indicates if the Comp Billing/posting Exist",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "minLength": 0,
+ "maxLength": 5
+ }
+ }
+ },
+ "resPreConfiguredRoutingInstrType": {
+ "type": "object",
+ "description": "Instruction to attach Pre-Configured Routing Instructions to a Reservation.",
+ "properties": {
+ "authorizerInfo": {
+ "description": "The authorizer information for Promotion Code with attached Complimentary Routing",
+ "$ref": "#/definitions/authorizerInfoType"
},
- "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.",
+ "ratePlanCode": {
+ "description": "Rate Code with attached Routing Instruction.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "instructions": {
- "description": "List of commission processing instructions.",
- "$ref": "#/definitions/commissionProcessingInstructionsType"
+ "minLength": 0,
+ "maxLength": 20
},
- "reservations": {
- "description": "List of reservations associated with the agent and its commission processing instructions.",
- "$ref": "#/definitions/commissionProcessingReservationsType"
+ "profileType": {
+ "description": "Profile Type with attached Routing Instruction.",
+ "$ref": "#/definitions/resProfileTypeType"
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "promotionCode": {
+ "description": "Promotion Code with attached Complimentary Routing.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "commissionProcessingAgentsType": {
- "description": "Commission processing instructions for an Agent.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/commissionProcessingAgentType"
- }
- },
- "commissionProcessingInstructionsType": {
- "description": "Type for commission process instruction. Possible instruction types are on hold and offset AR.",
+ "authorizerInfoType": {
"type": "object",
+ "description": "Authorizer Information",
"properties": {
- "offsetAR": {
- "description": "When set to true, commission agent and/or its associated reservation will be flagged to offset Account Receivable.",
- "type": "boolean"
+ "authorizerId": {
+ "$ref": "#/definitions/uniqueID_Type"
},
- "onHold": {
- "description": "Reason for setting the commission on hold.",
- "$ref": "#/definitions/codeDescriptionType"
+ "authorizerUserName": {
+ "description": "Application user name of the authorizer",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "release": {
- "description": "When set to true, commission agent and/or its associated reservation will be released from commission processing.",
+ "authorizerName": {
+ "description": "Full name of the authorizer.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 100
+ },
+ "authorizerRateCode": {
+ "description": "Rate code of the authorizer.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "inheritAuthorizerRateCode": {
+ "description": "Indicates whether user has the choice to have reservation inherit rate code from the authorizer.",
"type": "boolean"
}
}
},
- "commissionProcessingReservationType": {
- "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).",
+ "taxTypeType": {
"type": "object",
+ "description": "Provides information about the Tax Type.",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
+ "hotelId": {
+ "description": "Code of the Hotel.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "code": {
+ "description": "Code of the Tax Type.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "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.",
+ "description": {
+ "description": "Description of the Tax Type.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "instructions": {
- "description": "List of commission processing instructions.",
- "$ref": "#/definitions/commissionProcessingInstructionsType"
+ "collectingAgentTax": {
+ "description": "A boolean flag for Collecting Agent Tax",
+ "type": "boolean"
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "printAutoAdjust": {
+ "description": "Print auto adjust information for this tax type on the tax exempt report.",
+ "type": "boolean"
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "reportExemptDays": {
+ "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.",
+ "type": "integer"
+ },
+ "reportTaxPercentage": {
+ "description": "Tax percentage. Only used for tax exempt report.",
+ "type": "number",
+ "minimum": 0,
+ "maximum": 100
+ },
+ "minimumLengthOfStay": {
+ "description": "Minimun Length of Stay.",
+ "type": "integer"
}
}
},
- "commissionProcessingReservationsType": {
- "description": "Commission processing instructions for a reservation.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/commissionProcessingReservationType"
- }
- },
- "commissionReservationFailureType": {
- "description": "Collection of error and warning if any.",
+ "reservationDepositType": {
"type": "object",
+ "description": "Reservation Deposit Type.",
"properties": {
- "errors": {
- "description": "Details of the errors.",
- "$ref": "#/definitions/errorsType"
+ "amountRequired": {
+ "description": "Deposit Amount Required.",
+ "type": "number"
},
- "reservationInfo": {
- "description": "Reservation details along with failure reason.",
- "$ref": "#/definitions/reservationInfoType"
+ "amountPaid": {
+ "description": "Deposit Amount Paid.",
+ "type": "number"
},
- "warnings": {
- "description": "Details of the warnings.",
- "$ref": "#/definitions/warningsType"
+ "amountOwed": {
+ "description": "Deposit Amount Owed.",
+ "type": "number"
+ },
+ "dueDate": {
+ "description": "Deposit Due Date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "postingDate": {
+ "description": "Deposit Posting Date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "hasPaid": {
+ "description": "Resolves whether reservation has paid deposit.",
+ "type": "boolean"
+ },
+ "hasOutstanding": {
+ "description": "Resolves whether reservation has outstanding deposit.",
+ "type": "boolean"
}
}
},
- "commissionReservationFailuresType": {
- "description": "Reservation that wasn't successfully associated with the agent.",
+ "reservationAllowedActionsType": {
"type": "array",
- "maxItems": 4000,
+ "description": "Allowed action.",
+ "maxItems": 11,
"items": {
- "$ref": "#/definitions/commissionReservationFailureType"
- }
- },
- "commissionReservationInstructionsType": {
- "description": "Type for commission reservation instructions.",
- "type": "string",
- "enum": [
- "FetchReservationInfo"
- ]
- },
- "commissionStatus": {
- "description": "Existing Operations Responses will eventually be modified to be extended from this type.",
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/definitions/links"
- },
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
+ "$ref": "#/definitions/reservationAllowedActionType"
}
},
- "commissionStatusType": {
- "description": "Simple type for commission status. Valid values are Unpaid and Paid.",
+ "reservationAllowedActionType": {
"type": "string",
+ "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.",
"enum": [
- "Unpaid",
- "Paid"
+ "Cancel",
+ "Move",
+ "PreCharge",
+ "PostCharge",
+ "FacilitySchedule",
+ "Upsell",
+ "PreCheckIn",
+ "PostToNoShowCancel",
+ "NoShow",
+ "NameChange",
+ "Discount",
+ "HouseKeeping",
+ "EnrollToPrimaryMembership",
+ "EnrollInProgress"
]
},
- "commissionSummaryType": {
- "description": "Summary of the commission payment information totaled for all agents/sources.",
+ "reservationInterfaceStatusType": {
"type": "object",
+ "description": "Hotel Interface Type for a reservation and status of the various services",
"properties": {
- "aR": {
- "description": "Total commission amount held to offset the agents' and/or sources' accounts receivable accounts.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "onHold": {
- "description": "Total value of commission amounts being held for one or more agents/sources.",
- "$ref": "#/definitions/currencyAmountType"
+ "roomExtension": {
+ "description": "Identifier for the room extension",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "potential": {
- "description": "Total funds required to pay all commissions for one or more agents/sources.",
- "$ref": "#/definitions/currencyAmountType"
+ "hotelInterface": {
+ "description": "Hotel interface information for the reservation",
+ "$ref": "#/definitions/hotelInterfaceType"
},
- "toBePaid": {
- "description": "Difference between the Potential amount minus the On Hold amount minus the AR amount (Potential - On Hold - AR = To Be Paid).",
- "$ref": "#/definitions/currencyAmountType"
+ "interfaceRights": {
+ "description": "Contains a list of status/rights for the various services under this interface",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/interfaceRightsStatusType"
+ }
}
}
},
- "commissionToBeChanged": {
- "description": "Request type for update of commission detail.",
+ "hotelInterfaceType": {
"type": "object",
"properties": {
- "commissionDetail": {
- "description": "Contains fields that can be updated for commission i.e. commission amount, tax, prepaid, code and remarks.",
- "$ref": "#/definitions/commissionBaseDetailType"
+ "interfaceId": {
+ "description": "Unique DB internal number of a Hotel Interface record.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "links": {
- "$ref": "#/definitions/links"
+ "hotelId": {
+ "description": "Hotel Code",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "commissionsDetails": {
- "description": "Commissions for the requested account or agent id.",
- "type": "object",
- "properties": {
- "commissionInfoList": {
- "$ref": "#/definitions/commissionInfoListType"
+ "interfaceName": {
+ "description": "Name of the Hotel Interface",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "count": {
- "description": "Total number of rows returned",
- "type": "integer"
+ "interfaceType": {
+ "description": "Three letter code for each interface that identifies the interface.",
+ "$ref": "#/definitions/hotelInterfaceTypeType"
},
- "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"
+ "logo": {
+ "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "limit": {
- "description": "Indicates maximum number of records a Web Service should return.",
- "type": "integer"
+ "machineName": {
+ "description": "Unique machine name of the running IFC.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "links": {
- "$ref": "#/definitions/links"
+ "status": {
+ "description": "The current status of the IFC.",
+ "$ref": "#/definitions/hotelInterfaceStatusType"
},
- "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"
- },
- "totalPages": {
- "description": "Evaluated total page count based on the requested max fetch count.",
- "type": "integer"
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- },
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "activeFlag": {
+ "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.",
+ "type": "boolean"
}
}
},
- "communicationStatusType": {
- "description": "Enum to denote the Status of Readiness messages sent to Guest Devices.",
+ "hotelInterfaceTypeType": {
"type": "string",
"enum": [
- "Pending",
- "Completed",
- "Failed",
- "Sent",
- "Received",
- "Cancelled",
- "PendingAvailability"
+ "Bms",
+ "Cas",
+ "Ccw",
+ "Dls",
+ "Eft",
+ "Exp",
+ "Mak",
+ "Mbs",
+ "Msc",
+ "Pbx",
+ "Pos",
+ "Svs",
+ "Tik",
+ "Vid",
+ "Vms",
+ "Www",
+ "Xml"
+ ],
+ "description": "XML Posting Interface"
+ },
+ "hotelInterfaceStatusType": {
+ "type": "string",
+ "description": "Status of the Hotel Interface either STOPPED or RUNNING.",
+ "enum": [
+ "Stopped",
+ "Running",
+ "Waiting",
+ "StopInitiated",
+ "StartInitiated",
+ "RebootInitiated",
+ "Other"
]
},
- "compAccountingType": {
- "description": "Authorizer Information",
+ "interfaceRightsStatusType": {
"type": "object",
"properties": {
- "aRNumber": {
- "description": "AR Account Number of the authorizer",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "authorizerId": {
- "$ref": "#/definitions/uniqueID_Type"
- },
- "authorizerName": {
- "description": "Full name of the authorizer.",
- "type": "string",
- "maxLength": 100,
- "minLength": 0
- },
- "authorizerRateCode": {
- "description": "Rate code of the authorizer.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "authorizerUserName": {
- "description": "Application user name of the authorizer",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "compTypeCode": {
- "description": "The Comp Type for this Account. Used when using the Comp types functionality",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "right": {
+ "description": "Internal code for each allowed right of a Hotel Interface record.",
+ "type": "integer"
},
- "compVoucherNo": {
- "description": "The coupon or voucher number used by the external gaming system to track postings made to this routing.",
+ "statusCode": {
+ "description": "User defined code for an Interface Right.",
"type": "string",
- "maxLength": 30,
- "minLength": 0
- },
- "dateRange": {
- "description": "Arrival date range for comp routing",
- "$ref": "#/definitions/dateRangeType"
- },
- "inheritAuthorizerRateCode": {
- "description": "Indicates whether user has the choice to have reservation inherit rate code from the authorizer.",
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 5
},
- "membershipId": {
- "description": "Membership number",
+ "description": {
+ "description": "User defined description for an Interface Right.",
"type": "string",
- "maxLength": 100,
- "minLength": 0
- },
- "membershipIdNo": {
- "description": "Unique Id of membership",
- "type": "integer"
+ "minLength": 0,
+ "maxLength": 80
},
- "membershipNameOnCard": {
- "description": "Name displayed on the membership card",
+ "category": {
+ "description": "Category code of this interface right.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 1
}
}
},
- "compAuthorizerInfoType": {
- "description": "Authorizer Information",
+ "reservationTurndownInfoType": {
"type": "object",
+ "description": "Turndown information for a reservation",
"properties": {
- "authorizerId": {
- "$ref": "#/definitions/uniqueID_Type"
- },
- "authorizerName": {
- "description": "Full name of the authorizer.",
- "type": "string",
- "maxLength": 100,
- "minLength": 0
+ "allowed": {
+ "description": "Indicates if turndown is allowed or not",
+ "type": "boolean"
},
- "authorizerUserName": {
- "description": "Application user name of the authorizer",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "status": {
+ "description": "Indicates turndown status, values could be required, not required, completed",
+ "$ref": "#/definitions/turndownStatusType"
}
}
},
- "compRoutingRequestType": {
- "description": "Type for the details of a Comp Routing Request",
+ "turndownStatusType": {
+ "type": "string",
+ "description": "Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed.",
+ "enum": [
+ "Required",
+ "NotRequired",
+ "Compeleted"
+ ]
+ },
+ "resMobileNotificationsType": {
"type": "object",
+ "description": "Contains the status of Room Ready and Key Ready messages.",
"properties": {
- "comments": {
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "roomReady": {
+ "description": "Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED",
+ "$ref": "#/definitions/communicationStatusType"
},
- "declinedBy": {
- "description": "User information of user who declined comp routing request",
- "$ref": "#/definitions/userInfoType"
+ "keyReady": {
+ "description": "Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED",
+ "$ref": "#/definitions/communicationStatusType"
},
- "requestedBy": {
- "description": "User who requested the Comp Routing",
- "$ref": "#/definitions/userInfoType"
+ "checkoutMessageReceived": {
+ "description": "Indicates if the Mobile checkout message is received.",
+ "type": "boolean"
},
- "status": {
- "description": "Comp routing status",
- "$ref": "#/definitions/compRoutingStatusType"
+ "requiresAction": {
+ "description": "Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout",
+ "type": "boolean"
+ },
+ "errorMessage": {
+ "description": "Error message when Mobile Notification has failed.",
+ "type": "string"
}
}
},
- "compRoutingStatusType": {
- "description": "Status which indicates that the Request of Comp Routing was declined",
+ "communicationStatusType": {
"type": "string",
+ "description": "Enum to denote the Status of Readiness messages sent to Guest Devices.",
"enum": [
- "Request",
- "Comp",
- "Declined"
+ "Pending",
+ "Completed",
+ "Failed",
+ "Sent",
+ "Received",
+ "Cancelled",
+ "PendingAvailability"
]
},
- "companyInfoType": {
- "description": "Company Information of the Profile.",
+ "resCommunicationType": {
"type": "object",
+ "description": "Communication details for a reservation.",
"properties": {
- "department": {
- "description": "Department of the Profile.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "legalCompany": {
- "description": "Legal Company.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "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"
+ }
+ },
+ "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"
+ }
+ }
},
- "position": {
- "description": "Business Title or Position of the profile.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "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"
+ }
+ },
+ "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"
+ }
+ }
}
}
},
- "companyType": {
+ "telephoneInfoType": {
"type": "object",
+ "description": "Information on a telephone number for the customer.",
"properties": {
- "alternateLanguage": {
- "description": "Alternate Language of the company.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "telephone": {
+ "description": "Phone details for the profile.",
+ "$ref": "#/definitions/telephoneType"
},
- "alternateName": {
- "description": "Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language.",
+ "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",
- "maxLength": 80,
- "minLength": 0
- },
- "blacklist": {
- "description": "This element tells if profile is blacklisted or not.",
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 80
},
- "businessLocale": {
- "description": "A jurisdiction(Territory) in which a company is authorized to do business.",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "businessTitle": {
- "description": "Business Title.",
+ "minLength": 0,
+ "maxLength": 40
+ }
+ }
+ },
+ "telephoneType": {
+ "type": "object",
+ "description": "Information on a telephone number for the customer.",
+ "properties": {
+ "phoneTechType": {
+ "description": "Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "commissionCode": {
- "description": "Commission code of the company.",
+ "phoneUseType": {
+ "description": "Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "companyName": {
- "description": "Name of the company.",
+ "phoneUseTypeDescription": {
+ "description": "Description of the PhoneUseType code",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "companyName2": {
- "description": "Second Name of the company.",
+ "phoneNumber": {
+ "description": "Telephone number assigned to a single location.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "companyName3": {
- "description": "Third Name of the company.",
+ "extension": {
+ "description": "Extension to reach a specific party at the phone number.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "corporateIdType": {
- "description": "The type of corporate ID",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "primaryInd": {
+ "description": "When true, indicates a primary information.",
+ "type": "boolean"
},
- "creditRating": {
- "description": "Credit Rating of the company.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "orderSequence": {
+ "description": "Display Order sequence.",
+ "type": "number"
},
- "currencyCode": {
- "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "currencySymbol": {
- "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.",
+ "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",
- "maxLength": 10,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "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"
- },
- "iATAInfo": {
- "description": "IATA Information of the profile.",
- "$ref": "#/definitions/iATAInfoType"
- },
- "language": {
- "description": "Language identification.",
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
"type": "string",
- "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
+ "format": "date-time"
},
- "nationality": {
- "description": "Nationality code identification",
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "nationalityDescription": {
- "description": "Nationality code description",
+ "purgeDate": {
+ "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
+ }
+ }
+ },
+ "emailInfoType": {
+ "type": "object",
+ "description": "Information on an email for the customer.",
+ "properties": {
+ "email": {
+ "description": "eMail deatils for the profile.",
+ "$ref": "#/definitions/emailType"
},
- "vipDescription": {
- "description": "Description of the VIP status.",
+ "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",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "vipStatus": {
- "description": "VIP status of the company.",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "confDeliveryInfoType": {
+ "advanceCheckInType": {
"type": "object",
+ "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return",
"properties": {
- "communicationType": {
- "description": "CommunicationType through which the confirmation letter was sent.",
- "$ref": "#/definitions/confDeliveryMethod"
+ "advanceCheckedIn": {
+ "description": "Indicates if the reservation is marked as Advance Checked In",
+ "type": "boolean"
},
- "lastAttempted": {
- "description": "Date of last attempt to send confirmation letter.",
+ "expectedReturnTime": {
+ "description": "Expected Return Time",
"type": "string",
"format": "date-time"
},
- "lastStatus": {
- "description": "Status of last sent confirmation.",
- "$ref": "#/definitions/sentConfirmationStatus"
- },
- "successfulTries": {
- "description": "Number of success letter sent.",
- "type": "integer"
+ "eTRComments": {
+ "description": "ETR Comments",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "confDeliveryInfoTypes": {
- "description": "List of confirmation letter delivery methods and their status",
- "type": "array",
- "maxItems": 4,
- "items": {
- "$ref": "#/definitions/confDeliveryInfoType"
- }
+ "pMS_ResStatusType": {
+ "type": "string",
+ "description": "This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.",
+ "enum": [
+ "Reserved",
+ "Requested",
+ "NoShow",
+ "Cancelled",
+ "InHouse",
+ "CheckedOut",
+ "Waitlisted",
+ "DueIn",
+ "DueOut",
+ "Walkin",
+ "PendingCheckout"
+ ]
},
- "confDeliveryMethod": {
+ "resAccessRestrictionType": {
"type": "string",
+ "description": "Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.",
"enum": [
- "Print",
- "Email",
- "Fax",
- "Text",
- "NotConfigured"
+ "Change",
+ "Cancel",
+ "ChangeOrCancel"
]
},
- "confRecipientInfoType": {
+ "commissionPayoutToType": {
+ "type": "string",
+ "enum": [
+ "TravelAgent",
+ "Source",
+ "TravelAgentSource",
+ "None"
+ ]
+ },
+ "masterInfoType": {
"type": "object",
"properties": {
- "addressInfo": {
- "description": "id of the address where to send confirmation letter.",
- "$ref": "#/definitions/addressInfoType"
- },
- "emailInfo": {
- "description": "id of the Email where to send confirmation letter.",
- "$ref": "#/definitions/emailInfoType"
- },
- "faxInfo": {
- "description": "id of the Fax where to send confirmation letter.",
- "$ref": "#/definitions/telephoneInfoType"
- },
- "formerName": {
- "description": "Last Name of recipient.",
- "$ref": "#/definitions/profileNameType"
- },
- "profileId": {
- "description": "name id of the recipient.",
- "$ref": "#/definitions/profileId"
- },
- "recipientType": {
- "$ref": "#/definitions/profileTypeType"
+ "codeInfo": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/codeInfoType"
+ }
},
- "telephoneInfo": {
- "description": "id of the Mobile where to send confirmation letter.",
- "$ref": "#/definitions/telephoneInfoType"
+ "codeType": {
+ "$ref": "#/definitions/masterType"
}
}
},
- "configPackagePrimaryDetailsType": {
- "description": "A Config Package Info type.",
+ "codeInfoType": {
"type": "object",
+ "description": "",
"properties": {
- "arrangementCode": {
- "description": "Arrangement Code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "beginSellDate": {
- "description": "Indicates the begin sell date of the package.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
"description": {
- "description": "The description of the package.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "endSellDate": {
- "description": "Indicates the end sell date of the package.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "addtionalCodeInfo": {
+ "$ref": "#/definitions/addtionalCodeInfoType"
},
- "forecastGroup": {
- "description": "The Forecast group package belongs to.",
+ "hotelId": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "shortDescription": {
- "description": "The short description of the package.",
+ "code": {
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "configPackageTransactionType": {
- "description": "A HotelPackageTransaction type.",
- "type": "object",
- "properties": {
- "allowance": {
- "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"
- },
- "calculationRule": {
- "description": "The price calculation rule for this package.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "currency": {
- "description": "The currency code for this package.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "packagePostingRules": {
- "description": "The package posting rule details.",
- "$ref": "#/definitions/packagePostingRulesType"
- },
- "postingType": {
- "description": "The posting frequency for this package, e.g., daily, arrival, departure, etc.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "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
+ }
}
}
},
- "configPackageUsageDetailType": {
- "description": "A Config Package Usage Detail type.",
+ "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"
+ ]
+ },
+ "associateCommissionAgentToReservations": {
"type": "object",
+ "description": "Request type for associating reservations to Travel Agent or Source Profile.",
"properties": {
- "source": {
- "description": "Indicates if the source of the product is Rate header, Rate Detail or Reservation.",
- "$ref": "#/definitions/productSourceType"
+ "commissionAgent": {
+ "description": "Contains the id and type of the travel agent or source profile to be associated with the reservation.",
+ "$ref": "#/definitions/commissionAgentIDType"
},
- "usedInHouseReservations": {
- "description": "Indicates if any checked in reservations are using this product.",
- "type": "boolean"
+ "reservations": {
+ "description": "Contains list of reservation ids that will be associated to a travel agent or source profile.",
+ "$ref": "#/definitions/hotelReservationsIDType"
},
- "usedInRates": {
- "description": "Indicates if the package is used in any rate code.",
- "type": "boolean"
+ "instructions": {
+ "description": "List of commission reservation instructions.",
+ "$ref": "#/definitions/commissionReservationInstructionsType"
},
- "usedInReservations": {
- "description": "Indicates if the package is used in, reserved or prospect reservations.",
- "type": "boolean"
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "configPostingAttributesType": {
- "description": "A config Package posting attributes type.",
+ "commissionAgentIDType": {
"type": "object",
+ "description": "Type which contains the Commission Agent id and its type.",
"properties": {
- "addToRate": {
- "description": "The package price is added to the room rate.",
- "type": "boolean"
- },
- "calculatedPrice": {
- "description": "Calculated Package Price based from Number of Adults, Children and Calculation Rule.",
- "type": "number"
- },
- "catering": {
- "description": "Is package used for catering?",
- "type": "boolean"
- },
- "deliveryTimeRequired": {
- "description": "Indicates whether a delivery time is required for the package.",
- "type": "boolean"
- },
- "endTime": {
- "description": "End time the package is valid.",
- "type": "string"
- },
- "forecastNextDay": {
- "description": "Package will be forecasted for consumption the next business day.",
- "type": "boolean"
+ "commissionAgentType": {
+ "description": "Type of Commission Agent. Either Agent or Source.",
+ "$ref": "#/definitions/commissionAgentTypeType"
},
- "formula": {
- "description": "The custom formula used for this package, if any.",
+ "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",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "formulaFunctionArguments": {
- "description": "The function argument name-value combination accepted by the custom formula used for this package.",
- "$ref": "#/definitions/functionArgumentsType"
- },
- "formulaFunctionName": {
- "description": "The custom formula function name used for this package, if any.",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "inventoryItems": {
- "description": "Package Code Inventory Items type.",
+ "minLength": 0,
+ "maxLength": 40
+ }
+ }
+ },
+ "commissionAgentTypeType": {
+ "type": "string",
+ "description": "Simple type for commission agent type. Valid values are Agent and Source.",
+ "enum": [
+ "Agent",
+ "Source"
+ ]
+ },
+ "hotelReservationsIDType": {
+ "type": "object",
+ "description": "List of Reservation Unique identifiers to represent multiple reservations with each reservation's one unique id.",
+ "properties": {
+ "reservationId": {
+ "description": "Unique identifier for a reservation.",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/pkgInventoryItemType"
+ "$ref": "#/definitions/reservationId"
}
},
- "postNextDay": {
- "description": "package charges will be posted next business day.",
- "type": "boolean"
- },
- "postingRhythm": {
- "description": "The posting rhythm for this package.",
- "$ref": "#/definitions/packagePostingRhythmType"
- },
- "priceCalculationRule": {
- "description": "The price calculation rule for this package.",
- "$ref": "#/definitions/packageCalculationRuleType"
- },
- "printSeparateLine": {
- "description": "The package price is printed on separate line of the folio.",
- "type": "boolean"
- },
- "sellSeparate": {
- "description": "Can the package be sold separate from rate plan code?",
- "type": "boolean"
- },
- "startTime": {
- "description": "Start time the package is valid.",
- "type": "string"
- },
- "ticket": {
- "description": "Indicates whether a package is configured as a ticket or not.",
- "type": "boolean"
- },
- "webBookable": {
- "description": "Can package be sold via Web channel.",
- "type": "boolean"
+ "hotelId": {
+ "description": "All reservation ids in the list must belong to this property.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "confirmationStyle": {
+ "commissionReservationInstructionsType": {
+ "type": "string",
+ "description": "Type for commission reservation instructions.",
+ "enum": [
+ "FetchReservationInfo"
+ ]
+ },
+ "associateCommissionAgentToReservationsStatus": {
"type": "object",
+ "description": "Response type for associating reservations to Travel Agent or Source Profile.",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
- },
- "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",
- "maxLength": 80,
- "minLength": 0
- },
- "style": {
- "description": "Name of the confirmation letter style.",
- "type": "string"
+ "commissionReservationFailures": {
+ "description": "List of reservations that wasn't successfully associated with the agent.",
+ "$ref": "#/definitions/commissionReservationFailuresType"
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "confirmationType": {
+ "commissionReservationFailuresType": {
+ "type": "array",
+ "description": "Reservation that wasn't successfully associated with the agent.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/commissionReservationFailureType"
+ }
+ },
+ "commissionReservationFailureType": {
"type": "object",
+ "description": "Collection of error and warning if any.",
"properties": {
- "confirmationStyleInfo": {
- "description": "Confirmation style.",
- "$ref": "#/definitions/confirmationStyle"
+ "warnings": {
+ "description": "Details of the warnings.",
+ "$ref": "#/definitions/warningsType"
},
- "deliveryInfo": {
- "description": "The status of the confirmation letter sent via the specified CommunicationType.",
- "$ref": "#/definitions/confDeliveryInfoTypes"
+ "errors": {
+ "description": "Details of the errors.",
+ "$ref": "#/definitions/errorsType"
},
- "fromEmail": {
- "description": "Senders Email address.",
+ "reservationInfo": {
+ "description": "Reservation details along with failure reason.",
+ "$ref": "#/definitions/reservationInfoType"
+ }
+ }
+ },
+ "errorsType": {
+ "type": "array",
+ "description": "An error that occurred during the processing of a message.",
+ "maxItems": 99,
+ "items": {
+ "$ref": "#/definitions/errorType"
+ }
+ },
+ "errorType": {
+ "type": "object",
+ "description": "Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.",
+ "properties": {
+ "value": {
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "description": "Property Value"
},
- "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",
- "maxLength": 80,
- "minLength": 0
+ "shortText": {
+ "description": "An abbreviated version of the error in textual format.",
+ "type": "string"
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "code": {
+ "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "docURL": {
+ "description": "If present, this URL refers to an online description of the error that occurred.",
+ "type": "string"
},
- "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",
- "maxLength": 80,
- "minLength": 0
+ "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"
},
- "recipientInfo": {
- "description": "Receipient's information.",
- "$ref": "#/definitions/confRecipientInfoType"
+ "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"
},
- "sendTextMessage": {
- "description": "Flag to indicate sending confirmation letter as text message.",
- "type": "boolean"
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "language": {
+ "description": "Language identification.",
+ "type": "string",
+ "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
+ },
+ "nodeList": {
+ "description": "An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional 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"
}
}
},
- "confirmationsType": {
- "description": "List of confirmation letters.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/confirmationType"
- }
- },
- "countryNameType": {
- "description": "Code for a country or a nationality.",
+ "status": {
"type": "object",
+ "description": "Response Body.",
"properties": {
- "code": {
- "description": "Code for a country or a nationality.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
},
- "value": {
- "description": "Used for Character Strings, length 0 to 200.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
}
}
},
- "currencyAmountType": {
- "description": "A monetary value expressed with a currency code.",
+ "processCommissionPayments": {
"type": "object",
+ "description": "Request type for processing commission payments.",
"properties": {
- "amount": {
- "description": "A monetary amount.",
- "type": "number"
+ "criteria": {
+ "description": "Criteria for actual commission payments processing.",
+ "$ref": "#/definitions/processCommissionPaymentsCriteriaType"
},
- "currencyCode": {
- "description": "Provides a currency code to reflect the currency in which an amount may be expressed.",
- "type": "string",
- "maxLength": 3,
- "minLength": 3
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "currentRoomInfoType": {
- "description": "Room information of the reservation for the current day.",
+ "processCommissionPaymentsCriteriaType": {
"type": "object",
+ "description": "Generic commission criteria including hotel code, bank account id, agent id, reservation id and/or commission id",
"properties": {
- "assignedByAI": {
- "description": "Represents the room was assigned by AI Room Assignment.",
- "type": "boolean"
- },
- "roomDescription": {
- "description": "Current room description.",
+ "hotelId": {
+ "description": "Property of the commission record .",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "roomId": {
- "description": "Current room number.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "bankAccountId": {
+ "description": "Unique id of bank account.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "roomOwnershipType": {
- "description": "Provides the information of the assigned reservation room is an Owner,Referral or Regular room. This value is returned when Room Rotation OPERA Control is active and room number is assigned to a reservation.",
- "$ref": "#/definitions/reservationRoomOwnershipType"
+ "agentId": {
+ "description": "Unique travel agent or source profile ID.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "roomType": {
- "description": "Current room type.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "resvNameId": {
+ "description": "Unique reservation name ID.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "roomViewCode": {
- "description": "Represents the room view code like City view, River view, Ocean view etc.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "commissionId": {
+ "description": "Unique id of the commission.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "suggestedRoomNumbers": {
- "description": "Suggested room numbers.",
- "$ref": "#/definitions/codeListType"
+ "timeSpan": {
+ "description": "Date range that will be included on payment processing.",
+ "$ref": "#/definitions/timeSpanType"
},
- "upgradedByAI": {
- "description": "Represents the room was upgraded by AI Room Assignment.",
- "type": "boolean"
+ "checkNo": {
+ "description": "If payment method is check, this serves as the start check number of checks to be printed.",
+ "type": "number"
}
}
},
- "currentServicingAttendantType": {
- "description": "The Attendant Name and ID of the attendant servicing the room.",
+ "processCommissionPaymentsStatus": {
"type": "object",
+ "description": "Response type for processing commission payments.",
"properties": {
- "activeFlag": {
- "description": "Indicates if the Attendant is active.",
- "type": "string",
- "maxLength": 1,
- "minLength": 0
- },
- "appUser": {
- "description": "The App User Name and ID of the user who started the service.",
- "$ref": "#/definitions/applicationUserType"
- },
- "attendantId": {
- "description": "Attendant's unique identifier.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "paymentReport": {
+ "description": "Contains report id, batch id (for check payments) or export file (for eft payments)",
+ "$ref": "#/definitions/commissionPaymentReportType"
},
- "attendantName": {
- "description": "Attendant's name.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
- "floor": {
- "description": "The Floor which is assigned to the attendant.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "commissionsDetails": {
+ "type": "object",
+ "description": "Commissions for the requested account or agent id.",
+ "properties": {
+ "commissionInfoList": {
+ "$ref": "#/definitions/commissionInfoListType"
},
- "friday": {
- "type": "boolean"
+ "totalPages": {
+ "description": "Evaluated total page count based on the requested max fetch count.",
+ "type": "integer"
},
- "hotelId": {
- "description": "Property where the attendant belongs.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "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"
},
- "monday": {
- "type": "boolean"
+ "limit": {
+ "description": "Indicates maximum number of records a Web Service should return.",
+ "type": "integer"
},
- "saturday": {
+ "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"
},
- "section": {
- "description": "Section Code the attendant has been assigned.",
- "$ref": "#/definitions/housekeepingSectionType"
- },
- "startTime": {
- "description": "The start time of the service.",
- "type": "string",
- "format": "date-time"
- },
- "status": {
- "description": "Status of the respective Housekeeping Attendant.",
- "$ref": "#/definitions/servicingAttendantStatusType"
- },
- "sunday": {
- "type": "boolean"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "thursday": {
- "type": "boolean"
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
},
- "tuesday": {
- "type": "boolean"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "wednesday": {
- "type": "boolean"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "customChargeExemptionDateType": {
- "description": "Contains Custom Charge Exemption information for a day.",
- "type": "object",
- "properties": {
- "date": {
- "description": "Contains Custom Charge Exemption date.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "commissionInfoListType": {
+ "type": "array",
+ "description": "List of commission info.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/commissionInfoType"
+ }
+ },
+ "commissionInfoType": {
+ "type": "object",
+ "description": "Commission processing information including related bank, agents or source and funds details.",
+ "properties": {
+ "bankAccount": {
+ "$ref": "#/definitions/bankAccountType"
},
- "quantity": {
- "description": "Contains number of Custom Charge Exemption for a day.",
- "type": "integer"
+ "commissionAgents": {
+ "$ref": "#/definitions/commissionAgentsType"
+ },
+ "commissionSummary": {
+ "$ref": "#/definitions/commissionSummaryType"
}
}
},
- "customChargeExemptionDatesType": {
- "description": "Contains List of Custom Charge Exemption information for a day.",
+ "commissionAgentsType": {
"type": "array",
+ "description": "Agent or source profiles that were returned by the search.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/customChargeExemptionDateType"
+ "$ref": "#/definitions/commissionAgentType"
}
},
- "customChargeExemptionType": {
- "description": "Contains custom charges exemption information.",
+ "commissionAgentType": {
"type": "object",
+ "description": "Agent or source information along with their commission details.",
"properties": {
- "customChargeDates": {
- "description": "Contains exemption detail information for each date.",
- "$ref": "#/definitions/customChargeExemptionDatesType"
+ "agentInfo": {
+ "$ref": "#/definitions/agentInfoType"
},
- "customChargeQuantity": {
- "description": "Contains exemption quantity for the stay. When this value is configured, daily exemption quantities are not permitted.",
- "$ref": "#/definitions/customChargeQuantityType"
+ "commissionDetails": {
+ "$ref": "#/definitions/commissionDetailsType"
+ }
+ }
+ },
+ "agentInfoType": {
+ "type": "object",
+ "description": "Agent or source commission information.",
+ "properties": {
+ "bankAccountId": {
+ "description": "Unique bank account ID.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "customChargesExemption": {
- "description": "Contains exemption code and description.",
- "$ref": "#/definitions/codeDescriptionType"
+ "agentId": {
+ "description": "Unique ID of the travel agent or source.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "excludedDates": {
- "description": "Contains list of dates which are not valid for custom charge exemptions.",
- "$ref": "#/definitions/excludedDatesType"
+ "name": {
+ "description": "Travel agent or source profile name.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "percentage": {
- "description": "Exemption Percentage",
- "type": "number",
- "maximum": 100,
- "minimum": 0
+ "alternateName": {
+ "description": "Alternate name of the agent or source profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "propertyExemption": {
- "description": "Flag specifying if custom charge exemptions is property level or not.",
+ "city": {
+ "description": "City of the travel agency or source profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "iATANo": {
+ "description": "Travel agent's IATA number.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "profileType": {
+ "description": "Whether travel agent or source profile.",
+ "$ref": "#/definitions/profileTypeType"
+ },
+ "commissionCode": {
+ "description": "Profile's commission code.",
+ "$ref": "#/definitions/commissionCodeType"
+ },
+ "commissionAmount": {
+ "description": "Amount of the commission payment to be generated for that agent or source.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "holdReason": {
+ "description": "Hold code and description reason if all the reservations associated to the agent is on hold for commission.",
+ "$ref": "#/definitions/codeDescriptionType"
+ },
+ "onCommission": {
+ "description": "Whether this agent/source has been paid or will be paid for commission.",
+ "type": "boolean"
+ },
+ "onHold": {
+ "description": "When set to true, commission for all the reservations associated with this agent is flagged as on hold.",
"type": "boolean"
}
}
},
- "customChargeExemptionsType": {
- "description": "List of Custom Charge Exemptions.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/customChargeExemptionType"
- }
+ "profileTypeType": {
+ "type": "string",
+ "description": "The types of Profile handled by the web service.",
+ "enum": [
+ "Guest",
+ "Agent",
+ "Company",
+ "Group",
+ "Source",
+ "Employee",
+ "Hotel",
+ "Vendor",
+ "Contact",
+ "Purge",
+ "BusinessHeader",
+ "BillingAccount",
+ "Activity",
+ "Potential",
+ "Account"
+ ]
},
- "customChargeQuantityType": {
- "description": "Contains quantity of custom charge exemptions.",
+ "commissionCodeType": {
"type": "object",
+ "description": "Type for commission code info.",
"properties": {
- "available": {
- "description": "Indicates if Custom Charges Exemption information is editable.",
- "type": "boolean"
+ "code": {
+ "description": "Commission code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "quantity": {
- "description": "Contains number of Custom Charge Exemption for a day.",
- "type": "integer"
+ "vatPercentage": {
+ "description": "Total commission that will be paid.",
+ "type": "number"
}
}
},
- "customerType": {
- "description": "Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.",
+ "commissionDetailsType": {
+ "type": "array",
+ "description": "Commission details related to the stays for which the agent or source is eligible to receive commissions.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/commissionDetailType"
+ }
+ },
+ "commissionDetailType": {
"type": "object",
+ "description": "Criteria for updating a commission record.",
"properties": {
- "alienInfo": {
- "description": "Immigration/visa information of a foreign person.",
- "$ref": "#/definitions/alienInfoType"
+ "commissionId": {
+ "description": "Unique ID of the commission.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "anonymization": {
- "description": "Provides information about the guest's anonymization status",
- "$ref": "#/definitions/anonymizationType"
+ "commissionCode": {
+ "description": "Commission code that was used to determine the commission amount.",
+ "$ref": "#/definitions/commissionCodeType"
},
- "birthCountry": {
- "description": "Country of birth.",
- "$ref": "#/definitions/countryNameType"
+ "commissionAmount": {
+ "description": "Commission amount owed to the agent/source for this stay.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "birthDate": {
- "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "commissionTaxAmount": {
+ "description": "Tax amount of the commission.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "birthDateMasked": {
- "description": "Indicates the date of birth as masked.",
- "type": "string"
+ "prepaidCommissionAmount": {
+ "description": "Pre paid amount for the reservation.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "birthPlace": {
- "description": "Place of birth.",
+ "remarks": {
+ "description": "Remarks for the commission record.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "blacklist": {
- "description": "This element tells if profile is blacklisted or not.",
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 2000
},
- "businessTitle": {
- "description": "Business Title.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "reservationIdList": {
+ "description": "Used to provide PMS and/or CRS identifiers.",
+ "$ref": "#/definitions/reservationIdList"
},
- "citizenCountry": {
- "description": "Name of the (self-professed) country that is claimed for citizenship.",
- "$ref": "#/definitions/countryNameType"
+ "externalReferences": {
+ "description": "External Reference information for Reservation.",
+ "$ref": "#/definitions/externalReferencesType"
},
- "companyInfo": {
- "description": "Company Information of the Profile.",
- "$ref": "#/definitions/companyInfoType"
+ "guestInfo": {
+ "description": "Guest name on the reservation that generated the commission.",
+ "$ref": "#/definitions/resGuestInfoType"
},
- "creditRating": {
- "description": "Credit Rating of the customer.",
+ "blockCode": {
+ "description": "Block code of the reservation.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "currencyCode": {
- "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
+ "roomType": {
+ "description": "Room type code of the reservation.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "currencySymbol": {
- "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.",
+ "roomId": {
+ "description": "Room number assigned to the reservation",
"type": "string",
- "maxLength": 10,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "customerValue": {
- "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).",
+ "rateCode": {
+ "description": "Rate code of the reservation",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "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"
+ "rateAmount": {
+ "description": "Rate amount",
+ "$ref": "#/definitions/currencyAmountType"
},
- "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",
- "maxLength": 20,
- "minLength": 0
+ "timeSpan": {
+ "description": "Stay arrival and departure dates.",
+ "$ref": "#/definitions/timeSpanType"
},
- "identifications": {
- "description": "List of identification of the customer.",
- "type": "object",
- "properties": {
- "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"
- },
- "identificationInfo": {
- "description": "Collection of detailed information on the identification of the customer.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/identificationInfoType"
- }
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- }
- }
+ "commissionRevenue": {
+ "description": "Commissionable revenue in local currency.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "language": {
- "description": "Language identification.",
- "type": "string",
- "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
+ "commissionRevenueTaxAmount": {
+ "description": "Tax amount of the revenue.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "legalCompany": {
- "description": "Name Of the company the individual is associated with.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "aROffsetAmount": {
+ "description": "Amount settled to AR",
+ "$ref": "#/definitions/currencyAmountType"
},
- "nationality": {
- "description": "Nationality code identification",
+ "totalCommission": {
+ "description": "Total commission that will be paid.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "exchangeRate": {
+ "description": "Exchange rate of the currency.",
+ "type": "number"
+ },
+ "adjustmentNotes": {
+ "description": "System generated logs to indicate changes of commission record.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "nationalityDescription": {
- "description": "Nationality code description",
+ "holdReason": {
+ "description": "Hold code and description reason if the reservation is on hold for commission.",
+ "$ref": "#/definitions/codeDescriptionType"
+ },
+ "recordLocator": {
+ "description": "TA Record locator",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 240
},
- "personName": {
- "description": "Detailed name information for the customer.",
- "type": "array",
- "maxItems": 5,
- "items": {
- "$ref": "#/definitions/personNameType"
- }
+ "reservationStatus": {
+ "description": "Reservation status.",
+ "type": "string"
},
- "privateProfile": {
- "description": "This element tells profile is property exclusive or not.",
+ "commissionStatus": {
+ "description": "Commission status.",
+ "$ref": "#/definitions/commissionStatusType"
+ },
+ "onHold": {
+ "description": "When set to true, commission for this reservation is flagged as on hold.",
"type": "boolean"
},
- "profession": {
- "description": "Profession of a person.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "aROffset": {
+ "description": "When set to true, commission for this reservation is flagged to offset AR.",
+ "type": "boolean"
},
- "vipDescription": {
- "description": "Description of the VIP status.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "prepaid": {
+ "description": "When set to true, commission for this reservation is flagged as prepaid.",
+ "type": "boolean"
},
- "vipStatus": {
- "description": "VIP status of the customer.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "routing": {
+ "description": "When set to true, commission for this reservation is flagged as routing.",
+ "type": "boolean"
}
}
},
- "dailyDocket": {
- "description": "Response object for fetching log book entries.",
+ "commissionStatusType": {
+ "type": "string",
+ "description": "Simple type for commission status. Valid values are Unpaid and Paid.",
+ "enum": [
+ "Unpaid",
+ "Paid"
+ ]
+ },
+ "commissionSummaryType": {
"type": "object",
+ "description": "Summary of the commission payment information totaled for all agents/sources.",
"properties": {
- "dailyDocketEntries": {
- "description": "List of log book entries.",
- "$ref": "#/definitions/dailyDocketType"
+ "potential": {
+ "description": "Total funds required to pay all commissions for one or more agents/sources.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "aR": {
+ "description": "Total commission amount held to offset the agents' and/or sources' accounts receivable accounts.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "onHold": {
+ "description": "Total value of commission amounts being held for one or more agents/sources.",
+ "$ref": "#/definitions/currencyAmountType"
},
+ "toBePaid": {
+ "description": "Difference between the Potential amount minus the On Hold amount minus the AR amount (Potential - On Hold - AR = To Be Paid).",
+ "$ref": "#/definitions/currencyAmountType"
+ }
+ }
+ },
+ "calculateCommissions": {
+ "type": "object",
+ "description": "Request type for calculation of commission for all Travel Agent and/or Source.",
+ "properties": {
"links": {
"$ref": "#/definitions/links"
},
@@ -23540,254 +21956,242 @@
}
}
},
- "dailyDocketEntryType": {
- "description": "Log book entry.",
+ "calculateCommissionsStatus": {
"type": "object",
+ "description": "Response Body.",
"properties": {
- "department": {
- "description": "Department ID in which the log book entry belongs to.",
- "$ref": "#/definitions/codeDescriptionType"
- },
- "details": {
- "description": "Entry details.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "docketEntryId": {
- "description": "Unique identifier of the log book entry.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "entryDate": {
- "description": "The date-time in which the log book entry was created.",
- "type": "string",
- "format": "date-time"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "history": {
- "description": "Creation date time, Creator Id, last modification date time and last Modifier Id.",
- "$ref": "#/definitions/changeHistoryType"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "setProcessingInstructions": {
+ "type": "object",
+ "description": "Request Type for setting instructions for commission processing on Agent or Reservation level.",
+ "properties": {
+ "agents": {
+ "description": "List of commission processing instructions for agents and/or its associated reservations.",
+ "$ref": "#/definitions/commissionProcessingAgentsType"
},
- "hotelId": {
- "description": "Hotel Code of the log book entry.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
- "roleUserEntry": {
- "description": "Role or User in which the log book entry belongs to.",
- "$ref": "#/definitions/roleUserEntryType"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "dailyDocketType": {
- "description": "log book entry.",
+ "commissionProcessingAgentsType": {
"type": "array",
+ "description": "Commission processing instructions for an Agent.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/dailyDocketEntryType"
+ "$ref": "#/definitions/commissionProcessingAgentType"
}
},
- "dailyRateType": {
- "description": "The total amount charged for the service including additional amounts and fees.",
+ "commissionProcessingAgentType": {
"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": {
- "amountAfterTax": {
- "description": "The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).",
- "type": "number"
- },
- "amountBeforeTax": {
- "description": "The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).",
- "type": "number"
- },
- "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"
+ "url": {
+ "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "type": "string"
},
- "code": {
- "description": "Type of charge.",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "currencyCode": {
- "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "currencySymbol": {
- "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.",
+ "idContext": {
+ "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string",
- "maxLength": 10,
- "minLength": 0
- },
- "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"
+ "minLength": 0,
+ "maxLength": 80
},
- "description": {
+ "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",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "discount": {
- "description": "Room rate discount percentage or amount, code and textual reason for discount.",
- "$ref": "#/definitions/discountType"
+ "idExtension": {
+ "description": "Additional identifying value assigned by the creating system.",
+ "type": "integer"
},
- "end": {
- "description": "The ending value of the date range.",
+ "hotelId": {
+ "description": "Property from which the agent will be on hold for commission.",
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "fees": {
- "description": "A collection of fees or service charges.",
- "$ref": "#/definitions/feesType"
- },
- "rateOverride": {
- "description": "When true indicates that the rate amount has been overridden.",
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 20
},
- "start": {
- "description": "The starting value of the date range.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "instructions": {
+ "description": "List of commission processing instructions.",
+ "$ref": "#/definitions/commissionProcessingInstructionsType"
},
- "taxes": {
- "description": "A collection of taxes.",
- "$ref": "#/definitions/taxesType"
+ "reservations": {
+ "description": "List of reservations associated with the agent and its commission processing instructions.",
+ "$ref": "#/definitions/commissionProcessingReservationsType"
}
}
},
- "dailyRatesType": {
- "description": "Defines room rate information on a daily basis.",
+ "commissionProcessingInstructionsType": {
+ "type": "object",
+ "description": "Type for commission process instruction. Possible instruction types are on hold and offset AR.",
+ "properties": {
+ "onHold": {
+ "description": "Reason for setting the commission on hold.",
+ "$ref": "#/definitions/codeDescriptionType"
+ },
+ "release": {
+ "description": "When set to true, commission agent and/or its associated reservation will be released from commission processing.",
+ "type": "boolean"
+ },
+ "offsetAR": {
+ "description": "When set to true, commission agent and/or its associated reservation will be flagged to offset Account Receivable.",
+ "type": "boolean"
+ }
+ }
+ },
+ "commissionProcessingReservationsType": {
"type": "array",
+ "description": "Commission processing instructions for a reservation.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/dailyRateType"
+ "$ref": "#/definitions/commissionProcessingReservationType"
}
},
- "dateRangeType": {
- "description": "Date Range with Start and End dates.",
+ "commissionProcessingReservationType": {
"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": {
- "end": {
- "description": "The ending value of the date range.",
+ "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",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "start": {
- "description": "The starting value of the date range.",
+ "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
+ },
+ "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"
+ },
+ "instructions": {
+ "description": "List of commission processing instructions.",
+ "$ref": "#/definitions/commissionProcessingInstructionsType"
}
}
},
- "dateTimeRangeType": {
- "description": "Date Range with Start and End dates.",
+ "commissionDetails": {
"type": "object",
+ "description": "Response type for fetch commission detail.",
"properties": {
- "end": {
- "description": "The ending value of the time span.",
- "type": "string",
- "format": "date-time"
+ "commissionDetail": {
+ "description": "Contains reservation detail information and computed commission amount like gross, tax, prepaid, total.",
+ "$ref": "#/definitions/commissionDetailType"
},
- "start": {
- "description": "The starting value of the time span.",
- "type": "string",
- "format": "date-time"
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "dateTimeSpanType": {
- "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.",
+ "commissionToBeChanged": {
"type": "object",
+ "description": "Request type for update of commission detail.",
"properties": {
- "endDateTime": {
- "type": "string",
- "format": "date-time"
+ "commissionDetail": {
+ "description": "Contains fields that can be updated for commission i.e. commission amount, tax, prepaid, code and remarks.",
+ "$ref": "#/definitions/commissionBaseDetailType"
},
- "startDateTime": {
- "type": "string",
- "format": "date-time"
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "dateTimeStampGroupType": {
+ "commissionBaseDetailType": {
"type": "object",
+ "description": "Criteria for updating a commission record.",
"properties": {
- "createDateTime": {
- "description": "Time stamp of the creation.",
- "type": "string",
- "format": "date-time"
+ "commissionId": {
+ "description": "Unique ID of the commission.",
+ "$ref": "#/definitions/uniqueID_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",
- "maxLength": 200,
- "minLength": 0
+ "commissionCode": {
+ "description": "Commission code that was used to determine the commission amount.",
+ "$ref": "#/definitions/commissionCodeType"
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "commissionAmount": {
+ "description": "Commission amount owed to the agent/source for this stay.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
- "type": "string",
- "format": "date-time"
+ "commissionTaxAmount": {
+ "description": "Tax amount of the commission.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "purgeDate": {
- "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
+ "prepaidCommissionAmount": {
+ "description": "Pre paid amount for the reservation.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "remarks": {
+ "description": "Remarks for the commission record.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "dateUDFType": {
- "description": "Used to hold user defined field of Date Type.",
+ "commissionStatus": {
"type": "object",
+ "description": "Response Body.",
"properties": {
- "alternateName": {
- "description": "Label of user defined field used by vendors or customers.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "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",
- "maxLength": 20,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
- "value": {
- "description": "Value of user defined field.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "dateUDFsType": {
- "description": "Used to hold collection of user defined fields of Date Type.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/dateUDFType"
- }
- },
- "deliverQueueRoomsTextMessage": {
- "description": "Request to deliver a text message via Queue Reservations (for a guest) or Queue Rush (for housekeeping).",
+ "recalculateCommissionOnCodeChange": {
"type": "object",
+ "description": "Request type for recalculating commission amount when commission code of unpaid commission is changed.",
"properties": {
- "criteria": {
- "$ref": "#/definitions/queueRoomsTextCriteriaType"
- },
"links": {
"$ref": "#/definitions/links"
},
@@ -23796,4502 +22200,3628 @@
}
}
},
- "depositCancelRevenueType": {
- "description": "The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.",
- "type": "string",
- "enum": [
- "Rooms",
- "Catering",
- "All"
- ]
- },
- "depositPolicyType": {
- "description": "Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.",
+ "recalculateCommissionOnCodeChangeStatus": {
"type": "object",
+ "description": "Response type for recalculating commission amount when commission code of unpaid commission is changed",
"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"
- },
- "depositReceiptNo": {
- "description": "Receipt number associated with the deposit policy",
- "type": "integer"
- },
- "depositReqReversed": {
- "description": "Flag to indicate if deposit policy is reversed",
- "type": "boolean"
- },
- "description": {
- "description": "Text description of the Payment in a given language.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "formattedRule": {
- "description": "Formatted Text Rule of the deposit policy.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "manual": {
- "description": "Flag to indicate if the cancellation policy is manual.",
- "type": "boolean"
- },
- "policyCode": {
- "description": "Deposit Policy Code",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "commissionDetail": {
+ "description": "Contains reservation detail information and computed commission amount like gross, tax, prepaid, total.",
+ "$ref": "#/definitions/commissionDetailType"
},
- "transactionDate": {
- "description": "Transaction Date associated with the deposit policy",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "links": {
+ "$ref": "#/definitions/links"
},
- "typeOfCharges": {
- "description": "Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both",
- "$ref": "#/definitions/depositCancelRevenueType"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "directBillingType": {
- "description": "This is the preconfigured routing instruction type.",
+ "dailyDocket": {
"type": "object",
+ "description": "Response object for fetching log book entries.",
"properties": {
- "aRNumber": {
- "description": "Hotel Code for which the details of direct billing is provided for a profile.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "dailyDocketEntries": {
+ "description": "List of log book entries.",
+ "$ref": "#/definitions/dailyDocketType"
},
- "hotelId": {
- "description": "Hotel Code for which the details of direct billing is provided for a profile.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "discountType": {
- "description": "Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not specified since logically.",
+ "dailyDocketType": {
+ "type": "array",
+ "description": "log book entry.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/dailyDocketEntryType"
+ }
+ },
+ "dailyDocketEntryType": {
"type": "object",
+ "description": "Log book entry.",
"properties": {
- "amount": {
- "description": "A monetary amount.",
- "type": "number"
- },
- "currencyCode": {
- "description": "Provides a currency code to reflect the currency in which an amount may be expressed.",
+ "hotelId": {
+ "description": "Hotel Code of the log book entry.",
"type": "string",
- "maxLength": 3,
- "minLength": 3
+ "minLength": 0,
+ "maxLength": 20
},
- "discountCode": {
- "description": "Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent).",
+ "docketEntryId": {
+ "description": "Unique identifier of the log book entry.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "department": {
+ "description": "Department ID in which the log book entry belongs to.",
+ "$ref": "#/definitions/codeDescriptionType"
+ },
+ "roleUserEntry": {
+ "description": "Role or User in which the log book entry belongs to.",
+ "$ref": "#/definitions/roleUserEntryType"
+ },
+ "entryDate": {
+ "description": "The date-time in which the log book entry was created.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "discountReason": {
+ "details": {
+ "description": "Entry details.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "percent": {
- "description": "Percentage discount.",
- "type": "number"
+ "history": {
+ "description": "Creation date time, Creator Id, last modification date time and last Modifier Id.",
+ "$ref": "#/definitions/changeHistoryType"
}
}
},
- "downgradeType": {
- "description": "Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.",
- "type": "string",
- "enum": [
- "Grace",
- "Never",
- "Period"
- ]
- },
- "eCertificateClassficationType": {
- "description": "Enumeration of the different type of Ecertificate.",
- "type": "string",
- "enum": [
- "Promotion",
- "Award",
- "Benefit",
- "Other"
- ]
- },
- "eCertificateConsumeSourceType": {
- "description": "Indicates that OPERA E-Certificate is consumed by hotelPMS.",
- "type": "string",
- "enum": [
- "Central",
- "Web",
- "Hotel"
- ]
- },
- "eCertificateConsumptionType": {
- "description": "E-Certificates details.",
+ "roleUserEntryType": {
"type": "object",
+ "description": "Role or User in which the log book entry belongs to.",
"properties": {
- "authorizationCode": {
- "description": "Authorization code for consumption.",
- "type": "string",
- "maxLength": 100,
- "minLength": 0
- },
- "date": {
- "description": "Date the certificate was consumed.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "role": {
+ "$ref": "#/definitions/codeDescriptionType"
},
- "email": {
- "description": "Email of the person who consumed the certificate.",
+ "user": {
"type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "firstName": {
- "description": "First name of the person who consumed the certificate.",
+ "minLength": 0,
+ "maxLength": 60
+ }
+ }
+ },
+ "changeHistoryType": {
+ "type": "object",
+ "description": "Creation date time, Creator Id, last modification date time and last Modifier Id.",
+ "properties": {
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "format": "date-time"
},
- "hotelId": {
- "description": "Property where certificate was consumed for.",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "locationType": {
- "description": "Consumption location type.",
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "middleName": {
- "description": "Middle name of the person who consumed the certificate.",
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "referenceId": {
- "description": "Any reference like reservation no etc against which the certificate was consumed.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "serviceDate": {
- "description": "Date on which the service is due (arrival date in case of reservation).",
+ "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
+ }
+ }
+ },
+ "floorPlans": {
+ "type": "object",
+ "description": "Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.",
+ "properties": {
+ "floorPlansDetails": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/floorPlanType"
+ }
},
- "source": {
- "description": "Source of consumption.",
- "$ref": "#/definitions/eCertificateConsumeSourceType"
- },
- "surname": {
- "description": "Last name of the person who consumed the certificate..",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "userName": {
- "description": "Application user who created the consumption.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
- "userNotes": {
- "description": "Any notes on the certificate entered at time of consumption.",
- "type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "eCertificateGenerationType": {
- "description": "E-Certificates details.",
+ "floorPlanType": {
"type": "object",
+ "description": "Floor information containing collection of Room records that contain Housekeeping and Out Of Order information.",
"properties": {
- "generationDetail": {
- "description": "Reason for which e-certificate was generated.",
+ "rooms": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/floorPlanRoomType"
+ }
+ },
+ "hotelId": {
"type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "referenceValue": {
- "description": "Type of value that is in the certificate.valid values are membership_level.",
+ "siteCode": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "ruleId": {
- "description": "Key to identify the generation rule id.",
- "$ref": "#/definitions/uniqueID_Type"
+ "siteDescription": {
+ "type": "string"
}
}
},
- "eCertificateInfoType": {
- "description": "E-Certificates details.",
+ "floorPlanRoomType": {
"type": "object",
"properties": {
- "awardCode": {
- "description": "Award type to which the certificate is linked to.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "roomType": {
+ "description": "Room type basic information of the room.",
+ "$ref": "#/definitions/roomTypeShortInfoType"
},
- "benefitSummary": {
- "description": "Summary of Benefits attached to this ECertificate.",
+ "floor": {
+ "description": "Floor of the Room.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "certificateType": {
- "description": "User defined certificate code.",
+ "floorDescription": {
+ "description": "Description for the Floor of the Room.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "cost": {
- "description": "Cost of certificate.",
- "$ref": "#/definitions/currencyAmountType"
+ "roomFeatures": {
+ "description": "Room Features for the room.",
+ "$ref": "#/definitions/roomFeaturesType"
},
- "description": {
- "description": "Description about the certificate.",
+ "roomDescription": {
+ "description": "Detail Long Description Of The Room.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "hotels": {
- "description": "Hotel to which certificate is attached to.",
- "type": "object",
- "properties": {
- "code": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- },
- "scope": {
- "description": "Scope of e-cert: global,single property or multi property.",
- "$ref": "#/definitions/eCertificateScopeType"
- }
- }
+ "minLength": 0,
+ "maxLength": 20
},
- "label": {
- "description": "Label for the certificate.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "description": {
+ "description": "Description of the room.",
+ "$ref": "#/definitions/translationTextType2000"
},
- "longDescription": {
- "description": "Detail description about the certificate.",
+ "smokingPreference": {
+ "description": "This indicates room smoking preference.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
- },
- "maxExtensionAllowed": {
- "description": "Number of times e-certificate can be extended.",
- "type": "integer"
+ "minLength": 0,
+ "maxLength": 20
},
- "membershipType": {
- "description": "Membership type to which the certificate is linked to.",
+ "smokingPreferenceDescription": {
+ "description": "This indicates the description of the room smoking preference.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "promotionCode": {
- "description": "Promotion code to which certificate is attached to.",
+ "building": {
+ "description": "Building associated with the room.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "usageCriteria": {
- "$ref": "#/definitions/eCertificateUsageCriteriaType"
+ "roomAssignmentRating": {
+ "description": "Assignment Rating associated with the room.",
+ "$ref": "#/definitions/ratePlanRatingType"
},
- "value": {
- "description": "Value of the certificate for the guest.",
- "$ref": "#/definitions/currencyAmountType"
+ "accessible": {
+ "description": "Indicates whether the room is accessibility compliant.",
+ "type": "boolean"
},
- "voucherBenefitCode": {
- "description": "Voucher benefit code attached to the certificate.",
+ "roomId": {
+ "description": "Code of the room.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
- }
- }
- },
- "eCertificateIssueSourceType": {
- "description": "Indicates that OPERA E-Certificate is issued by external system.",
- "type": "string",
- "enum": [
- "Opera",
- "Web",
- "Interface"
- ]
- },
- "eCertificateIssueType": {
- "description": "Indicates that guest purchased OPERA E-Certificate.",
- "type": "string",
- "enum": [
- "Assigned",
- "OptedIn",
- "Purchased"
- ]
- },
- "eCertificateScopeType": {
- "description": "Indicates that OPERA E-Certificate is available for a specific list of hotels.",
- "type": "string",
- "enum": [
- "Global",
- "Hotel",
- "MultiHotel"
- ]
- },
- "eCertificateStatusType": {
- "description": "Indicates that OPERA E-Certificate is reserved.",
- "type": "string",
- "enum": [
- "Cancelled",
- "Consumed",
- "Deleted",
- "Expired",
- "Issued",
- "Reserved"
- ]
- },
- "eCertificateType": {
- "description": "E-Certificates details.",
- "type": "object",
- "properties": {
- "awardId": {
- "description": "AwardID.",
- "$ref": "#/definitions/awardId"
+ "minLength": 0,
+ "maxLength": 20
},
- "awardPoints": {
- "description": "Award points if any in case of certificate use membership award.",
- "type": "integer"
+ "meetingRoom": {
+ "description": "Indicates whether the room is a Meeting Room",
+ "type": "boolean"
},
- "cancelRequestDate": {
- "description": "Date on which the cancellation was requested.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "roomSection": {
+ "description": "Room sections of the room.",
+ "$ref": "#/definitions/roomSectionType"
},
- "certificateId": {
- "description": "System generated unique certificate id.",
- "type": "integer"
+ "housekeeping": {
+ "description": "Identifies the Housekeeping information..",
+ "$ref": "#/definitions/housekeepingType"
},
- "certificateNo": {
- "description": "Printed certificate no. This has to be unique.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "outOfOrder": {
+ "description": "Identifies the room Out of Order/Out of Service information.",
+ "$ref": "#/definitions/roomsOutOfOrderType"
},
- "consumptionDetail": {
- "$ref": "#/definitions/eCertificateConsumptionType"
+ "discrepancy": {
+ "description": "Identifies the room discrepancy information.",
+ "$ref": "#/definitions/roomDiscrepanciesType"
},
- "databaseId": {
- "description": "External reference from which the record is created.",
+ "sitePlanSection": {
+ "description": "Identifies the site plan location of the room.",
+ "$ref": "#/definitions/sitePlanSectionType"
+ },
+ "componentRoomNumber": {
+ "description": "This flag indicates component room.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "eCertificateInfo": {
- "$ref": "#/definitions/eCertificateInfoType"
+ "connectingRooms": {
+ "description": "This flag indicates connecting rooms.",
+ "$ref": "#/definitions/roomRoomsType"
},
- "expiryDate": {
- "description": "Date of expiry.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "componentRooms": {
+ "description": "This flag indicates component rooms.",
+ "$ref": "#/definitions/roomRoomsType"
},
- "extensionCount": {
- "description": "Number of times e-certificate is already extended.",
- "type": "integer"
+ "attendant": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/currentServicingAttendantType"
+ }
},
- "generationDetail": {
- "$ref": "#/definitions/eCertificateGenerationType"
+ "hold": {
+ "description": "Hold attributes if any.",
+ "$ref": "#/definitions/roomHoldType"
},
- "inLieuSequence": {
- "description": "Seq of the in lieu of certificate. 1..n. original certificate will be treated as null = 0.",
- "type": "integer"
+ "turndownInfo": {
+ "$ref": "#/definitions/turndownInfoType"
},
- "inactiveDate": {
- "description": "Date the record was marked as inactive.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "resvInfo": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationShortInfoType"
+ }
},
- "issueDate": {
- "description": "Date when certificate was issued.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "componentRoomNumbers": {
+ "description": "List of component room numbers.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
},
- "issueType": {
- "description": "Process action issued the certificate. valid values are assigned (a),opt in (o) and purchased (p).",
- "$ref": "#/definitions/eCertificateIssueType"
+ "guests": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/floorPlanRoomGuestType"
+ }
+ }
+ },
+ "description": "This type represents the primary room attributes."
+ },
+ "roomTypeShortInfoType": {
+ "type": "object",
+ "description": "Basic information of room type.",
+ "properties": {
+ "pseudo": {
+ "description": "Indicates if room is a pseudo. This is read-only.",
+ "type": "boolean"
},
- "newExpiryDate": {
- "description": "New Date of expiry to extend e-certificate.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "suite": {
+ "description": "Indicates if room is a suite. This is read-only.",
+ "type": "boolean"
},
- "originalCertificateNo": {
- "description": "In case of in lieu of certificate this will contain the original certificate no.",
+ "roomClass": {
+ "description": "Room Class of the room. This is read-only.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "originalVoucherNo": {
- "description": "In case of in lieu of certificate this will contain the original voucher no.",
+ "shortDescription": {
+ "description": "Short Description of room type.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "printed": {
- "description": "Print status of the certificate.",
+ "houseKeeping": {
+ "description": "Indicates if room type of the room is flagged as housekeeping. This is read-only.",
"type": "boolean"
},
- "profileId": {
- "description": "NameId.",
- "$ref": "#/definitions/profileId"
- },
- "source": {
- "description": "Source of e-certificate.",
- "$ref": "#/definitions/eCertificateIssueSourceType"
- },
- "status": {
- "description": "Status of the certificate.",
- "$ref": "#/definitions/eCertificateStatusType"
+ "smokingPreference": {
+ "description": "Specifies the smoking preference for room type of the room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "voucherNo": {
- "description": "System generated unique voucher number.",
+ "building": {
+ "description": "Building associated with the room.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
- }
- }
- },
- "eCertificateUsageCriteriaType": {
- "description": "E-Certificates details.",
- "type": "object",
- "properties": {
- "benefit": {
- "description": "Indicates to attach a rate code to the e-certificate as a benefit.",
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 20
},
- "cancelAllowed": {
- "description": "Identify if cancel is allowed or not.",
- "type": "boolean"
+ "roomAssignmentRating": {
+ "description": "Assignment Rating associated with the room.",
+ "$ref": "#/definitions/ratePlanRatingType"
},
- "generateInLieuCertificate": {
- "description": "Identify if in lieu of certificate can be generated or not.",
- "type": "boolean"
+ "minimumOccupancy": {
+ "description": "Minimum occupancy for the room type.",
+ "type": "integer"
},
- "hotel": {
- "description": "Indicates if web certificate can be consumed in hotel.",
- "type": "boolean"
+ "maximumOccupancy": {
+ "description": "Maximum occupancy for the room type.",
+ "type": "integer"
},
- "reservation": {
- "description": "Indicates if certificate is to be used against reservation or not.",
- "type": "boolean"
+ "roomFeatures": {
+ "description": "Room Features for the room.",
+ "$ref": "#/definitions/roomFeaturesType"
},
- "verifyCertificateNo": {
- "description": "Specify if the certificate number verification is required at time of consumption or not.",
+ "accessible": {
+ "description": "Indicates if room type is accessible.",
"type": "boolean"
},
- "web": {
- "description": "Indicates if web certificate can be consumed in OWS.",
- "type": "boolean"
+ "roomType": {
+ "description": "Room type of the room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "webAllowed": {
- "description": "Indicates if certificate consumption allowable on the web.",
+ "meetingRoom": {
+ "description": "Indicates whether function space can be meeting room.",
"type": "boolean"
}
}
},
- "eCertificatesType": {
- "description": "List of e-certificates for the profile.",
+ "ratePlanRatingType": {
+ "type": "string",
+ "description": "Possible Rate plan rating values.",
+ "enum": [
+ "MostImportant",
+ "Important",
+ "SomewhatImportant",
+ "LessImportant",
+ "LeastImportant",
+ "NoValueSet"
+ ]
+ },
+ "roomFeaturesType": {
"type": "array",
+ "description": "A recurring element that identifies the room features.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/eCertificateType"
+ "$ref": "#/definitions/roomFeatureType"
}
},
- "eCouponType": {
- "description": "Reservation eCoupon Type Information.",
+ "roomFeatureType": {
"type": "object",
+ "description": "Room Feature Information.",
"properties": {
- "autoAttached": {
- "description": "Determines whether the eCoupon is attached through the Rate Code or not.",
- "type": "boolean"
- },
"code": {
- "description": "Code to attach the eCoupon to Reservation.",
+ "description": "A code representing a room feature.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
"description": {
- "description": "Description of the eCoupon attached to the Reservation.",
+ "description": "A code representing a room feature.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "eCouponId": {
- "description": "ECouponID to attach the eCoupon to Reservation.",
- "$ref": "#/definitions/uniqueID_Type"
+ "orderSequence": {
+ "description": "Display Order sequence.",
+ "type": "number"
},
- "issuedQuantity": {
- "description": "Assigned Quantity for the eCoupon when attached to Reservation.",
+ "quantity": {
+ "description": "Indicates quantity.",
"type": "integer"
- },
- "ratePlanCode": {
- "description": "Rate plan of the attached eCoupon to Reservation.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "reason": {
- "description": "Reason for attaching/modifing eCoupon.",
+ }
+ }
+ },
+ "translationTextType2000": {
+ "type": "object",
+ "description": "Contains Multiple translated texts and language codes.",
+ "properties": {
+ "defaultText": {
+ "description": "Default text with Character length from 0 to 2000.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
- },
- "usedQuantity": {
- "description": "Used Quantity of the eCoupon for the Reservation.",
- "type": "integer"
+ "minLength": 0,
+ "maxLength": 2000
},
- "welcomeOffer": {
- "description": "Determines whether this eCoupon is eligible for welcome offer or not.",
- "type": "boolean"
+ "translatedTexts": {
+ "description": "List of translated text and language codes.",
+ "$ref": "#/definitions/translationsTextType"
}
}
},
- "eCouponsType": {
- "description": "Collection of ECouponType object.",
+ "translationsTextType": {
"type": "array",
+ "description": "Language code for the translation.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/eCouponType"
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "Used for Character Strings, length 0 to 2000.",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "language": {
+ "description": "Language identification.",
+ "type": "string",
+ "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
+ }
+ },
+ "description": "Language code for the translation."
}
},
- "effectiveRateType": {
- "description": "Effective rate amount per guest on specific dates.",
+ "roomSectionType": {
"type": "object",
"properties": {
- "amountBeforeTax": {
- "description": "Rate amount Before Tax.",
- "type": "number"
- },
- "end": {
- "description": "The ending value of the date range.",
+ "daySectionCode": {
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "extraChildRate": {
- "description": "Rate amount for each extra Child.",
- "type": "number"
- },
- "extraPersonRate": {
- "description": "Rate amount for each extra person.",
- "type": "number"
- },
- "fivePersonRate": {
- "description": "Rate amount for five persons.",
- "type": "number"
- },
- "fourChildrenRate": {
- "description": "Rate amount for four Children.",
- "type": "number"
- },
- "fourPersonRate": {
- "description": "Rate amount for four persons.",
- "type": "number"
+ "minLength": 0,
+ "maxLength": 20
},
- "hotelId": {
+ "eveningSectionCode": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ }
+ }
+ },
+ "housekeepingType": {
+ "type": "object",
+ "description": "Identifies the Housekeeping information.",
+ "properties": {
+ "roomStatus": {
+ "description": "The Room status information per the reservation and housekeeping.",
+ "$ref": "#/definitions/roomStatusType"
},
- "minimumChildrenForFreeStay": {
- "description": "Minimum number of children needed to get free stay.",
- "type": "integer"
+ "roomPersons": {
+ "description": "The Room person information per the reservation and housekeeping.",
+ "$ref": "#/definitions/roomPersonsType"
},
- "numberOfRooms": {
- "type": "integer"
+ "guestServiceRequest": {
+ "$ref": "#/definitions/guestHousekeepingServiceRequestType"
},
- "oneChildRate": {
- "description": "Rate amount for one Child.",
- "type": "number"
+ "cleaningPriority": {
+ "description": "Cleaning priority for the room, if a priority was set.",
+ "$ref": "#/definitions/roomCleaningPriorityType"
},
- "onePersonRate": {
- "description": "Rate amount for one person.",
- "type": "number"
+ "roomCondition": {
+ "description": "Condition of the room, if a condition was set.",
+ "$ref": "#/definitions/roomConditionType"
},
- "overrideFloorAmount": {
- "description": "true if floor amount needs to be override",
+ "linenChange": {
+ "description": "Indicates if a linen change is necessary.",
"type": "boolean"
},
- "pointsRequired": {
- "description": "The number of award points required for applying this rate plan schedule.",
- "type": "number"
- },
- "rateByAgeBuckets": {
- "description": "Collection of rate amount by age bracket.",
- "$ref": "#/definitions/rateByAgeBucketsType"
- },
- "ratePlanCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomType": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "start": {
- "description": "The starting value of the date range.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "threeChildrenRate": {
- "description": "Rate amount for three Children.",
- "type": "number"
- },
- "threePersonRate": {
- "description": "Rate amount for three persons.",
- "type": "number"
- },
- "twoChildrenRate": {
- "description": "Rate amount for two Children.",
- "type": "number"
- },
- "twoPersonRate": {
- "description": "Rate amount for two persons.",
- "type": "number"
+ "facilityTaskCode": {
+ "description": "Facility task Code/ Task Code assigned to the room for the day.",
+ "$ref": "#/definitions/codeListType"
}
}
},
- "effectiveRatesType": {
- "description": "Collection of effective rate amount per guest on specific dates.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/effectiveRateType"
- }
- },
- "emailInfoType": {
- "description": "Information on an email for the customer.",
+ "roomStatusType": {
"type": "object",
"properties": {
- "email": {
- "description": "eMail deatils for the profile.",
- "$ref": "#/definitions/emailType"
+ "reservationStatusList": {
+ "description": "List of status of the reservation to which this Room is assigned..",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/housekeepingRoomReservationStatusType"
+ }
},
- "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",
- "maxLength": 80,
- "minLength": 0
+ "roomStatus": {
+ "description": "Status of the room (Dirty/Clean/Inspected/Pickup).",
+ "$ref": "#/definitions/housekeepingRoomStatusType"
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "frontOfficeStatus": {
+ "description": "Front office status ( Occupied/Vacant ).",
+ "$ref": "#/definitions/frontOfficeRoomStatusType"
+ },
+ "housekeepingStatus": {
+ "description": "Housekeeping status ( Occupied/Vacant ).",
+ "$ref": "#/definitions/frontOfficeRoomStatusType"
}
}
},
- "emailType": {
- "description": "Information on an email for the customer.",
- "type": "object",
- "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",
- "maxLength": 200,
- "minLength": 0
- },
- "emailAddress": {
- "description": "Defines the e-mail address.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "emailFormat": {
- "description": "Supported Email format.",
- "type": "string",
- "enum": [
- "Html",
- "Text"
- ]
- },
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
- "type": "string",
- "format": "date-time"
- },
- "orderSequence": {
- "description": "Display Order sequence.",
- "type": "number"
- },
- "primaryInd": {
- "description": "When true, indicates a primary information.",
- "type": "boolean"
- },
- "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
- },
- "type": {
- "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve).",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "typeDescription": {
- "description": "Describes the Type code",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- }
- }
+ "frontOfficeRoomStatusType": {
+ "type": "string",
+ "description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.",
+ "enum": [
+ "Vacant",
+ "Occupied"
+ ]
},
- "employeeInfoType": {
+ "roomPersonsType": {
"type": "object",
"properties": {
- "addressInfo": {
- "$ref": "#/definitions/addressInfoType"
- },
- "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"
- },
- "department": {
- "$ref": "#/definitions/codeDescriptionType"
- },
- "emailInfo": {
- "$ref": "#/definitions/emailInfoType"
- },
- "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",
- "maxLength": 20,
- "minLength": 0
- },
- "personName": {
- "$ref": "#/definitions/personNameType"
- },
- "phoneInfo": {
- "$ref": "#/definitions/telephoneInfoType"
+ "frontOfficePersons": {
+ "type": "integer"
},
- "profileId": {
- "$ref": "#/definitions/uniqueID_Type"
+ "houseKeepingPersons": {
+ "type": "integer"
}
}
},
- "entityType": {
- "description": "Indicates the rule is based on Minutes associated with the charge.",
- "type": "string",
- "enum": [
- "ThresholdCount",
- "ThresholdQuantity",
- "ThresholdMinutes"
- ]
- },
- "errorInstance": {
- "description": "Complex type that contains error instance details for a REST call.",
+ "roomCleaningPriorityType": {
"type": "object",
- "title": "Error Instance Details",
- "required": [
- "type",
- "title"
- ],
+ "description": "Type to indicate the cleaning priority for a room.",
"properties": {
- "detail": {
- "description": "Human-readable description specific to this occurrence of the problem.",
- "type": "string"
- },
- "instance": {
- "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced.",
- "type": "string"
- },
- "o:errorCode": {
- "description": "Application error code, which is different from HTTP error code.",
- "type": "string"
- },
- "o:errorPath": {
- "description": "Path to the problem at the resource or property level.",
- "type": "string"
- },
- "status": {
- "description": "HTTP status code for this occurrence of the problem, set by the origin server.",
+ "prioritySequence": {
+ "description": "Priority sequence of the room for cleaning.",
"type": "integer"
- },
- "title": {
- "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.",
- "type": "string"
- },
- "type": {
- "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML).",
- "type": "string"
}
}
},
- "errorType": {
- "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.",
+ "roomConditionType": {
"type": "object",
+ "description": "Condition to be assigned on the room.",
"properties": {
- "code": {
- "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "docURL": {
- "description": "If present, this URL refers to an online description of the error that occurred.",
- "type": "string"
- },
- "language": {
- "description": "Language identification.",
- "type": "string",
- "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
- },
- "nodeList": {
- "description": "An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional 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"
- },
- "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"
- },
- "shortText": {
- "description": "An abbreviated version of the error in textual format.",
- "type": "string"
- },
- "status": {
- "description": "If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.",
- "type": "string"
+ "roomCondition": {
+ "description": "Code and Decription of Condition to be assigned on the room.",
+ "$ref": "#/definitions/codeDescriptionType"
},
- "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"
+ "assignmentType": {
+ "description": "Determine if room, after applying condition, is available or not in Room Assignment listing.",
+ "$ref": "#/definitions/roomConditionAssigmentType"
},
- "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\".",
+ "remarks": {
+ "description": "Remarks on room condition assignment.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "value": {
- "description": "Property Value",
- "type": "string"
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "errorsType": {
- "description": "An error that occurred during the processing of a message.",
+ "roomConditionAssigmentType": {
+ "type": "string",
+ "description": "Simple type for Room Condition assignment type. Valid values are Available and NotAvailable Only.",
+ "enum": [
+ "Available",
+ "NotAvailable"
+ ]
+ },
+ "codeListType": {
"type": "array",
- "maxItems": 99,
+ "maxItems": 4000,
"items": {
- "$ref": "#/definitions/errorType"
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
}
},
- "eventId": {
- "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).",
+ "roomsOutOfOrderType": {
+ "type": "array",
+ "description": "Date Range and reasons for a room being Out of Order/Out Of Service (If the room is OO/OS).",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomOutOfOrderType"
+ }
+ },
+ "roomOutOfOrderType": {
"type": "object",
+ "description": "Out Of Order and Out Of Service Room information.",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "repairRemarks": {
+ "description": "Notes or Remarks on the OO/OS room",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "returnStatus": {
+ "description": "Room Status which will be used on completion of OO/OS.",
+ "$ref": "#/definitions/housekeepingRoomStatusType"
},
- "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.",
+ "reasonCode": {
+ "description": "Reason Code why the room is OO/OS.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "reasonDesc": {
+ "description": "Reason Description why the room is OO/OS.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
- }
- }
- },
- "exceptionDetailType": {
- "description": "Complex type that contains error details for a REST call.",
- "type": "object",
- "title": "Error Detail",
- "required": [
- "type",
- "title"
- ],
- "properties": {
- "detail": {
- "description": "Human-readable description specific to this occurrence of the problem.",
- "type": "string"
+ "minLength": 0,
+ "maxLength": 80
},
- "instance": {
- "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced.",
- "type": "string"
- },
- "links": {
- "$ref": "#/definitions/links"
- },
- "o:errorCode": {
- "description": "Application error code, which is different from HTTP error code.",
- "type": "string"
- },
- "o:errorDetails": {
- "description": "Details of the error message, consisting of a hierarchical tree structure.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/errorInstance"
- }
- },
- "o:errorPath": {
- "description": "Path to the problem at the resource or property level.",
- "type": "string"
+ "newDateRange": {
+ "description": "The new start date and end date, if the dates were changed as part of an update. This would be blank for new OO/OS rooms.",
+ "$ref": "#/definitions/dateRangeType"
},
- "status": {
- "description": "HTTP status code for this occurrence of the problem, set by the origin server.",
- "type": "integer"
+ "roomStatus": {
+ "description": "The out of order or out of service room status OO/OS.",
+ "$ref": "#/definitions/housekeepingRoomStatusType"
},
- "title": {
- "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.",
- "type": "string"
+ "start": {
+ "description": "The starting value of the date range.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "type": {
- "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML).",
- "type": "string"
+ "end": {
+ "description": "The ending value of the date range.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
}
}
},
- "excludedDateType": {
- "description": "Specifies all the enabled dates.",
+ "dateRangeType": {
"type": "object",
+ "description": "Date Range with Start and End dates.",
"properties": {
- "date": {
- "description": "Contains exclusion date.",
+ "start": {
+ "description": "The starting value of the date range.",
"type": "string",
"format": "date",
"maxLength": 8
},
- "reason": {
- "description": "Contains reason for exclusion.",
- "$ref": "#/definitions/exclusionReasonType"
+ "end": {
+ "description": "The ending value of the date range.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
}
}
},
- "excludedDatesType": {
- "description": "Contains list of dates which are valid for custom charge exemptions.",
+ "roomDiscrepanciesType": {
"type": "array",
+ "description": "Room Discrepancies between front office and housekeeping room status and number of persons in the room.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/excludedDateType"
+ "$ref": "#/definitions/roomDiscrepancyType"
}
},
- "exclusionReasonType": {
- "description": "Custom Charge has already been Processed for this date within the reservation stay.",
+ "roomDiscrepancyType": {
"type": "string",
+ "description": "Simple type for discrepant room status instructions to be used in requests for fetching housekeeping and front office room discrepancy. Valid values are Sleep, Skip, Person Discrepancy, Due Out Only.",
"enum": [
- "NotConfigured",
- "CustomChargeProcessed"
+ "Sleep",
+ "Skip",
+ "PersonDiscrepancy"
]
},
- "externalReferenceType": {
- "description": "This type contains unique information of external reference.",
+ "sitePlanSectionType": {
"type": "object",
+ "description": "Represents the site plan section record.",
"properties": {
- "id": {
- "description": "Unique ID of external reference.",
+ "sectionCode": {
+ "description": "The site plan section code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "sectionType": {
+ "description": "The section type.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "idContext": {
- "description": "ID context for external reference.",
+ "linkCode": {
+ "description": "The link code for the section.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "idExtension": {
- "description": "ID extension for external reference.",
- "type": "integer"
+ "coordinates": {
+ "description": "The coordinates for this section.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The description of this section.",
+ "type": "string"
}
}
},
- "externalReferencesType": {
- "description": "This type contains unique information of external reference.",
+ "roomRoomsType": {
"type": "array",
+ "description": "Collection of rooms.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/externalReferenceType"
+ "$ref": "#/definitions/roomRoomType"
}
},
- "fBAInfoType": {
- "description": "FBA ( Flexible Benefits Awards ) related fields.",
+ "roomRoomType": {
"type": "object",
+ "description": "This type represents the primary room attributes.",
"properties": {
- "amount": {
- "description": "Award's FBA amount.",
- "type": "number"
+ "roomType": {
+ "description": "Room type basic information of the room.",
+ "$ref": "#/definitions/roomTypeShortInfoType"
},
- "currencyCode": {
- "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
+ "floor": {
+ "description": "Floor of the Room.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "currencySymbol": {
- "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.",
+ "floorDescription": {
+ "description": "Description for the Floor of the Room.",
"type": "string",
- "maxLength": 10,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "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"
+ "roomFeatures": {
+ "description": "Room Features for the room.",
+ "$ref": "#/definitions/roomFeaturesType"
},
- "fbaBillGenDate": {
- "description": "Business date of the FBA bill generation.",
+ "roomDescription": {
+ "description": "Detail Long Description Of The Room.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "flexibleBenefitAward": {
- "description": "Indicates if this certificate is a Flexible Benefit Award certificate.",
- "type": "boolean"
+ "description": {
+ "description": "Description of the room.",
+ "$ref": "#/definitions/translationTextType2000"
},
- "monetaryValue": {
- "description": "Award's FBA monetary values.",
- "type": "number"
+ "smokingPreference": {
+ "description": "This indicates room smoking preference.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "orphanCertificate": {
- "description": "Indicates whether the certificate is Orphan or not.",
- "type": "boolean"
+ "smokingPreferenceDescription": {
+ "description": "This indicates the description of the room smoking preference.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "posted": {
- "description": "Indicates whether FBA has been posted.",
- "type": "boolean"
+ "building": {
+ "description": "Building associated with the room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "postedAmount": {
- "description": "Award's FBA posted amount.",
- "type": "number"
+ "roomAssignmentRating": {
+ "description": "Assignment Rating associated with the room.",
+ "$ref": "#/definitions/ratePlanRatingType"
},
- "postingBusinessDate": {
- "description": "Business date of the FBA posting.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "accessible": {
+ "description": "Indicates whether the room is accessibility compliant.",
+ "type": "boolean"
},
- "postingDateTime": {
- "description": "Date and time of the FBA posting.",
+ "roomId": {
+ "description": "Code of the room.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "reimburseAllowed": {
- "description": "Marks if the certificate is eligible for reimbursement.",
+ "meetingRoom": {
+ "description": "Indicates whether the room is a Meeting Room",
"type": "boolean"
},
- "reimbursed": {
- "description": "Indicates whether FBA has been reimbursed.",
- "type": "boolean"
+ "roomCondition": {
+ "description": "Code and description of condition assigned on the room.",
+ "$ref": "#/definitions/codeDescriptionType"
+ }
+ }
+ },
+ "currentServicingAttendantType": {
+ "type": "object",
+ "description": "The Attendant Name and ID of the attendant servicing the room.",
+ "properties": {
+ "section": {
+ "description": "Section Code the attendant has been assigned.",
+ "$ref": "#/definitions/housekeepingSectionType"
},
- "reimbursedAmount": {
- "description": "Award's FBA reimbursed amount.",
- "type": "number"
+ "floor": {
+ "description": "The Floor which is assigned to the attendant.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "reimbursementBusinessDate": {
- "description": "Business date of the FBA reimbursement.",
+ "attendantId": {
+ "description": "Attendant's unique identifier.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "reimbursementDateTime": {
- "description": "Date and time of the FBA reimbursement.",
+ "attendantName": {
+ "description": "Attendant's name.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 80
},
- "resettleAllowed": {
- "description": "Marks if the certificate is eligible for resettlement",
+ "hotelId": {
+ "description": "Property where the attendant belongs.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "activeFlag": {
+ "description": "Indicates if the Attendant is active.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 1
+ },
+ "sunday": {
"type": "boolean"
},
- "settled": {
- "description": "Indicates whether FBA has been settled.",
+ "monday": {
"type": "boolean"
},
- "settlementBusinessDate": {
- "description": "Business date of the FBA settlement.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "tuesday": {
+ "type": "boolean"
},
- "settlementDateTime": {
- "description": "Date and time of the FBA settlement.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "wednesday": {
+ "type": "boolean"
+ },
+ "thursday": {
+ "type": "boolean"
+ },
+ "friday": {
+ "type": "boolean"
+ },
+ "saturday": {
+ "type": "boolean"
+ },
+ "appUser": {
+ "description": "The App User Name and ID of the user who started the service.",
+ "$ref": "#/definitions/applicationUserType"
+ },
+ "startTime": {
+ "description": "The start time of the service.",
+ "type": "string",
+ "format": "date-time"
},
"status": {
- "description": "Possible FBA statuses.",
- "$ref": "#/definitions/fBAStatusType"
+ "description": "Status of the respective Housekeeping Attendant.",
+ "$ref": "#/definitions/servicingAttendantStatusType"
}
}
},
- "fBAStatusType": {
- "description": "Flexible benefit award has been reimbursed.",
- "type": "string",
- "enum": [
- "Ordered",
- "Attached",
- "Posted",
- "Settled",
- "Reimbursed"
- ]
- },
- "facilityCodeType": {
- "description": "Facility Housekeeping Code, its description and quantity.",
+ "housekeepingSectionType": {
"type": "object",
+ "description": "Information regarding Housekeeping Sections.",
"properties": {
+ "hotelId": {
+ "description": "Property where this section is defined.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
"code": {
- "description": "Facility code value.",
+ "description": "The Housekeeping Section Code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
"description": {
- "description": "Facility Code.",
+ "description": "Description of the Section.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "quantity": {
- "description": "Signifies the quantity.",
+ "sectionGroup": {
+ "description": "Housekeeping Section Group.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "targetCredits": {
+ "description": "Target Credit for each task sheet created for this section when auto task assignment is broken out by section.",
+ "type": "integer"
+ },
+ "rooms": {
+ "description": "Rooms count for this section code. This is auto populated while creating/fetching record.",
+ "type": "integer"
+ },
+ "roomCredits": {
+ "description": "Number of housekeeping credits. This is auto populated while creating/fetching record.",
"type": "integer"
+ },
+ "sequence": {
+ "description": "Display sequence when task assignment is automatically broken out by Section Group.",
+ "type": "integer"
+ },
+ "inactive": {
+ "description": "Indicates if the Section Code is active.",
+ "type": "boolean"
}
}
},
- "facilityCodesType": {
- "description": "List of the facility codes.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/facilityCodeType"
- }
- },
- "facilityTaskType": {
- "description": "Information regarding facility task on a reservation.",
+ "applicationUserType": {
"type": "object",
"properties": {
- "date": {
- "description": "The Date on which the task is applicable.",
+ "hotel": {
+ "description": "Hotel where user belongs.",
+ "$ref": "#/definitions/codeDescriptionType"
+ },
+ "appUser": {
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 60
},
- "supplies": {
- "description": "Supplies associated with the task.",
- "$ref": "#/definitions/facilityCodesType"
+ "lDAPUser": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 60
},
- "task": {
- "description": "The Task Code.",
- "$ref": "#/definitions/housekeepingTaskCodeType"
- }
- }
- },
- "feeType": {
- "description": "Applicable service charges or fees.",
- "type": "object",
- "properties": {
- "amount": {
- "description": "A monetary amount.",
- "type": "number"
+ "actAs": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "code": {
- "description": "Code identifying the fee (e.g.,agency fee, municipality fee).",
+ "actAt": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "currencyCode": {
- "description": "Provides a currency code to reflect the currency in which an amount may be expressed.",
+ "userDefaultLanguage": {
"type": "string",
- "maxLength": 3,
- "minLength": 3
+ "minLength": 0,
+ "maxLength": 20
},
- "description": {
+ "appUserId": {
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "cashierId": {
+ "type": "integer"
+ },
+ "cashierTitle": {
+ "description": "Cashier title.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "type": {
- "description": "Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).",
- "$ref": "#/definitions/amountDeterminationType"
- }
- }
- },
- "feesType": {
- "description": "A collection of fees or service charges.",
- "type": "object",
- "properties": {
- "amount": {
- "description": "A monetary amount.",
- "type": "number"
+ "department": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 60
},
- "currencyCode": {
- "description": "Provides a currency code to reflect the currency in which an amount may be expressed.",
+ "departmentLocation": {
"type": "string",
- "maxLength": 3,
- "minLength": 3
+ "minLength": 0,
+ "maxLength": 60
},
- "fee": {
- "description": "An individual fee or service charge.",
- "type": "array",
- "maxItems": 99,
- "items": {
- "$ref": "#/definitions/feeType"
- }
+ "salesRepCode": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "expiryDate": {
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "disabledUntil": {
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "passwordChangeDate": {
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "userInfo": {
+ "$ref": "#/definitions/employeeInfoType"
+ },
+ "userSessionInfo": {
+ "description": "This is only used during log-in.",
+ "$ref": "#/definitions/userSessionInfoType"
+ },
+ "attendantInfo": {
+ "$ref": "#/definitions/attendantType"
}
}
},
- "fetchActivityBookingsType": {
- "description": "Used in the request message to describe the \"filtering Criteria\" when executing an activity lookup.",
+ "employeeInfoType": {
"type": "object",
"properties": {
- "activities": {
- "description": "The specific acitvity information to be used for filtering the Look-up.",
- "$ref": "#/definitions/activityList"
+ "personName": {
+ "$ref": "#/definitions/personNameType"
},
- "address": {
- "description": "Detailed Address information for the customer.",
- "$ref": "#/definitions/addressType"
+ "profileId": {
+ "$ref": "#/definitions/uniqueID_Type"
},
- "hotelId": {
- "description": "Hotel Code, It is used to filter hotel specific children to this specific hotel code.",
+ "addressInfo": {
+ "$ref": "#/definitions/addressInfoType"
+ },
+ "emailInfo": {
+ "$ref": "#/definitions/emailInfoType"
+ },
+ "phoneInfo": {
+ "$ref": "#/definitions/telephoneInfoType"
+ },
+ "department": {
+ "$ref": "#/definitions/codeDescriptionType"
+ },
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "personName": {
- "description": "Detailed name information for the customer.",
- "$ref": "#/definitions/personNameType"
+ "birthDate": {
+ "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "profileId": {
- "description": "ProfileID associated with the Activity under lookup.",
- "$ref": "#/definitions/uniqueIDListType"
+ "birthDateMasked": {
+ "description": "Indicates the date of birth as masked.",
+ "type": "string"
}
}
},
- "fixedChargeDetailType": {
- "description": "Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.",
+ "personNameType": {
"type": "object",
+ "description": "This provides name information for a person.",
"properties": {
- "article": {
- "description": "Holds related article code and description.",
- "$ref": "#/definitions/codeDescriptionType"
+ "namePrefix": {
+ "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "chargeAmount": {
- "description": "Price of the product.",
- "$ref": "#/definitions/currencyAmountType"
+ "givenName": {
+ "description": "Given name, first name or names.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "percent": {
- "description": "Percentage of the rate amount.",
- "type": "number",
- "maximum": 100,
- "minimum": 0
+ "middleName": {
+ "description": "The middle name of the person name.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "quantity": {
- "description": "Quantity of the product.",
- "type": "integer"
+ "surname": {
+ "description": "Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "roomNights": {
- "description": "Holds number of comp or cash room night to allocate.",
+ "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
+ },
+ "nameTitleSuffix": {
+ "description": "Title Suffix. Must be populated if ADVANCED_TITLE is on.",
"type": "integer"
},
- "supplement": {
- "description": "Additional information regarding the fixed charge.",
+ "envelopeGreeting": {
+ "description": "Envelope Greeting of the profile",
+ "type": "string"
+ },
+ "salutation": {
+ "description": "Salutation of the profile",
+ "type": "string"
+ },
+ "nameType": {
+ "description": "Type of name of the individual, such as former, nickname, alternate or alias name.",
+ "$ref": "#/definitions/personNameTypeType"
+ },
+ "language": {
+ "description": "Language identification.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
},
- "transaction": {
- "description": "Transaction code and description of a fixed charge.",
- "$ref": "#/definitions/codeDescriptionType"
+ "externalSystem": {
+ "description": "When name type is external, indicates the external system the name belongs to.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "fixedChargeFrequencyType": {
- "description": "Yearly.",
+ "personNameTypeType": {
"type": "string",
+ "description": "Person's name in an external system.",
"enum": [
- "O",
- "D",
- "W",
- "M",
- "Q",
- "Y"
+ "Primary",
+ "Alternate",
+ "Incognito",
+ "External",
+ "Phonetic"
]
},
- "fixedChargeScheduleType": {
- "description": "Holds schedule of fixed charge.",
+ "userSessionInfoType": {
"type": "object",
"properties": {
- "dateToExecute": {
- "description": "Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.",
+ "businessDate": {
"type": "string",
"format": "date",
"maxLength": 8
},
- "dayToExecute": {
- "description": "Day of when to execute fixed charge. Applicable when frequency is Daily or Weekly.",
- "type": "string",
- "maxLength": 3,
- "minLength": 0
- },
- "end": {
- "description": "The ending value of the date range.",
+ "systemDate": {
"type": "string",
"format": "date",
"maxLength": 8
},
- "frequency": {
- "description": "Frequency of a fixed charge.",
- "$ref": "#/definitions/fixedChargeFrequencyType"
+ "terminal": {
+ "type": "string"
},
- "start": {
- "description": "The starting value of the date range.",
+ "runningApp": {
+ "type": "string"
+ },
+ "shareProfiles": {
+ "type": "boolean"
+ },
+ "hotel": {
+ "$ref": "#/definitions/codeDescriptionType"
+ },
+ "cro": {
+ "$ref": "#/definitions/codeDescriptionType"
+ },
+ "chain": {
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "cROCountryCode": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "sessionDefaults": {
+ "$ref": "#/definitions/userSessionDefaultsType"
+ },
+ "parameters": {
+ "$ref": "#/definitions/parametersType"
}
}
},
- "fixedChargeType": {
- "description": "Holds fixed charge information.",
+ "userSessionDefaultsType": {
"type": "object",
"properties": {
- "charge": {
- "description": "Holds specific details of fixed charge.",
- "$ref": "#/definitions/fixedChargeDetailType"
- },
- "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",
- "maxLength": 80,
- "minLength": 0
+ "dbDateFormat": {
+ "type": "string"
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "oracleDateFormat": {
+ "type": "string"
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "oracleTimeFormat": {
+ "type": "string"
},
- "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",
- "maxLength": 80,
- "minLength": 0
+ "javaDateFormat": {
+ "type": "string"
},
- "schedule": {
- "description": "Holds schedule of fixed charge.",
- "$ref": "#/definitions/fixedChargeScheduleType"
+ "javaTimeFormat": {
+ "type": "string"
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "currencyCode": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "currencyFormat": {
+ "type": "string"
+ },
+ "defaultLanguage": {
"type": "string"
+ },
+ "baseLanguage": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "fixedChargesType": {
- "description": "Holds fixed charge detail.",
+ "parametersType": {
"type": "array",
+ "description": "Collection of generic Name-Value-Pair parameters.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/fixedChargeType"
+ "$ref": "#/definitions/parameterType"
+ }
+ },
+ "parameterType": {
+ "type": "object",
+ "description": "Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined.",
+ "properties": {
+ "parameterName": {
+ "description": "Name of the parameter.",
+ "type": "string"
+ },
+ "parameterValue": {
+ "description": "Value of the parameter.",
+ "type": "string"
+ }
+ }
+ },
+ "attendantType": {
+ "type": "object",
+ "properties": {
+ "attendantId": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "hotelId": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
+ }
+ },
+ "servicingAttendantStatusType": {
+ "type": "string",
+ "description": "Possible values for the Status of a Servicing Attendant.",
+ "enum": [
+ "Standby",
+ "Break",
+ "Working",
+ "Completed"
+ ]
+ },
+ "roomHoldType": {
+ "type": "object",
+ "properties": {
+ "holdUntil": {
+ "description": "The date and time when hold will expire.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "holdUser": {
+ "description": "User who placed room on hold.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "comments": {
+ "description": "Comments of the room hold.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ }
+ }
+ },
+ "turndownInfoType": {
+ "type": "object",
+ "properties": {
+ "turndownStatusInfo": {
+ "$ref": "#/definitions/turndownStatusType"
+ }
+ }
+ },
+ "reservationShortInfoType": {
+ "type": "object",
+ "properties": {
+ "guestName": {
+ "description": "Guest name that is registered for the reservation.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "reservationId": {
+ "$ref": "#/definitions/reservationId"
+ },
+ "reservationStatusInfo": {
+ "$ref": "#/definitions/housekeepingRoomReservationStatusType"
+ },
+ "stayDateInfo": {
+ "$ref": "#/definitions/stayDateInfoType"
+ },
+ "vipStatus": {
+ "description": "VIP status of the guest.",
+ "$ref": "#/definitions/vIPStatusType"
+ },
+ "profileId": {
+ "description": "ProfileId of the guest.",
+ "$ref": "#/definitions/uniqueID_Type"
+ }
}
},
"floorPlanRoomGuestType": {
"type": "object",
"properties": {
+ "lastName": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
"arrival": {
"type": "string",
"format": "date",
"maxLength": 8
},
- "confirmationNo": {
- "type": "string"
- },
"departure": {
"type": "string",
"format": "date",
"maxLength": 8
},
- "firstName": {
- "type": "string"
- },
- "lastName": {
+ "shareID": {
"type": "string"
},
- "shareID": {
+ "confirmationNo": {
"type": "string"
}
}
},
- "floorPlanRoomType": {
- "description": "This type represents the primary room attributes.",
+ "statistics": {
"type": "object",
+ "description": "Response element for frontOffice statistics.",
"properties": {
- "accessible": {
- "description": "Indicates whether the room is accessibility compliant.",
- "type": "boolean"
- },
- "attendant": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/currentServicingAttendantType"
- }
- },
- "building": {
- "description": "Building associated with the room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "statisticsCode": {
+ "description": ".",
+ "$ref": "#/definitions/hSKStatReportCodeType"
},
- "componentRoomNumber": {
- "description": "This flag indicates component room.",
+ "calendarDate": {
+ "description": "Statistical date of the requested report.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date"
},
- "componentRoomNumbers": {
- "description": "List of component room numbers.",
+ "metricSet": {
"type": "array",
- "maxItems": 4000,
+ "description": "Base statistic set holder which defines the span of the statistical data.",
"items": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "type": "object",
+ "description": ".",
+ "properties": {
+ "metrics": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/hSKStatType"
+ }
+ },
+ "code": {
+ "type": "string",
+ "maxLength": 2000
+ },
+ "start": {
+ "type": "string",
+ "format": "date"
+ },
+ "end": {
+ "type": "string",
+ "format": "date"
+ }
+ }
}
},
- "componentRooms": {
- "description": "This flag indicates component rooms.",
- "$ref": "#/definitions/roomRoomsType"
- },
- "connectingRooms": {
- "description": "This flag indicates connecting rooms.",
- "$ref": "#/definitions/roomRoomsType"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "description": {
- "description": "Description of the room.",
- "$ref": "#/definitions/translationTextType2000"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "hSKStatReportCodeType": {
+ "type": "string",
+ "description": "Supported Housekeeping report codes.",
+ "enum": [
+ "HouseSummary",
+ "HouseSummaryMonthToDate",
+ "HouseSummaryYearToDate",
+ "ReservationActivity",
+ "ReservationActivityDaily",
+ "ReservationActivityMonthToDate",
+ "ReservationActivityYearToDate",
+ "ComplimentaryOrHouseUse",
+ "DailyProjection",
+ "RoomStatus",
+ "LastHourStatus",
+ "Turndown",
+ "InHouse",
+ "CheckIns",
+ "CheckOuts",
+ "AvailableRooms",
+ "RoomMaintenance",
+ "ReservationStatistics",
+ "VIPGuests",
+ "AdvanceCheckIn",
+ "BlockArrivals",
+ "ReservationsCancellationsToday",
+ "AIRoomAssignment",
+ "CompRouting"
+ ]
+ },
+ "hSKStatType": {
+ "type": "object",
+ "description": "Since the statistical value can be represented in different measure of units, this element will provide a flexible definition for the supported Opera9 statistical units.",
+ "properties": {
+ "value": {
+ "description": "Statistical value.",
+ "type": "number"
},
- "discrepancy": {
- "description": "Identifies the room discrepancy information.",
- "$ref": "#/definitions/roomDiscrepanciesType"
+ "category": {
+ "description": "Statistical unit category.",
+ "$ref": "#/definitions/statUnitCategoryType"
},
- "floor": {
- "description": "Floor of the Room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "code": {
+ "$ref": "#/definitions/hSKStatCodeType"
+ }
+ }
+ },
+ "statUnitCategoryType": {
+ "type": "string",
+ "description": "Supported statistical units.",
+ "enum": [
+ "Numeric",
+ "Amount"
+ ]
+ },
+ "hSKStatCodeType": {
+ "type": "string",
+ "description": "Supported housekeeping statistical codes.",
+ "enum": [
+ "ApprovedCompPostings",
+ "StagedCompPostings",
+ "DeclinedCompPostings",
+ "CompRoutingInstructionsRequests",
+ "TotalPhysicalRooms",
+ "TotalRoomsToSell",
+ "TotalOutOfOrder",
+ "TotalOutOfService",
+ "TotalRevenue",
+ "PercentRoomsOccupied",
+ "StayoverRooms",
+ "StayoverPersons",
+ "StayoverVIP",
+ "DeparturesExpectedRooms",
+ "DeparturesExpectedPersons",
+ "DeparturesExpectedVIP",
+ "DeparturesActualRooms",
+ "DeparturesActualPersons",
+ "DeparturesActualVIP",
+ "DeparturesInLastHour",
+ "ArrivalsInLastHour",
+ "ArrivalsTotal",
+ "ArrivalsExpectedRooms",
+ "ArrivalsExpectedPersons",
+ "ArrivalsExpectedVIP",
+ "ArrivalsExpectedRoomsMadeToday",
+ "ArrivalsExpectedPersonsMadeToday",
+ "ArrivalsExpectedVIPMadeToday",
+ "ArrivalsActualRooms",
+ "ArrivalsActualPersons",
+ "ArrivalsActualVIP",
+ "ExtendedStaysRooms",
+ "ExtendedStaysPersons",
+ "ExtendedStaysVIP",
+ "DeparturesTotal",
+ "EarlyDeparturesRooms",
+ "EarlyDeparturesPersons",
+ "EarlyDeparturesVIP",
+ "DayUseRooms",
+ "DayUsePersons",
+ "DayUseVIP",
+ "WalkInRooms",
+ "WalkInPersons",
+ "WalkInVIP",
+ "CanceledOnArrivalRooms",
+ "CanceledOnArrivalPersons",
+ "CanceledOnArrivalVIP",
+ "ComplimentaryArrivalRooms",
+ "ComplimentaryArrivalPersons",
+ "ComplimentaryArrivalVIP",
+ "ComplimentaryStayoverRooms",
+ "ComplimentaryStayoverPersons",
+ "ComplimentaryStayoverVIP",
+ "ComplimentaryDepartureRooms",
+ "ComplimentaryDeparturePersons",
+ "ComplimentaryDepartureVIP",
+ "HouseUseArrivalVIP",
+ "HouseUseStayoverRooms",
+ "HouseUseStayoverPersons",
+ "HouseUseStayoverVIP",
+ "HouseUseDepartureRooms",
+ "HouseUseDeparturePersons",
+ "HouseUseDepartureVIP",
+ "MinAvailableTonightRooms",
+ "MaxOccupiedTonightRooms",
+ "MaxOccupiedTonightPersons",
+ "MaxOccupiedTonightVIP",
+ "MaxPercentageOccupiedTonightRooms",
+ "BlocksNotPickedUp",
+ "IndividualRooms",
+ "IndividualPersons",
+ "IndividualVIP",
+ "GroupAndBlockRooms",
+ "GroupAndBlockPersons",
+ "GroupAndBlockVIP",
+ "RoomRevenue",
+ "AverageRoomRevenue",
+ "InspectedRooms",
+ "InspectedVacant",
+ "InspectedAssigned",
+ "InspectedOccupied",
+ "CleanedRooms",
+ "CleanVacant",
+ "CleanAssigned",
+ "CleanOccupied",
+ "DirtyVacant",
+ "DirtyAssigned",
+ "DirtyOccupied",
+ "PickupVacant",
+ "PickupAssigned",
+ "PickupOccupied",
+ "OutOfOrderVacant",
+ "OutOfOrderAssigned",
+ "OutOfOrderOccupied",
+ "OutOfServiceVacant",
+ "OutOfServiceAssigned",
+ "OutOfServiceOccupied",
+ "QueueRooms",
+ "TurndownRequired",
+ "TurndownNotRequired",
+ "TurndownCompletedRequired",
+ "AdultsInHouse",
+ "ChildrenInHouse",
+ "AdultsExpectedCheckedOut",
+ "ChildrenExpectedCheckedOut",
+ "AdultsDeparted",
+ "ChildrenDeparted",
+ "InHouseRooms",
+ "InHouse",
+ "MaxOccupancyPercentage",
+ "Stayover",
+ "TotalRoomsReserved",
+ "RevPar",
+ "SkipRooms",
+ "SleepRooms",
+ "HouseUseArrivalRooms",
+ "HouseUseArrivalPersons",
+ "AverageCheckInTime",
+ "CurrentAveWaitTime",
+ "CheckedInsTotal",
+ "ExpectedCheckInsTotal",
+ "CheckedOutsTotal",
+ "ExpectedCheckOutsTotal",
+ "ScheduledCheckOutsTotal",
+ "RoomMaintenanceResolvedTotal",
+ "RoomMaintenanceUnResolvedTotal",
+ "PreRegisteredTotal",
+ "VIPPreRegisteredTotal",
+ "OpenFolioTotal",
+ "TurndownTotal",
+ "VIPTurndownTotal",
+ "VIPGuestsArriving",
+ "VIPGuestsDeparting",
+ "VIPGuestsTotal",
+ "IndividualAdvanceCheckedInCurrent",
+ "BlockAdvanceCheckedInCurrent",
+ "IndividualAdvanceCheckedInInhouse",
+ "BlockAdvanceCheckedInInhouse",
+ "IndividualAdvanceCheckedInTotal",
+ "BlockAdvanceCheckedInTotal",
+ "InHouseBlocksTotal",
+ "CancellationsTotal",
+ "NewReservationsTotal",
+ "ArrivalResvs",
+ "ArrivalVIPResvs",
+ "ArrivalMemberResvs",
+ "ArrivalUnallocResvs",
+ "ArrivalManualAssgnResvs",
+ "ArrivalAIAssgnResvs",
+ "ArrivalAIUpgResvs",
+ "ArrivalAIAssgnVIPResvs",
+ "ArrivalAIAssgnMemberResvs",
+ "ArrivalAIAssgnOverridden"
+ ]
+ },
+ "activityLog": {
+ "type": "object",
+ "description": "Fulfillment activity log response.",
+ "properties": {
+ "activityLogDetails": {
+ "description": "List of activity log entries.",
+ "$ref": "#/definitions/activityLogListType"
},
- "floorDescription": {
- "description": "Description for the Floor of the Room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
- "guests": {
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "activityLogListType": {
+ "type": "object",
+ "properties": {
+ "activityLog": {
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/floorPlanRoomGuestType"
+ "$ref": "#/definitions/activityLogType"
}
},
- "hold": {
- "description": "Hold attributes if any.",
- "$ref": "#/definitions/roomHoldType"
+ "totalPages": {
+ "description": "Evaluated total page count based on the requested max fetch count.",
+ "type": "integer"
},
- "housekeeping": {
- "description": "Identifies the Housekeeping information..",
- "$ref": "#/definitions/housekeepingType"
+ "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"
},
- "meetingRoom": {
- "description": "Indicates whether the room is a Meeting Room",
+ "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"
},
- "outOfOrder": {
- "description": "Identifies the room Out of Order/Out of Service information.",
- "$ref": "#/definitions/roomsOutOfOrderType"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "resvInfo": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationShortInfoType"
- }
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
+ }
+ }
+ },
+ "activityLogType": {
+ "type": "object",
+ "properties": {
+ "hotelId": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "roomAssignmentRating": {
- "description": "Assignment Rating associated with the room.",
- "$ref": "#/definitions/ratePlanRatingType"
+ "module": {
+ "type": "string"
},
- "roomDescription": {
- "description": "Detail Long Description Of The Room.",
+ "logDate": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "roomFeatures": {
- "description": "Room Features for the room.",
- "$ref": "#/definitions/roomFeaturesType"
+ "refActionId": {
+ "type": "number"
},
- "roomId": {
- "description": "Code of the room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "logUserId": {
+ "type": "integer"
},
- "roomSection": {
- "description": "Room sections of the room.",
- "$ref": "#/definitions/roomSectionType"
+ "logUserName": {
+ "type": "string"
},
- "roomType": {
- "description": "Room type basic information of the room.",
- "$ref": "#/definitions/roomTypeShortInfoType"
+ "machineStation": {
+ "type": "string"
},
- "sitePlanSection": {
- "description": "Identifies the site plan location of the room.",
- "$ref": "#/definitions/sitePlanSectionType"
+ "croCode": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "smokingPreference": {
- "description": "This indicates room smoking preference.",
+ "actionType": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 100
},
- "smokingPreferenceDescription": {
- "description": "This indicates the description of the room smoking preference.",
+ "actionDescription": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "iPAddress": {
+ "description": "The IP Address of the machine that performed the activity",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "turndownInfo": {
- "$ref": "#/definitions/turndownInfoType"
+ "deviceCode": {
+ "description": "The selected device code",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "floorPlanType": {
- "description": "Floor information containing collection of Room records that contain Housekeeping and Out Of Order information.",
+ "taskSheetStatistics": {
"type": "object",
"properties": {
- "hotelId": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "rooms": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/floorPlanRoomType"
- }
+ "taskStatisticsInfo": {
+ "description": "Information regarding the Task Sheet statistics.",
+ "$ref": "#/definitions/hSKTaskSheetStatisticsInfoType"
},
- "siteCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
- "siteDescription": {
- "type": "string"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "floorPlans": {
- "description": "Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.",
+ "hSKTaskSheetStatisticsInfoType": {
"type": "object",
+ "description": "Holds the task sheet statistics information.",
"properties": {
- "floorPlansDetails": {
+ "taskSheetStatisticsInfo": {
"type": "array",
+ "maxItems": 4000,
"items": {
- "$ref": "#/definitions/floorPlanType"
+ "$ref": "#/definitions/hSKTaskSheetInfoType"
}
},
- "links": {
- "$ref": "#/definitions/links"
- },
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "masterInfoList": {
+ "description": "Refer to Generic common types document",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/masterInfoType"
+ }
}
}
},
- "folioShortInfoType": {
- "description": "This type contains information of generated bills.",
+ "hSKTaskSheetInfoType": {
"type": "object",
+ "description": "Holds the information for the task sheet.",
"properties": {
- "autoGenerated": {
- "description": "Flag to indicate if the folio is auto generated or not.",
- "type": "boolean"
+ "assignedTasks": {
+ "$ref": "#/definitions/assignedTasksType"
},
- "folioDate": {
- "description": "Date of Folio Generation.",
+ "attendant": {
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 100
},
- "folioNo": {
- "description": "Folio No of the bill generated.",
- "type": "number"
+ "taskSeqNo": {
+ "type": "integer"
},
- "folioStatus": {
- "$ref": "#/definitions/folioStatusType"
+ "taskSheetType": {
+ "$ref": "#/definitions/taskSheetType"
},
- "folioType": {
- "description": "Folio type of the bill generated.",
+ "taskSheetNo": {
+ "type": "integer"
+ },
+ "taskDate": {
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "folioView": {
- "description": "The folio window where the settlement is applied.",
+ "totalTaskCredits": {
"type": "integer"
},
- "internalFolioWindowID": {
- "description": "Internal window ID which is unique to the reservation. This ID can only be used for reference.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "totalCompletedCredits": {
+ "type": "integer"
},
- "invoiceNo": {
- "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios",
- "type": "number"
- }
- }
- },
- "folioStatusType": {
- "description": "The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.",
- "type": "string",
- "enum": [
- "Deposit",
- "Void",
- "Ok",
- "Zero",
- "Compress",
- "Converted",
- "Internal"
- ]
- },
- "folioTextsType": {
- "description": "This stores the description for the type of tax calculation especially with tax exemption, etc.",
- "type": "array",
- "maxItems": 2,
- "items": {
- "type": "object",
- "properties": {
- "row": {
- "description": "Row number of the additional text.",
- "type": "integer"
- },
- "text": {
- "description": "Additional text field to display on the folio.",
- "type": "string",
- "maxLength": 50,
- "minLength": 0
+ "averageActualTimeInSecs": {
+ "type": "integer"
+ },
+ "taskSheetDetails": {
+ "$ref": "#/definitions/hSKTaskSheetDetailsInfoType"
+ },
+ "roomSummary": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "object",
+ "properties": {
+ "housekeepingRoomStatusType": {
+ "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.",
+ "type": "string",
+ "enum": [
+ "Clean",
+ "Dirty",
+ "Pickup",
+ "Inspected",
+ "OutOfOrder",
+ "OutOfService"
+ ]
+ },
+ "totalCount": {
+ "type": "integer"
+ }
+ }
}
}
}
},
- "foliosShortInfoType": {
- "description": "This type contains a list of generated bills for a reservation.",
+ "assignedTasksType": {
"type": "array",
+ "description": "Holds the assigned task codes for a tasksheet.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/folioShortInfoType"
+ "$ref": "#/definitions/assignedTaskType"
}
},
- "foreignExchangeType": {
- "description": "Foreign Exchange info.",
+ "assignedTaskType": {
"type": "object",
+ "description": "Holds the assigned task code for a tasksheet.",
"properties": {
- "effectiveDate": {
- "description": "Effective Exchange date for the foreign currency posting.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "type": {
- "description": "Exchange Type for the postings.",
+ "taskCode": {
+ "description": "The Code for the task.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "formattedTextTextType": {
- "description": "Provides text and indicates whether it is formatted or not.",
+ "taskSheetType": {
+ "type": "string",
+ "description": "Task Sheet classification.",
+ "enum": [
+ "NoServiceRequired",
+ "DoNotDisturb",
+ "ManuallyCreated",
+ "AutomaticGeneration",
+ "Isolated",
+ "ExtraRooms"
+ ]
+ },
+ "hSKTaskSheetDetailsInfoType": {
"type": "object",
+ "description": "Holds the task sheet statistics details information.",
"properties": {
- "language": {
- "description": "Language identification.",
- "type": "string",
- "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
- },
- "value": {
- "description": "Property Value",
- "type": "string"
+ "rooms": {
+ "description": "Details of the room which is part of the Task Sheet. The room details will be returned when the request for IncludeTaskSheetDetails(flag in the search type) is true.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "object",
+ "properties": {
+ "roomType": {
+ "description": "Room type basic information of the room.",
+ "$ref": "#/definitions/roomTypeShortInfoType"
+ },
+ "floor": {
+ "description": "Floor of the Room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "floorDescription": {
+ "description": "Description for the Floor of the Room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "roomFeatures": {
+ "description": "Room Features for the room.",
+ "$ref": "#/definitions/roomFeaturesType"
+ },
+ "roomDescription": {
+ "description": "Detail Long Description Of The Room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "description": {
+ "description": "Description of the room.",
+ "$ref": "#/definitions/translationTextType2000"
+ },
+ "smokingPreference": {
+ "description": "This indicates room smoking preference.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "smokingPreferenceDescription": {
+ "description": "This indicates the description of the room smoking preference.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "building": {
+ "description": "Building associated with the room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "roomAssignmentRating": {
+ "description": "Assignment Rating associated with the room.",
+ "$ref": "#/definitions/ratePlanRatingType"
+ },
+ "accessible": {
+ "description": "Indicates whether the room is accessibility compliant.",
+ "type": "boolean"
+ },
+ "roomId": {
+ "description": "Code of the room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "meetingRoom": {
+ "description": "Indicates whether the room is a Meeting Room",
+ "type": "boolean"
+ },
+ "roomSection": {
+ "description": "Room sections of the room.",
+ "$ref": "#/definitions/roomSectionType"
+ },
+ "housekeeping": {
+ "description": "Identifies the Housekeeping information..",
+ "$ref": "#/definitions/housekeepingType"
+ },
+ "outOfOrder": {
+ "description": "Identifies the room Out of Order/Out of Service information.",
+ "$ref": "#/definitions/roomsOutOfOrderType"
+ },
+ "discrepancy": {
+ "description": "Identifies the room discrepancy information.",
+ "$ref": "#/definitions/roomDiscrepanciesType"
+ },
+ "sitePlanSection": {
+ "description": "Identifies the site plan location of the room.",
+ "$ref": "#/definitions/sitePlanSectionType"
+ },
+ "componentRoomNumber": {
+ "description": "This flag indicates component room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "connectingRooms": {
+ "description": "This flag indicates connecting rooms.",
+ "$ref": "#/definitions/roomRoomsType"
+ },
+ "componentRooms": {
+ "description": "This flag indicates component rooms.",
+ "$ref": "#/definitions/roomRoomsType"
+ },
+ "attendant": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/currentServicingAttendantType"
+ }
+ },
+ "hold": {
+ "description": "Hold attributes if any.",
+ "$ref": "#/definitions/roomHoldType"
+ },
+ "turndownInfo": {
+ "$ref": "#/definitions/turndownInfoType"
+ },
+ "resvInfo": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationShortInfoType"
+ }
+ },
+ "componentRoomNumbers": {
+ "description": "List of component room numbers.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
+ },
+ "reservationInfo": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationInfoType"
+ }
+ },
+ "servicingInfo": {
+ "description": "Information regarding the current servicing of the room.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/currentServicingAttendantType"
+ }
+ },
+ "attendantTimeEntriesInfo": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/hSKAttendantTimeLogsType"
+ }
+ },
+ "instructions": {
+ "description": "Task Sheet instructions at the room level.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "totalCredits": {
+ "description": "Total credits for this room.",
+ "type": "integer"
+ },
+ "wakeUpTime": {
+ "description": "The wake up time of the current date",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "cleaningSequence": {
+ "description": "The sequence for cleaning this room in the task sheet. This would apply only for Pickup and Dirty rooms.",
+ "type": "integer"
+ },
+ "defaultSequence": {
+ "description": "The sequence for this room from configuration.",
+ "type": "integer"
+ },
+ "hasPriority": {
+ "description": "The priority for this room.",
+ "type": "boolean"
+ },
+ "actualTimeInMins": {
+ "description": "The actual time spent by the attendant when doing a service to the room.",
+ "type": "integer"
+ },
+ "roomSkipCount": {
+ "description": "The number of skip count for that room.",
+ "type": "integer"
+ }
+ },
+ "description": "This type represents the primary room attributes."
+ }
}
}
},
- "frontOfficeRoomStatusType": {
- "description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.",
- "type": "string",
- "enum": [
- "Vacant",
- "Occupied"
- ]
- },
- "functionArgumentType": {
- "description": "This type provided details of a function argument and the value it holds.",
+ "hSKAttendantTimeLogsType": {
"type": "object",
+ "description": "Holds the information for the task sheet.",
"properties": {
- "dataType": {
- "description": "Specifies the datatype of the function argument.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "name": {
- "description": "Specifies the name of the function argument.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "startRoomStatus": {
+ "$ref": "#/definitions/housekeepingRoomStatusType"
},
- "position": {
- "description": "Specifies the position of the function argument in the argument list.",
- "type": "integer"
+ "endRoomStatus": {
+ "$ref": "#/definitions/housekeepingRoomStatusType"
},
- "required": {
- "description": "Argument of the function mandatory or not.",
- "type": "boolean"
+ "startTime": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "value": {
- "description": "Specifies the value held by the function argument.",
+ "endTime": {
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "functionArgumentsType": {
- "description": "Collection of function arguments and their corresponding values.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/functionArgumentType"
- }
- },
- "futureListType": {
- "description": "A collection of reservation history details attached to Profiles.",
+ "roomInterfaceStatus": {
"type": "object",
+ "description": "Response object for fetching room interface status",
"properties": {
- "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"
- },
- "reservationInfo": {
- "description": "Additional reservation information attached to the profile . Eg : Future reservation details",
+ "roomInterfaceStatusList": {
+ "description": "Collection of room, reservation and interface status information.",
"type": "array",
- "maxItems": 4000,
"items": {
"$ref": "#/definitions/reservationInfoType"
}
},
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "gdsNegotiatedInfoType": {
- "description": "This provides information for a channel negotiated rate.",
+ "reservationInterface": {
"type": "object",
+ "description": "Request to change the interface status for a reservation.",
"properties": {
- "accessCode": {
- "description": "The GDS negotiated rate code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "end": {
- "description": "The ending value of the date range.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "inactive": {
- "description": "The GDS Negotiated Rate is inactive or not",
- "type": "boolean"
+ "reservationInterfaceStatus": {
+ "description": "Contains collection of reservation and interface information",
+ "type": "object",
+ "properties": {
+ "logo": {
+ "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.",
+ "$ref": "#/definitions/codeType"
+ },
+ "interfaceStatusList": {
+ "description": "Collection of reservation and interface information.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/changeInterfaceStatusType"
+ }
+ }
+ }
},
- "order": {
- "description": "The sell order.",
- "type": "integer"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "start": {
- "description": "The starting value of the date range.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "gdsNegotiatedType": {
- "description": "This holds a list of GdsNegotiatedInfoType.",
+ "changeInterfaceStatusType": {
"type": "object",
+ "description": "This will contain reservation id and corresponding interface information for which the interface status needs to be updated.",
"properties": {
- "bookingChannelCode": {
- "description": "Booking Channel Code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "reservationId": {
+ "description": "Unique identifier of the reservation.",
+ "$ref": "#/definitions/reservationId"
},
- "channelRatePlanCode": {
- "description": "Channel Room Type.",
+ "roomExtension": {
+ "description": "Unique identifier for the room extension",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "gdsNegotiatedInfoList": {
- "description": "List of channel negotiated rates for the profile.",
+ "interfaceRights": {
+ "description": "Contains a list of status/rights for the various services under this interface",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/gdsNegotiatedInfoType"
+ "$ref": "#/definitions/interfaceRightsStatusType"
}
- },
- "hotelId": {
- "description": "Hotel Code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
}
}
},
- "givenNameType": {
- "description": "Given name, first name or names",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "guestCountsType": {
- "description": "A collection of GuestCount by age group.",
+ "roomKeyInterfaceDetails": {
"type": "object",
+ "description": "Response with the configuration details of active room key interfaces including the available key encoders.",
"properties": {
- "adults": {
- "description": "Defines the number of Adults.",
- "type": "integer"
- },
- "childAges": {
- "description": "Defines Children's Ages. Number of children ages mentioned may mot match with children counts.",
- "$ref": "#/definitions/childAgesType"
+ "keyInterfaceDetails": {
+ "description": "Collection of configuration details of active room key interfaces.",
+ "$ref": "#/definitions/roomKeyInterfaceDetailsType"
},
- "childBuckets": {
- "description": "Defines children counts with Age Qualifying Group(Child Bucket#1) classification.",
- "$ref": "#/definitions/childBucketsType"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "children": {
- "description": "Defines the number of Children.",
- "type": "integer"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "guestHousekeepingServiceRequestType": {
- "description": "Possible values for the Guest Service Status.",
- "type": "string",
- "enum": [
- "DoNotDisturb",
- "MakeUpRoom",
- "NoStatusSelected"
- ]
+ "roomKeyInterfaceDetailsType": {
+ "type": "array",
+ "description": "Configuration details of room key interface.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomKeyInterfaceDetailType"
+ }
},
- "guestLastStayInfoType": {
- "description": "Contains last stay related details of the guest.",
+ "roomKeyInterfaceDetailType": {
"type": "object",
"properties": {
- "lastStayDate": {
- "description": "Guest's last stay date.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "interfaceRights": {
+ "description": "Room key interface rights.",
+ "$ref": "#/definitions/roomKeyInterfaceRightsType"
},
- "lastStayRate": {
- "description": "The Rate amount of the guest's last stay.",
- "$ref": "#/definitions/currencyAmountType"
+ "encoders": {
+ "description": "Available room key interface encoders.",
+ "$ref": "#/definitions/roomKeyEncodersType"
},
- "lastStayRoom": {
- "description": "Room Number where the guest stayed.",
+ "hotelId": {
+ "description": "Hotel code of the interface.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "totalStay": {
- "description": "The total number of previous stay of the guest.",
- "type": "integer"
- }
- }
- },
- "guestMessageType": {
- "description": "Holds the Message information for a Reservation",
- "type": "object",
- "properties": {
- "createDateTime": {
- "description": "Time stamp of the creation.",
+ "interfaceName": {
+ "description": "Name of the interface.",
"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.",
+ "interfaceDescription": {
+ "description": "Description of the interface.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "delivery": {
- "description": "Holds the Delivery Method Information",
- "$ref": "#/definitions/messageDeliveryType"
+ "sendValidStartDateTime": {
+ "description": "Indicator if the DLS Interface allows to send valid start date and time.",
+ "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.",
+ "propertyDateTime": {
+ "description": "Current property date and time.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "format": "date-time"
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "multipleRoomKeys": {
+ "description": "Indicator if additional rooms are allowed to be included in key creation.",
+ "type": "boolean"
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
- },
- "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",
- "maxLength": 80,
- "minLength": 0
- },
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "additionalRoomsLimit": {
+ "description": "Maximum number of additional rooms allowed.",
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 999
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
+ "outboundCode": {
+ "description": "Outbound Code linked to the property interface.",
"type": "string",
- "format": "date-time"
- },
- "message": {
- "description": "Holds the Message Information",
- "$ref": "#/definitions/messageType"
- },
- "purgeDate": {
- "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
+ "minLength": 0,
+ "maxLength": 20
+ }
+ }
+ },
+ "roomKeyInterfaceRightsType": {
+ "type": "array",
+ "description": "Holds the key encoder right.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomKeyInterfaceRightType"
+ }
+ },
+ "roomKeyInterfaceRightType": {
+ "type": "object",
+ "properties": {
+ "rightsCode": {
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "description": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "right": {
+ "type": "integer"
}
}
},
- "guestMessagesType": {
- "description": "Holds the Message Information",
+ "roomKeyEncodersType": {
"type": "array",
+ "description": "Holds the key encoder right.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/guestMessageType"
+ "$ref": "#/definitions/roomKeyEncoderType"
}
},
- "hSKAttendantTimeLogsType": {
- "description": "Holds the information for the task sheet.",
+ "roomKeyEncoderType": {
"type": "object",
"properties": {
- "endRoomStatus": {
- "$ref": "#/definitions/housekeepingRoomStatusType"
+ "interfaceId": {
+ "type": "string"
},
- "endTime": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "encoderId": {
+ "type": "string"
},
- "startRoomStatus": {
- "$ref": "#/definitions/housekeepingRoomStatusType"
+ "workstation": {
+ "type": "string"
},
- "startTime": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "location": {
+ "type": "string"
+ },
+ "deviceArea": {
+ "type": "string"
}
}
},
- "hSKStatCodeType": {
- "description": "Supported housekeeping statistical codes.",
- "type": "string",
- "enum": [
- "ApprovedCompPostings",
- "StagedCompPostings",
- "DeclinedCompPostings",
- "CompRoutingInstructionsRequests",
- "TotalPhysicalRooms",
- "TotalRoomsToSell",
- "TotalOutOfOrder",
- "TotalOutOfService",
- "TotalRevenue",
- "PercentRoomsOccupied",
- "StayoverRooms",
- "StayoverPersons",
- "StayoverVIP",
- "DeparturesExpectedRooms",
- "DeparturesExpectedPersons",
- "DeparturesExpectedVIP",
- "DeparturesActualRooms",
- "DeparturesActualPersons",
- "DeparturesActualVIP",
- "DeparturesInLastHour",
- "ArrivalsInLastHour",
- "ArrivalsTotal",
- "ArrivalsExpectedRooms",
- "ArrivalsExpectedPersons",
- "ArrivalsExpectedVIP",
- "ArrivalsExpectedRoomsMadeToday",
- "ArrivalsExpectedPersonsMadeToday",
- "ArrivalsExpectedVIPMadeToday",
- "ArrivalsActualRooms",
- "ArrivalsActualPersons",
- "ArrivalsActualVIP",
- "ExtendedStaysRooms",
- "ExtendedStaysPersons",
- "ExtendedStaysVIP",
- "DeparturesTotal",
- "EarlyDeparturesRooms",
- "EarlyDeparturesPersons",
- "EarlyDeparturesVIP",
- "DayUseRooms",
- "DayUsePersons",
- "DayUseVIP",
- "WalkInRooms",
- "WalkInPersons",
- "WalkInVIP",
- "CanceledOnArrivalRooms",
- "CanceledOnArrivalPersons",
- "CanceledOnArrivalVIP",
- "ComplimentaryArrivalRooms",
- "ComplimentaryArrivalPersons",
- "ComplimentaryArrivalVIP",
- "ComplimentaryStayoverRooms",
- "ComplimentaryStayoverPersons",
- "ComplimentaryStayoverVIP",
- "ComplimentaryDepartureRooms",
- "ComplimentaryDeparturePersons",
- "ComplimentaryDepartureVIP",
- "HouseUseArrivalVIP",
- "HouseUseStayoverRooms",
- "HouseUseStayoverPersons",
- "HouseUseStayoverVIP",
- "HouseUseDepartureRooms",
- "HouseUseDeparturePersons",
- "HouseUseDepartureVIP",
- "MinAvailableTonightRooms",
- "MaxOccupiedTonightRooms",
- "MaxOccupiedTonightPersons",
- "MaxOccupiedTonightVIP",
- "MaxPercentageOccupiedTonightRooms",
- "BlocksNotPickedUp",
- "IndividualRooms",
- "IndividualPersons",
- "IndividualVIP",
- "GroupAndBlockRooms",
- "GroupAndBlockPersons",
- "GroupAndBlockVIP",
- "RoomRevenue",
- "AverageRoomRevenue",
- "InspectedRooms",
- "InspectedVacant",
- "InspectedAssigned",
- "InspectedOccupied",
- "CleanedRooms",
- "CleanVacant",
- "CleanAssigned",
- "CleanOccupied",
- "DirtyVacant",
- "DirtyAssigned",
- "DirtyOccupied",
- "PickupVacant",
- "PickupAssigned",
- "PickupOccupied",
- "OutOfOrderVacant",
- "OutOfOrderAssigned",
- "OutOfOrderOccupied",
- "OutOfServiceVacant",
- "OutOfServiceAssigned",
- "OutOfServiceOccupied",
- "QueueRooms",
- "TurndownRequired",
- "TurndownNotRequired",
- "TurndownCompletedRequired",
- "AdultsInHouse",
- "ChildrenInHouse",
- "AdultsExpectedCheckedOut",
- "ChildrenExpectedCheckedOut",
- "AdultsDeparted",
- "ChildrenDeparted",
- "InHouseRooms",
- "InHouse",
- "MaxOccupancyPercentage",
- "Stayover",
- "TotalRoomsReserved",
- "RevPar",
- "SkipRooms",
- "SleepRooms",
- "HouseUseArrivalRooms",
- "HouseUseArrivalPersons",
- "AverageCheckInTime",
- "CurrentAveWaitTime",
- "CheckedInsTotal",
- "ExpectedCheckInsTotal",
- "CheckedOutsTotal",
- "ExpectedCheckOutsTotal",
- "ScheduledCheckOutsTotal",
- "RoomMaintenanceResolvedTotal",
- "RoomMaintenanceUnResolvedTotal",
- "PreRegisteredTotal",
- "VIPPreRegisteredTotal",
- "OpenFolioTotal",
- "TurndownTotal",
- "VIPTurndownTotal",
- "VIPGuestsArriving",
- "VIPGuestsDeparting",
- "VIPGuestsTotal",
- "IndividualAdvanceCheckedInCurrent",
- "BlockAdvanceCheckedInCurrent",
- "IndividualAdvanceCheckedInInhouse",
- "BlockAdvanceCheckedInInhouse",
- "IndividualAdvanceCheckedInTotal",
- "BlockAdvanceCheckedInTotal",
- "InHouseBlocksTotal",
- "CancellationsTotal",
- "NewReservationsTotal",
- "ArrivalResvs",
- "ArrivalVIPResvs",
- "ArrivalMemberResvs",
- "ArrivalUnallocResvs",
- "ArrivalManualAssgnResvs",
- "ArrivalAIAssgnResvs",
- "ArrivalAIUpgResvs",
- "ArrivalAIAssgnVIPResvs",
- "ArrivalAIAssgnMemberResvs",
- "ArrivalAIAssgnOverridden"
- ]
- },
- "hSKStatReportCodeType": {
- "description": "Supported Housekeeping report codes.",
- "type": "string",
- "enum": [
- "HouseSummary",
- "HouseSummaryMonthToDate",
- "HouseSummaryYearToDate",
- "ReservationActivity",
- "ReservationActivityDaily",
- "ReservationActivityMonthToDate",
- "ReservationActivityYearToDate",
- "ComplimentaryOrHouseUse",
- "DailyProjection",
- "RoomStatus",
- "LastHourStatus",
- "Turndown",
- "InHouse",
- "CheckIns",
- "CheckOuts",
- "AvailableRooms",
- "RoomMaintenance",
- "ReservationStatistics",
- "VIPGuests",
- "AdvanceCheckIn",
- "BlockArrivals",
- "ReservationsCancellationsToday",
- "AIRoomAssignment",
- "CompRouting"
- ]
+ "reservationQueueStatistics": {
+ "type": "object",
+ "description": "Response for the fetch of current Reservations In Queue statistics. Contains the statistic information.",
+ "properties": {
+ "statistics": {
+ "description": "Queue Reservation statistics. Currently statistic is by Room Type.",
+ "$ref": "#/definitions/reservationQueueStatisticsType"
+ },
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
},
- "hSKStatType": {
- "description": "Since the statistical value can be represented in different measure of units, this element will provide a flexible definition for the supported Opera9 statistical units.",
+ "reservationQueueStatisticsType": {
"type": "object",
+ "description": "Type for statistics of the reservations currently in Queue for Check-In.",
"properties": {
- "category": {
- "description": "Statistical unit category.",
- "$ref": "#/definitions/statUnitCategoryType"
+ "roomType": {
+ "description": "Room Type statistics for the reservations currently in Queue for Check-In.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationQueueRoomTypeStatisticsType"
+ }
},
- "code": {
- "$ref": "#/definitions/hSKStatCodeType"
+ "averageQueueTimeToCheckIn": {
+ "description": "The average time, in seconds, a reservation was on queue prior to Check-In.",
+ "type": "integer"
},
- "value": {
- "description": "Statistical value.",
- "type": "number"
+ "averageQueueTimeCurrentReservations": {
+ "description": "The average time, in seconds, of the reservations currently in queue.",
+ "type": "integer"
}
}
},
- "hSKTaskSheetDetailsInfoType": {
- "description": "Holds the task sheet statistics details information.",
+ "reservationQueueRoomTypeStatisticsType": {
"type": "object",
+ "description": "Type for Room Type statistics for reservations currently in Queue for Check-In. Statistics would be the number of rooms for each room type which is currently in Queue. Statistics will also include the current number of rooms for each room status for the resort at the current time i.e the number of dirty rooms, clean rooms for each room type. In addition, the statistics will include the number of rooms per room type which are Vacant / Occupied.",
"properties": {
- "rooms": {
- "description": "Details of the room which is part of the Task Sheet. The room details will be returned when the request for IncludeTaskSheetDetails(flag in the search type) is true.",
+ "roomType": {
+ "description": "The room type for the statistics.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "fOStatus": {
+ "description": "The number of rooms for the room type grouped by their FO status i.e Vacant or Occupied.",
"type": "array",
"maxItems": 4000,
"items": {
- "description": "This type represents the primary room attributes.",
"type": "object",
"properties": {
- "accessible": {
- "description": "Indicates whether the room is accessibility compliant.",
- "type": "boolean"
- },
- "actualTimeInMins": {
- "description": "The actual time spent by the attendant when doing a service to the room.",
- "type": "integer"
- },
- "attendant": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/currentServicingAttendantType"
- }
- },
- "attendantTimeEntriesInfo": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/hSKAttendantTimeLogsType"
- }
- },
- "building": {
- "description": "Building associated with the room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "cleaningSequence": {
- "description": "The sequence for cleaning this room in the task sheet. This would apply only for Pickup and Dirty rooms.",
- "type": "integer"
- },
- "componentRoomNumber": {
- "description": "This flag indicates component room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "componentRoomNumbers": {
- "description": "List of component room numbers.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- },
- "componentRooms": {
- "description": "This flag indicates component rooms.",
- "$ref": "#/definitions/roomRoomsType"
- },
- "connectingRooms": {
- "description": "This flag indicates connecting rooms.",
- "$ref": "#/definitions/roomRoomsType"
- },
- "defaultSequence": {
- "description": "The sequence for this room from configuration.",
- "type": "integer"
- },
- "description": {
- "description": "Description of the room.",
- "$ref": "#/definitions/translationTextType2000"
- },
- "discrepancy": {
- "description": "Identifies the room discrepancy information.",
- "$ref": "#/definitions/roomDiscrepanciesType"
- },
- "floor": {
- "description": "Floor of the Room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "floorDescription": {
- "description": "Description for the Floor of the Room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "hasPriority": {
- "description": "The priority for this room.",
- "type": "boolean"
- },
- "hold": {
- "description": "Hold attributes if any.",
- "$ref": "#/definitions/roomHoldType"
- },
- "housekeeping": {
- "description": "Identifies the Housekeeping information..",
- "$ref": "#/definitions/housekeepingType"
- },
- "instructions": {
- "description": "Task Sheet instructions at the room level.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "meetingRoom": {
- "description": "Indicates whether the room is a Meeting Room",
- "type": "boolean"
- },
- "outOfOrder": {
- "description": "Identifies the room Out of Order/Out of Service information.",
- "$ref": "#/definitions/roomsOutOfOrderType"
- },
- "reservationInfo": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationInfoType"
- }
- },
- "resvInfo": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationShortInfoType"
- }
- },
- "roomAssignmentRating": {
- "description": "Assignment Rating associated with the room.",
- "$ref": "#/definitions/ratePlanRatingType"
- },
- "roomDescription": {
- "description": "Detail Long Description Of The Room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomFeatures": {
- "description": "Room Features for the room.",
- "$ref": "#/definitions/roomFeaturesType"
- },
- "roomId": {
- "description": "Code of the room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomSection": {
- "description": "Room sections of the room.",
- "$ref": "#/definitions/roomSectionType"
- },
- "roomSkipCount": {
- "description": "The number of skip count for that room.",
- "type": "integer"
- },
- "roomType": {
- "description": "Room type basic information of the room.",
- "$ref": "#/definitions/roomTypeShortInfoType"
- },
- "servicingInfo": {
- "description": "Information regarding the current servicing of the room.",
+ "roomStatus": {
+ "description": "The total number of rooms for the room type grouped by their Room Status i.e Clean, Dirty etc..",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/currentServicingAttendantType"
+ "type": "object",
+ "properties": {
+ "housekeepingRoomStatus": {
+ "description": "The room status code example Clean, Dirty etc.",
+ "$ref": "#/definitions/housekeepingRoomStatusType"
+ },
+ "totalRooms": {
+ "description": "The total number of rooms for the room status.",
+ "type": "integer"
+ }
+ }
}
},
- "sitePlanSection": {
- "description": "Identifies the site plan location of the room.",
- "$ref": "#/definitions/sitePlanSectionType"
- },
- "smokingPreference": {
- "description": "This indicates room smoking preference.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "smokingPreferenceDescription": {
- "description": "This indicates the description of the room smoking preference.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "frontOfficeStatus": {
+ "description": "The FO status code i.e Vacant, Occupied.",
+ "$ref": "#/definitions/frontOfficeRoomStatusType"
},
- "totalCredits": {
- "description": "Total credits for this room.",
+ "totalRooms": {
+ "description": "The total number of rooms for the Front Office status.",
"type": "integer"
- },
- "turndownInfo": {
- "$ref": "#/definitions/turndownInfoType"
- },
- "wakeUpTime": {
- "description": "The wake up time of the current date",
- "type": "string",
- "format": "date",
- "maxLength": 8
}
}
}
+ },
+ "totalInQueue": {
+ "description": "The total number of reservations in Queue for this room type.",
+ "type": "integer"
}
}
},
- "hSKTaskSheetInfoType": {
- "description": "Holds the information for the task sheet.",
+ "reservationsInQueue": {
"type": "object",
+ "description": "Response for the operation to fetch Reservations in Queue",
"properties": {
- "assignedTasks": {
- "$ref": "#/definitions/assignedTasksType"
+ "reservations": {
+ "description": "List of reservation currently in queue.",
+ "$ref": "#/definitions/reservationList"
},
- "attendant": {
- "type": "string",
- "maxLength": 100,
- "minLength": 0
- },
- "averageActualTimeInSecs": {
- "type": "integer"
- },
- "roomSummary": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "object",
- "properties": {
- "housekeepingRoomStatusType": {
- "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.",
- "type": "string",
- "enum": [
- "Clean",
- "Dirty",
- "Pickup",
- "Inspected",
- "OutOfOrder",
- "OutOfService"
- ]
- },
- "totalCount": {
- "type": "integer"
- }
- }
- }
- },
- "taskDate": {
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "taskSeqNo": {
- "type": "integer"
- },
- "taskSheetDetails": {
- "$ref": "#/definitions/hSKTaskSheetDetailsInfoType"
- },
- "taskSheetNo": {
- "type": "integer"
- },
- "taskSheetType": {
- "$ref": "#/definitions/taskSheetType"
+ "roomStatusInfo": {
+ "description": "Master Information regarding the room status for each of the rooms included in the response.",
+ "$ref": "#/definitions/hotelRoomsType"
},
- "totalCompletedCredits": {
- "type": "integer"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "totalTaskCredits": {
- "type": "integer"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "hSKTaskSheetStatisticsInfoType": {
- "description": "Holds the task sheet statistics information.",
+ "reservationList": {
"type": "object",
+ "description": "A collection of reservation details attached to Profiles.",
"properties": {
- "masterInfoList": {
- "description": "Refer to Generic common types document",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/masterInfoType"
- }
- },
- "taskSheetStatisticsInfo": {
+ "reservationInfo": {
+ "description": "Additional reservation information attached to the profile . Eg : History,Future reservations",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/hSKTaskSheetInfoType"
+ "$ref": "#/definitions/reservationInfoType"
}
- }
- }
- },
- "historyListType": {
- "description": "A collection of reservation history details attached to Profiles.",
- "type": "object",
- "properties": {
- "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"
},
- "reservationInfo": {
- "description": "Additional reservation information attached to the profile . Eg : History reservation details",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationInfoType"
- }
- },
"totalResults": {
"description": "Total number of rows queried",
"type": "integer"
- }
- }
- },
- "holdRooms": {
- "description": "Request to place rooms on hold.",
- "type": "object",
- "properties": {
- "holdRoomsDetails": {
- "description": "List of rooms, hold reason, and comments.",
- "$ref": "#/definitions/roomsHoldsType"
- },
- "links": {
- "$ref": "#/definitions/links"
- },
- "overrideRoomHold": {
- "description": "If trying to hold a room, which is held by a different user, then this flag will allow the current request to override that hold.",
- "type": "boolean"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
}
}
},
- "hotelInterfaceStatusType": {
- "description": "Status of the Hotel Interface either STOPPED or RUNNING.",
- "type": "string",
- "enum": [
- "Stopped",
- "Running",
- "Waiting",
- "StopInitiated",
- "StartInitiated",
- "RebootInitiated",
- "Other"
- ]
- },
- "hotelInterfaceType": {
+ "hotelRoomsType": {
"type": "object",
+ "description": "Collection of Room record that contain Housekeeping and Out Of Order information.",
"properties": {
- "activeFlag": {
- "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.",
- "type": "boolean"
+ "room": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomType"
+ }
},
"hotelId": {
- "description": "Hotel Code",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "interfaceId": {
- "description": "Unique DB internal number of a Hotel Interface record.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "interfaceName": {
- "description": "Name of the Hotel Interface",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "interfaceType": {
- "description": "Three letter code for each interface that identifies the interface.",
- "$ref": "#/definitions/hotelInterfaceTypeType"
- },
- "logo": {
- "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "machineName": {
- "description": "Unique machine name of the running IFC.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "status": {
- "description": "The current status of the IFC.",
- "$ref": "#/definitions/hotelInterfaceStatusType"
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "hotelInterfaceTypeType": {
- "description": "XML Posting Interface",
- "type": "string",
- "enum": [
- "Bms",
- "Cas",
- "Ccw",
- "Dls",
- "Eft",
- "Exp",
- "Mak",
- "Mbs",
- "Msc",
- "Pbx",
- "Pos",
- "Svs",
- "Tik",
- "Vid",
- "Vms",
- "Www",
- "Xml"
- ]
- },
- "hotelReservationTraceType": {
- "description": "Extended Trace object to hold information for a reservation.",
+ "roomType": {
"type": "object",
+ "description": "This type represents the primary room attributes.",
"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",
- "maxLength": 200,
- "minLength": 0
- },
- "departmentId": {
- "description": "Indicates the Department code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "roomType": {
+ "description": "Room type basic information of the room.",
+ "$ref": "#/definitions/roomTypeShortInfoType"
},
- "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.",
+ "floor": {
+ "description": "Floor of the Room.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "floorDescription": {
+ "description": "Description for the Floor of the Room.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "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",
- "maxLength": 80,
- "minLength": 0
+ "roomFeatures": {
+ "description": "Room Features for the room.",
+ "$ref": "#/definitions/roomFeaturesType"
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "roomDescription": {
+ "description": "Detail Long Description Of The Room.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
- "type": "string",
- "format": "date-time"
+ "description": {
+ "description": "Description of the room.",
+ "$ref": "#/definitions/translationTextType2000"
},
- "purgeDate": {
- "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
+ "smokingPreference": {
+ "description": "This indicates room smoking preference.",
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "reservationId": {
- "description": "Reservation ID of the reservation for which the traces are to be retrieved.",
- "$ref": "#/definitions/reservationId"
- },
- "resolveInfo": {
- "description": "Information regarding the status of the trace",
- "$ref": "#/definitions/traceResolveType"
- },
- "timeInfo": {
- "description": "Date of the trace.",
- "$ref": "#/definitions/traceTimeInfoType"
- },
- "traceText": {
- "description": "The information this trace contains.",
- "type": "string"
+ "minLength": 0,
+ "maxLength": 20
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "smokingPreferenceDescription": {
+ "description": "This indicates the description of the room smoking preference.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
- }
- }
- },
- "hotelReservationTracesType": {
- "description": "List of Reservation Traces.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/hotelReservationTraceType"
- }
- },
- "hotelReservationType": {
- "description": "The Reservation class contains the current reservation being created or altered.",
- "type": "object",
- "properties": {
- "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"
+ "minLength": 0,
+ "maxLength": 20
},
- "accessRestrictionMessage": {
- "description": "Configurable Access Restriction Message for Excluded Block or Rate Code.",
+ "building": {
+ "description": "Building associated with the room.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
- },
- "additionalGuestInfo": {
- "description": "Entry Date into the country. (Croatian Requirements).",
- "$ref": "#/definitions/resGuestAdditionalInfoType"
- },
- "advanceCheckIn": {
- "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return",
- "$ref": "#/definitions/advanceCheckInType"
- },
- "alerts": {
- "description": "List of reservation alerts.",
- "$ref": "#/definitions/alertsType"
+ "minLength": 0,
+ "maxLength": 20
},
- "allowAutoCheckin": {
- "description": "Flag to allow auto checkin",
- "type": "boolean"
+ "roomAssignmentRating": {
+ "description": "Assignment Rating associated with the room.",
+ "$ref": "#/definitions/ratePlanRatingType"
},
- "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.",
+ "accessible": {
+ "description": "Indicates whether the room is accessibility compliant.",
"type": "boolean"
},
- "allowMobileViewFolio": {
- "description": "Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.",
- "type": "boolean"
+ "roomId": {
+ "description": "Code of the room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "allowPreRegistration": {
- "description": "Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false.",
+ "meetingRoom": {
+ "description": "Indicates whether the room is a Meeting Room",
"type": "boolean"
},
- "allowedActions": {
- "description": "Collection of allowed actions for the reservation.",
- "$ref": "#/definitions/reservationAllowedActionsType"
- },
- "associatedReservations": {
- "description": "Information regarding associated reservations.",
- "$ref": "#/definitions/associatedResType"
+ "roomSection": {
+ "description": "Room sections of the room.",
+ "$ref": "#/definitions/roomSectionType"
},
- "attachments": {
- "description": "Collection of attachments available for that reservation",
- "$ref": "#/definitions/attachmentsType"
+ "housekeeping": {
+ "description": "Identifies the Housekeeping information..",
+ "$ref": "#/definitions/housekeepingType"
},
- "autoBorrowFromHouse": {
- "description": "This flag will force to borrow from house if borrow required for number of rooms requested, this will only applicable when reservation is attached to a Block.",
- "type": "boolean"
+ "outOfOrder": {
+ "description": "Identifies the room Out of Order/Out of Service information.",
+ "$ref": "#/definitions/roomsOutOfOrderType"
},
- "callHistory": {
- "description": "List of reservation calls.",
- "$ref": "#/definitions/callHistoryType"
+ "discrepancy": {
+ "description": "Identifies the room discrepancy information.",
+ "$ref": "#/definitions/roomDiscrepanciesType"
},
- "cancellation": {
- "description": "Information regarding why reservation has been/was cancelled. This could hold information as history even if reservation is no more in in Cancelled status.",
- "type": "object",
- "properties": {
- "cancellationNo": {
- "description": "Cancellation Number given when reservation was last cancelled.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "code": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "date": {
- "description": "Date when reservation was last cancelled.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "description": {
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- }
- }
+ "sitePlanSection": {
+ "description": "Identifies the site plan location of the room.",
+ "$ref": "#/definitions/sitePlanSectionType"
},
- "cashiering": {
- "description": "Holds cashiering related information for the reservation.",
- "$ref": "#/definitions/resCashieringType"
+ "componentRoomNumber": {
+ "description": "This flag indicates component room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "catering": {
- "description": "Catering event information if reservation is associated with the catering event.",
- "$ref": "#/definitions/cateringResInfoType"
+ "connectingRooms": {
+ "description": "This flag indicates connecting rooms.",
+ "$ref": "#/definitions/roomRoomsType"
},
- "chargeCardNumber": {
- "description": "This attribute represents Hotel charge card number. This number is generated automatically in OPERA when a reservation is created in OPERA. It is part of a functionality that provide the guest with the convenience of placing all their charges directly on their reservation folio.",
- "type": "string",
- "maxLength": 100,
- "minLength": 0
+ "componentRooms": {
+ "description": "This flag indicates component rooms.",
+ "$ref": "#/definitions/roomRoomsType"
},
- "comments": {
- "description": "List of Notes for the Guest related to the reservation.",
+ "attendant": {
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/commentInfoType"
+ "$ref": "#/definitions/currentServicingAttendantType"
}
},
- "compAuthorizer": {
- "description": "Reservation Comp Authorizer.",
- "$ref": "#/definitions/compAuthorizerInfoType"
- },
- "computedReservationStatus": {
- "description": "Indicates the Computed status of the reservation.",
- "$ref": "#/definitions/pMS_ResStatusType"
- },
- "confirmationLetters": {
- "description": "List of reservation confirmation letters.",
- "$ref": "#/definitions/confirmationsType"
- },
- "createBusinessDate": {
- "description": "Business Date when the reservation was created.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "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",
- "maxLength": 200,
- "minLength": 0
- },
- "customChargeExemptionDetails": {
- "description": "List of Custom Charge Exemptions attached to the reservation.",
- "$ref": "#/definitions/customChargeExemptionsType"
- },
- "customNameValueDetail": {
- "description": "List of Custom Name Value Information attached to the reservation.",
- "$ref": "#/definitions/nameValueDetailType"
- },
- "customReference": {
- "description": "Custom Reference to identify reservation.",
- "type": "string",
- "maxLength": 50,
- "minLength": 0
- },
- "displayColor": {
- "description": "The color to display this reservation on room grid displays.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "displayColorDetails": {
- "description": "Information of reservation display color, determined based on OPERA parameter RESERVATION_COLOR_DEFINITION ",
- "$ref": "#/definitions/reservationDisplayColorInfoType"
- },
- "eCertificates": {
- "description": "List of ECertificates attached to the reservation.",
- "$ref": "#/definitions/reservationECertificatesType"
- },
- "eCoupons": {
- "description": "List of eCoupons.",
- "$ref": "#/definitions/eCouponsType"
- },
- "extSystemSync": {
- "type": "boolean"
- },
- "externalReferences": {
- "description": "External Reference information for Reservation.",
- "$ref": "#/definitions/externalReferencesType"
- },
- "fixedCharges": {
- "description": "List of reservation fixed charges.",
- "$ref": "#/definitions/fixedChargesType"
+ "hold": {
+ "description": "Hold attributes if any.",
+ "$ref": "#/definitions/roomHoldType"
},
- "folios": {
- "description": "This element returns any automatically generated folios during check-in, based on the Fetch Instruction \"AutoFolios\". When the parameter \"Auto Generate Credit Bill for Deposit upon Check In\" is enabled, during check-in credit bills are automatically generated for the deposits. The generated credit bill details are returned so that user can preview/print the folio. For some countries like Portugal, it is mandatory to print the folio and hence this information is needed",
- "$ref": "#/definitions/foliosShortInfoType"
+ "turndownInfo": {
+ "$ref": "#/definitions/turndownInfoType"
},
- "guestComments": {
- "description": "List of Notes for the Guest related to the profile.",
+ "resvInfo": {
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/commentInfoType"
+ "$ref": "#/definitions/reservationShortInfoType"
}
},
- "guestMemberships": {
- "description": "List of Memberships for the Guest related to the reservation.",
+ "componentRoomNumbers": {
+ "description": "List of component room numbers.",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/membershipType"
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
}
},
- "guestMessages": {
- "description": "List of Messages.",
- "$ref": "#/definitions/guestMessagesType"
- },
- "hasOpenFolio": {
- "type": "boolean"
- },
- "hotelId": {
+ "rotationRoomId": {
+ "description": "Rotation room of the room type.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ }
+ }
+ },
+ "queueReservation": {
+ "type": "object",
+ "description": "Request to add a reservation to the Queue for Check-In. A reservation can be added to the queue prior to Check-In on the day of arrival.",
+ "properties": {
+ "hotelId": {
+ "description": "Property where the reservation exists.",
+ "$ref": "#/definitions/codeType"
},
- "housekeeping": {
- "description": "Holds rooms housekeeping information.",
- "$ref": "#/definitions/resHousekeepingType"
- },
- "inventoryItems": {
- "description": "A collection of inventory items attached to a reservation.",
- "$ref": "#/definitions/resInventoryItemsType"
- },
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
- "type": "string",
- "format": "date-time"
- },
- "linkedReservation": {
- "description": "Reservations related to the current Reservation.",
- "$ref": "#/definitions/linkedReservationsInfoType"
- },
- "locators": {
- "description": "Collection of Locators available for that reservation",
- "$ref": "#/definitions/reservationLocatorsType"
- },
- "lockHandle": {
- "description": "An id representing the record lock for this reservation. When passed, update operation will verify that this lock is still valid.",
- "type": "number"
- },
- "markAsRecentlyAccessed": {
- "description": "Mark this reservation as recently accessed.",
- "type": "boolean"
- },
- "optedForCommunication": {
- "description": "Flag containing true or false value to determine if the guest has opted for communications pertaining to this reservation.Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is marked for communication. Upon fetch, the current state of the flag will show true or false.",
- "type": "boolean"
- },
- "overrideBlockRestriction": {
- "type": "boolean"
- },
- "overrideExternalChecks": {
- "description": "Forcefully override the create/update action on the Reservation. For real-time CRS interfaces, this element is used as force selling indicator in case of Create or Update Reservation",
- "type": "boolean"
- },
- "overrideInstructions": {
- "description": "List of overrides done for the reservation.",
- "$ref": "#/definitions/overrideInstructionsType"
- },
- "overrideInventoryCheck": {
- "description": "Indicates to Override the Room Inventory Check if applicable.",
- "type": "boolean"
- },
- "overrideOutOfServiceCheck": {
- "description": "Indicates to Override the Room Out Of Service Check if applicable.",
- "type": "boolean"
- },
- "party": {
- "description": "Party/PartyCode when reservation is part of a party(a small group).",
- "type": "string",
- "maxLength": 50,
- "minLength": 0
- },
- "preRegistered": {
- "description": "Is the reservation pre-registered.",
- "type": "boolean"
- },
- "preferenceCollection": {
- "description": "Collection of reservation preferences.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/preferenceTypeType"
- }
- },
- "prepaidCards": {
- "description": "Collection of Prepaid Cards available for that reservation",
- "$ref": "#/definitions/prepaidCardsType"
- },
- "primaryEnrollmentChain": {
- "description": "Name of the Chain for the primary enrollment",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "primaryEnrollmentResort": {
- "description": "Name Of the Resort/Hotel for the primary enrollment",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "printRate": {
- "description": "Indicates whether to show the rate or not on a printed document which includes the rate.",
- "type": "boolean"
- },
- "profileAwards": {
- "description": "Collection of profile awards available for that reservation",
- "$ref": "#/definitions/awardsType"
+ "reservationId": {
+ "description": "Reservation ID of the reservation which is to be added to the queue.",
+ "$ref": "#/definitions/reservationId"
},
- "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
+ "links": {
+ "$ref": "#/definitions/links"
},
- "queue": {
- "description": "Information about the time and duration this reservation was on Queue for Checkin.",
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "reservationQueuePriority": {
+ "type": "object",
+ "description": "Response to the request to add a reservation to the Queue for Check-In.",
+ "properties": {
+ "queueInfo": {
+ "description": "Queue Information for this reservation.",
"$ref": "#/definitions/reservationQueueInformationType"
},
- "reinstateDate": {
- "description": "Business Date when the reservation was last reinstated.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "reservationActivities": {
- "description": "Collection of Reservation Activities available for that reservation",
- "$ref": "#/definitions/activityLookUpList"
- },
- "reservationAwards": {
- "description": "Collection of Awards,Certificates for the guest profile.",
- "$ref": "#/definitions/awardsType"
- },
- "reservationCommunication": {
- "description": "Collection of reservation communication details.",
- "$ref": "#/definitions/resCommunicationType"
- },
- "reservationGuests": {
- "description": "Collection of guests associated with the reservation.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/resGuestType"
- }
- },
- "reservationIdList": {
- "description": "Used to provide PMS and/or CRS identifiers.",
- "$ref": "#/definitions/reservationIdList"
- },
- "reservationIndicators": {
- "description": "Indicators of additional information attached to the reservation",
- "$ref": "#/definitions/indicatorsType"
- },
- "reservationMemberships": {
- "description": "List of reservation memberships.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationMembershipType"
- }
+ "links": {
+ "$ref": "#/definitions/links"
},
- "reservationPackages": {
- "description": "A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.",
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "shortReservation": {
+ "type": "object",
+ "properties": {
+ "reservationInfoList": {
+ "description": "Short reservation information response.",
"type": "array",
- "maxItems": 4000,
"items": {
- "$ref": "#/definitions/reservationPackageType"
- }
- },
- "reservationPaymentMethods": {
- "description": "A collection of Payment Method objects.",
- "$ref": "#/definitions/reservationPaymentMethodsType"
- },
- "reservationPolicies": {
- "description": "A collection of Cancellation Penalties objects.",
- "$ref": "#/definitions/reservationPoliciesType"
- },
- "reservationProfiles": {
- "description": "Collection of guests associated with the reservation.",
- "type": "object",
- "properties": {
- "commissionPayoutTo": {
- "description": "If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.",
- "$ref": "#/definitions/commissionPayoutToType"
- },
- "reservationProfile": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationProfileType"
- }
- }
- }
- },
- "reservationStatus": {
- "description": "Indicates the Actual status of the reservation.",
- "$ref": "#/definitions/pMS_ResStatusType"
- },
- "roomStay": {
- "description": "Room stays information.",
- "$ref": "#/definitions/roomStayType"
- },
- "roomStayReservation": {
- "description": "Boolean True if this reservation is reserving rooms. False if it is only reserving services.",
- "type": "boolean"
- },
- "routingInstructions": {
- "description": "Set of Routing Instructions.",
- "$ref": "#/definitions/routingInfoListType"
- },
- "scheduledActivities": {
- "description": "Collection of Scheduled Activities available for that reservation",
- "$ref": "#/definitions/activityLookUpList"
- },
- "serviceRequests": {
- "description": "Collection of Service Requests available for that reservation",
- "$ref": "#/definitions/serviceRequests"
- },
- "sharedGuests": {
- "description": "Collection of guests who share this reservation.",
- "$ref": "#/definitions/resSharedGuestListType"
- },
- "shares": {
- "description": "Collection of share reservation available for that reservation",
- "$ref": "#/definitions/hotelReservationsType"
- },
- "sourceOfSale": {
- "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.",
- "$ref": "#/definitions/sourceOfSaleType"
- },
- "statisticalClassification": {
- "description": "Catering event information if reservation is associated with the catering event.",
- "$ref": "#/definitions/resStatClassificationType"
- },
- "tickets": {
- "description": "List of Reservation Tickets.",
- "$ref": "#/definitions/ticketsType"
- },
- "traces": {
- "description": "List of reservation Traces.",
- "$ref": "#/definitions/hotelReservationTracesType"
- },
- "trackItItems": {
- "description": "Collection of TrackIt Items available for that reservation",
- "$ref": "#/definitions/trackItItemsType"
- },
- "transactionDiversions": {
- "description": "List of transaction diversions attached to the reservation.",
- "type": "object",
- "properties": {
- "actionType": {
- "type": "string",
- "maxLength": 2000
- },
- "transactionDiversions": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationTransactionDiversionsType"
- }
- }
+ "$ref": "#/definitions/reservationInfoType"
}
},
- "upgradeEligible": {
- "description": "Indicates whether the reservation is eligible for upgrade.",
- "type": "boolean"
- },
- "userDefinedFields": {
- "description": "Collections of user defined fields.",
- "$ref": "#/definitions/userDefinedFieldsType"
- },
- "waitlist": {
- "description": "Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is no more in Waitlist status.",
- "$ref": "#/definitions/waitlistResType"
+ "reservationsSummary": {
+ "description": "Collection of Reservations summary and their information.",
+ "$ref": "#/definitions/reservationsSummaryType"
},
- "walkIn": {
- "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"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "webRegistrationCards": {
- "description": "Collection of Web Registration Cards available for that reservation",
- "$ref": "#/definitions/attachmentsType"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "hotelReservationsIDType": {
- "description": "List of Reservation Unique identifiers to represent multiple reservations with each reservation's one unique id.",
+ "reservationsSummaryType": {
"type": "object",
+ "description": "Type which shows all fetched reservations summary depends on Fetch Summary Instruction.",
"properties": {
- "hotelId": {
- "description": "All reservation ids in the list must belong to this property.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "roomSummary": {
+ "description": "Room Summary of the reservations.",
+ "$ref": "#/definitions/roomSummaryType"
},
- "reservationId": {
- "description": "Unique identifier for a reservation.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationId"
- }
+ "paymentMethodSummary": {
+ "description": "Payment methods summary of the reservations.",
+ "$ref": "#/definitions/paymentMethodsSummaryType"
+ },
+ "blockSummary": {
+ "description": "Holds reservation information related to block(s) searched.",
+ "$ref": "#/definitions/blockResvSummaryType"
}
}
},
- "hotelReservationsType": {
- "description": "A collection of Reservation objects and Unique IDs of Reservation.",
+ "roomSummaryType": {
"type": "object",
"properties": {
- "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"
- },
- "reservation": {
- "description": "A collection of Reservations.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/hotelReservationType"
- }
+ "assignedRooms": {
+ "description": "Indicates summary of the assigned rooms.",
+ "$ref": "#/definitions/assignedRoomsSummaryType"
},
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
+ "unassignedRooms": {
+ "description": "Indicates summary of the unassigned rooms.",
+ "$ref": "#/definitions/unassignedRoomsSummaryType"
}
}
},
- "hotelRooms": {
+ "assignedRoomsSummaryType": {
"type": "object",
+ "description": "Indicates summary of the assigned rooms.",
"properties": {
"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"
- },
- "hotelRoomsDetails": {
- "description": "Hotel rooms response based on criteria request.",
- "$ref": "#/definitions/hotelRoomsType"
- },
- "limit": {
- "description": "Indicates maximum number of records a Web Service should return.",
- "type": "integer"
- },
- "links": {
- "$ref": "#/definitions/links"
- },
- "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"
- },
- "totalPages": {
- "description": "Evaluated total page count based on the requested max fetch count.",
- "type": "integer"
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- },
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "description": "Number of reservations with assigned rooms.",
+ "type": "string",
+ "minLength": 4,
+ "maxLength": 4
}
}
},
- "hotelRoomsOrderBy": {
- "description": "This type is used to support various sortings for available rooms search results.",
- "type": "string",
- "enum": [
- "ForecastRotationPoints"
- ]
- },
- "hotelRoomsType": {
- "description": "Collection of Room record that contain Housekeeping and Out Of Order information.",
+ "unassignedRoomsSummaryType": {
"type": "object",
+ "description": "Indicates summary of the unassigned rooms.",
"properties": {
- "hotelId": {
+ "count": {
+ "description": "Number of reservations with unassigned rooms.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "room": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomType"
- }
+ "minLength": 4,
+ "maxLength": 4
}
}
},
- "housekeepingRoomReservationStatusType": {
- "description": "Room Reservation status types used in housekeeping. These may be different from the actual reservation statuses as these relate to the current reservation for the room.",
- "type": "string",
- "enum": [
- "Arrival",
- "Arrived",
- "DayUse",
- "DueOut",
- "Departed",
- "NotReserved",
- "StayOver"
- ]
- },
- "housekeepingRoomStatusType": {
- "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.",
- "type": "string",
- "enum": [
- "Clean",
- "Dirty",
- "Pickup",
- "Inspected",
- "OutOfOrder",
- "OutOfService"
- ]
- },
- "housekeepingSectionType": {
- "description": "Information regarding Housekeeping Sections.",
+ "paymentMethodsSummaryType": {
"type": "object",
"properties": {
- "code": {
- "description": "The Housekeeping Section Code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "description": {
- "description": "Description of the Section.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "hotelId": {
- "description": "Property where this section is defined.",
+ "establishedCount": {
+ "description": "Reservations count with payment method established.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "inactive": {
- "description": "Indicates if the Section Code is active.",
- "type": "boolean"
- },
- "roomCredits": {
- "description": "Number of housekeeping credits. This is auto populated while creating/fetching record.",
- "type": "integer"
+ "minLength": 4,
+ "maxLength": 4
},
- "rooms": {
- "description": "Rooms count for this section code. This is auto populated while creating/fetching record.",
- "type": "integer"
- },
- "sectionGroup": {
- "description": "Housekeeping Section Group.",
+ "unestablishedCount": {
+ "description": "Reservations count with no payment method established.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "sequence": {
- "description": "Display sequence when task assignment is automatically broken out by Section Group.",
- "type": "integer"
- },
- "targetCredits": {
- "description": "Target Credit for each task sheet created for this section when auto task assignment is broken out by section.",
- "type": "integer"
+ "minLength": 4,
+ "maxLength": 4
}
}
},
- "housekeepingTaskCodeType": {
- "description": "Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.",
+ "blockResvSummaryType": {
"type": "object",
+ "description": "Indicates summary of the Total reservations for the block.",
"properties": {
- "code": {
- "description": "The Code for the task.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "description": {
- "description": "Description of the Task Code.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "facilityDepartureTask": {
- "description": "Indicates if this task code is the default departure task for Facility Tasks. This requires",
- "type": "boolean"
- },
- "hotelId": {
- "description": "Property where this task code is configured.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "instructions": {
- "description": "Instructions for this Task Code.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "linenChange": {
- "description": "Indicates if a linen change is necessary.",
- "type": "boolean"
- },
- "sequence": {
- "description": "Ordering sequence for display.",
+ "totalReservations": {
+ "description": "Number of reservations with block.",
"type": "integer"
}
}
},
- "housekeepingType": {
- "description": "Identifies the Housekeeping information.",
+ "roomsAI": {
"type": "object",
+ "description": "Request to run AI Room Assignment and allocate rooms to incoming reservations.",
"properties": {
- "cleaningPriority": {
- "description": "Cleaning priority for the room, if a priority was set.",
- "$ref": "#/definitions/roomCleaningPriorityType"
- },
- "facilityTaskCode": {
- "description": "Facility task Code/ Task Code assigned to the room for the day.",
+ "hotelCodes": {
+ "description": "List of resorts for which the room assignment algorithm needs to run.",
"$ref": "#/definitions/codeListType"
},
- "guestServiceRequest": {
- "$ref": "#/definitions/guestHousekeepingServiceRequestType"
- },
- "linenChange": {
- "description": "Indicates if a linen change is necessary.",
- "type": "boolean"
- },
- "roomCondition": {
- "description": "Condition of the room, if a condition was set.",
- "$ref": "#/definitions/roomConditionType"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "autoAssignRoom": {
+ "type": "object",
+ "description": "Request for auto assignment of rooms to reservations.",
+ "properties": {
+ "criteria": {
+ "description": "Criteria for auto assignment of rooms to reservations.",
+ "$ref": "#/definitions/reservationAutoRoomAssignRequestType"
},
- "roomPersons": {
- "description": "The Room person information per the reservation and housekeeping.",
- "$ref": "#/definitions/roomPersonsType"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "roomStatus": {
- "description": "The Room status information per the reservation and housekeeping.",
- "$ref": "#/definitions/roomStatusType"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "iATAInfoType": {
- "description": "IATA Information of the profile.",
+ "reservationAutoRoomAssignRequestType": {
"type": "object",
+ "description": "Request criteria for auto assignment of rooms to reserved reservations.",
"properties": {
- "iATACompany": {
- "description": "IATA Company Detail.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "reservationCriteria": {
+ "description": "A list of reservation ids which will be used to auto assign rooms.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationIdList"
+ }
},
- "iATAConsortia": {
- "description": "IATA Consortia.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "roomSelectionCriteria": {
+ "description": "Search type for the rooms which will be used to assign.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "hotelId": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "roomStatusFilter": {
+ "description": "Fetch instructions that should be used to get hotel rooms.",
+ "type": "object",
+ "properties": {
+ "hotelRoomStatusList": {
+ "description": "Hotel room status instructions to be used in requests for fetching rooms.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/housekeepingRoomStatusType"
+ }
+ },
+ "hotelFORoomStatusList": {
+ "description": "Front office room status instructions to be used in requests for fetching housekeeping rooms.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/frontOfficeRoomStatusType"
+ }
+ }
+ }
+ },
+ "roomRange": {
+ "description": "Room range instructions.",
+ "$ref": "#/definitions/roomRangeType"
+ },
+ "hotelRoomDateRange": {
+ "description": "Date range instructions.",
+ "$ref": "#/definitions/timeSpanType"
+ },
+ "roomTypes": {
+ "description": "The room types of hotel rooms to be fetched.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
+ },
+ "roomClass": {
+ "description": "The room class of hotel rooms to be fetched.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "floor": {
+ "description": "The floor of room to be fetched.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "includeDueOut": {
+ "description": "This flag when set to true will include rooms assigned to due out reservations.",
+ "type": "boolean"
+ },
+ "departureTime": {
+ "description": "When IncludeDueOut is enable,it is the departure time before which to search.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "roomFeatures": {
+ "description": "The Room Features of the room to be fetched.",
+ "$ref": "#/definitions/roomFeaturesType"
+ },
+ "smokingPreference": {
+ "description": "The smoking preference of room to be fetched.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "includeAllRoomConditions": {
+ "description": "This flag when set to true will include all room conditions, when set to false then room with \"General Assignment\" condition type will be excluded from the result.",
+ "type": "boolean"
+ },
+ "includeComponentRooms": {
+ "description": "This flag when set to true will include all component rooms",
+ "type": "boolean"
+ },
+ "includePseudoRooms": {
+ "description": "This flag when set to true will include all pseudo rooms",
+ "type": "boolean"
+ },
+ "includeOORoomCheck": {
+ "description": "This flag when set to true will work for Available Rooms functionality",
+ "type": "boolean"
+ },
+ "connectingRoomsOnly": {
+ "description": "This flag when set to true will include only connecting rooms.",
+ "type": "boolean"
+ },
+ "reservationId": {
+ "$ref": "#/definitions/reservationId"
+ },
+ "pseudoRoomsOnly": {
+ "description": "This flag when set to true will include only pseudo rooms",
+ "type": "boolean"
+ },
+ "includeAttendentInRoom": {
+ "description": "This flag when set to true will includes attendent in Rooms",
+ "type": "boolean"
+ },
+ "roomNumberWildcard": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "useAIRoomAssignment": {
+ "description": "If the AI ROOM ASSIGNMENT application parameter is set to Y, this flag when set to true will use the AI Room Assignment algorithm to fetch the results in order of suitability.",
+ "type": "boolean"
+ },
+ "includeDepartureRooms": {
+ "description": "Indicates if departure rooms are to be included in the auto assignment.",
+ "type": "boolean"
+ },
+ "useAssociatedProfilePreferences": {
+ "description": "Indicates if preferences on the profile associated to the reservation should be used to determine the room type. The preferences for FLOOR, SMOKING and ROOM FEATURES will be used.",
+ "type": "boolean"
+ },
+ "excludeRoomFeatures": {
+ "description": "It indicates to exclude rooms with the selected Room Feature(s). It allows alphanumeric values(e.g.,TUB,BOLCONY,MV)",
+ "$ref": "#/definitions/roomFeaturesType"
+ },
+ "excludeFloorPreferences": {
+ "description": "It indicates to exclude rooms with the selected Floor(s).It allows alphanumeric values(e.g.,01,02,03,GROUND,five)",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
+ },
+ "perfectFitRoomsOnly": {
+ "type": "boolean",
+ "description": "When this flag is set to true, it will fetch only rooms that have exactly Y nights free with the reservation guest(s) points. This will prevent any gaps in room assignment."
+ },
+ "orderBy": {
+ "description": "When Forecast Rotation is checked, the room rotation order will consider any future reservations for point calculation and reorder the rooms accordingly.This is supported when OPERA Control Room Rotation and Forecast Rotation Points are active.",
+ "$ref": "#/definitions/hotelRoomsOrderBy"
+ },
+ "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"
+ }
+ }
},
- "iATAValidationResult": {
- "description": "IATA Validation Result.",
+ "roomNumberLocked": {
+ "description": "Update the do not move flag used to locking the reservation room number.",
"type": "boolean"
}
}
},
- "identificationInfoType": {
- "description": "Information on the identification of the customer.",
+ "roomRangeType": {
"type": "object",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
+ "fromRoomNumber": {
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "identification": {
- "description": "Detailed information on the identification of the customer.",
- "$ref": "#/definitions/identificationType"
+ "minLength": 0,
+ "maxLength": 20
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "toRoomNumber": {
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "identificationType": {
- "description": "Identification information of the customer.",
+ "autoAssignedRoom": {
+ "type": "array",
+ "description": "Collection of result set which is made of reservation id, error and warning.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/autoRoomAssignType"
+ }
+ },
+ "autoRoomAssignType": {
"type": "object",
+ "description": "Collection of error and warning if any.",
"properties": {
- "expirationDate": {
- "description": "Expiration date of Identification.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "warnings": {
+ "description": "Details of the warnings.",
+ "$ref": "#/definitions/warningsType"
},
- "idNumber": {
- "description": "Identification Number.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "errors": {
+ "description": "Details of the errors.",
+ "$ref": "#/definitions/errorsType"
},
- "idNumberMasked": {
- "description": "Masked Identification Number.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "reservationId": {
+ "description": "Unique identifiers for the reservation for auto assign room.",
+ "$ref": "#/definitions/reservationId"
},
- "idType": {
- "description": "Identification Type. Eg Passport, Driving License etc.",
+ "arrivalDate": {
+ "description": "Arrival date of the reservation.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "format": "date-time"
},
- "issuedCountry": {
- "description": "The country where Identification was issued.",
+ "departureDate": {
+ "description": "Departure date of the reservation.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "issuedDate": {
- "description": "Issued date of Identification.",
+ "guestName": {
+ "description": "Guest name associated to the reservation.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 200
},
- "issuedPlace": {
- "description": "The place where Identification was issued.",
+ "roomId": {
+ "description": "Room number associated to the reservation.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "orderSequence": {
- "description": "Display Order sequence.",
- "type": "number"
+ "minLength": 0,
+ "maxLength": 20
},
- "primaryInd": {
- "description": "When true, indicates a primary information.",
- "type": "boolean"
+ "confirmationNo": {
+ "description": "Reservation confirmation number.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "registeredProperty": {
- "description": "Property where the identification belongs to.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "roomStatus": {
+ "description": "Status of the room (Dirty/Clean/Inspected/Pickup).",
+ "$ref": "#/definitions/housekeepingRoomStatusType"
}
}
},
- "imageSetType": {
- "description": "Represents on image set record.",
+ "massAdvanceCheckInReservations": {
"type": "object",
+ "description": "Request object to Submit Batch job for Mass Advance Check In of Reservations.",
"properties": {
- "chainCode": {
- "description": "The image set chain code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "criteria": {
+ "description": "Criteria for Submiting a request for Mass Advance Check In of Reservations.",
+ "$ref": "#/definitions/massAdvanceCheckInCriteriaType"
},
- "description": {
- "description": "The image set description.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "massAdvanceCheckInCriteriaType": {
+ "type": "object",
+ "description": "Criteria for performing Mass Advance Check In of Reservations",
+ "properties": {
"hotelId": {
- "description": "The image set hotel code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "imageOrder": {
- "description": "The image set order.",
- "type": "integer"
- },
- "imageSet": {
- "description": "The image set name.",
+ "description": "Resort to which the Reservation belongs.",
"type": "string",
- "maxLength": 800,
- "minLength": 0
- },
- "imageStyle": {
- "description": "The image set enumerated style.",
- "$ref": "#/definitions/imageStyleType"
+ "minLength": 0,
+ "maxLength": 20
},
- "imageType": {
- "description": "The image set type.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "reservationIdList": {
+ "description": "Collection of IDs of Reservations that should be Mass Advance Checked In",
+ "$ref": "#/definitions/reservationIdList"
},
- "imageURL": {
- "description": "The image set URL.",
+ "expectedReturnTime": {
+ "description": "Time when the guest is expected to return to perform Check In",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "format": "date-time"
},
- "language": {
- "description": "Language identification.",
+ "eTRComments": {
+ "description": "Comments relating to the Advance Checked In guest's return to the property to perform Check In",
"type": "string",
- "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
+ "minLength": 0,
+ "maxLength": 2000
+ }
+ }
+ },
+ "massCheckInReservations": {
+ "type": "object",
+ "description": "Request object to Submit Batch job for Mass Checkin of Reservations.",
+ "properties": {
+ "criteria": {
+ "description": "Criteria for Submiting Mass CHeckin of Reservations.",
+ "$ref": "#/definitions/massCheckInCriteriaType"
},
- "sequenceId": {
- "description": "The image set sequence ID.",
- "type": "integer"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "website": {
- "description": "The image set website.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "imageStyleType": {
- "description": "An enumeration of image styles.",
- "type": "string",
- "enum": [
- "Full",
- "Thumbnail",
- "Icon",
- "Square",
- "Banner",
- "Button",
- "Lowres",
- "Highres"
- ]
- },
- "indicatorType": {
- "description": "Lamp indicator Type.",
+ "massCheckInCriteriaType": {
"type": "object",
+ "description": "This will have details of reservations and advance criteria for performing Mass Checkin of Reservations",
"properties": {
- "count": {
- "description": "Indicates number of occurrences of the indicator.",
- "type": "integer"
- },
- "indicatorName": {
- "description": "Name of the indicator.",
+ "hotelId": {
+ "description": "Resort to which the Reservation belongs.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "reservationIdList": {
+ "description": "Collection of Reservation ID's that should be Mass Checked in",
+ "$ref": "#/definitions/reservationIdList"
+ },
+ "additionalCriteria": {
+ "description": "Additional RoomStatus Criteria for Mass Checkin",
+ "type": "object",
+ "properties": {
+ "roomStatuses": {
+ "description": "Additional RoomStatus Criteria for Mass Checkin",
+ "$ref": "#/definitions/roomStatusListType"
+ }
+ }
}
}
},
- "indicatorsType": {
- "description": "Collection of lamp indicators.",
+ "roomStatusListType": {
"type": "array",
+ "description": "Room Status Type.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/indicatorType"
+ "$ref": "#/definitions/housekeepingRoomStatusType"
}
},
- "instanceLink": {
- "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.",
+ "advanceCheckInReservation": {
"type": "object",
- "required": [
- "href",
- "rel",
- "method",
- "operationId"
- ],
+ "description": "Request object to perform Advance Check In of a Reservation.",
"properties": {
- "href": {
- "description": "URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
- "type": "string"
- },
- "method": {
- "description": "HTTP method for requesting the target of the link.",
- "type": "string",
- "enum": [
- "GET",
- "POST",
- "PUT",
- "DELETE",
- "PATCH",
- "OPTIONS",
- "HEAD"
- ]
- },
- "operationId": {
- "description": "The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.",
- "type": "string"
- },
- "rel": {
- "description": "Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
- "type": "string"
- },
- "targetSchema": {
- "description": "Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
- "type": "string"
+ "reservation": {
+ "description": "Information required for performing Advance Check In.",
+ "$ref": "#/definitions/advanceCheckInReservationType"
},
- "templated": {
- "description": "Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
- "type": "boolean",
- "default": false
+ "links": {
+ "$ref": "#/definitions/links"
},
- "title": {
- "description": "Exact copy of the \"summary\" field on the linked operation.",
- "type": "string"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "interfaceRightsStatusType": {
+ "advanceCheckInReservationType": {
"type": "object",
+ "description": "Information needed to perform Advance Check In of a Reservation",
"properties": {
- "category": {
- "description": "Category code of this interface right.",
+ "hotelId": {
+ "description": "Resort to which the Reservation belongs.",
"type": "string",
- "maxLength": 1,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "description": {
- "description": "User defined description for an Interface Right.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "reservationId": {
+ "description": "ID of the Reservation that is being Advance Checked In",
+ "$ref": "#/definitions/reservationId"
},
- "right": {
- "description": "Internal code for each allowed right of a Hotel Interface record.",
- "type": "integer"
+ "expectedReturnTime": {
+ "description": "Time when the guest is expected to return to perform Check In",
+ "type": "string",
+ "format": "date-time"
},
- "statusCode": {
- "description": "User defined code for an Interface Right.",
+ "eTRComments": {
+ "description": "Comments relating to the Advance Checked In guest's return to the property",
"type": "string",
- "maxLength": 5,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "reservationCommunication": {
+ "description": "Collection of Reservation communication information such as phone numbers and email addresses.",
+ "$ref": "#/definitions/resCommunicationType"
+ },
+ "optedForCommunication": {
+ "description": "Indicates if the guest has opted for communications pertaining to this reservation.",
+ "type": "boolean"
}
}
},
- "itemInfoType": {
- "description": "Basic information regarding an Item.",
+ "reservation": {
"type": "object",
+ "description": "Validation checks includes the following: - Reservation is not valid to be checked in. - Split is still required before the reservation can be checked in. - Room information is missing. - Payment information is missing. - The status of the room needs to be reviewed. - Sharers was impacted. The check-in process affected the reservation details of shared guests on the reservation. - Sharers was not impacted. The check-in process has not affected the reservation details of shared guests on the reservation.",
"properties": {
- "availabilityPeriod": {
- "description": "Defines a Time period when the item is available.",
- "$ref": "#/definitions/timeWindowType"
- },
- "code": {
- "description": "Item Code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "defaultDuration": {
- "description": "Define the default duration in days when booking the item.",
- "type": "integer"
- },
- "description": {
- "description": "Detail description of an item.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "fixedCharge": {
- "description": "If true indicates that item has fixed charge when it is attached to a reservation.",
- "type": "boolean"
- },
- "itemHoldId": {
- "description": "ID reference for the hold Item",
- "type": "number"
- },
- "itemPool": {
- "description": "Indicates if it is an item pool. Not applicable for Item within the Item Pool.",
- "type": "boolean"
- },
- "name": {
- "description": "Name of an item.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "outsideStay": {
- "description": "If true indicates that item could be held outside of the reservation stay days.",
- "type": "boolean"
- },
- "quantity": {
- "description": "Quantity of hold Item",
- "type": "integer"
- },
- "requiredForBooking": {
- "description": "If true indicates that item is required for the reservation.",
- "type": "boolean"
+ "reservation": {
+ "type": "object",
+ "description": "Criteria element to check-in a reservation",
+ "properties": {
+ "roomId": {
+ "description": "Expected room no. If this attribute is included, then Opera will check if the currently configured room no in the database matches this value.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "checkOutTime": {
+ "description": "Request to update the checkout time.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "startCheckInProcessTime": {
+ "description": "Represents the time the user starts the check in process.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "endCheckInProcessTime": {
+ "description": "Represents the time the user compeletes the check in process.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "lockHandle": {
+ "description": "An id representing the record lock for this reservation. When passed, update operation will verify that this lock is still valid.",
+ "type": "number"
+ },
+ "profilePrivacyPrompted": {
+ "description": "Dictates whether Profile privacy stop in check in is prompted.",
+ "type": "boolean"
+ },
+ "ignoreWarnings": {
+ "description": "Dictates whether to ignore warnings ( e.g. room availability ) before check in.",
+ "type": "boolean"
+ },
+ "stopCheckin": {
+ "description": "Indicates the Stop Check In reservation Global Alert flag.",
+ "type": "boolean"
+ },
+ "printRegistration": {
+ "description": "Flag for Print Registration Card",
+ "type": "boolean"
+ },
+ "overrideAdvancePaymentValidation": {
+ "description": "Flag to override advance payment validation.",
+ "type": "boolean"
+ }
+ }
},
- "sellInEvent": {
- "description": "If true indicates that item can be sold in event.",
- "type": "boolean"
+ "fetchReservationInstruction": {
+ "description": "Instructions to fetch reservations .",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/checkedInReservationInstructionType"
+ }
},
- "sellInReservation": {
- "description": "If true indicates that item can be sold in reservation.",
+ "includeNotifications": {
+ "description": "When \"true\" alerts and comments are fetched. When \"false\", these alerts and comments are not retrieved.",
"type": "boolean"
},
- "sellSeparate": {
- "description": "If true indicates that item is allowed to sell separately.",
- "type": "boolean"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "timeSpan": {
- "description": "Date Range to get the inventories of the items.",
- "$ref": "#/definitions/timeSpanType"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "keyCardType": {
- "description": "Key card types.",
+ "checkedInReservationInstructionType": {
"type": "string",
+ "description": "Fetch Instruction to indicate if any automatically generated folios information should be returned in the response. For example, in a scenario when automatic credit bills are generated during check-in for the deposits, this instruction can be used to get the credit bill folios which can be used for printing/previewing the folios.",
"enum": [
- "Mifare1K",
- "Mifare4K",
- "MifareUltralight"
+ "ReservationDetail",
+ "AutoFolios",
+ "ExcludeRoomSuggestion"
]
},
- "keyTrackType": {
- "type": "object",
- "properties": {
- "keyTrack1": {
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "keyTrack2": {
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "keyTrack3": {
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "keyTrack4": {
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- }
- }
- },
- "keywordDetailType": {
- "type": "object",
- "properties": {
- "newKeyword": {
- "description": "The new keyword value.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- }
- }
- },
- "keywordType": {
- "type": "object",
- "properties": {
- "keyword": {
- "description": "The keyword value.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "keywordDetail": {
- "description": "The keyword new value, in case keyword value is modified.",
- "$ref": "#/definitions/keywordDetailType"
- },
- "type": {
- "description": "The type of keyword",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "languageType": {
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "lastStayInfoType": {
- "description": "Contains last stay related details for the profile",
+ "checkedinReservation": {
"type": "object",
+ "description": "CheckIn response will commonly be errors over warnings. If a check has to be done before checking a reservation to a hotel, then the VerifyCheckinReservation operation can be utilized.",
"properties": {
- "lastRate": {
- "description": "Used to hold last rate information for the profile.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "lastRoom": {
- "description": "Used to hold last room information for the profile.",
- "type": "string"
+ "reservation": {
+ "description": "Reservation record showing the current state of the reservation.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/hotelReservationType"
+ }
},
- "lastVisit": {
- "description": "Used to hold last stay information for the profile.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "links": {
+ "$ref": "#/definitions/links"
},
- "totalStay": {
- "description": "The total number of previous stay of the profile.",
- "type": "integer"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "linkedReservationInfoType": {
+ "hotelReservationType": {
"type": "object",
+ "description": "The Reservation class contains the current reservation being created or altered.",
"properties": {
- "allowedActions": {
- "description": "Collection of allowed actions for the linked reservation.",
- "$ref": "#/definitions/reservationAllowedActionsType"
- },
- "balance": {
- "$ref": "#/definitions/currencyAmountType"
+ "reservationIdList": {
+ "description": "Used to provide PMS and/or CRS identifiers.",
+ "$ref": "#/definitions/reservationIdList"
},
- "displayColor": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "externalReferences": {
+ "description": "External Reference information for Reservation.",
+ "$ref": "#/definitions/externalReferencesType"
},
- "givenName": {
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "associatedReservations": {
+ "description": "Information regarding associated reservations.",
+ "$ref": "#/definitions/associatedResType"
},
- "guarantee": {
- "$ref": "#/definitions/resGuaranteeType"
+ "sourceOfSale": {
+ "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.",
+ "$ref": "#/definitions/sourceOfSaleType"
},
- "hotelId": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "roomStay": {
+ "description": "Room stays information.",
+ "$ref": "#/definitions/roomStayType"
},
- "linkReservationType": {
- "$ref": "#/definitions/linkedReservationType"
+ "compAuthorizer": {
+ "description": "Reservation Comp Authorizer.",
+ "$ref": "#/definitions/compAuthorizerInfoType"
},
- "rate": {
- "$ref": "#/definitions/currencyAmountType"
+ "reservationGuests": {
+ "description": "Collection of guests associated with the reservation.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/resGuestType"
+ }
},
- "ratePlanCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "sharedGuests": {
+ "description": "Collection of guests who share this reservation.",
+ "$ref": "#/definitions/resSharedGuestListType"
},
- "reservationBlock": {
- "description": "Key information about the block for the linked reservation.",
- "$ref": "#/definitions/reservationBlockType"
+ "additionalGuestInfo": {
+ "description": "Entry Date into the country. (Croatian Requirements).",
+ "$ref": "#/definitions/resGuestAdditionalInfoType"
},
- "reservationIdList": {
- "$ref": "#/definitions/reservationIdList"
+ "reservationProfiles": {
+ "description": "Collection of guests associated with the reservation.",
+ "type": "object",
+ "properties": {
+ "reservationProfile": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationProfileType"
+ }
+ },
+ "commissionPayoutTo": {
+ "description": "If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.",
+ "$ref": "#/definitions/commissionPayoutToType"
+ }
+ }
},
- "reservationStatus": {
- "description": "Indicates the Actual status of the reservation.",
- "$ref": "#/definitions/pMS_ResStatusType"
+ "reservationCommunication": {
+ "description": "Collection of reservation communication details.",
+ "$ref": "#/definitions/resCommunicationType"
},
- "reverseCheckInAllowed": {
- "description": "This attribute is to verify if reverse check-in is allowed for the reservation.",
- "type": "boolean"
+ "reservationAwards": {
+ "description": "Collection of Awards,Certificates for the guest profile.",
+ "$ref": "#/definitions/awardsType"
},
- "room": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "trackItItems": {
+ "description": "Collection of TrackIt Items available for that reservation",
+ "$ref": "#/definitions/trackItItemsType"
},
- "roomNumberLocked": {
- "description": "This attribute is to verify if room number is locked for the reservation. When true the room number cannot be changed",
- "type": "boolean"
+ "shares": {
+ "description": "Collection of share reservation available for that reservation",
+ "$ref": "#/definitions/hotelReservationsType"
},
- "roomType": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "locators": {
+ "description": "Collection of Locators available for that reservation",
+ "$ref": "#/definitions/reservationLocatorsType"
},
- "suppressRate": {
- "description": "This attribute checks if rate is suppressed or not in order to properly show strike through.",
- "type": "boolean"
+ "attachments": {
+ "description": "Collection of attachments available for that reservation",
+ "$ref": "#/definitions/attachmentsType"
},
- "surname": {
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "webRegistrationCards": {
+ "description": "Collection of Web Registration Cards available for that reservation",
+ "$ref": "#/definitions/attachmentsType"
},
- "timeSpan": {
- "$ref": "#/definitions/timeSpanType"
+ "serviceRequests": {
+ "description": "Collection of Service Requests available for that reservation",
+ "$ref": "#/definitions/serviceRequests"
},
- "title": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "linkedReservationType": {
- "description": "Enumeration of the different Linked Reservation Types.",
- "type": "string",
- "enum": [
- "Linked",
- "Shared",
- "Default"
- ]
- },
- "linkedReservations": {
- "type": "object",
- "properties": {
- "linkedReservationList": {
- "description": "Set of reservations linked to the requested Reservation.",
- "$ref": "#/definitions/linkedReservationsInfoType"
+ "reservationActivities": {
+ "description": "Collection of Reservation Activities available for that reservation",
+ "$ref": "#/definitions/activityLookUpList"
},
- "links": {
- "$ref": "#/definitions/links"
+ "scheduledActivities": {
+ "description": "Collection of Scheduled Activities available for that reservation",
+ "$ref": "#/definitions/activityLookUpList"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "linkedReservationsInfoType": {
- "description": "Linked Reservations.",
- "type": "object",
- "properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "prepaidCards": {
+ "description": "Collection of Prepaid Cards available for that reservation",
+ "$ref": "#/definitions/prepaidCardsType"
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "profileAwards": {
+ "description": "Collection of profile awards available for that reservation",
+ "$ref": "#/definitions/awardsType"
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "reservationPackages": {
+ "description": "A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationPackageType"
+ }
},
- "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",
- "maxLength": 80,
- "minLength": 0
+ "inventoryItems": {
+ "description": "A collection of inventory items attached to a reservation.",
+ "$ref": "#/definitions/resInventoryItemsType"
},
- "reservationInfo": {
+ "comments": {
+ "description": "List of Notes for the Guest related to the reservation.",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/linkedReservationInfoType"
+ "$ref": "#/definitions/commentInfoType"
}
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
- }
- }
- },
- "links": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/instanceLink"
- }
- },
- "mailingActionsType": {
- "description": "Defines mailing action list for the profile.",
- "type": "object",
- "properties": {
- "active": {
- "description": "When true indicates that profile has subscribed to the mailing list.",
- "type": "boolean"
+ "guestComments": {
+ "description": "List of Notes for the Guest related to the profile.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/commentInfoType"
+ }
},
- "count": {
- "description": "Total number of rows returned",
- "type": "integer"
+ "guestMemberships": {
+ "description": "List of Memberships for the Guest related to the reservation.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/membershipType"
+ }
},
- "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"
+ "preferenceCollection": {
+ "description": "Collection of reservation preferences.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/preferenceTypeType"
+ }
},
- "mailingAction": {
- "description": "Defines mailing action code and description.",
+ "reservationMemberships": {
+ "description": "List of reservation memberships.",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/codeDescriptionType"
+ "$ref": "#/definitions/reservationMembershipType"
}
},
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- }
- }
- },
- "massAdvanceCheckInCriteriaType": {
- "description": "Criteria for performing Mass Advance Check In of Reservations",
- "type": "object",
- "properties": {
- "eTRComments": {
- "description": "Comments relating to the Advance Checked In guest's return to the property to perform Check In",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "reservationPaymentMethods": {
+ "description": "A collection of Payment Method objects.",
+ "$ref": "#/definitions/reservationPaymentMethodsType"
},
- "expectedReturnTime": {
- "description": "Time when the guest is expected to return to perform Check In",
- "type": "string",
- "format": "date-time"
+ "routingInstructions": {
+ "description": "Set of Routing Instructions.",
+ "$ref": "#/definitions/routingInfoListType"
},
- "hotelId": {
- "description": "Resort to which the Reservation belongs.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "reservationPolicies": {
+ "description": "A collection of Cancellation Penalties objects.",
+ "$ref": "#/definitions/reservationPoliciesType"
},
- "reservationIdList": {
- "description": "Collection of IDs of Reservations that should be Mass Advance Checked In",
- "$ref": "#/definitions/reservationIdList"
- }
- }
- },
- "massAdvanceCheckInReservations": {
- "description": "Request object to Submit Batch job for Mass Advance Check In of Reservations.",
- "type": "object",
- "properties": {
- "criteria": {
- "description": "Criteria for Submiting a request for Mass Advance Check In of Reservations.",
- "$ref": "#/definitions/massAdvanceCheckInCriteriaType"
+ "cashiering": {
+ "description": "Holds cashiering related information for the reservation.",
+ "$ref": "#/definitions/resCashieringType"
},
- "links": {
- "$ref": "#/definitions/links"
+ "housekeeping": {
+ "description": "Holds rooms housekeeping information.",
+ "$ref": "#/definitions/resHousekeepingType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "massCheckInCriteriaType": {
- "description": "This will have details of reservations and advance criteria for performing Mass Checkin of Reservations",
- "type": "object",
- "properties": {
- "additionalCriteria": {
- "description": "Additional RoomStatus Criteria for Mass Checkin",
- "type": "object",
- "properties": {
- "roomStatuses": {
- "description": "Additional RoomStatus Criteria for Mass Checkin",
- "$ref": "#/definitions/roomStatusListType"
- }
- }
+ "linkedReservation": {
+ "description": "Reservations related to the current Reservation.",
+ "$ref": "#/definitions/linkedReservationsInfoType"
},
- "hotelId": {
- "description": "Resort to which the Reservation belongs.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "extSystemSync": {
+ "type": "boolean"
},
- "reservationIdList": {
- "description": "Collection of Reservation ID's that should be Mass Checked in",
- "$ref": "#/definitions/reservationIdList"
- }
- }
- },
- "massCheckInReservations": {
- "description": "Request object to Submit Batch job for Mass Checkin of Reservations.",
- "type": "object",
- "properties": {
- "criteria": {
- "description": "Criteria for Submiting Mass CHeckin of Reservations.",
- "$ref": "#/definitions/massCheckInCriteriaType"
+ "userDefinedFields": {
+ "description": "Collections of user defined fields.",
+ "$ref": "#/definitions/userDefinedFieldsType"
},
- "links": {
- "$ref": "#/definitions/links"
+ "reservationIndicators": {
+ "description": "Indicators of additional information attached to the reservation",
+ "$ref": "#/definitions/indicatorsType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "masterAccountInfoType": {
- "type": "object",
- "properties": {
- "masterAccountId": {
- "description": "Unique ID of the Master account.",
- "$ref": "#/definitions/uniqueID_Type"
+ "waitlist": {
+ "description": "Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is no more in Waitlist status.",
+ "$ref": "#/definitions/waitlistResType"
},
- "masterAccountName": {
- "description": "Name of the Master account.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- }
- }
- },
- "masterInfoCodeDetailType": {
- "type": "string",
- "enum": [
- "LongDescription",
- "ShortDescription"
- ]
- },
- "masterInfoType": {
- "type": "object",
- "properties": {
- "codeInfo": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/codeInfoType"
+ "cancellation": {
+ "description": "Information regarding why reservation has been/was cancelled. This could hold information as history even if reservation is no more in in Cancelled status.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "code": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "cancellationNo": {
+ "description": "Cancellation Number given when reservation was last cancelled.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "date": {
+ "description": "Date when reservation was last cancelled.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ }
}
},
- "codeType": {
- "$ref": "#/definitions/masterType"
- }
- }
- },
- "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"
- ]
- },
- "mealPlanCodeType": {
- "description": "Meal plan codes associated with the rate codes.",
- "type": "object",
- "properties": {
- "breakfastIncluded": {
- "description": "Represents if the meal plan code is available for breakfast or not.",
- "type": "boolean"
+ "catering": {
+ "description": "Catering event information if reservation is associated with the catering event.",
+ "$ref": "#/definitions/cateringResInfoType"
},
- "code": {
- "description": "Meal plan code.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "statisticalClassification": {
+ "description": "Catering event information if reservation is associated with the catering event.",
+ "$ref": "#/definitions/resStatClassificationType"
},
- "dinnerIncluded": {
- "description": "Represents if the meal plan code is available for dinner or not.",
- "type": "boolean"
+ "alerts": {
+ "description": "List of reservation alerts.",
+ "$ref": "#/definitions/alertsType"
},
- "included": {
- "description": "Represents if the meal plan code is included in rate code or not.",
- "type": "boolean"
+ "traces": {
+ "description": "List of reservation Traces.",
+ "$ref": "#/definitions/hotelReservationTracesType"
},
- "lunchIncluded": {
- "description": "Represents if the meal plan code is available for lunch or not.",
- "type": "boolean"
- }
- }
- },
- "mealPlansType": {
- "description": "Meal plan codes associated with the rate codes.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/mealPlanCodeType"
- }
- },
- "membershipEarningPreferenceType": {
- "description": "The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.",
- "type": "string",
- "enum": [
- "Points",
- "Miles"
- ]
- },
- "membershipInfoType": {
- "description": "The Membership object identifies the frequent customer reward program.",
- "type": "object",
- "properties": {
- "accountId": {
- "description": "The account identification number for this particular member in this particular program.",
- "type": "string",
- "maxLength": 50,
- "minLength": 0
+ "confirmationLetters": {
+ "description": "List of reservation confirmation letters.",
+ "$ref": "#/definitions/confirmationsType"
},
- "bonusCode": {
- "description": "The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "callHistory": {
+ "description": "List of reservation calls.",
+ "$ref": "#/definitions/callHistoryType"
},
- "membershipId": {
- "description": "Membership ID (Unique ID from the memberships table).",
+ "fixedCharges": {
+ "description": "List of reservation fixed charges.",
+ "$ref": "#/definitions/fixedChargesType"
+ },
+ "guestMessages": {
+ "description": "List of Messages.",
+ "$ref": "#/definitions/guestMessagesType"
+ },
+ "lockHandle": {
+ "description": "An id representing the record lock for this reservation. When passed, update operation will verify that this lock is still valid.",
"type": "number"
},
- "membershipLevel": {
- "description": "The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "overrideInstructions": {
+ "description": "List of overrides done for the reservation.",
+ "$ref": "#/definitions/overrideInstructionsType"
},
- "membershipLevelDesc": {
- "description": "The description of the Bonus Code.(Platinum for code P)",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "queue": {
+ "description": "Information about the time and duration this reservation was on Queue for Checkin.",
+ "$ref": "#/definitions/reservationQueueInformationType"
},
- "membershipTypeDesc": {
- "description": "The description of the ProgramCode.(Delta Previlige for code DP)",
+ "allowedActions": {
+ "description": "Collection of allowed actions for the reservation.",
+ "$ref": "#/definitions/reservationAllowedActionsType"
+ },
+ "eCoupons": {
+ "description": "List of eCoupons.",
+ "$ref": "#/definitions/eCouponsType"
+ },
+ "transactionDiversions": {
+ "description": "List of transaction diversions attached to the reservation.",
+ "type": "object",
+ "properties": {
+ "transactionDiversions": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationTransactionDiversionsType"
+ }
+ },
+ "actionType": {
+ "type": "string",
+ "maxLength": 2000
+ }
+ }
+ },
+ "advanceCheckIn": {
+ "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return",
+ "$ref": "#/definitions/advanceCheckInType"
+ },
+ "tickets": {
+ "description": "List of Reservation Tickets.",
+ "$ref": "#/definitions/ticketsType"
+ },
+ "accessRestrictionMessage": {
+ "description": "Configurable Access Restriction Message for Excluded Block or Rate Code.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 4000
},
- "playerRanking": {
- "description": "Ranking assigned to the Player Profile by the Gaming system.",
- "type": "integer"
+ "eCertificates": {
+ "description": "List of ECertificates attached to the reservation.",
+ "$ref": "#/definitions/reservationECertificatesType"
},
- "programCode": {
- "description": "The code or name of the membership program ('Hertz', 'AAdvantage', etc.).",
+ "customNameValueDetail": {
+ "description": "List of Custom Name Value Information attached to the reservation.",
+ "$ref": "#/definitions/nameValueDetailType"
+ },
+ "customChargeExemptionDetails": {
+ "description": "List of Custom Charge Exemptions attached to the reservation.",
+ "$ref": "#/definitions/customChargeExemptionsType"
+ },
+ "folios": {
+ "description": "This element returns any automatically generated folios during check-in, based on the Fetch Instruction \"AutoFolios\". When the parameter \"Auto Generate Credit Bill for Deposit upon Check In\" is enabled, during check-in credit bills are automatically generated for the deposits. The generated credit bill details are returned so that user can preview/print the folio. For some countries like Portugal, it is mandatory to print the folio and hence this information is needed",
+ "$ref": "#/definitions/foliosShortInfoType"
+ },
+ "autoBorrowFromHouse": {
+ "description": "This flag will force to borrow from house if borrow required for number of rooms requested, this will only applicable when reservation is attached to a Block.",
+ "type": "boolean"
+ },
+ "overrideExternalChecks": {
+ "description": "Forcefully override the create/update action on the Reservation. For real-time CRS interfaces, this element is used as force selling indicator in case of Create or Update Reservation",
+ "type": "boolean"
+ },
+ "hotelId": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "membershipType": {
- "description": "Detailed information of the memberships.",
- "type": "object",
- "properties": {
- "benefits": {
- "description": "benefits for the membership.",
- "$ref": "#/definitions/benefitsType"
+ "minLength": 0,
+ "maxLength": 20
},
- "centralSetup": {
- "description": "Indicates how the award points for this membership type will be managed.",
+ "roomStayReservation": {
+ "description": "Boolean True if this reservation is reserving rooms. False if it is only reserving services.",
"type": "boolean"
},
- "comment": {
- "description": "Additional comments regarding to the membership.",
- "$ref": "#/definitions/paragraphType"
+ "reservationStatus": {
+ "description": "Indicates the Actual status of the reservation.",
+ "$ref": "#/definitions/pMS_ResStatusType"
+ },
+ "computedReservationStatus": {
+ "description": "Indicates the Computed status of the reservation.",
+ "$ref": "#/definitions/pMS_ResStatusType"
+ },
+ "walkIn": {
+ "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"
+ },
+ "printRate": {
+ "description": "Indicates whether to show the rate or not on a printed document which includes the rate.",
+ "type": "boolean"
},
"createDateTime": {
"description": "Time stamp of the creation.",
@@ -28301,850 +25831,887 @@
"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",
- "maxLength": 200,
- "minLength": 0
- },
- "currentPoints": {
- "description": "Profile MemberShip Points.",
- "type": "number"
- },
- "downgrade": {
- "description": "Defines how downgrading will be handled for this membership.",
- "$ref": "#/definitions/downgradeType"
+ "minLength": 0,
+ "maxLength": 200
},
- "downgradeDescription": {
- "description": "Indicates information regarding the member's possible downgrades.",
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
"type": "string",
- "maxLength": 32000,
- "minLength": 0
+ "format": "date-time"
},
- "earningPreference": {
- "description": "Earning preference to the membership.",
- "$ref": "#/definitions/membershipEarningPreferenceType"
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
- "effectiveDate": {
- "description": "Indicates the starting date.",
+ "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
},
- "enrollmentResort": {
- "description": "Resort/CRO where enrollment is done.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "enrollmentSource": {
- "description": "Source from where the enrollment is done.",
+ "createBusinessDate": {
+ "description": "Business Date when the reservation was created.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "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"
+ "format": "date",
+ "maxLength": 8
},
- "expireDate": {
- "description": "Indicates the ending date.",
+ "reinstateDate": {
+ "description": "Business Date when the reservation was last reinstated.",
"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"
- },
- "inactive": {
- "description": "Indicates whether membership is active or inactive.",
- "type": "boolean"
- },
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "party": {
+ "description": "Party/PartyCode when reservation is part of a party(a small group).",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 50
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
+ "primaryEnrollmentResort": {
+ "description": "Name Of the Resort/Hotel for the primary enrollment",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 80
},
- "memberStatus": {
- "description": "Indicates where the guest is in the membership enrollment process.",
+ "primaryEnrollmentChain": {
+ "description": "Name of the Chain for the primary enrollment",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "membershipClass": {
- "description": "Indicates the membership class.",
- "type": "string"
+ "minLength": 0,
+ "maxLength": 80
},
- "membershipEnrollmentCode": {
- "description": "Indicates how the guest enrolled in the program.",
+ "customReference": {
+ "description": "Custom Reference to identify reservation.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "membershipId": {
- "description": "Card Number of the membership.",
- "type": "string"
- },
- "membershipIdNo": {
- "description": "Membership ID Number.",
- "type": "integer"
- },
- "membershipLevel": {
- "description": "Indicates the membership level.",
- "type": "string"
+ "minLength": 0,
+ "maxLength": 50
},
- "membershipLevelDescription": {
- "description": "Indicates the membership level description.",
+ "displayColor": {
+ "description": "The color to display this reservation on room grid displays.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "membershipType": {
- "description": "Type of membership.",
- "type": "string"
+ "displayColorDetails": {
+ "description": "Information of reservation display color, determined based on OPERA parameter RESERVATION_COLOR_DEFINITION ",
+ "$ref": "#/definitions/reservationDisplayColorInfoType"
},
- "nameOnCard": {
- "description": "Name to be displayed on the membership card.",
- "type": "string"
+ "markAsRecentlyAccessed": {
+ "description": "Mark this reservation as recently accessed.",
+ "type": "boolean"
},
- "newMembershipNumber": {
- "description": "Card Number of the membership.",
- "type": "string"
+ "overrideInventoryCheck": {
+ "description": "Indicates to Override the Room Inventory Check if applicable.",
+ "type": "boolean"
},
- "orderSequence": {
- "description": "Display Order sequence.",
- "type": "number"
+ "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"
},
- "playerRanking": {
- "description": "Ranking assigned to the Player Profile by the Gaming system.",
- "type": "integer"
+ "preRegistered": {
+ "description": "Is the reservation pre-registered.",
+ "type": "boolean"
},
- "pointsLabel": {
- "description": "Label used to refer to points for this membership type",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "upgradeEligible": {
+ "description": "Indicates whether the reservation is eligible for upgrade.",
+ "type": "boolean"
},
- "preferredCard": {
- "description": "Preferred Card.",
+ "overrideBlockRestriction": {
"type": "boolean"
},
- "primaryMembership": {
- "description": "Boolean indicator set to True implies membership is a Primary Membership.",
+ "allowAutoCheckin": {
+ "description": "Flag to allow auto checkin",
"type": "boolean"
},
- "primaryMembershipYn": {
- "description": "Indicator if Membership is a Primary Membership.",
- "type": "string",
- "maxLength": 1,
- "minLength": 0
+ "hasOpenFolio": {
+ "type": "boolean"
},
- "programDescription": {
- "description": "Description of the membership program.",
- "type": "string"
+ "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"
},
- "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
+ "allowMobileViewFolio": {
+ "description": "Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.",
+ "type": "boolean"
},
- "rating": {
- "description": "Value Rating Type Description for this membership.",
- "type": "string"
+ "allowPreRegistration": {
+ "description": "Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false.",
+ "type": "boolean"
},
- "reIssueNewCard": {
- "description": "The status of issuing new membership card to the member.",
- "$ref": "#/definitions/cardReIssueType"
+ "optedForCommunication": {
+ "description": "Flag containing true or false value to determine if the guest has opted for communications pertaining to this reservation.Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is marked for communication. Upon fetch, the current state of the flag will show true or false.",
+ "type": "boolean"
},
- "signupDate": {
- "description": "Indicates when the member signed up for the loyalty program.",
+ "chargeCardNumber": {
+ "description": "This attribute represents Hotel charge card number. This number is generated automatically in OPERA when a reservation is created in OPERA. It is part of a functionality that provide the guest with the convenience of placing all their charges directly on their reservation folio.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 100
},
- "tierAdministration": {
- "description": "Defines the degree of participation for this membership in the tier management portion of the program.",
- "$ref": "#/definitions/tierAdministrationType"
+ "overrideOutOfServiceCheck": {
+ "description": "Indicates to Override the Room Out Of Service Check if applicable.",
+ "type": "boolean"
},
- "upgradeDescription": {
- "description": "Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.",
- "type": "string",
- "maxLength": 32000,
- "minLength": 0
+ "hasVoucher": {
+ "description": "This flag value true indicates the reservation matches a Voucher Rule. It is supported only if OPERA Control Vouchers is active.",
+ "type": "boolean"
}
}
},
- "membershipTypeLevelType": {
+ "associatedResType": {
"type": "object",
+ "description": "Information regarding associated reservations to the reservation.",
"properties": {
- "level": {
- "description": "Description type for Rule Details",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "parentReservation": {
+ "description": "Stores Unique ID of the parent reservation.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "type": {
- "description": "Code type for Rule Details",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "originalMultiRoomRes": {
+ "description": "Stores Unique ID of the original multi room reservation from which this reservation is split off.",
+ "$ref": "#/definitions/uniqueID_Type"
}
}
},
- "messageDeliveryType": {
- "description": "Holds the Delivery Information of the Message",
+ "roomStayType": {
"type": "object",
"properties": {
- "deliveredBy": {
- "description": "User who delivered the message (who marked message as received)",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "deliveryDate": {
- "description": "Date the message has been delivered (marked as received)",
- "type": "string",
- "format": "date-time"
+ "registrationNumber": {
+ "description": "Registration Number of the reservation for the current day.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "deliveryStatus": {
- "description": "Status of the Message (Received or Not Received)",
- "$ref": "#/definitions/messageStatusType"
+ "currentRoomInfo": {
+ "description": "Room information of the reservation for the current day.",
+ "$ref": "#/definitions/currentRoomInfoType"
},
- "printDate": {
- "description": "Date when message has been printed",
- "type": "string",
- "format": "date-time"
+ "reservationKeyInfo": {
+ "description": "Holds the room key information provided by the Door Lock System.",
+ "$ref": "#/definitions/reservationKeyInfoType"
},
- "textMessageRecipientNo": {
- "description": "Number in which the message is to be sent.",
+ "roomRates": {
+ "description": "A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomRateType"
+ }
+ },
+ "guestCounts": {
+ "$ref": "#/definitions/guestCountsType"
+ },
+ "arrivalDate": {
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "format": "date"
},
- "textMessageSentBy": {
- "description": "User who sent the message",
+ "departureDate": {
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "format": "date"
},
- "textMessageSentById": {
- "description": "User Id of who sent the message",
- "type": "integer"
+ "expectedTimes": {
+ "description": "The Expected Arrival and Departure Times.",
+ "$ref": "#/definitions/resExpectedTimesType"
},
- "textMessageSentDate": {
- "description": "Date when message has been sent via SMS",
- "type": "string",
- "format": "date-time"
- }
- }
- },
- "messageStatusType": {
- "description": "Status of the Message.",
- "type": "string",
- "enum": [
- "Mr",
- "Nr"
- ]
- },
- "messageType": {
- "description": "Holds the Message Information",
- "type": "object",
- "properties": {
- "messageDate": {
- "description": "Date the message was created",
- "type": "string",
- "format": "date-time"
+ "originalTimeSpan": {
+ "description": "The Original Time Span(Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same.",
+ "$ref": "#/definitions/timeSpanType"
},
- "messageText": {
- "description": "Message Content",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "guarantee": {
+ "description": "The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.",
+ "$ref": "#/definitions/resGuaranteeType"
},
- "operator": {
- "description": "User who created the Message",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "promotion": {
+ "description": "Promotions applied to the reservation to get the promotional rate.",
+ "$ref": "#/definitions/promotionType"
},
- "recipient": {
- "description": "Recipient of the Message",
+ "suiteWith": {
+ "description": "Connecting Rooms.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "typeOfMessage": {
- "description": "Type of message (Voice/Text)",
- "$ref": "#/definitions/typeOfMessageType"
- }
- }
- },
- "moveInHouseGuest": {
- "description": "To move a reservation, the reservation needs to be in Checked-In state.",
- "type": "object",
- "properties": {
- "criteria": {
- "description": "Defines search criteria needed to configure a room to a reservation.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Description of why room is moved.",
- "$ref": "#/definitions/stringLength2000"
- },
- "hotelId": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "includeDepartureRooms": {
- "description": "Indicates if departure rooms are to be included for room assignment.",
- "type": "boolean"
- },
- "includedSharers": {
- "description": "Valid share reservation identifier.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/reservationIdList"
- }
- },
- "oldRoomStatus": {
- "description": "On a successful RoomMove, this status will be configured in the reservation's previous room.",
- "$ref": "#/definitions/housekeepingRoomStatusType"
- },
- "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"
- },
- "overrideInstructions": {
- "description": "If this element is present, override flags will be set when configuring the room to the reservation.",
- "$ref": "#/definitions/reservationRoomSelectionOverrideType"
- },
- "reasonCode": {
- "description": "Identifies the room move reason code.",
- "$ref": "#/definitions/codeType"
- },
- "reservationIdList": {
- "$ref": "#/definitions/reservationIdList"
- },
- "roomId": {
- "description": "Room identifier which the reservation will hold.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomNumberLocked": {
- "description": "Update the do not move flag used to locking the reservation room number.",
- "type": "boolean"
- },
- "updateRoomTypeCharged": {
- "description": "Update the Room Type used for the Rate calculation.",
- "type": "boolean"
- }
+ "total": {
+ "description": "The total amount charged for the Room Stay.",
+ "$ref": "#/definitions/totalType"
+ },
+ "totalPoints": {
+ "description": "The total number of Points charged for the Room Stay.",
+ "$ref": "#/definitions/pointsType"
+ },
+ "multiValueAttrs": {
+ "description": "Informative indicators indicating different values of an attribute exists over the stay.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "maxLength": 2000
}
},
- "links": {
- "$ref": "#/definitions/links"
+ "upsellInfo": {
+ "description": "Indicates Upsell Information to be applied on Reservation.",
+ "$ref": "#/definitions/upsellInfoType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "movedInHouseGuest": {
- "description": "Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room's occupancy level has been compromised. - The room's pricing is NOT available.",
- "type": "object",
- "properties": {
- "effectiveRates": {
- "description": "Collection of effective rates per stay dates per guest to be applied on reservation including its shares.",
- "$ref": "#/definitions/effectiveRatesType"
+ "mobileNotifications": {
+ "description": "Denotes the status of Room Ready and Key Ready messages.",
+ "$ref": "#/definitions/resMobileNotificationsType"
},
- "links": {
- "$ref": "#/definitions/links"
+ "roomNumberLocked": {
+ "description": "When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.",
+ "type": "boolean"
},
- "newRates": {
- "description": "Collection of new room rate information on a daily basis.",
- "$ref": "#/definitions/dailyRatesType"
+ "printRate": {
+ "description": "This control whether rate info will be printed in confirmation letter.",
+ "type": "boolean"
},
- "oldRates": {
- "description": "Collection of old room rate information on a daily basis.",
- "$ref": "#/definitions/dailyRatesType"
+ "ownerReservationType": {
+ "description": "Indicates whether reservation is for Unit/Room Owner or Authorized User. If this attribute is not define it is a regular/rental reservation.",
+ "$ref": "#/definitions/ownerResTypeType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "namePrefixType": {
- "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "nameTypeType": {
- "type": "string",
- "enum": [
- "Guest",
- "Company",
- "Agent",
- "Contact",
- "Source",
- "Group",
- "Employee",
- "Hotel",
- "Purge"
- ]
- },
- "nameValueDataTypeType": {
- "type": "string",
- "enum": [
- "String",
- "Number",
- "Date",
- "Datetime",
- "Time",
- "Integer"
- ]
- },
- "nameValueDetailType": {
- "description": "Detailed information returned during name value search.",
- "type": "object",
- "properties": {
- "nameValues": {
- "description": "Name Value List.",
- "$ref": "#/definitions/nameValuesType"
- }
- }
- },
- "nameValueModuleType": {
- "type": "string",
- "enum": [
- "Reservation",
- "Folio",
- "Profile",
- "Fintrix"
- ]
- },
- "nameValueOriginType": {
- "description": "Contains origin details.",
- "type": "object",
- "properties": {
- "destination": {
- "description": "Contains destination column for Origin.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "primaryShareType": {
+ "description": "This is populated in case of primary share scenario. This indicates whether this reservation is primary or non primary. Changes or postings to the 'non-primary' share reservation is not allowed.",
+ "$ref": "#/definitions/primaryShareTypeType"
},
- "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",
- "maxLength": 80,
- "minLength": 0
+ "remoteCheckInAllowed": {
+ "description": "Indicates whether the reservation is pre-registered for internet check-in or not.",
+ "type": "boolean"
},
- "originName": {
- "description": "Contains origin i.e. Reseravtion, Profile, Folio or FinTrx.",
- "$ref": "#/definitions/nameValueModuleType"
+ "bookingMedium": {
+ "description": "Classifies the medium(Channel field on reservation screen) through which the reservation is made.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "bookingMediumDescription": {
+ "description": "Description of the booking medium.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "availableUpsellOfferCount": {
+ "description": "Number of Upsell Offers Available for this stay. This will only be populated if the Upsell Instruction is included in the Allowed Instruction request",
+ "type": "integer"
}
}
},
- "nameValueType": {
- "description": "Contains name value pair.",
+ "currentRoomInfoType": {
"type": "object",
+ "description": "Room information of the reservation for the current day.",
"properties": {
- "dataType": {
- "description": "Contains data type for values.",
- "$ref": "#/definitions/nameValueDataTypeType"
- },
- "formatString": {
- "description": "Contains format string for values.",
+ "roomType": {
+ "description": "Current room type.",
"type": "string",
- "maxLength": 100,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "name": {
- "description": "Contains unique key which represents for record field.",
+ "roomId": {
+ "description": "Current room number.",
"type": "string",
- "maxLength": 100,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "origin": {
- "description": "Contains Origin information.",
- "$ref": "#/definitions/nameValueOriginType"
+ "roomOwnershipType": {
+ "description": "Provides the information of the assigned reservation room is an Owner,Referral or Regular room. This value is returned when Room Rotation OPERA Control is active and room number is assigned to a reservation.",
+ "$ref": "#/definitions/reservationRoomOwnershipType"
},
- "usageInstruction": {
- "description": "Contains value(s) to identify the reports to include the collected information in e.g. PFH=Print Folio Header, PFD=Print Folio Detail.",
+ "suggestedRoomNumbers": {
+ "description": "Suggested room numbers.",
"$ref": "#/definitions/codeListType"
},
- "value": {
- "description": "Contains value for the record/column.",
- "type": "string",
- "maxLength": 4000,
- "minLength": 0
- }
- }
- },
- "nameValuesType": {
- "description": "List of name value pairs.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/nameValueType"
- }
- },
- "negotiatedInfoType": {
- "description": "This provides information for a profile negotiated rate.",
- "type": "object",
- "properties": {
- "comissionCode": {
- "description": "Informational purposes only in numeric format.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "corporateAgreementId": {
- "description": "The master identifier for multiple offices/locations under the same company profile. This is optional",
+ "roomDescription": {
+ "description": "Current room description.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "end": {
- "description": "The ending value of the date range.",
+ "roomViewCode": {
+ "description": "Represents the room view code like City view, River view, Ocean view etc.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 40
},
- "inactive": {
- "description": "Negotiated Rate is inactive or not",
+ "assignedByAI": {
+ "description": "Represents the room was assigned by AI Room Assignment.",
"type": "boolean"
},
- "order": {
- "description": "The sell order.",
- "type": "integer"
- },
- "start": {
- "description": "The starting value of the date range.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "upgradedByAI": {
+ "description": "Represents the room was upgraded by AI Room Assignment.",
+ "type": "boolean"
}
}
},
- "negotiatedType": {
- "description": "This holds a list of NegotiatedInfoType.",
+ "roomRateType": {
"type": "object",
"properties": {
- "hotelId": {
- "description": "Hotel code for the negotiated rate.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "total": {
+ "$ref": "#/definitions/totalType"
},
- "negotiatedInfoList": {
+ "totalPoints": {
+ "$ref": "#/definitions/pointsType"
+ },
+ "rates": {
+ "$ref": "#/definitions/ratesType"
+ },
+ "packages": {
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/negotiatedInfoType"
+ "$ref": "#/definitions/packageElementType"
}
},
- "rateCode": {
- "description": "Rate plan code for the negotiated rate.",
+ "stayProfiles": {
+ "description": "Profile associated with the room Stay.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationProfileType"
+ }
+ },
+ "guestCounts": {
+ "description": "A collection of Guest Counts associated with the room rate.",
+ "$ref": "#/definitions/guestCountsType"
+ },
+ "taxFreeGuestCounts": {
+ "description": "A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts.",
+ "$ref": "#/definitions/guestCountsType"
+ },
+ "awards": {
+ "description": "Membership Awards code applied on the reservation.",
+ "$ref": "#/definitions/resAwardsType"
+ },
+ "foreignExchange": {
+ "description": "Exchange Type information for the postings.",
+ "$ref": "#/definitions/foreignExchangeType"
+ },
+ "reservationBlock": {
+ "description": "Key information about the block for this reservation.",
+ "$ref": "#/definitions/reservationBlockType"
+ },
+ "roomRateInfo": {
+ "description": "Information about the Room Rate Combination.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "numberRangeType": {
- "description": "Date Range with Start and End dates.",
- "type": "object",
- "properties": {
- "from": {
- "description": "The starting value of the range of number",
- "type": "integer"
+ "minLength": 0,
+ "maxLength": 2000
},
- "to": {
- "description": "The ending value of the range of number",
- "type": "integer"
- }
- }
- },
- "numericUDFType": {
- "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.",
- "type": "object",
- "properties": {
- "alternateName": {
- "description": "Label of user defined field used by vendors or customers.",
+ "mealPlans": {
+ "description": "Meal plan codes for rate plan code.",
+ "$ref": "#/definitions/mealPlansType"
+ },
+ "roomType": {
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "name": {
- "description": "Name of user defined field.",
+ "ratePlanCode": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "value": {
- "description": "Value of user defined field.",
- "type": "number"
- }
- }
- },
- "numericUDFsType": {
- "description": "Used to hold collection of user defined fields of Numeric Type.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/numericUDFType"
- }
- },
- "offsetUnitType": {
- "description": "Indicates deadline offset unit type.",
- "type": "string",
- "enum": [
- "Year",
- "Month",
- "Day",
- "Hour"
- ]
- },
- "operaVersionNumberType": {
- "description": "Current Opera Version Number",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "overrideInstructionType": {
- "description": "Type for Overrides. Contains information for the override action performed while booking a reservation.",
- "type": "object",
- "properties": {
- "date": {
- "description": "The date when the override was done.",
+ "promotionCode": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "start": {
+ "description": "The starting value of the date range.",
"type": "string",
"format": "date",
"maxLength": 8
},
- "description": {
- "description": "The description of the restriction for which the override was done.",
+ "end": {
+ "description": "The ending value of the date range.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "reasonCode": {
- "description": "The override reason code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "availability": {
+ "description": "Used to specify an availability status for the room rate. When available value could be either not specified or \"Available\".",
+ "$ref": "#/definitions/roomRateAvailReasonType"
},
- "reasonDescription": {
- "description": "The override reason description.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "suppressRate": {
+ "type": "boolean"
},
- "type": {
- "description": "The type of override done. If done for Availability, then it will be AVAILABILITY.",
+ "marketCode": {
+ "description": "The code that relates to the market being sold to (e.g., the corporate market, packages).",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "userId": {
- "description": "Login ID of the user who performed the override.",
+ "marketCodeDescription": {
+ "description": "Description of the market code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
+ },
+ "sourceCode": {
+ "description": "To specify where the business came from e.g. radio, newspaper ad, etc.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "sourceCodeDescription": {
+ "description": "Description of the source of business.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
+ },
+ "numberOfUnits": {
+ "description": "The number of rooms.",
+ "type": "integer"
+ },
+ "roomId": {
+ "description": "A string value representing the unique identification of a room.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "pseudoRoom": {
+ "description": "True indicates as pseudo room type. This is usually used for a posting master reservation.",
+ "type": "boolean"
+ },
+ "roomTypeCharged": {
+ "description": "Room Type used for the Rate calculation.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "commissionCode": {
+ "description": "Commission Code applicable for commission calculation for Travel Agent/Company.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "commissionable": {
+ "description": "Indicates Commission is applicable for commission calculation for Travel Agent/Company.",
+ "type": "boolean"
+ },
+ "houseUseOnly": {
+ "description": "Indicates this reservation is for House use.",
+ "type": "boolean"
+ },
+ "complimentary": {
+ "description": "Indicates this reservation rate is complimentary.",
+ "type": "boolean"
+ },
+ "inventoryLender": {
+ "description": "Indicates whether the room type inventory was taken from the allotment or House availability.",
+ "type": "string"
+ },
+ "fixedRate": {
+ "description": "Fixed Rate Indicator.",
+ "type": "boolean"
+ },
+ "barRanking": {
+ "description": "Best Available rates ranking.",
+ "type": "integer"
+ },
+ "rateGroup": {
+ "description": "For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "discountAllowed": {
+ "description": "Indicates if the Rate Code is discountable i.e discounts are allowed on the rate code.",
+ "type": "boolean"
+ },
+ "bogoDiscount": {
+ "description": "Indicates if the Rate Code has BOGO(Bye one Get one) indicator.",
+ "type": "boolean"
+ },
+ "rateLevel": {
+ "description": "Rate plan type like Corporate,Regular,Military,Weekend etc.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "commissionPercentage": {
+ "description": "Indicates commission percentage used by the rate plan.",
+ "type": "integer"
+ },
+ "commissionAmount": {
+ "description": "Indicates commission amount used by the rate plan.",
+ "type": "integer"
+ },
+ "credentialsRequired": {
+ "description": "If true, indicates that credentials is required to sell the rate code.",
+ "type": "boolean"
+ },
+ "taxIncluded": {
+ "description": "If true, indicates if tax is included in the rate code.",
+ "type": "boolean"
+ },
+ "rateDescription": {
+ "description": "Rate code description.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
}
}
},
- "overrideInstructionsType": {
- "description": "List of override actions done.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/overrideInstructionType"
- }
- },
- "ownerResTypeType": {
- "type": "string",
- "enum": [
- "Owner",
- "AuthorizedUser"
- ]
- },
- "ownerType": {
- "description": "Generic type for information about an owner.",
+ "totalType": {
"type": "object",
+ "description": "The total amount charged for the service including additional amounts and fees.",
"properties": {
- "department": {
- "description": "Department to which the owner belongs to.",
- "$ref": "#/definitions/codeDescriptionType"
+ "taxes": {
+ "description": "A collection of taxes.",
+ "$ref": "#/definitions/taxesType"
},
- "email": {
- "description": "Email information of the owner.",
- "$ref": "#/definitions/emailInfoType"
+ "fees": {
+ "description": "A collection of fees or service charges.",
+ "$ref": "#/definitions/feesType"
},
- "hotel": {
- "description": "Hotel to which the owner belongs to.",
- "$ref": "#/definitions/codeDescriptionType"
+ "description": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "name": {
- "description": "Provides name information of the owner.",
- "$ref": "#/definitions/personNameType"
+ "amountBeforeTax": {
+ "description": "The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).",
+ "type": "number"
},
- "ownerCode": {
- "description": "Unique Code to identify the owner.",
+ "amountAfterTax": {
+ "description": "The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).",
+ "type": "number"
+ },
+ "currencyCode": {
+ "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "phone": {
- "description": "Information on the telephone number of the owner.",
- "$ref": "#/definitions/telephoneInfoType"
+ "currencySymbol": {
+ "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 10
},
- "primary": {
- "description": "When true, this is a primary owner.",
+ "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"
+ },
+ "code": {
+ "description": "Type of charge.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "rateOverride": {
+ "description": "When true indicates that the rate amount has been overridden.",
"type": "boolean"
},
- "profileId": {
- "description": "Unique owner profile information.",
- "$ref": "#/definitions/profileId"
+ "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"
+ }
+ }
+ },
+ "taxesType": {
+ "type": "object",
+ "description": "A collection of taxes.",
+ "properties": {
+ "tax": {
+ "description": "An individual tax.",
+ "type": "array",
+ "maxItems": 99,
+ "items": {
+ "$ref": "#/definitions/taxType"
+ }
},
- "relationship": {
- "description": "Relationship of the owner within the profile or block.",
- "$ref": "#/definitions/codeDescriptionType"
+ "amount": {
+ "description": "A monetary amount.",
+ "type": "number"
},
- "userId": {
- "description": "Unique application user ID.",
- "$ref": "#/definitions/uniqueID_Type"
+ "currencyCode": {
+ "description": "Provides a currency code to reflect the currency in which an amount may be expressed.",
+ "type": "string",
+ "minLength": 3,
+ "maxLength": 3
+ }
+ }
+ },
+ "taxType": {
+ "type": "object",
+ "description": "Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "userName": {
- "description": "Unique application user name of the owner.",
+ "type": {
+ "description": "Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).",
+ "$ref": "#/definitions/amountDeterminationType"
+ },
+ "code": {
+ "description": "Code identifying the fee (e.g.,agency fee, municipality fee).",
+ "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",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 3,
+ "maxLength": 3
}
}
},
- "pMS_ResStatusType": {
- "description": "This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.",
+ "amountDeterminationType": {
"type": "string",
+ "description": "Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.",
"enum": [
- "Reserved",
- "Requested",
- "NoShow",
- "Cancelled",
- "InHouse",
- "CheckedOut",
- "Waitlisted",
- "DueIn",
- "DueOut",
- "Walkin",
- "PendingCheckout"
+ "Inclusive",
+ "Exclusive"
]
},
- "packageCalculationRuleType": {
- "description": "Simple type for package caluculation rules.",
- "type": "string",
- "enum": [
- "FlatRate",
- "PerPerson",
- "PerAdult",
- "PerChild",
- "PerRoom"
- ]
+ "feesType": {
+ "type": "object",
+ "description": "A collection of fees or service charges.",
+ "properties": {
+ "fee": {
+ "description": "An individual fee or service charge.",
+ "type": "array",
+ "maxItems": 99,
+ "items": {
+ "$ref": "#/definitions/feeType"
+ }
+ },
+ "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
+ }
+ }
},
- "packageCodeHeaderType": {
+ "feeType": {
"type": "object",
+ "description": "Applicable service charges or fees.",
"properties": {
- "postingAttributes": {
- "description": "Package code posting attributes.",
- "$ref": "#/definitions/configPostingAttributesType"
+ "description": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "primaryDetails": {
- "description": "Package code header primary details.",
- "$ref": "#/definitions/configPackagePrimaryDetailsType"
+ "type": {
+ "description": "Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).",
+ "$ref": "#/definitions/amountDeterminationType"
},
- "transactionDetails": {
- "description": "Package code header transaction information.",
- "$ref": "#/definitions/configPackageTransactionType"
+ "code": {
+ "description": "Code identifying the fee (e.g.,agency fee, municipality fee).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "usageDetails": {
- "description": "Package code usage information.",
- "$ref": "#/definitions/configPackageUsageDetailType"
+ "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
}
}
},
- "packageConsumptionType": {
- "description": "Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.",
+ "ratesType": {
"type": "object",
+ "description": "Individual rate amount.",
"properties": {
- "allowanceConsumed": {
- "description": "Indicates if Allowance(for POS packages) has been consumed/posted for today.",
- "type": "boolean"
+ "rate": {
+ "description": "The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/amountType"
+ }
},
- "defaultQuantity": {
- "description": "The default quantity attached in the package.",
- "type": "integer"
+ "rateRange": {
+ "description": "Rate Range details like maximum rate amount and minimum rate amount in each available rate category.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/rateRangeType"
+ }
+ }
+ }
+ },
+ "amountType": {
+ "type": "object",
+ "description": "Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description.",
+ "properties": {
+ "base": {
+ "description": "The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements.",
+ "$ref": "#/definitions/totalType"
},
- "excludedQuantity": {
- "description": "The quantity which has been excluded in the package.",
- "type": "integer"
+ "additionalGuestAmounts": {
+ "description": "Collection of incremental charges per age qualifying code for additional guests. Amount charged for additional occupant is with respect to age group of the base guests.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/additionalGuestAmountType"
+ }
},
- "totalQuantity": {
- "description": "The total quantity of the package, calculated based on the calculation rule as defined in the PackageHeaderType.",
- "type": "integer"
+ "discount": {
+ "description": "Discount percentage and/or Amount, code and textual reason for discount",
+ "$ref": "#/definitions/discountType"
+ },
+ "shareRatePercentage": {
+ "description": "Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.",
+ "type": "number",
+ "minimum": 0,
+ "maximum": 100
+ },
+ "shareDistributionInstruction": {
+ "description": "Last rate share distribution instruction applied on share reservation daily rate segment.",
+ "$ref": "#/definitions/shareDistributionInstructionType"
+ },
+ "total": {
+ "description": "The total amount charged for this rate including additional occupant amounts and fees.",
+ "$ref": "#/definitions/totalType"
+ },
+ "requiredPoints": {
+ "description": "The Points contains the number of points required to book a particular room type.",
+ "$ref": "#/definitions/pointsType"
+ },
+ "effectiveRate": {
+ "description": "The reservation effective amount charged for the accommodation or service (i.e. base amount + amount for Add to Rate Combine Line packages) per unit of time",
+ "$ref": "#/definitions/totalType"
+ },
+ "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
}
}
},
- "packageElementType": {
+ "additionalGuestAmountType": {
"type": "object",
"properties": {
- "addRateCombinedLine": {
- "type": "boolean"
+ "amount": {
+ "$ref": "#/definitions/totalType"
},
- "addRateSeprateLine": {
- "type": "boolean"
+ "ageQualifyingCode": {
+ "type": "string",
+ "enum": [
+ "ADULT",
+ "CHILD",
+ "OTHER",
+ "CHILDBUCKET1",
+ "CHILDBUCKET2",
+ "CHILDBUCKET3",
+ "CHILDBUCKET4",
+ "CHILDBUCKET5"
+ ]
+ }
+ }
+ },
+ "discountType": {
+ "type": "object",
+ "description": "Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not specified since logically.",
+ "properties": {
+ "discountReason": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "allowance": {
- "$ref": "#/definitions/currencyAmountType"
+ "percent": {
+ "description": "Percentage discount.",
+ "type": "number"
+ },
+ "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
+ },
+ "discountCode": {
+ "description": "Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
+ }
+ },
+ "shareDistributionInstructionType": {
+ "type": "string",
+ "description": "The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL -> Full Rate for each Sharer. SPLIT-> Split the Rate amount between Sharer Reservations. ENTIRE -> This Sharer will get the total amount of the rate code for all the Sharer Reservations.",
+ "enum": [
+ "Full",
+ "Entire",
+ "Split",
+ "CustomSplit"
+ ]
+ },
+ "rateRangeType": {
+ "type": "object",
+ "description": "Rate Range details like maximum rate amount and minimum rate amount in each available rate category.",
+ "properties": {
+ "base": {
+ "description": "The base amount charged for the accommodation or service.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/totalType"
+ }
},
+ "rateChange": {
+ "description": "Rate Change Indicator.",
+ "type": "boolean"
+ }
+ }
+ },
+ "packageElementType": {
+ "type": "object",
+ "properties": {
"amount": {
"$ref": "#/definitions/currencyAmountType"
},
- "calculationRule": {
- "type": "string"
+ "allowance": {
+ "$ref": "#/definitions/currencyAmountType"
},
"description": {
"type": "array",
"maxItems": 4000,
"items": {
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
}
},
+ "startDate": {
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
"endDate": {
"type": "string",
"format": "date",
"maxLength": 8
},
- "endTime": {
+ "packageCode": {
"type": "string"
},
- "includedInRate": {
- "type": "boolean"
- },
- "packageCode": {
+ "calculationRule": {
"type": "string"
},
"postingRhythm": {
@@ -29153,737 +26720,1185 @@
"quantity": {
"type": "integer"
},
- "sellSeparate": {
+ "includedInRate": {
"type": "boolean"
},
- "startDate": {
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "addRateSeprateLine": {
+ "type": "boolean"
+ },
+ "addRateCombinedLine": {
+ "type": "boolean"
},
"startTime": {
"type": "string"
+ },
+ "endTime": {
+ "type": "string"
+ },
+ "sellSeparate": {
+ "type": "boolean"
}
}
},
- "packagePostingRhythmType": {
- "description": "Package Posting rhythm type.",
+ "reservationProfileType": {
"type": "object",
"properties": {
- "certainNightsOfTheWeek": {
- "description": "Post the package on certain nights of the week.",
+ "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"
+ },
+ "reservationProfileType": {
+ "$ref": "#/definitions/resProfileTypeType"
+ }
+ }
+ },
+ "profileType": {
+ "type": "object",
+ "description": "Type provides the detailed information about the profile and its children.",
+ "properties": {
+ "customer": {
+ "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"
+ },
+ "addresses": {
+ "description": "List of customer addresses.",
"type": "object",
"properties": {
- "friday": {
- "type": "boolean"
+ "addressInfo": {
+ "description": "Collection of Detailed information on an address for the customer.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/addressInfoType"
+ }
},
- "monday": {
+ "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"
},
- "saturday": {
- "type": "boolean"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "sunday": {
- "type": "boolean"
+ "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
+ },
+ "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
+ },
+ "influenceCode": {
+ "description": "Influence Code associated to the profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "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"
+ }
},
- "thursday": {
+ "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"
},
- "tuesday": {
- "type": "boolean"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "wednesday": {
- "type": "boolean"
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
}
}
},
- "customNightSchedule": {
- "description": "The start and end of the posting period is determined as follows: If the package is attached to a rate code: The period starts with the date when the rate code to which the package is attached becomes effective for the stay. The period ends with the date of the last night for that rate code (or the last night of the stay if the rate code remains in effect until the departure date). If the package is attached separately to the reservation: The Begin Date specified on the reservation when the package was attached is the start date for the period. The End Date specified on the reservation when the package was attached is the end date for the period. If no Begin Date and/or End Date are specified when the package is attached to the reservation, the Begin Date is assumed to be the arrival date and the End Date is assumed to be the departure date of the reservation, irrespective of when the package is attached to the reservation.",
+ "emails": {
+ "description": "List of email address for the customer.",
"type": "object",
"properties": {
- "night1": {
- "description": "Night 1 indicator.",
- "type": "boolean"
+ "emailInfo": {
+ "description": "Collection of Detailed information on an eMail address for the customer.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/emailInfoType"
+ }
},
- "night10": {
- "description": "Night 10 indicator.",
+ "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"
},
- "night11": {
- "description": "Night 11 indicator.",
- "type": "boolean"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "night12": {
- "description": "Night 12 indicator.",
- "type": "boolean"
+ "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"
+ }
},
- "night13": {
- "description": "Night 13 indicator.",
+ "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"
},
- "night14": {
- "description": "Night 14 indicator.",
- "type": "boolean"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "night2": {
- "description": "Night 2 indicator.",
- "type": "boolean"
+ "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"
+ }
},
- "night3": {
- "description": "Night 3 indicator.",
+ "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"
},
- "night4": {
- "description": "Night 4 indicator.",
- "type": "boolean"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "night5": {
- "description": "Night 5 indicator.",
- "type": "boolean"
+ "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"
+ }
},
- "night6": {
- "description": "Night 6 indicator.",
+ "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"
},
- "night7": {
- "description": "Night 7 indicator.",
- "type": "boolean"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "night8": {
- "description": "Night 8 indicator.",
- "type": "boolean"
+ "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"
+ }
},
- "night9": {
- "description": "Night 9 indicator.",
+ "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"
}
}
},
- "customStaySchedule": {
- "description": "This user defined schedule lets you enter a posting rhythm over a 14-day period, starting with the arrival date, by assigning the day (number) within a guest stay for posting this package price.",
+ "preferenceCollection": {
+ "description": "List of customer preferences.",
"type": "object",
"properties": {
- "night1": {
- "description": "Night 1 indicator.",
- "type": "boolean"
+ "preferenceType": {
+ "description": "Collection of Detailed information on preferences of the customer.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/preferenceTypeType"
+ }
},
- "night10": {
- "description": "Night 10 indicator.",
+ "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"
},
- "night11": {
- "description": "Night 11 indicator.",
- "type": "boolean"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "night12": {
- "description": "Night 12 indicator.",
- "type": "boolean"
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
+ }
+ }
+ },
+ "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"
+ }
},
- "night13": {
- "description": "Night 13 indicator.",
+ "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"
},
- "night14": {
- "description": "Night 14 indicator.",
- "type": "boolean"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "night2": {
- "description": "Night 2 indicator.",
- "type": "boolean"
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
+ }
+ }
+ },
+ "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"
+ }
},
- "night3": {
- "description": "Night 3 indicator.",
+ "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"
},
- "night4": {
- "description": "Night 4 indicator.",
- "type": "boolean"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "night5": {
- "description": "Night 5 indicator.",
- "type": "boolean"
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
+ }
+ }
+ },
+ "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"
+ }
},
- "night6": {
- "description": "Night 6 indicator.",
+ "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"
},
- "night7": {
- "description": "Night 7 indicator.",
- "type": "boolean"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "night8": {
- "description": "Night 8 indicator.",
- "type": "boolean"
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
+ }
+ }
+ },
+ "profileIndicators": {
+ "description": "Indicators of additional information attached to the profile",
+ "$ref": "#/definitions/indicatorsType"
+ },
+ "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"
+ }
},
- "night9": {
- "description": "Night 9 indicator.",
+ "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"
}
}
},
- "everyXNightsStartingNightY": {
- "description": "Post the package every X nights Staring from Night Y.",
+ "relationshipsSummary": {
+ "description": "Contains a collection of profiles that have a relationship with this profile.",
"type": "object",
"properties": {
- "postEveryXNights": {
- "description": "Occurance of nights when the package needs to be posted and consumed.",
+ "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"
},
- "startOnNightY": {
- "description": "Starting night for consumption and posting prices.",
+ "count": {
+ "description": "Total number of rows returned",
"type": "integer"
}
}
},
- "type": {
- "description": "Posting Rhythm for the package.",
- "$ref": "#/definitions/postingRhythmType"
- }
- }
- },
- "packagePostingRulesType": {
- "type": "object",
- "properties": {
- "alternateCodesList": {
- "description": "The alternate transaction code that can be consumed by the guest in place of the transaction code.",
+ "reservationInfoList": {
+ "description": "Collection of Detailed information on history and future reservations associated with the profile.",
+ "$ref": "#/definitions/reservationHistoryFutureInfoType"
+ },
+ "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.",
+ "$ref": "#/definitions/profileAccessType"
+ },
+ "profileRestrictions": {
+ "description": "Detailed information on restrictions associated with the profile.",
+ "$ref": "#/definitions/profileRestrictions"
+ },
+ "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"
+ },
+ "cashiering": {
+ "description": "Contains cashiering related details for the profile",
+ "$ref": "#/definitions/profileCashieringType"
+ },
+ "commissionInfoList": {
+ "description": "Contains commission related details for the profile.",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/packageTransactionCodeType"
+ "$ref": "#/definitions/profileCommissionType"
}
},
- "lossCode": {
- "description": "The transaction code to record package Loss, if any, from un-consumed allowance.",
- "$ref": "#/definitions/packageTransactionCodeType"
- },
- "overageCode": {
- "description": "The overage code to record over consumed allowance.",
- "$ref": "#/definitions/packageTransactionCodeType"
+ "userDefinedFields": {
+ "description": "Collections of user defined fields.",
+ "$ref": "#/definitions/userDefinedFieldsType"
},
- "profitCode": {
- "description": "The transaction code to record package profit, if any, from un-consumed allowance.",
- "$ref": "#/definitions/packageTransactionCodeType"
+ "webUserAccounts": {
+ "description": "List of Web User Accounts of the profile.",
+ "$ref": "#/definitions/webUserAccountsType"
},
- "transactionCode": {
- "description": "The Transaction code used to post the package price.",
- "$ref": "#/definitions/packageTransactionCodeType"
- }
- }
- },
- "packageTransactionCodeType": {
- "type": "object",
- "properties": {
- "code": {
- "description": "Posting / transaction code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "taxInfo": {
+ "description": "Profile information about tax.",
+ "$ref": "#/definitions/profileTaxInfoType"
},
- "description": {
- "description": "The description of the code.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "salesInfo": {
+ "description": "Sales information of the profiles.",
+ "$ref": "#/definitions/salesInfoType"
},
- "type": {
- "description": "Code is inclusive or exclusive of other chanrges such as taxes.",
- "$ref": "#/definitions/amountDeterminationType"
- }
- }
- },
- "paragraphType": {
- "description": "An indication of a new paragraph for a sub-section of a formatted text message.",
- "type": "object",
- "properties": {
- "image": {
- "description": "An image for this paragraph.",
- "type": "string"
+ "eCertificates": {
+ "description": "E-Certificate assosiated with the profile.",
+ "$ref": "#/definitions/eCertificatesType"
},
- "text": {
- "description": "Formatted text content.",
- "$ref": "#/definitions/formattedTextTextType"
+ "subscriptions": {
+ "description": "List of profile subscriptions.",
+ "$ref": "#/definitions/profileSubscriptionListType"
},
- "url": {
- "description": "A URL for this paragraph.",
- "type": "string"
- }
- }
- },
- "parameterType": {
- "description": "Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined.",
- "type": "object",
- "properties": {
- "parameterName": {
- "description": "Name of the parameter.",
- "type": "string"
+ "localizationGuestType": {
+ "description": "Localization Guest Type assocaited to the profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "parameterValue": {
- "description": "Value of the parameter.",
- "type": "string"
- }
- }
- },
- "parametersType": {
- "description": "Collection of generic Name-Value-Pair parameters.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/parameterType"
- }
- },
- "payeeInfoType": {
- "description": "Payee information.",
- "type": "object",
- "properties": {
- "payeeAccountInfo": {
- "description": "AR account short info of the payee.",
- "$ref": "#/definitions/aRAccountShortInfoType"
+ "eligibleForFiscalFolio": {
+ "description": "Eligible for Fiscal Folio/Payload generation.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "payeeAddress": {
- "description": "Address of the payee.",
- "$ref": "#/definitions/addressInfoType"
+ "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"
+ }
+ }
},
- "payeeAddressCount": {
- "description": "Payee multiple address count.",
- "type": "integer"
+ "profileType": {
+ "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.",
+ "$ref": "#/definitions/profileTypeType"
},
- "payeeId": {
- "description": "Opera name id of the payee.",
- "$ref": "#/definitions/uniqueID_Type"
+ "statusCode": {
+ "description": "Status of the profile. Active/Inactive",
+ "$ref": "#/definitions/profileStatusType"
},
- "payeeName": {
- "description": "Name of the payee.",
+ "registeredProperty": {
+ "description": "Hotel which this profile is registered with. This attribute is not used for configuration.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "payeeReferenceCurrency": {
- "description": "Reference currency of the payee.",
+ "requestForHotel": {
+ "description": "Hotel which this profile is to be registered. This attribute is only used during creation of profile.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "payeeTaxNumber": {
- "description": "The tax number of the payee.",
+ "protectedBy": {
+ "description": "What level this profile is protected.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
- }
- }
- },
- "paymentMethodsSummaryType": {
- "type": "object",
- "properties": {
- "establishedCount": {
- "description": "Reservations count with payment method established.",
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
"type": "string",
- "maxLength": 4,
- "minLength": 4
+ "format": "date-time"
},
- "unestablishedCount": {
- "description": "Reservations count with no payment method established.",
+ "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
+ },
+ "purgeDate": {
+ "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
"type": "string",
- "maxLength": 4,
- "minLength": 4
+ "format": "date",
+ "maxLength": 8
+ },
+ "markAsRecentlyAccessed": {
+ "description": "Mark this profile as recently accessed.",
+ "type": "boolean"
+ },
+ "markForHistory": {
+ "description": "\"true\" setting marks the profile to be kept from being purged, once the profile is marked inactive.",
+ "type": "boolean"
+ },
+ "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"
}
}
},
- "personNameType": {
- "description": "This provides name information for a person.",
+ "customerType": {
"type": "object",
+ "description": "Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.",
"properties": {
- "envelopeGreeting": {
- "description": "Envelope Greeting of the profile",
+ "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"
},
- "externalSystem": {
- "description": "When name type is external, indicates the external system the name belongs to.",
+ "currencyCode": {
+ "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "givenName": {
- "description": "Given name, first name or names.",
+ "currencySymbol": {
+ "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "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})*"
},
- "middleName": {
- "description": "The middle name of the person name.",
+ "nationality": {
+ "description": "Nationality code identification",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "namePrefix": {
- "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)",
+ "nationalityDescription": {
+ "description": "Nationality code description",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "nameSuffix": {
- "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)",
+ "customerValue": {
+ "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "nameTitle": {
- "description": "Degree or honors (e.g., Ph.D., M.D.)",
+ "creditRating": {
+ "description": "Credit Rating of the customer.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "nameTitleSuffix": {
- "description": "Title Suffix. Must be populated if ADVANCED_TITLE is on.",
- "type": "integer"
+ "minLength": 0,
+ "maxLength": 20
},
- "nameType": {
- "description": "Type of name of the individual, such as former, nickname, alternate or alias name.",
- "$ref": "#/definitions/personNameTypeType"
+ "vipStatus": {
+ "description": "VIP status of the customer.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "salutation": {
- "description": "Salutation of the profile",
- "type": "string"
+ "vipDescription": {
+ "description": "Description of the VIP status.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "surname": {
- "description": "Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.",
+ "birthPlace": {
+ "description": "Place of birth.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "privateProfile": {
+ "description": "This element tells profile is property exclusive or not.",
+ "type": "boolean"
+ },
+ "blacklist": {
+ "description": "This element tells if profile is blacklisted or not.",
+ "type": "boolean"
}
}
},
- "personNameTypeType": {
- "description": "Person's name in an external system.",
- "type": "string",
- "enum": [
- "Primary",
- "Alternate",
- "Incognito",
- "External",
- "Phonetic"
- ]
- },
- "phoneNumberType": {
- "description": "Phone number",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "pkgInventoryItemType": {
+ "identificationInfoType": {
"type": "object",
+ "description": "Information on the identification of the customer.",
"properties": {
- "articleNumber": {
- "description": "Article Number of the inventory item.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "identification": {
+ "description": "Detailed information on the identification of the customer.",
+ "$ref": "#/definitions/identificationType"
},
- "description": {
- "description": "Description of the inventory item.",
+ "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",
- "maxLength": 200,
- "minLength": 0
- },
- "itemId": {
- "description": "Identifier for the inventory item.",
- "type": "integer"
+ "minLength": 0,
+ "maxLength": 80
},
- "quantity": {
- "description": "Quantity of the inventory item allocated to the package.",
- "type": "integer"
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "pointsType": {
- "description": "The Redeem Points contains the number of points required to book a room type.",
+ "identificationType": {
"type": "object",
+ "description": "Identification information of the customer.",
"properties": {
- "awardsType": {
- "description": "Awards type for the award type rate code.",
- "type": "string"
+ "idType": {
+ "description": "Identification Type. Eg Passport, Driving License etc.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "points": {
- "description": "No of points required to book this Room Stay.",
- "type": "integer"
+ "idNumber": {
+ "description": "Identification Number.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "idNumberMasked": {
+ "description": "Masked Identification Number.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "issuedCountry": {
+ "description": "The country where Identification was issued.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "issuedDate": {
+ "description": "Issued date of Identification.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "issuedPlace": {
+ "description": "The place where Identification was issued.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "expirationDate": {
+ "description": "Expiration date of Identification.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "registeredProperty": {
+ "description": "Property where the identification belongs to.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "primaryInd": {
+ "description": "When true, indicates a primary information.",
+ "type": "boolean"
+ },
+ "orderSequence": {
+ "description": "Display Order sequence.",
+ "type": "number"
}
}
},
- "policyAmountPercentType": {
- "description": "Defines the percentage basis for calculating the fee amount or the amount.",
+ "alienInfoType": {
"type": "object",
+ "description": "immigration/visa information of a foreign person.",
"properties": {
- "amount": {
- "description": "A monetary amount.",
- "type": "number"
- },
- "basisType": {
- "description": "Provides the basis for how the amount of the guarantee is calculated.",
- "$ref": "#/definitions/policyBasisTypeType"
+ "alienRegistrationNo": {
+ "description": "Alien Registration Number.",
+ "type": "string"
},
- "currencyCode": {
- "description": "Provides a currency code to reflect the currency in which an amount may be expressed.",
+ "immigrationStatus": {
+ "description": "Immigration Status on an Alien.",
"type": "string",
- "maxLength": 3,
- "minLength": 3
- },
- "nights": {
- "description": "The number of nights of the hotel stay that are used to calculate the fee amount.",
- "type": "integer"
+ "minLength": 0,
+ "maxLength": 40
},
- "percent": {
- "description": "The percentage used to calculate the amount.",
- "type": "number",
- "maximum": 100,
- "minimum": 0
+ "visaValidityType": {
+ "description": "Visa Type of an Alien.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "policyBasisTypeType": {
- "description": "Full Amount.",
- "type": "string",
- "enum": [
- "FlatAmount",
- "Percentage",
- "Nights",
- "NightPercentage",
- "FullAmount"
- ]
- },
- "policyDeadlineType": {
- "description": "Cancellation deadline, absolute or relative.",
+ "companyInfoType": {
"type": "object",
+ "description": "Company Information of the Profile.",
"properties": {
- "absoluteDeadline": {
- "description": "Defines the absolute deadline. Either this or the offset attributes may be used.",
+ "legalCompany": {
+ "description": "Legal Company.",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 20
},
- "offsetDropTime": {
- "description": "Time on offset day the cancellation penalties applies.",
+ "department": {
+ "description": "Department of the Profile.",
"type": "string",
- "format": "date-time"
- },
- "offsetFromArrival": {
- "description": "The number of days before arrival that allows cancellation without penalties.",
- "type": "integer"
+ "minLength": 0,
+ "maxLength": 20
},
- "offsetFromBookingDate": {
- "description": "The number of days after booking deposit must be paid.",
- "type": "integer"
+ "position": {
+ "description": "Business Title or Position of the profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "postingRhythmType": {
- "description": "Simple type for posting Rhythm types.",
- "type": "string",
- "enum": [
- "EveryNight",
- "ArrivalNight",
- "EveryXNightsStartingNightY",
- "CertainNightsOfTheWeek",
- "LastNight",
- "EveryNightExceptArrivalNight",
- "EveryNightExceptLast",
- "EveryNightExceptFirstAndLast",
- "CustomStaySchedule",
- "CustomNightSchedule",
- "FloatingAllowancePerStay",
- "TicketPosting"
- ]
- },
- "preferenceType": {
- "description": "Guest Preference details for the profile.",
+ "companyType": {
"type": "object",
"properties": {
- "copyToProfile": {
- "description": "Specifies whether to copy the reservation preference to the profile or not.",
- "type": "boolean"
+ "companyName": {
+ "description": "Name of the company.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "description": {
- "description": "Preference Description for display purposes.",
+ "companyName2": {
+ "description": "Second Name of the company.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "excludedPreferencesCount": {
- "description": "Specifies the count of preferences excluded for the attached reservation preference.",
- "type": "integer"
+ "companyName3": {
+ "description": "Third Name of the company.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "global": {
- "description": "Whether this preference is property specific or not.",
- "type": "boolean"
+ "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
},
- "hotels": {
- "description": "If specified preference belongs to the Hotels listed, otherwise it is a global preference.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
+ "alternateLanguage": {
+ "description": "Alternate Language of the company.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "preferenceId": {
+ "businessLocale": {
+ "description": "A jurisdiction(Territory) in which a company is authorized to do business.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "preferenceValue": {
- "description": "Preference value for display purposes.",
+ "iATAInfo": {
+ "description": "IATA Information of the profile.",
+ "$ref": "#/definitions/iATAInfoType"
+ },
+ "businessTitle": {
+ "description": "Business Title.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "source": {
- "description": "Source of the preference.",
+ "currencyCode": {
+ "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
- }
- }
- },
- "preferenceTypeType": {
- "description": "Preference details for the profile.",
- "type": "object",
- "properties": {
- "availableQuantity": {
- "description": "Available quantity of preferences (maximum quantity - Existing preferences)per preference group.",
+ "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"
},
- "createDateTime": {
- "description": "Time stamp of the creation.",
+ "language": {
+ "description": "Language identification.",
"type": "string",
- "format": "date-time"
+ "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
},
- "creatorId": {
- "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.",
+ "nationality": {
+ "description": "Nationality code identification",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "nationalityDescription": {
+ "description": "Nationality code description",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
+ "commissionCode": {
+ "description": "Commission code of the company.",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 20
},
- "maxQuantity": {
- "description": "Maximum quantity of preferences allowed per preference group.",
- "type": "integer"
+ "creditRating": {
+ "description": "Credit Rating of the company.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "maxResortUsedQuantity": {
- "description": "Maximum quantity of preferences used by any resort per preference group.",
- "type": "integer"
+ "corporateIdType": {
+ "description": "The type of corporate ID",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "preference": {
- "description": "Collection of Preferences for the profile.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/preferenceType"
- }
+ "vipStatus": {
+ "description": "VIP status of the company.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "preferenceType": {
- "description": "Preference group code.",
+ "vipDescription": {
+ "description": "Description of the VIP status.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "preferenceTypeDescription": {
- "description": "Preference group description.",
- "type": "string"
+ "blacklist": {
+ "description": "This element tells if profile is blacklisted or not.",
+ "type": "boolean"
+ }
+ }
+ },
+ "iATAInfoType": {
+ "type": "object",
+ "description": "IATA Information of the profile.",
+ "properties": {
+ "iATACompany": {
+ "description": "IATA Company Detail.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "purgeDate": {
- "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
+ "iATAConsortia": {
+ "description": "IATA Consortia.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 40
},
- "reservationPreference": {
- "description": "Whether this preference is reservation preference or not.",
+ "iATAValidationResult": {
+ "description": "IATA Validation Result.",
"type": "boolean"
- },
- "sequence": {
- "description": "Preference Sequence.",
- "type": "string"
}
}
},
- "prepaidCardDetailsType": {
- "description": "Prepaid Card Details.",
+ "imageSetType": {
"type": "object",
+ "description": "Represents on image set record.",
"properties": {
- "activateDate": {
- "description": "Holds fixed charge detail.",
+ "language": {
+ "description": "Language identification.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
},
- "balanceTotal": {
- "description": "Holds fixed charge detail.",
- "$ref": "#/definitions/currencyAmountType"
+ "imageSet": {
+ "description": "The image set name.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 800
},
- "creditTotal": {
- "description": "Holds fixed charge detail.",
- "$ref": "#/definitions/currencyAmountType"
+ "sequenceId": {
+ "description": "The image set sequence ID.",
+ "type": "integer"
},
- "debitTotal": {
- "description": "Holds fixed charge detail.",
- "$ref": "#/definitions/currencyAmountType"
+ "imageStyle": {
+ "description": "The image set enumerated style.",
+ "$ref": "#/definitions/imageStyleType"
},
- "expiredDate": {
- "description": "Holds fixed charge detail.",
+ "imageType": {
+ "description": "The image set type.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 80
},
- "initialCreditTotal": {
- "description": "Holds fixed charge detail.",
- "$ref": "#/definitions/currencyAmountType"
+ "hotelId": {
+ "description": "The image set hotel code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "initialLoadDate": {
- "description": "Holds fixed charge detail.",
+ "chainCode": {
+ "description": "The image set chain code.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "reservedTotal": {
- "description": "Holds fixed charge detail.",
- "$ref": "#/definitions/currencyAmountType"
+ "imageURL": {
+ "description": "The image set URL.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "transactions": {
- "description": "Holds fixed charge detail.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/prepaidCardTransactionType"
- }
+ "description": {
+ "description": "The image set description.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "validUntilDate": {
- "description": "Holds fixed charge detail.",
+ "imageOrder": {
+ "description": "The image set order.",
+ "type": "integer"
+ },
+ "website": {
+ "description": "The image set website.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "prepaidCardTransactionType": {
- "description": "Prepaid Card transaction.",
+ "imageStyleType": {
+ "type": "string",
+ "description": "An enumeration of image styles.",
+ "enum": [
+ "Full",
+ "Thumbnail",
+ "Icon",
+ "Square",
+ "Banner",
+ "Button",
+ "Lowres",
+ "Highres"
+ ]
+ },
+ "uRLInfoType": {
"type": "object",
+ "description": "Web site address.",
"properties": {
- "amount": {
- "description": "Prepaid Card Amount.",
- "$ref": "#/definitions/currencyAmountType"
+ "url": {
+ "description": "Provides URL information.",
+ "$ref": "#/definitions/uRLType"
+ },
+ "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
+ }
+ }
+ },
+ "uRLType": {
+ "type": "object",
+ "description": "Web site address, in IETF(The Internet Engineering Task Force) specified format.",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "Property Value"
+ },
+ "type": {
+ "description": "Defines the purpose of the URL address, such as personal, business, public, etc.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "typeDescription": {
+ "description": "Describes the Type code",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "primaryInd": {
+ "description": "When true, indicates a primary information.",
+ "type": "boolean"
+ },
+ "orderSequence": {
+ "description": "Display Order sequence.",
+ "type": "number"
+ }
+ }
+ },
+ "commentInfoType": {
+ "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"
},
"createDateTime": {
"description": "Time stamp of the creation.",
@@ -29893,3868 +27908,4558 @@
"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",
- "maxLength": 200,
- "minLength": 0
- },
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "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
+ },
"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
},
- "transactionDate": {
- "description": "Transaction number of the Prepaid card transaction.",
+ "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",
- "format": "date",
- "maxLength": 8
- },
- "transactionNo": {
- "description": "Transaction number of the Prepaid card transaction.",
- "type": "number"
+ "minLength": 0,
+ "maxLength": 80
},
- "transactionType": {
- "description": "Transaction type enumeration.",
- "$ref": "#/definitions/prepaidCardTrxTypeType"
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "prepaidCardTrxTypeType": {
- "description": "Reload transaction.",
- "type": "string",
- "enum": [
- "Activate",
- "Cancel",
- "Cashout",
- "Inquiry",
- "Issue",
- "Redeem",
- "Reload"
- ]
- },
- "prepaidCardType": {
- "description": "Holds fixed charge information.",
+ "commentType": {
"type": "object",
+ "description": "An indication of a new paragraph for a sub-section of a formatted text message.",
"properties": {
- "amount": {
- "description": "Prepaid Card Amount.",
- "$ref": "#/definitions/currencyAmountType"
+ "text": {
+ "description": "Formatted text content.",
+ "$ref": "#/definitions/formattedTextTextType"
},
- "cardDetails": {
- "description": "Prepaid Card details from vendor.",
- "$ref": "#/definitions/prepaidCardDetailsType"
+ "image": {
+ "description": "An image for this paragraph.",
+ "type": "string"
},
- "cardNo": {
- "description": "Prepaid card / account number.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "url": {
+ "description": "A URL for this paragraph.",
+ "type": "string"
},
- "cardNumberMasked": {
- "description": "Masked Prepaid card / account number.",
+ "commentTitle": {
+ "description": "Specifies Comment's Title.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 4000
},
- "createDateTime": {
- "description": "Time stamp of the creation.",
+ "notificationLocation": {
+ "description": "Notification Location associated with the Note.",
"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.",
+ "type": {
+ "description": "Specifies type of the comment.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "firstName": {
- "description": "Given name, first name or names.",
+ "typeDescription": {
+ "description": "Comment type Description.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "giftCard": {
- "description": "Indicates a gift card type.",
+ "internal": {
+ "description": "When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.",
+ "type": "boolean"
+ },
+ "confidential": {
+ "description": "When true, the comment may be confidential.",
+ "type": "boolean"
+ },
+ "overrideInternal": {
+ "description": "When true, the note internal could be modified.",
+ "type": "boolean"
+ },
+ "protectDescription": {
+ "description": "When true, the note title will be populated from the note type description and couldn't be modified.",
"type": "boolean"
},
"hotelId": {
- "description": "Hotel context for the Reservations.",
+ "description": "If specified comment belongs to the Hotel, otherwise it is a global comment.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "interfaceId": {
- "description": "The unique ID for the Interface.",
- "$ref": "#/definitions/uniqueID_Type"
+ "actionType": {
+ "description": "Specifies type of action described in the comments.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "actionDate": {
+ "description": "Indicates at which date an action described in the comment must be taken.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
"type": "string",
"format": "date-time"
},
- "name": {
- "description": "Family name, last name or Company Name.",
+ "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",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "pinCode": {
- "description": "Prepaid card pin code.",
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
"type": "string",
- "maxLength": 10,
- "minLength": 0
+ "format": "date-time"
},
- "profileId": {
- "description": "Card / Account holder name ID",
- "$ref": "#/definitions/profileId"
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
"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
+ }
+ }
+ },
+ "formattedTextTextType": {
+ "type": "object",
+ "description": "Provides text and indicates whether it is formatted or not.",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "Property Value"
},
- "reservationId": {
- "description": "The unique ID of the reservation to which this record applies.",
- "$ref": "#/definitions/reservationId"
+ "language": {
+ "description": "Language identification.",
+ "type": "string",
+ "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
}
}
},
- "prepaidCardsType": {
- "description": "Holds fixed charge detail.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/prepaidCardType"
+ "profileDeliveryMethod": {
+ "type": "object",
+ "description": "Delivery Information type to the profile.",
+ "properties": {
+ "deliveryId": {
+ "description": "Delivery ID. It will be empty in case of new delivery method.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "deliveryType": {
+ "description": "Delivery type can have a value EMAIL, ELECTRONIC etc and it depends on the parameter set in OPERA Control.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "deliveryValue": {
+ "description": "Delivery value holds the corresponding value of the delivery type..",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "hotelId": {
+ "description": "Property that has delivery methods configured.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "deliveryModule": {
+ "description": "Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..",
+ "$ref": "#/definitions/profileDeliveryModuleType"
+ },
+ "primaryInd": {
+ "description": "When true, indicates a primary information.",
+ "type": "boolean"
+ },
+ "orderSequence": {
+ "description": "Display Order sequence.",
+ "type": "number"
+ }
}
},
- "primaryShareTypeType": {
+ "profileDeliveryModuleType": {
"type": "string",
+ "description": "Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..",
"enum": [
- "Primary",
- "NonPrimary"
+ "EfolioExport"
]
},
- "privacyInfoType": {
- "description": "Defines Privacy related information for the profile.",
+ "profileMembershipType": {
"type": "object",
+ "description": "Detailed information of the memberships.",
"properties": {
- "allowEmail": {
- "description": "Indicates if the profile wishes to allow Email.",
- "type": "boolean"
+ "comment": {
+ "description": "Additional comments regarding to the membership.",
+ "$ref": "#/definitions/paragraphType"
},
- "allowPhone": {
- "description": "Indicates if the profile wishes to allow phone calls.",
- "type": "boolean"
+ "newMembershipNumber": {
+ "description": "Card Number of the membership.",
+ "type": "string"
},
- "allowSMS": {
- "description": "Indicates if the profile wishes to allow SMS.",
- "type": "boolean"
+ "nameOnCard": {
+ "description": "Name to be displayed on the membership card.",
+ "type": "string"
},
- "autoEnrollLoyaltyProgram": {
- "description": "Indicates if the profile wishes to be automatically enrolled in the property's loyalty program.",
- "type": "boolean"
+ "programDescription": {
+ "description": "Description of the membership program.",
+ "type": "string"
},
- "infoFromThirdParty": {
- "description": "Indicates if the profile is ok getting info from third parties.",
- "type": "boolean"
+ "membershipLevel": {
+ "description": "Indicates the membership level.",
+ "type": "string"
},
- "lastPrivacyPromptDate": {
- "description": "Indicate the last privacy prompt date of the guest.",
+ "membershipLevelDescription": {
+ "description": "Indicates the membership level description.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 200
},
- "marketResearchParticipation": {
- "description": "Indicates if the profile participates in market research.",
- "type": "boolean"
+ "membershipClass": {
+ "description": "Indicates the membership class.",
+ "type": "string"
},
- "optInAutoEnrollmentMember": {
- "description": "Indicates if the profile wishes to opt in for Auto Enrolment Member.",
- "type": "boolean"
+ "earningPreference": {
+ "description": "Earning preference to the membership.",
+ "$ref": "#/definitions/membershipEarningPreferenceType"
},
- "optInEmail": {
- "description": "Indicates if the profile wishes to opt in for Email.",
+ "inactive": {
+ "description": "Indicates whether membership is active or inactive.",
"type": "boolean"
},
- "optInMailingList": {
- "description": "Indicates if the profile wishes to opt in for Mailing List.",
- "type": "boolean"
+ "benefits": {
+ "description": "benefits for the membership.",
+ "$ref": "#/definitions/benefitsType"
},
- "optInMarketResearch": {
- "description": "Indicates if the profile wishes to opt in for Market Research.",
+ "tierAdministration": {
+ "description": "Defines the degree of participation for this membership in the tier management portion of the program.",
+ "$ref": "#/definitions/tierAdministrationType"
+ },
+ "downgrade": {
+ "description": "Defines how downgrading will be handled for this membership.",
+ "$ref": "#/definitions/downgradeType"
+ },
+ "reIssueNewCard": {
+ "description": "The status of issuing new membership card to the member.",
+ "$ref": "#/definitions/cardReIssueType"
+ },
+ "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"
},
- "optInPhone": {
- "description": "Indicates if the profile wishes to opt in for Phone.",
+ "upgradeDescription": {
+ "description": "Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 32000
+ },
+ "downgradeDescription": {
+ "description": "Indicates information regarding the member's possible downgrades.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 32000
+ },
+ "rating": {
+ "description": "Value Rating Type Description for this membership.",
+ "type": "string"
+ },
+ "membershipEnrollmentCode": {
+ "description": "Indicates how the guest enrolled in the program.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "memberStatus": {
+ "description": "Indicates where the guest is in the membership enrollment process.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "currentPoints": {
+ "description": "Profile MemberShip Points.",
+ "type": "number"
+ },
+ "pointsLabel": {
+ "description": "Label used to refer to points for this membership type",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "enrollmentSource": {
+ "description": "Source from where the enrollment is done.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "enrollmentResort": {
+ "description": "Resort/CRO where enrollment is done.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "preferredCard": {
+ "description": "Preferred Card.",
"type": "boolean"
},
- "optInSms": {
- "description": "Indicates if the profile wishes to opt in for SMS.",
+ "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.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 1
+ },
+ "primaryMembership": {
+ "description": "Boolean indicator set to True implies membership is a Primary Membership.",
"type": "boolean"
},
- "optInThirdParty": {
- "description": "Indicates if the profile wishes to opt in for Third Party.",
+ "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.",
"type": "boolean"
- }
- }
- },
- "processCommissionPayments": {
- "description": "Request type for processing commission payments.",
- "type": "object",
- "properties": {
- "criteria": {
- "description": "Criteria for actual commission payments processing.",
- "$ref": "#/definitions/processCommissionPaymentsCriteriaType"
},
- "links": {
- "$ref": "#/definitions/links"
+ "signupDate": {
+ "description": "Indicates when the member signed up for the loyalty program.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "processCommissionPaymentsCriteriaType": {
- "description": "Generic commission criteria including hotel code, bank account id, agent id, reservation id and/or commission id",
- "type": "object",
- "properties": {
- "agentId": {
- "description": "Unique travel agent or source profile ID.",
- "$ref": "#/definitions/uniqueID_Type"
+ "effectiveDate": {
+ "description": "Indicates the starting date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "bankAccountId": {
- "description": "Unique id of bank account.",
- "$ref": "#/definitions/uniqueID_Type"
+ "expireDate": {
+ "description": "Indicates the ending date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "checkNo": {
- "description": "If payment method is check, this serves as the start check number of checks to be printed.",
+ "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"
},
- "commissionId": {
- "description": "Unique id of the commission.",
- "$ref": "#/definitions/uniqueID_Type"
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
+ "type": "string",
+ "format": "date-time"
},
- "hotelId": {
- "description": "Property of the commission record .",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "resvNameId": {
- "description": "Unique reservation name ID.",
- "$ref": "#/definitions/uniqueID_Type"
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
+ "type": "string",
+ "format": "date-time"
},
- "timeSpan": {
- "description": "Date range that will be included on payment processing.",
- "$ref": "#/definitions/timeSpanType"
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ },
+ "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
}
}
},
- "processCommissionPaymentsStatus": {
- "description": "Response type for processing commission payments.",
+ "paragraphType": {
"type": "object",
+ "description": "An indication of a new paragraph for a sub-section of a formatted text message.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "text": {
+ "description": "Formatted text content.",
+ "$ref": "#/definitions/formattedTextTextType"
},
- "paymentReport": {
- "description": "Contains report id, batch id (for check payments) or export file (for eft payments)",
- "$ref": "#/definitions/commissionPaymentReportType"
+ "image": {
+ "description": "An image for this paragraph.",
+ "type": "string"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "url": {
+ "description": "A URL for this paragraph.",
+ "type": "string"
}
}
},
- "productSourceType": {
- "description": "Sources of Products",
+ "membershipEarningPreferenceType": {
"type": "string",
+ "description": "The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.",
"enum": [
- "Reservation",
- "RateHeader",
- "RateDetail"
+ "Points",
+ "Miles"
]
},
- "profileAccessType": {
+ "benefitsType": {
+ "type": "array",
+ "description": "Basic information about membership benefit.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/benefitType"
+ }
+ },
+ "benefitType": {
"type": "object",
+ "description": "Basic information about membership benefit.",
"properties": {
- "chainCode": {
- "description": "Indicates the Chain code where the profile was created",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "croCode": {
- "description": "Indicates the CRO code where the profile was created",
+ "code": {
+ "description": "Benefit code associated with a membership.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "hotelId": {
- "description": "Indicates the Hotel code where the profile was created",
+ "message": {
+ "description": "Processing message for membership benefit.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 4000
},
- "sharedLevel": {
- "description": "Indicates whether the profile is shared at the following levels : global/property/CRO",
- "$ref": "#/definitions/profileSharedLevelType"
+ "inactive": {
+ "description": "Indicates whether membership benefit is active or inactive.",
+ "type": "boolean"
}
}
},
- "profileCashieringDetailType": {
- "description": "The type contains routing instructions for the profile.",
+ "tierAdministrationType": {
+ "type": "string",
+ "description": "Do not upgrade membership. The membership may be downgraded.",
+ "enum": [
+ "Disabled",
+ "NoUpgrade"
+ ]
+ },
+ "downgradeType": {
+ "type": "string",
+ "description": "Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.",
+ "enum": [
+ "Grace",
+ "Never",
+ "Period"
+ ]
+ },
+ "cardReIssueType": {
+ "type": "string",
+ "description": "Request to re issue a new card.",
+ "enum": [
+ "Pending",
+ "NotApplicable",
+ "Requested"
+ ]
+ },
+ "preferenceTypeType": {
"type": "object",
+ "description": "Preference details for the profile.",
"properties": {
- "eCommerceId": {
- "description": "E-Commerce ID of the Profile",
- "$ref": "#/definitions/uniqueID_Type"
+ "preference": {
+ "description": "Collection of Preferences for the profile.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/preferenceType"
+ }
},
- "fiscalGuestType": {
- "description": "Guest type code.",
+ "preferenceType": {
+ "description": "Preference group code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "hotelId": {
- "description": "Hotel Code for which the routing instructions are provided for a profile.",
+ "preferenceTypeDescription": {
+ "description": "Preference group description.",
+ "type": "string"
+ },
+ "sequence": {
+ "description": "Preference Sequence.",
+ "type": "string"
+ },
+ "maxQuantity": {
+ "description": "Maximum quantity of preferences allowed per preference group.",
+ "type": "integer"
+ },
+ "availableQuantity": {
+ "description": "Available quantity of preferences (maximum quantity - Existing preferences)per preference group.",
+ "type": "integer"
+ },
+ "maxResortUsedQuantity": {
+ "description": "Maximum quantity of preferences used by any resort per preference group.",
+ "type": "integer"
+ },
+ "reservationPreference": {
+ "description": "Whether this preference is reservation preference or not.",
+ "type": "boolean"
+ },
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "paymentMethod": {
- "description": "Payment Method Details.",
- "$ref": "#/definitions/codeDescriptionType"
+ "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
},
- "routingInstructions": {
- "description": "Set of preconfigured transaction codes.",
- "$ref": "#/definitions/profileRoutingInstructionsType"
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
+ "type": "string",
+ "format": "date-time"
},
- "taxType": {
- "description": "Tax type code.",
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ },
+ "purgeDate": {
+ "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
}
}
},
- "profileCashieringType": {
- "description": "Contains cashiering related details for the profile",
+ "preferenceType": {
"type": "object",
+ "description": "Guest Preference details for the profile.",
"properties": {
- "arNoCentral": {
- "description": "Account Receivables Central Number.",
+ "preferenceValue": {
+ "description": "Preference value for display purposes.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "autoFolioSettlementType": {
- "description": "Contains the auto folio settlement type for the profile.",
+ "description": {
+ "description": "Preference Description for display purposes.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "currencyCode": {
- "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "global": {
+ "description": "Whether this preference is property specific or not.",
+ "type": "boolean"
},
- "currencySymbol": {
- "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.",
+ "source": {
+ "description": "Source of the preference.",
"type": "string",
- "maxLength": 10,
- "minLength": 0
- },
- "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"
+ "minLength": 0,
+ "maxLength": 40
},
- "directBillingList": {
- "description": "Contains the direct billing related information for the profile.",
+ "hotels": {
+ "description": "If specified preference belongs to the Hotels listed, otherwise it is a global preference.",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/directBillingType"
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
}
},
- "paymentDueDays": {
- "description": "Ability to define on the account, the number of days after which the invoice should be paid.",
- "type": "integer"
- },
- "referenceCurrency": {
- "description": "Reference Currency.",
+ "preferenceId": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "taxPercent1": {
- "description": "Tax1 Percentage for Collecting Agent.",
- "type": "integer"
- },
- "taxPercent2": {
- "description": "Tax2 Percentage for Collecting Agent.",
- "type": "integer"
+ "minLength": 0,
+ "maxLength": 20
},
- "taxPercent3": {
- "description": "Tax3 Percentage for Collecting Agent.",
+ "excludedPreferencesCount": {
+ "description": "Specifies the count of preferences excluded for the attached reservation preference.",
"type": "integer"
},
- "taxPercent4": {
- "description": "Tax4 Percentage for Collecting Agent.",
- "type": "integer"
+ "copyToProfile": {
+ "description": "Specifies whether to copy the reservation preference to the profile or not.",
+ "type": "boolean"
+ }
+ }
+ },
+ "keywordType": {
+ "type": "object",
+ "properties": {
+ "keywordDetail": {
+ "description": "The keyword new value, in case keyword value is modified.",
+ "$ref": "#/definitions/keywordDetailType"
},
- "taxPercent5": {
- "description": "Tax5 Percentage for Collecting Agent.",
- "type": "integer"
+ "type": {
+ "description": "The type of keyword",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "vATOffsetYN": {
- "description": "VAT Offset Flag.",
+ "keyword": {
+ "description": "The keyword value.",
"type": "string",
- "maxLength": 1,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
}
}
},
- "profileCommissionType": {
- "description": "This is the preconfigured routing instruction type.",
+ "keywordDetailType": {
"type": "object",
"properties": {
- "bankAccount": {
- "description": "Bank account used for the commission for a profile.",
+ "newKeyword": {
+ "description": "The new keyword value.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
+ }
+ }
+ },
+ "negotiatedType": {
+ "type": "object",
+ "description": "This holds a list of NegotiatedInfoType.",
+ "properties": {
+ "negotiatedInfoList": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/negotiatedInfoType"
+ }
},
- "commissionCode": {
- "description": "commission Code for a profile.",
+ "hotelId": {
+ "description": "Hotel code for the negotiated rate.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "currencyCode": {
- "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
+ "rateCode": {
+ "description": "Rate plan code for the negotiated rate.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
+ }
+ },
+ "negotiatedInfoType": {
+ "type": "object",
+ "description": "This provides information for a profile negotiated rate.",
+ "properties": {
+ "corporateAgreementId": {
+ "description": "The master identifier for multiple offices/locations under the same company profile. This is optional",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "currencySymbol": {
- "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.",
+ "comissionCode": {
+ "description": "Informational purposes only in numeric format.",
"type": "string",
- "maxLength": 10,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "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).",
+ "order": {
+ "description": "The sell order.",
"type": "integer"
},
- "hotelId": {
- "description": "Hotel Code for the commission being used for a profile.",
+ "inactive": {
+ "description": "Negotiated Rate is inactive or not",
+ "type": "boolean"
+ },
+ "start": {
+ "description": "The starting value of the date range.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "paymentMethod": {
- "description": "Type of payment associated with the bank account.",
- "$ref": "#/definitions/commissionPaymentMethods"
+ "end": {
+ "description": "The ending value of the date range.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
}
}
},
- "profileDeliveryMethod": {
- "description": "Delivery Information type to the profile.",
+ "gdsNegotiatedType": {
"type": "object",
+ "description": "This holds a list of GdsNegotiatedInfoType.",
"properties": {
- "deliveryId": {
- "description": "Delivery ID. It will be empty in case of new delivery method.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "deliveryModule": {
- "description": "Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..",
- "$ref": "#/definitions/profileDeliveryModuleType"
- },
- "deliveryType": {
- "description": "Delivery type can have a value EMAIL, ELECTRONIC etc and it depends on the parameter set in OPERA Control.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "gdsNegotiatedInfoList": {
+ "description": "List of channel negotiated rates for the profile.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/gdsNegotiatedInfoType"
+ }
},
- "deliveryValue": {
- "description": "Delivery value holds the corresponding value of the delivery type..",
+ "bookingChannelCode": {
+ "description": "Booking Channel Code.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
"hotelId": {
- "description": "Property that has delivery methods configured.",
+ "description": "Hotel Code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "orderSequence": {
- "description": "Display Order sequence.",
- "type": "number"
+ "minLength": 0,
+ "maxLength": 20
},
- "primaryInd": {
- "description": "When true, indicates a primary information.",
- "type": "boolean"
+ "channelRatePlanCode": {
+ "description": "Channel Room Type.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "profileDeliveryModuleType": {
- "description": "Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..",
- "type": "string",
- "enum": [
- "EfolioExport"
- ]
- },
- "profileId": {
- "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).",
+ "gdsNegotiatedInfoType": {
"type": "object",
+ "description": "This provides information for a channel negotiated rate.",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "accessCode": {
+ "description": "The GDS negotiated rate code.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
+ "order": {
+ "description": "The sell order.",
"type": "integer"
},
- "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",
- "maxLength": 80,
- "minLength": 0
+ "inactive": {
+ "description": "The GDS Negotiated Rate is inactive or not",
+ "type": "boolean"
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "start": {
+ "description": "The starting value of the date range.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "end": {
+ "description": "The ending value of the date range.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
}
}
},
- "profileIdList": {
- "description": "Unique Id that references an object uniquely in the system.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/uniqueID_Type"
- }
- },
- "profileMembershipType": {
- "description": "Detailed information of the memberships.",
+ "relationshipInfoType": {
"type": "object",
+ "description": "Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.",
"properties": {
- "benefits": {
- "description": "benefits for the membership.",
- "$ref": "#/definitions/benefitsType"
+ "changeRelationship": {
+ "description": "Information about the changes in relationship for the profile",
+ "$ref": "#/definitions/changeRelationsType"
},
- "centralSetup": {
- "description": "Indicates how the award points for this membership type will be managed.",
- "type": "boolean"
+ "relationshipProfile": {
+ "description": "Refer to Relationship Profile type document.",
+ "$ref": "#/definitions/relationshipProfileType"
},
- "comment": {
- "description": "Additional comments regarding to the membership.",
- "$ref": "#/definitions/paragraphType"
+ "masterAccountInfo": {
+ "description": "Refer to Master Profile type document.",
+ "$ref": "#/definitions/masterAccountInfoType"
},
- "createDateTime": {
- "description": "Time stamp of the creation.",
+ "id": {
+ "description": "Relationship identifier.",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 80
},
- "creatorId": {
- "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.",
+ "relation": {
+ "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "currentPoints": {
- "description": "Profile MemberShip Points.",
- "type": "number"
+ "relationDescription": {
+ "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
- "downgrade": {
- "description": "Defines how downgrading will be handled for this membership.",
- "$ref": "#/definitions/downgradeType"
+ "targetRelation": {
+ "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "downgradeDescription": {
- "description": "Indicates information regarding the member's possible downgrades.",
+ "targetRelationDescription": {
+ "description": "Displays the description of the target relation(Target Profile).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ }
+ }
+ },
+ "changeRelationsType": {
+ "type": "object",
+ "description": "Detailed information regarding the changes made to relationships for the profile.",
+ "properties": {
+ "id": {
+ "description": "Relationship identifier.",
"type": "string",
- "maxLength": 32000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "earningPreference": {
- "description": "Earning preference to the membership.",
- "$ref": "#/definitions/membershipEarningPreferenceType"
+ "relation": {
+ "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "effectiveDate": {
- "description": "Indicates the starting date.",
+ "relationDescription": {
+ "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 200
},
- "enrollmentResort": {
- "description": "Resort/CRO where enrollment is done.",
+ "targetRelation": {
+ "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "enrollmentSource": {
- "description": "Source from where the enrollment is done.",
+ "targetRelationDescription": {
+ "description": "Displays the description of the target relation(Target Profile).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
+ }
+ }
+ },
+ "relationshipProfileType": {
+ "type": "object",
+ "properties": {
+ "customer": {
+ "description": "Detailed information of the customer",
+ "$ref": "#/definitions/customerType"
},
- "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"
+ "company": {
+ "description": "Detailed information of the Company.",
+ "$ref": "#/definitions/companyType"
},
- "expireDate": {
- "description": "Indicates the ending date.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "telephone": {
+ "description": "Information on telephone details for the customer/company",
+ "$ref": "#/definitions/telephoneInfoType"
},
- "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"
+ "address": {
+ "description": "Information on address details for the customer/company",
+ "$ref": "#/definitions/addressInfoType"
},
- "inactive": {
- "description": "Indicates whether membership is active or inactive.",
- "type": "boolean"
+ "email": {
+ "description": "Information on email address for the customer/company",
+ "$ref": "#/definitions/emailInfoType"
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "uRLs": {
+ "description": "Information on web url/address for the customer/company",
+ "$ref": "#/definitions/uRLInfoType"
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
- "type": "string",
- "format": "date-time"
+ "primaryOwner": {
+ "description": "Primary Owner of the profile",
+ "$ref": "#/definitions/ownerType"
},
- "memberStatus": {
- "description": "Indicates where the guest is in the membership enrollment process.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "profileIdList": {
+ "description": "Original profile details for which the relationships was created",
+ "$ref": "#/definitions/uniqueIDListType"
},
- "membershipClass": {
- "description": "Indicates the membership class.",
- "type": "string"
+ "changeProfileIdList": {
+ "description": "Updated/changed profile details for the relationships created",
+ "$ref": "#/definitions/uniqueIDListType"
},
- "membershipEnrollmentCode": {
- "description": "Indicates how the guest enrolled in the program.",
+ "primary": {
+ "description": "Indicates if this relationship is the primary relationship.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "membershipId": {
- "description": "Card Number of the membership.",
- "type": "string"
+ "id": {
+ "description": "Relationship identifier.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "membershipIdNo": {
- "description": "Membership ID Number.",
- "type": "integer"
+ "statusCode": {
+ "description": "Status of the profile. Active/Inactive",
+ "$ref": "#/definitions/profileStatusType"
},
- "membershipLevel": {
- "description": "Indicates the membership level.",
- "type": "string"
+ "profileType": {
+ "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.",
+ "$ref": "#/definitions/profileTypeType"
+ }
+ }
+ },
+ "ownerType": {
+ "type": "object",
+ "description": "Generic type for information about an owner.",
+ "properties": {
+ "hotel": {
+ "description": "Hotel to which the owner belongs to.",
+ "$ref": "#/definitions/codeDescriptionType"
},
- "membershipLevelDescription": {
- "description": "Indicates the membership level description.",
+ "userId": {
+ "description": "Unique application user ID.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "userName": {
+ "description": "Unique application user name of the owner.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "membershipType": {
- "description": "Type of membership.",
- "type": "string"
+ "ownerCode": {
+ "description": "Unique Code to identify the owner.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "nameOnCard": {
- "description": "Name to be displayed on the membership card.",
- "type": "string"
+ "profileId": {
+ "description": "Unique owner profile information.",
+ "$ref": "#/definitions/profileId"
},
- "newMembershipNumber": {
- "description": "Card Number of the membership.",
- "type": "string"
+ "name": {
+ "description": "Provides name information of the owner.",
+ "$ref": "#/definitions/personNameType"
},
- "orderSequence": {
- "description": "Display Order sequence.",
- "type": "number"
+ "department": {
+ "description": "Department to which the owner belongs to.",
+ "$ref": "#/definitions/codeDescriptionType"
},
- "playerRanking": {
- "description": "Ranking assigned to the Player Profile by the Gaming system.",
- "type": "integer"
+ "email": {
+ "description": "Email information of the owner.",
+ "$ref": "#/definitions/emailInfoType"
},
- "pointsLabel": {
- "description": "Label used to refer to points for this membership type",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "phone": {
+ "description": "Information on the telephone number of the owner.",
+ "$ref": "#/definitions/telephoneInfoType"
},
- "preferredCard": {
- "description": "Preferred Card.",
- "type": "boolean"
+ "relationship": {
+ "description": "Relationship of the owner within the profile or block.",
+ "$ref": "#/definitions/codeDescriptionType"
},
- "primaryMembership": {
- "description": "Boolean indicator set to True implies membership is a Primary Membership.",
+ "primary": {
+ "description": "When true, this is a primary owner.",
"type": "boolean"
+ }
+ }
+ },
+ "uniqueIDListType": {
+ "type": "array",
+ "description": "Unique Id that references an object uniquely in the system.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/uniqueID_Type"
+ }
+ },
+ "profileStatusType": {
+ "type": "string",
+ "enum": [
+ "Active",
+ "Inactive"
+ ]
+ },
+ "masterAccountInfoType": {
+ "type": "object",
+ "properties": {
+ "masterAccountId": {
+ "description": "Unique ID of the Master account.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "primaryMembershipYn": {
- "description": "Indicator if Membership is a Primary Membership.",
+ "masterAccountName": {
+ "description": "Name of the Master account.",
"type": "string",
- "maxLength": 1,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
+ }
+ }
+ },
+ "relationshipInfoSummaryType": {
+ "type": "object",
+ "description": "RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.",
+ "properties": {
+ "relationshipProfile": {
+ "description": "Refer to Relationship Profile Summary type document.",
+ "$ref": "#/definitions/relationshipProfileSummaryType"
},
- "programDescription": {
- "description": "Description of the membership program.",
- "type": "string"
+ "masterAccountDetails": {
+ "description": "Refer to Master Profile type document.",
+ "$ref": "#/definitions/masterAccountInfoType"
},
- "purgeDate": {
- "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
+ "relationshipID": {
+ "description": "Relationship identifier.",
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "rating": {
- "description": "Value Rating Type Description for this membership.",
- "type": "string"
+ "minLength": 0,
+ "maxLength": 80
},
- "reIssueNewCard": {
- "description": "The status of issuing new membership card to the member.",
- "$ref": "#/definitions/cardReIssueType"
+ "sourceRelation": {
+ "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "signupDate": {
- "description": "Indicates when the member signed up for the loyalty program.",
+ "sourceRelationDescription": {
+ "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 200
},
- "tierAdministration": {
- "description": "Defines the degree of participation for this membership in the tier management portion of the program.",
- "$ref": "#/definitions/tierAdministrationType"
+ "targetRelation": {
+ "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "upgradeDescription": {
- "description": "Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.",
+ "targetRelationDescription": {
+ "description": "Displays the description of the target relation(Target Profile).",
"type": "string",
- "maxLength": 32000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
}
}
},
- "profileNameType": {
- "description": "This provides name information for a person.",
+ "relationshipProfileSummaryType": {
"type": "object",
"properties": {
- "fullName": {
- "description": "Full display Name.",
+ "customerName": {
+ "description": "Name of the customer",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "givenName": {
- "description": "Given name, first name or names.",
+ "companyName": {
+ "description": "Name of the company.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "middleName": {
- "description": "The middle name of the person name.",
+ "telephoneNumber": {
+ "description": "Telephone number assigned to a single location",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "name": {
- "description": "Family name, last name or Company Name.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "address": {
+ "description": "Information on address details for the customer/company",
+ "$ref": "#/definitions/relationshipAddressType"
},
- "namePrefix": {
- "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)",
+ "emailAddress": {
+ "description": "Defines the e-mail address.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "nameSuffix": {
- "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)",
+ "ownerCode": {
+ "description": "Unique Code to identify the owner.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "nameTitle": {
- "description": "Degree or honors (e.g., Ph.D., M.D.)",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "profileIdList": {
+ "description": "Original profile details for which the relationships was created",
+ "$ref": "#/definitions/uniqueIDListType"
},
- "nameType": {
- "description": "Type of name of the individual, such as former, nickname, alternate or alias name.",
- "$ref": "#/definitions/personNameTypeType"
+ "primary": {
+ "description": "Indicates if this relationship is the primary relationship.",
+ "type": "boolean"
+ },
+ "profileStatus": {
+ "description": "Status of the profile. Active/Inactive",
+ "$ref": "#/definitions/profileStatusType"
+ },
+ "primaryOwnerCode": {
+ "description": "When true, this is a primary owner.",
+ "type": "boolean"
+ },
+ "profileType": {
+ "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.",
+ "$ref": "#/definitions/profileTypeType"
}
}
},
- "profileRestrictions": {
+ "relationshipAddressType": {
"type": "object",
+ "description": "Provides address information for a Relationship.",
"properties": {
- "reason": {
- "description": "Restriction reason associated with the current profile.",
+ "addressLine": {
+ "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.",
+ "type": "array",
+ "maxItems": 4,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ }
+ },
+ "city": {
+ "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "reasonDescription": {
- "description": "Description of restriction reason.",
+ "postalCode": {
+ "description": "Post Office Code number.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 15
},
- "restricted": {
- "description": "True indicates there are restrictions associated with the current profile.",
- "type": "boolean"
+ "state": {
+ "description": "State or Province name (e.g., Texas).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "country": {
+ "description": "Country name (e.g., Ireland).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
}
}
},
- "profileRoutingInstructionsType": {
- "description": "The type contains routing instructions for the profile.",
+ "reservationHistoryFutureInfoType": {
"type": "object",
+ "description": "Information of History and Future Reservation details attached to Profiles.",
"properties": {
- "autoPopulateRouting": {
- "description": "A flag which determines whether the instructions has to be automatically populated for this profile or not.",
- "type": "boolean"
- },
- "billingInstructions": {
- "description": "Set of preconfigured Billing Instruction results.",
- "$ref": "#/definitions/billingInstructionsType"
+ "historyList": {
+ "description": "Refer to History list type document.",
+ "$ref": "#/definitions/historyListType"
},
- "transactionCodes": {
- "description": "Set of preconfigured transaction codes.",
- "$ref": "#/definitions/trxCodesInfoType"
+ "futureList": {
+ "description": "Refer to Future list type document.",
+ "$ref": "#/definitions/futureListType"
}
}
},
- "profileSharedLevelType": {
- "description": "Simple types for Shared level.",
- "type": "string",
- "enum": [
- "Global",
- "Property",
- "Cro"
- ]
- },
- "profileStatusType": {
- "type": "string",
- "enum": [
- "Active",
- "Inactive"
- ]
- },
- "profileSubscriptionListType": {
- "description": "Details of the OPERA Profile subscription to external system",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/profileSubscriptionType"
+ "historyListType": {
+ "type": "object",
+ "description": "A collection of reservation history details attached to Profiles.",
+ "properties": {
+ "reservationInfo": {
+ "description": "Additional reservation information attached to the profile . Eg : History reservation details",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationInfoType"
+ }
+ },
+ "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"
+ }
}
},
- "profileSubscriptionType": {
- "description": "Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular external system",
+ "futureListType": {
"type": "object",
+ "description": "A collection of reservation history details attached to Profiles.",
"properties": {
- "distributed": {
- "description": "Indicates if the profile was distributed to the external system.",
+ "reservationInfo": {
+ "description": "Additional reservation information attached to the profile . Eg : Future reservation details",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationInfoType"
+ }
+ },
+ "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"
},
- "externalProfileId": {
- "description": "Profile ID within the external system.",
- "$ref": "#/definitions/uniqueID_Type"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "force": {
- "description": "Indicates if the profile information should be overwritten by the external system.",
- "type": "boolean"
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
+ }
+ }
+ },
+ "reservationStayHistoryFutureInfoType": {
+ "type": "object",
+ "description": "Information of History and Future Reservation details attached to Profiles.",
+ "properties": {
+ "historyList": {
+ "description": "Refer to History list type document.",
+ "$ref": "#/definitions/stayHistoryListType"
},
- "inactive": {
- "description": "Indicates whether this subscription is active or inactive.",
+ "futureList": {
+ "description": "Refer to Future list type document.",
+ "$ref": "#/definitions/stayFutureListType"
+ }
+ }
+ },
+ "stayHistoryListType": {
+ "type": "object",
+ "description": "A collection of reservation history details attached to Profiles.",
+ "properties": {
+ "reservationInfo": {
+ "description": "Additional reservation information attached to the profile . Eg : History reservation details",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$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"
},
- "lastDistributionDate": {
- "description": "Timestamp of the most recent distribution of this profile to the external system.",
- "type": "string",
- "format": "date-time"
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "lastExternalUpdateDate": {
- "description": "Timestamp of the most recent update of the subscription information by the external system.",
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
+ }
+ }
+ },
+ "stayReservationInfoType": {
+ "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"
+ },
+ "roomStay": {
+ "description": "Collection of room stays.",
+ "$ref": "#/definitions/stayInfoType"
+ },
+ "attachedProfiles": {
+ "description": "List of attached profiles",
+ "$ref": "#/definitions/resAttachedProfileListType"
+ },
+ "hotelId": {
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 20
},
- "profileId": {
- "description": "OPERA Profile ID that this subscription record corresponds to.",
- "$ref": "#/definitions/profileId"
+ "reservationStatus": {
+ "description": "Indicates the status of the reservation.",
+ "$ref": "#/definitions/pMS_ResStatusType"
},
- "profileInfo": {
- "description": "This provides name information for a person.",
- "type": "object",
- "properties": {
- "fullName": {
- "description": "Full display Name.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "givenName": {
- "description": "Given name, first name or names.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "middleName": {
- "description": "The middle name of the person name.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "name": {
- "description": "Family name, last name or Company Name.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "namePrefix": {
- "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "nameSuffix": {
- "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "nameTitle": {
- "description": "Degree or honors (e.g., Ph.D., M.D.)",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "nameType": {
- "description": "Type of name of the individual, such as former, nickname, alternate or alias name.",
- "$ref": "#/definitions/personNameTypeType"
- },
- "profileType": {
- "description": "OPERA profile type such as Individual or Company",
- "$ref": "#/definitions/profileTypeType"
- }
+ "computedReservationStatus": {
+ "description": "Indicates the status of the reservation.",
+ "$ref": "#/definitions/pMS_ResStatusType"
+ }
+ }
+ },
+ "stayFutureListType": {
+ "type": "object",
+ "description": "A collection of reservation history details attached to Profiles.",
+ "properties": {
+ "reservationInfo": {
+ "description": "Additional reservation information attached to the profile . Eg : Future reservation details",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/stayReservationInfoType"
}
},
- "subscriptionDate": {
- "description": "Timestamp when the profile was subscribed to.",
- "type": "string",
- "format": "date-time"
+ "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"
},
- "systemCode": {
- "description": "Code of system where profile is subscribed to.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "systemType": {
- "description": "Type of system where profile is subscribed to.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
}
}
},
- "profileTaxInfoType": {
- "description": "Profile information related to tax.",
+ "lastStayInfoType": {
"type": "object",
+ "description": "Contains last stay related details for the profile",
"properties": {
- "businessId": {
- "description": "Business ID. The maximum length of this element should not exceed 120 characters.",
+ "lastVisit": {
+ "description": "Used to hold last stay information for the profile.",
"type": "string",
- "maxLength": 128,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "businessRegistration": {
- "description": "Business Registration Code. The maximum length of this element should not exceed 120 characters.",
- "type": "string",
- "maxLength": 128,
- "minLength": 0
+ "lastRoom": {
+ "description": "Used to hold last room information for the profile.",
+ "type": "string"
},
- "tax1No": {
- "description": "The tax id of this profile. Usually issued by a government agency. Used by 1099 printing.",
+ "lastRate": {
+ "description": "Used to hold last rate information for the profile.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "totalStay": {
+ "description": "The total number of previous stay of the profile.",
+ "type": "integer"
+ }
+ }
+ },
+ "profileAccessType": {
+ "type": "object",
+ "properties": {
+ "chainCode": {
+ "description": "Indicates the Chain code where the profile was created",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "tax2No": {
- "description": "Tax 2 id of this profile.",
+ "croCode": {
+ "description": "Indicates the CRO code where the profile was created",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "taxCategory": {
- "description": "Tax Category to be changed.",
+ "hotelId": {
+ "description": "Indicates the Hotel code where the profile was created",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "taxOffice": {
- "description": "Tax Office to be changed.",
+ "sharedLevel": {
+ "description": "Indicates whether the profile is shared at the following levels : global/property/CRO",
+ "$ref": "#/definitions/profileSharedLevelType"
+ }
+ }
+ },
+ "profileSharedLevelType": {
+ "type": "string",
+ "description": "Simple types for Shared level.",
+ "enum": [
+ "Global",
+ "Property",
+ "Cro"
+ ]
+ },
+ "profileRestrictions": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "description": "Restriction reason associated with the current profile.",
"type": "string",
- "maxLength": 30,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "taxType": {
- "description": "Tax type to be changed.",
+ "reasonDescription": {
+ "description": "Description of restriction reason.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "restricted": {
+ "description": "True indicates there are restrictions associated with the current profile.",
+ "type": "boolean"
}
}
},
- "profileType": {
- "description": "Type provides the detailed information about the profile and its children.",
+ "mailingActionsType": {
"type": "object",
+ "description": "Defines mailing action list for the profile.",
"properties": {
- "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"
- }
- },
- "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"
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- }
- }
- },
- "businessSegments": {
- "description": "Business/Market Segment associated to the profile.",
+ "mailingAction": {
+ "description": "Defines mailing action code and description.",
"type": "array",
"maxItems": 4000,
"items": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "$ref": "#/definitions/codeDescriptionType"
}
},
- "cashiering": {
- "description": "Contains cashiering related details for the profile",
- "$ref": "#/definitions/profileCashieringType"
+ "active": {
+ "description": "When true indicates that profile has subscribed to the mailing list.",
+ "type": "boolean"
},
- "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"
- }
- },
- "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"
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "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"
},
- "commissionInfoList": {
- "description": "Contains commission related details for the profile.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/profileCommissionType"
- }
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
},
- "company": {
- "description": "Detailed company information for this profile.",
- "$ref": "#/definitions/companyType"
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
+ }
+ }
+ },
+ "privacyInfoType": {
+ "type": "object",
+ "description": "Defines Privacy related information for the profile.",
+ "properties": {
+ "marketResearchParticipation": {
+ "description": "Indicates if the profile participates in market research.",
+ "type": "boolean"
},
- "createDateTime": {
- "description": "Time stamp of the creation.",
+ "lastPrivacyPromptDate": {
+ "description": "Indicate the last privacy prompt date of the guest.",
"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.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "infoFromThirdParty": {
+ "description": "Indicates if the profile is ok getting info from third parties.",
+ "type": "boolean"
},
- "customer": {
- "description": "Detailed customer information for this profile.",
- "$ref": "#/definitions/customerType"
+ "autoEnrollLoyaltyProgram": {
+ "description": "Indicates if the profile wishes to be automatically enrolled in the property's loyalty program.",
+ "type": "boolean"
},
- "eCertificates": {
- "description": "E-Certificate assosiated with the profile.",
- "$ref": "#/definitions/eCertificatesType"
+ "allowPhone": {
+ "description": "Indicates if the profile wishes to allow phone calls.",
+ "type": "boolean"
},
- "eligibleForFiscalFolio": {
- "description": "Eligible for Fiscal Folio/Payload generation.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "allowSMS": {
+ "description": "Indicates if the profile wishes to allow SMS.",
+ "type": "boolean"
},
- "emails": {
- "description": "List of email address for the customer.",
- "type": "object",
- "properties": {
- "count": {
- "description": "Total number of rows returned",
- "type": "integer"
- },
- "emailInfo": {
- "description": "Collection of Detailed information on an eMail address for the customer.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/emailInfoType"
- }
- },
- "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"
- }
- }
+ "allowEmail": {
+ "description": "Indicates if the profile wishes to allow Email.",
+ "type": "boolean"
},
- "gdsNegotiatedRates": {
- "description": "List of channel negotiated rates that this profile has been assigned to.",
- "type": "object",
- "properties": {
- "count": {
- "description": "Total number of rows returned",
- "type": "integer"
- },
- "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"
- }
- }
+ "optInMailingList": {
+ "description": "Indicates if the profile wishes to opt in for Mailing List.",
+ "type": "boolean"
},
- "hasCommission": {
- "description": "Populates true if the profile has commission configured false otherwise.",
+ "optInMarketResearch": {
+ "description": "Indicates if the profile wishes to opt in for Market Research.",
"type": "boolean"
},
- "influenceCode": {
- "description": "Influence Code associated to the profile.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "optInThirdParty": {
+ "description": "Indicates if the profile wishes to opt in for Third Party.",
+ "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.",
+ "optInAutoEnrollmentMember": {
+ "description": "Indicates if the profile wishes to opt in for Auto Enrolment Member.",
"type": "boolean"
},
- "keywords": {
- "description": "List of customer keywords.",
- "type": "object",
- "properties": {
- "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"
- },
- "keyword": {
- "description": "Collection of keywords attached to the profile.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/keywordType"
- }
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- }
- }
+ "optInPhone": {
+ "description": "Indicates if the profile wishes to opt in for Phone.",
+ "type": "boolean"
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
- "type": "string",
- "format": "date-time"
- },
- "lastStayInfo": {
- "description": "Information on last stay of the profile.",
- "$ref": "#/definitions/lastStayInfoType"
- },
- "localizationGuestType": {
- "description": "Localization Guest Type assocaited to the profile.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "mailingActions": {
- "description": "Contains collection of mailing action list associated with the profile",
- "$ref": "#/definitions/mailingActionsType"
- },
- "markAsRecentlyAccessed": {
- "description": "Mark this profile as recently accessed.",
+ "optInSms": {
+ "description": "Indicates if the profile wishes to opt in for SMS.",
"type": "boolean"
},
- "markForHistory": {
- "description": "\"true\" setting marks the profile to be kept from being purged, once the profile is marked inactive.",
+ "optInEmail": {
+ "description": "Indicates if the profile wishes to opt in for Email.",
"type": "boolean"
- },
- "negotiatedRates": {
- "description": "List of profile negotiated rates.",
- "type": "object",
- "properties": {
- "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"
- },
- "negotiatedRate": {
- "description": "Collection of Detailed information on profile negotiated rates.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/negotiatedType"
- }
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- }
+ }
+ }
+ },
+ "profileCashieringType": {
+ "type": "object",
+ "description": "Contains cashiering related details for the profile",
+ "properties": {
+ "directBillingList": {
+ "description": "Contains the direct billing related information for the profile.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/directBillingType"
}
},
- "ownerCode": {
- "description": "Owner Code associated to the profile.",
+ "autoFolioSettlementType": {
+ "description": "Contains the auto folio settlement type for the profile.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "preferenceCollection": {
- "description": "List of customer preferences.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- }
- },
- "privacyInfo": {
- "description": "Contains privacy related information associated with the profile",
- "$ref": "#/definitions/privacyInfoType"
- },
- "profileAccessType": {
- "description": "Detailed information on access type associated with the profile.",
- "$ref": "#/definitions/profileAccessType"
- },
- "profileDeliveryMethods": {
- "description": "List of Delivery methods configured against a Property for this Profile.",
- "type": "object",
- "properties": {
- "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"
- },
- "profileDeliveryMethod": {
- "description": "Collection of delivery methods for this Profile.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/profileDeliveryMethod"
- }
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- }
- }
+ "minLength": 0,
+ "maxLength": 40
},
- "profileImage": {
- "description": "The profile image.",
- "$ref": "#/definitions/imageSetType"
+ "paymentDueDays": {
+ "description": "Ability to define on the account, the number of days after which the invoice should be paid.",
+ "type": "integer"
},
- "profileIndicators": {
- "description": "Indicators of additional information attached to the profile",
- "$ref": "#/definitions/indicatorsType"
+ "taxPercent1": {
+ "description": "Tax1 Percentage for Collecting Agent.",
+ "type": "integer"
},
- "profileMemberships": {
- "description": "List of loyalty program(s) the profile is subscribed to.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- }
+ "taxPercent2": {
+ "description": "Tax2 Percentage for Collecting Agent.",
+ "type": "integer"
},
- "profileRestrictions": {
- "description": "Detailed information on restrictions associated with the profile.",
- "$ref": "#/definitions/profileRestrictions"
+ "taxPercent3": {
+ "description": "Tax3 Percentage for Collecting Agent.",
+ "type": "integer"
},
- "profileType": {
- "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.",
- "$ref": "#/definitions/profileTypeType"
+ "taxPercent4": {
+ "description": "Tax4 Percentage for Collecting Agent.",
+ "type": "integer"
},
- "protectedBy": {
- "description": "What level this profile is protected.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "taxPercent5": {
+ "description": "Tax5 Percentage for Collecting Agent.",
+ "type": "integer"
},
- "purgeDate": {
- "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
+ "arNoCentral": {
+ "description": "Account Receivables Central Number.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "registeredProperty": {
- "description": "Hotel which this profile is registered with. This attribute is not used for configuration.",
+ "referenceCurrency": {
+ "description": "Reference Currency.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "relationships": {
- "description": "Contains a collection of profiles that have a relationship with this profile.",
- "type": "object",
- "properties": {
- "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"
- },
- "relationship": {
- "description": "A collection of the profiles that have a relationship with this profile.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/relationshipInfoType"
- }
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- }
- }
- },
- "relationshipsSummary": {
- "description": "Contains a collection of profiles that have a relationship with this profile.",
- "type": "object",
- "properties": {
- "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"
- },
- "relationship": {
- "description": "A collection of the profiles summary that have a relationship with this profile.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/relationshipInfoSummaryType"
- }
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- }
- }
+ "minLength": 0,
+ "maxLength": 20
},
- "requestForHotel": {
- "description": "Hotel which this profile is to be registered. This attribute is only used during creation of profile.",
+ "vATOffsetYN": {
+ "description": "VAT Offset Flag.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "reservationInfoList": {
- "description": "Collection of Detailed information on history and future reservations associated with the profile.",
- "$ref": "#/definitions/reservationHistoryFutureInfoType"
- },
- "roomOwnershipsList": {
- "description": "Room Ownership records.",
- "type": "object",
- "properties": {
- "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"
- },
- "roomOwnershipInfo": {
- "description": "Collection of Detailed information on Room Ownership records.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomOwnershipType"
- }
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- }
- }
- },
- "salesInfo": {
- "description": "Sales information of the profiles.",
- "$ref": "#/definitions/salesInfoType"
- },
- "showInactiveRoomOwners": {
- "description": "Flag to show inactive Room Owners.",
- "type": "boolean"
- },
- "statusCode": {
- "description": "Status of the profile. Active/Inactive",
- "$ref": "#/definitions/profileStatusType"
- },
- "stayReservationInfoList": {
- "description": "Collection of Detailed information on history and future reservations associated with the profile.",
- "$ref": "#/definitions/reservationStayHistoryFutureInfoType"
- },
- "subscriptions": {
- "description": "List of profile subscriptions.",
- "$ref": "#/definitions/profileSubscriptionListType"
- },
- "taxInfo": {
- "description": "Profile information about tax.",
- "$ref": "#/definitions/profileTaxInfoType"
- },
- "telephones": {
- "description": "List of Telephone Number Information",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- }
+ "minLength": 0,
+ "maxLength": 1
},
- "territory": {
- "description": "Territory associated to the profile.",
+ "currencyCode": {
+ "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "traceCode": {
- "description": "Trace Code associated to the profile.",
+ "currencySymbol": {
+ "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "uRLs": {
- "description": "List of Information on a URL for the customer.",
- "type": "object",
- "properties": {
- "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"
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- },
- "uRLInfo": {
- "description": "Collection of Detailed information on web url/address for the customer.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/uRLInfoType"
- }
- }
- }
- },
- "userDefinedFields": {
- "description": "Collections of user defined fields.",
- "$ref": "#/definitions/userDefinedFieldsType"
+ "minLength": 0,
+ "maxLength": 10
},
- "webUserAccounts": {
- "description": "List of Web User Accounts of the profile.",
- "$ref": "#/definitions/webUserAccountsType"
+ "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"
}
}
},
- "profileTypeType": {
- "description": "The types of Profile handled by the web service.",
- "type": "string",
- "enum": [
- "Guest",
- "Agent",
- "Company",
- "Group",
- "Source",
- "Employee",
- "Hotel",
- "Vendor",
- "Contact",
- "Purge",
- "BusinessHeader",
- "BillingAccount",
- "Activity",
- "Potential",
- "Account"
- ]
- },
- "promotionType": {
- "description": "Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.",
+ "directBillingType": {
"type": "object",
+ "description": "This is the preconfigured routing instruction type.",
"properties": {
- "couponCode": {
- "description": "Promotion Coupon Code when promotion is setup to have a valid coupon code.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "promotionCode": {
- "description": "Promotion code associated with the rate plan.",
+ "hotelId": {
+ "description": "Hotel Code for which the details of direct billing is provided for a profile.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "promotionName": {
- "description": "Promotion code Name associated with the rate plan.",
+ "aRNumber": {
+ "description": "Hotel Code for which the details of direct billing is provided for a profile.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "queueReservation": {
- "description": "Request to add a reservation to the Queue for Check-In. A reservation can be added to the queue prior to Check-In on the day of arrival.",
+ "profileCommissionType": {
"type": "object",
+ "description": "This is the preconfigured routing instruction type.",
"properties": {
"hotelId": {
- "description": "Property where the reservation exists.",
- "$ref": "#/definitions/codeType"
- },
- "links": {
- "$ref": "#/definitions/links"
+ "description": "Hotel Code for the commission being used for a profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "reservationId": {
- "description": "Reservation ID of the reservation which is to be added to the queue.",
- "$ref": "#/definitions/reservationId"
+ "commissionCode": {
+ "description": "commission Code for a profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "queueRoomsTextCriteriaType": {
- "description": "Text message criteria type, used to deliver a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).",
- "type": "object",
- "properties": {
- "hotelId": {
- "description": "Resort context of the text message.",
+ "bankAccount": {
+ "description": "Bank account used for the commission for a profile.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "messageType": {
- "description": "Type of text message to be delivered.",
- "$ref": "#/definitions/queueRoomsTextMessageType"
+ "paymentMethod": {
+ "description": "Type of payment associated with the bank account.",
+ "$ref": "#/definitions/commissionPaymentMethods"
},
- "mobileNumber": {
- "description": "Mobile number that the text message will be delivered to.",
+ "currencyCode": {
+ "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "reservationId": {
- "description": "Reservation ID, necessary if the text message will be delivered based on a queued reservation.",
- "$ref": "#/definitions/uniqueID_Type"
+ "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"
}
}
},
- "queueRoomsTextMessageType": {
- "description": "Text message will be delivered via Queue Rush, to housekeeping.",
+ "commissionPaymentMethods": {
"type": "string",
+ "description": "Check",
"enum": [
- "QueueReservation",
- "QueueRush"
+ "Cent",
+ "Eft",
+ "Chk"
]
},
- "queueTextInfoType": {
- "description": "Information regarding the message sent to guest.",
+ "userDefinedFieldsType": {
"type": "object",
+ "description": "A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.",
"properties": {
- "sentBy": {
- "description": "User name of the user who sent message.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "characterUDFs": {
+ "description": "Collection of user defined fields of Character/String Type.",
+ "$ref": "#/definitions/characterUDFsType"
},
- "sentTime": {
- "description": "Time the text was last sent to the user.",
- "type": "string",
- "format": "date-time"
+ "numericUDFs": {
+ "description": "Collection of user defined fields of Numeric Type.",
+ "$ref": "#/definitions/numericUDFsType"
+ },
+ "dateUDFs": {
+ "description": "Collection of user defined fields of Date Type.",
+ "$ref": "#/definitions/dateUDFsType"
}
}
},
- "queuedRoomsTextMessage": {
- "description": "Response for retrieving a predefined text message, for Queue Reservations or Queue Rush.",
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/definitions/links"
- },
- "messageText": {
- "description": "Predefined message text, based on the message type defined in the request.",
- "$ref": "#/definitions/stringLength200"
- },
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
+ "characterUDFsType": {
+ "type": "array",
+ "description": "Used to hold collection of user defined fields of Character/String Type.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/characterUDFType"
}
},
- "rateByAgeBucketType": {
- "description": "Rate amount by age bucket.",
+ "characterUDFType": {
"type": "object",
+ "description": "Used to hold user defined field of Character/String Type.",
"properties": {
- "maximumAge": {
- "description": "Maximum age for age bucket.",
- "type": "integer"
+ "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
},
- "minimumAge": {
- "description": "Minimum age for age bucket.",
- "type": "integer"
+ "value": {
+ "description": "Value of user defined field.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "rateAmount": {
- "description": "Rate amount by age bucket.",
- "type": "number"
+ "alternateName": {
+ "description": "Label of user defined field used by vendors or customers.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "rateByAgeBucketsType": {
- "description": "Rate amount by age bucket.",
+ "numericUDFsType": {
"type": "array",
- "maxItems": 3,
+ "description": "Used to hold collection of user defined fields of Numeric Type.",
+ "maxItems": 4000,
"items": {
- "$ref": "#/definitions/rateByAgeBucketType"
+ "$ref": "#/definitions/numericUDFType"
}
},
- "rateChangeInstructionType": {
- "description": "Defines override rate type.",
+ "numericUDFType": {
"type": "object",
+ "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.",
"properties": {
- "discount": {
- "description": "Discount percentage and/or amount, code and textual reason for discount.",
- "$ref": "#/definitions/discountType"
+ "name": {
+ "description": "Name of user defined field.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "rateChange": {
- "description": "Rate change type.",
- "$ref": "#/definitions/rateChangeType"
+ "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": 2000
}
}
},
- "rateChangeType": {
- "description": "Simple type for rate change type.",
- "type": "string",
- "enum": [
- "Verify",
- "OldRate",
- "NewRate"
- ]
- },
- "ratePlanRatingType": {
- "description": "Possible Rate plan rating values.",
- "type": "string",
- "enum": [
- "MostImportant",
- "Important",
- "SomewhatImportant",
- "LessImportant",
- "LeastImportant",
- "NoValueSet"
- ]
- },
- "rateRangeType": {
- "description": "Rate Range details like maximum rate amount and minimum rate amount in each available rate category.",
- "type": "object",
- "properties": {
- "base": {
- "description": "The base amount charged for the accommodation or service.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/totalType"
- }
- },
- "rateChange": {
- "description": "Rate Change Indicator.",
- "type": "boolean"
- }
+ "dateUDFsType": {
+ "type": "array",
+ "description": "Used to hold collection of user defined fields of Date Type.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/dateUDFType"
}
},
- "ratesType": {
- "description": "Individual rate amount.",
+ "dateUDFType": {
"type": "object",
+ "description": "Used to hold user defined field of Date Type.",
"properties": {
- "rate": {
- "description": "The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/amountType"
- }
+ "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
},
- "rateRange": {
- "description": "Rate Range details like maximum rate amount and minimum rate amount in each available rate category.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/rateRangeType"
- }
+ "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": 2000
}
}
},
- "recalculateCommissionOnCodeChange": {
- "description": "Request type for recalculating commission amount when commission code of unpaid commission is changed.",
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/definitions/links"
- },
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
+ "webUserAccountsType": {
+ "type": "array",
+ "description": "Web User Accounts List.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/webUserAccountType"
}
},
- "recalculateCommissionOnCodeChangeStatus": {
- "description": "Response type for recalculating commission amount when commission code of unpaid commission is changed",
+ "webUserAccountType": {
"type": "object",
+ "description": "Web User Account of the guest.",
"properties": {
- "commissionDetail": {
- "description": "Contains reservation detail information and computed commission amount like gross, tax, prepaid, total.",
- "$ref": "#/definitions/commissionDetailType"
+ "securityQuestion": {
+ "description": "Security Question and its Code associated with the account to verify the user.",
+ "$ref": "#/definitions/codeDescriptionType"
},
- "links": {
- "$ref": "#/definitions/links"
+ "securityAnswer": {
+ "description": "Answer to the Security Question.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "relationshipAddressType": {
- "description": "Provides address information for a Relationship.",
- "type": "object",
- "properties": {
- "addressLine": {
- "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.",
- "type": "array",
- "maxItems": 4,
- "items": {
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- }
+ "comments": {
+ "description": "Comments.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
},
- "city": {
- "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).",
+ "history": {
+ "description": "Web User Account History.",
+ "$ref": "#/definitions/webUserHistoryType"
+ },
+ "newLoginName": {
+ "description": "New Login Name of the guest.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "country": {
- "description": "Country name (e.g., Ireland).",
+ "newPassword": {
+ "description": "Login Password.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "postalCode": {
- "description": "Post Office Code number.",
+ "autoGeneratePassword": {
+ "description": "A flag which determines if the password is auto generated.",
+ "type": "boolean"
+ },
+ "loginName": {
+ "description": "Login Name of the guest.",
"type": "string",
- "maxLength": 15,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "state": {
- "description": "State or Province name (e.g., Texas).",
+ "domainCode": {
+ "description": "Domain code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "locked": {
+ "description": "Boolean flag that indicates whether the web account is locked or not.",
+ "type": "boolean"
+ },
+ "inactive": {
+ "description": "Boolean flag that indicates whether the web account is inactive or not.",
+ "type": "boolean"
}
}
},
- "relationshipInfoSummaryType": {
- "description": "RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.",
+ "webUserHistoryType": {
"type": "object",
+ "description": "Creation date time, Creator Id, last modification date time and last Modifier Id.",
"properties": {
- "masterAccountDetails": {
- "description": "Refer to Master Profile type document.",
- "$ref": "#/definitions/masterAccountInfoType"
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
+ "type": "string",
+ "format": "date-time"
},
- "relationshipID": {
- "description": "Relationship identifier.",
+ "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",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "relationshipProfile": {
- "description": "Refer to Relationship Profile Summary type document.",
- "$ref": "#/definitions/relationshipProfileSummaryType"
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
+ "type": "string",
+ "format": "date-time"
},
- "sourceRelation": {
- "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "sourceRelationDescription": {
- "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
+ "purgeDate": {
+ "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "targetRelation": {
- "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).",
+ "lastLogin": {
+ "description": "Last login date.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "targetRelationDescription": {
- "description": "Displays the description of the target relation(Target Profile).",
+ "lastPasswordChange": {
+ "description": "Last Password change date.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
+ },
+ "inactiveDate": {
+ "description": "Inactive date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
}
}
},
- "relationshipInfoType": {
- "description": "Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.",
+ "profileTaxInfoType": {
"type": "object",
+ "description": "Profile information related to tax.",
"properties": {
- "changeRelationship": {
- "description": "Information about the changes in relationship for the profile",
- "$ref": "#/definitions/changeRelationsType"
- },
- "id": {
- "description": "Relationship identifier.",
+ "tax1No": {
+ "description": "The tax id of this profile. Usually issued by a government agency. Used by 1099 printing.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "masterAccountInfo": {
- "description": "Refer to Master Profile type document.",
- "$ref": "#/definitions/masterAccountInfoType"
+ "tax2No": {
+ "description": "Tax 2 id of this profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "relation": {
- "description": "Indicates the type of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
+ "taxCategory": {
+ "description": "Tax Category to be changed.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "relationDescription": {
- "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).",
+ "taxOffice": {
+ "description": "Tax Office to be changed.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 30
},
- "relationshipProfile": {
- "description": "Refer to Relationship Profile type document.",
- "$ref": "#/definitions/relationshipProfileType"
+ "taxType": {
+ "description": "Tax type to be changed.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "targetRelation": {
- "description": "Displays the type of relationship the Related profile(Target Profile) has with the current profile(Source Profile).",
+ "businessId": {
+ "description": "Business ID. The maximum length of this element should not exceed 120 characters.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 128
},
- "targetRelationDescription": {
- "description": "Displays the description of the target relation(Target Profile).",
+ "businessRegistration": {
+ "description": "Business Registration Code. The maximum length of this element should not exceed 120 characters.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 128
}
}
},
- "relationshipProfileSummaryType": {
+ "salesInfoType": {
"type": "object",
+ "description": "Provides sales information about the profiles of type company, travel agent, source and contact.",
"properties": {
- "address": {
- "description": "Information on address details for the customer/company",
- "$ref": "#/definitions/relationshipAddressType"
+ "scope": {
+ "description": "Defines the scope.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "companyName": {
- "description": "Name of the company.",
+ "scopeCity": {
+ "description": "Defines the scope city.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "customerName": {
- "description": "Name of the customer",
+ "accountType": {
+ "description": "Defines the account type.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "emailAddress": {
- "description": "Defines the e-mail address.",
+ "accountSource": {
+ "description": "Defines the account source.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "ownerCode": {
- "description": "Unique Code to identify the owner.",
+ "industryCode": {
+ "description": "Defines the industry code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "primary": {
- "description": "Indicates if this relationship is the primary relationship.",
- "type": "boolean"
+ "businessSegments": {
+ "description": "Defines the Business segments.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "primaryOwnerCode": {
- "description": "When true, this is a primary owner.",
- "type": "boolean"
+ "priority": {
+ "description": "Defines the priority.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
},
- "profileIdList": {
- "description": "Original profile details for which the relationships was created",
- "$ref": "#/definitions/uniqueIDListType"
+ "roomsPotential": {
+ "description": "Defines the rooms potential.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
},
- "profileStatus": {
- "description": "Status of the profile. Active/Inactive",
- "$ref": "#/definitions/profileStatusType"
+ "actionCode": {
+ "description": "Defines the action code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
},
- "profileType": {
- "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.",
- "$ref": "#/definitions/profileTypeType"
+ "competitionCode": {
+ "description": "Defines the competition code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
},
- "telephoneNumber": {
- "description": "Telephone number assigned to a single location",
+ "influence": {
+ "description": "Defines the influence for the contact profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "preferredRoom": {
+ "description": "Defines the Preferred Room for profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "hotelId": {
+ "description": "Hotel Code used to filter the sales information.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "relationshipProfileType": {
+ "eCertificatesType": {
+ "type": "array",
+ "description": "List of e-certificates for the profile.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/eCertificateType"
+ }
+ },
+ "eCertificateType": {
"type": "object",
+ "description": "E-Certificates details.",
"properties": {
- "address": {
- "description": "Information on address details for the customer/company",
- "$ref": "#/definitions/addressInfoType"
- },
- "changeProfileIdList": {
- "description": "Updated/changed profile details for the relationships created",
- "$ref": "#/definitions/uniqueIDListType"
+ "certificateId": {
+ "description": "System generated unique certificate id.",
+ "type": "integer"
},
- "company": {
- "description": "Detailed information of the Company.",
- "$ref": "#/definitions/companyType"
+ "voucherNo": {
+ "description": "System generated unique voucher number.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "customer": {
- "description": "Detailed information of the customer",
- "$ref": "#/definitions/customerType"
+ "certificateNo": {
+ "description": "Printed certificate no. This has to be unique.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "email": {
- "description": "Information on email address for the customer/company",
- "$ref": "#/definitions/emailInfoType"
+ "eCertificateInfo": {
+ "$ref": "#/definitions/eCertificateInfoType"
},
- "id": {
- "description": "Relationship identifier.",
+ "expiryDate": {
+ "description": "Date of expiry.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "primary": {
- "description": "Indicates if this relationship is the primary relationship.",
+ "newExpiryDate": {
+ "description": "New Date of expiry to extend e-certificate.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "primaryOwner": {
- "description": "Primary Owner of the profile",
- "$ref": "#/definitions/ownerType"
+ "profileId": {
+ "description": "NameId.",
+ "$ref": "#/definitions/profileId"
},
- "profileIdList": {
- "description": "Original profile details for which the relationships was created",
- "$ref": "#/definitions/uniqueIDListType"
+ "consumptionDetail": {
+ "$ref": "#/definitions/eCertificateConsumptionType"
},
- "profileType": {
- "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.",
- "$ref": "#/definitions/profileTypeType"
+ "status": {
+ "description": "Status of the certificate.",
+ "$ref": "#/definitions/eCertificateStatusType"
},
- "statusCode": {
- "description": "Status of the profile. Active/Inactive",
- "$ref": "#/definitions/profileStatusType"
+ "printed": {
+ "description": "Print status of the certificate.",
+ "type": "boolean"
},
- "telephone": {
- "description": "Information on telephone details for the customer/company",
- "$ref": "#/definitions/telephoneInfoType"
+ "inactiveDate": {
+ "description": "Date the record was marked as inactive.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "uRLs": {
- "description": "Information on web url/address for the customer/company",
- "$ref": "#/definitions/uRLInfoType"
- }
- }
- },
- "reprintCommissionCheckByRange": {
- "description": "Request type for reprinting a range of check payments.",
- "type": "object",
- "properties": {
- "criteria": {
- "description": "Contains criteria for reprinting a range of check payments",
- "$ref": "#/definitions/reprintCommissionCheckRangeCriteriaType"
+ "awardId": {
+ "description": "AwardID.",
+ "$ref": "#/definitions/awardId"
},
- "links": {
- "$ref": "#/definitions/links"
+ "databaseId": {
+ "description": "External reference from which the record is created.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "reprintCommissionCheckByRangeStatus": {
- "description": "Response type for reprinting a range of check payments.",
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "source": {
+ "description": "Source of e-certificate.",
+ "$ref": "#/definitions/eCertificateIssueSourceType"
},
- "reprintCheckReport": {
- "description": "Contains report id and batch id",
- "$ref": "#/definitions/commissionPaymentReportType"
+ "issueType": {
+ "description": "Process action issued the certificate. valid values are assigned (a),opt in (o) and purchased (p).",
+ "$ref": "#/definitions/eCertificateIssueType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "issueDate": {
+ "description": "Date when certificate was issued.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "awardPoints": {
+ "description": "Award points if any in case of certificate use membership award.",
+ "type": "integer"
+ },
+ "generationDetail": {
+ "$ref": "#/definitions/eCertificateGenerationType"
+ },
+ "originalVoucherNo": {
+ "description": "In case of in lieu of certificate this will contain the original voucher no.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "originalCertificateNo": {
+ "description": "In case of in lieu of certificate this will contain the original certificate no.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "inLieuSequence": {
+ "description": "Seq of the in lieu of certificate. 1..n. original certificate will be treated as null = 0.",
+ "type": "integer"
+ },
+ "cancelRequestDate": {
+ "description": "Date on which the cancellation was requested.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "extensionCount": {
+ "description": "Number of times e-certificate is already extended.",
+ "type": "integer"
}
}
},
- "reprintCommissionCheckRangeCriteriaType": {
- "description": "Base type for payment activity information",
+ "eCertificateInfoType": {
"type": "object",
+ "description": "E-Certificates details.",
"properties": {
- "allowExistingCheckNo": {
- "description": "Set to true if an existing check number can be used as the starting check number for reprint.",
- "type": "boolean"
+ "certificateType": {
+ "description": "User defined certificate code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "bankAccountId": {
- "description": "Unique id of bank account.",
- "$ref": "#/definitions/uniqueID_Type"
+ "membershipType": {
+ "description": "Membership type to which the certificate is linked to.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "batchId": {
- "description": "Batch id of the commission payments.",
- "$ref": "#/definitions/uniqueID_Type"
+ "awardCode": {
+ "description": "Award type to which the certificate is linked to.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "checkRange": {
- "description": "Check range.",
- "$ref": "#/definitions/numberRangeType"
+ "promotionCode": {
+ "description": "Promotion code to which certificate is attached to.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "hotelId": {
- "description": "Property of the commission record.",
+ "voucherBenefitCode": {
+ "description": "Voucher benefit code attached to the certificate.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "startCheckNo": {
- "description": "Start check no of commission to be applied to the set.",
- "type": "number"
+ "hotels": {
+ "description": "Hotel to which certificate is attached to.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
+ },
+ "scope": {
+ "description": "Scope of e-cert: global,single property or multi property.",
+ "$ref": "#/definitions/eCertificateScopeType"
+ }
+ }
+ },
+ "description": {
+ "description": "Description about the certificate.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ },
+ "longDescription": {
+ "description": "Detail description about the certificate.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
+ },
+ "label": {
+ "description": "Label for the certificate.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "maxExtensionAllowed": {
+ "description": "Number of times e-certificate can be extended.",
+ "type": "integer"
+ },
+ "usageCriteria": {
+ "$ref": "#/definitions/eCertificateUsageCriteriaType"
+ },
+ "value": {
+ "description": "Value of the certificate for the guest.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "cost": {
+ "description": "Cost of certificate.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "benefitSummary": {
+ "description": "Summary of Benefits attached to this ECertificate.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
}
}
},
- "requestActionType": {
- "type": "string",
- "enum": [
- "Create",
- "Remove",
- "Query"
- ]
- },
- "resAccessRestrictionType": {
- "description": "Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.",
+ "eCertificateScopeType": {
"type": "string",
+ "description": "Indicates that OPERA E-Certificate is available for a specific list of hotels.",
"enum": [
- "Change",
- "Cancel",
- "ChangeOrCancel"
+ "Global",
+ "Hotel",
+ "MultiHotel"
]
},
- "resAccompanyGuestInfoType": {
+ "eCertificateUsageCriteriaType": {
"type": "object",
+ "description": "E-Certificates details.",
"properties": {
- "firstName": {
- "description": "Given name, first name or names",
- "type": "string"
+ "reservation": {
+ "description": "Indicates if certificate is to be used against reservation or not.",
+ "type": "boolean"
},
- "fullName": {
- "description": "String representation of the full name",
- "type": "string"
+ "web": {
+ "description": "Indicates if web certificate can be consumed in OWS.",
+ "type": "boolean"
},
- "lastName": {
- "description": "Family name, last name.",
- "type": "string"
+ "webAllowed": {
+ "description": "Indicates if certificate consumption allowable on the web.",
+ "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"
+ "benefit": {
+ "description": "Indicates to attach a rate code to the e-certificate as a benefit.",
+ "type": "boolean"
},
- "registrationCardNo": {
- "description": "Unique identifier of the police registration card number.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- }
- }
- },
- "resAccompanyGuestListType": {
- "description": "Collection of accompany guests",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/resAccompanyGuestInfoType"
- }
- },
- "resAttachedProfileListType": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/resAttachedProfileType"
- }
- },
- "resAttachedProfileType": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Attached profile name",
- "type": "string"
+ "hotel": {
+ "description": "Indicates if web certificate can be consumed in hotel.",
+ "type": "boolean"
},
- "profileIdList": {
- "description": "Collection of unique profile identifiers",
- "$ref": "#/definitions/profileIdList"
+ "verifyCertificateNo": {
+ "description": "Specify if the certificate number verification is required at time of consumption or not.",
+ "type": "boolean"
},
- "reservationProfileType": {
- "$ref": "#/definitions/resProfileTypeType"
+ "cancelAllowed": {
+ "description": "Identify if cancel is allowed or not.",
+ "type": "boolean"
+ },
+ "generateInLieuCertificate": {
+ "description": "Identify if in lieu of certificate can be generated or not.",
+ "type": "boolean"
}
}
},
- "resAwardsType": {
- "description": "Membership Awards code applied on the reservation.",
+ "eCertificateConsumptionType": {
"type": "object",
+ "description": "E-Certificates details.",
"properties": {
- "awardVouchers": {
- "$ref": "#/definitions/awardVouchersType"
+ "hotelId": {
+ "description": "Property where certificate was consumed for.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "membershipNo": {
- "description": "Membership program under which the award is applied.",
- "$ref": "#/definitions/uniqueID_Type"
+ "source": {
+ "description": "Source of consumption.",
+ "$ref": "#/definitions/eCertificateConsumeSourceType"
},
- "originalRoomType": {
- "description": "Room Type before the Upgrade Award.",
+ "surname": {
+ "description": "Last name of the person who consumed the certificate..",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "upgradeRoomType": {
- "description": "Room Type after the Upgrade Award.",
+ "firstName": {
+ "description": "First name of the person who consumed the certificate.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "resCancelPenaltyType": {
- "description": "The CancelPenalty class defines the cancellation policy of the hotel facility.",
- "type": "object",
- "properties": {
- "amountPercent": {
- "description": "Cancellation fee expressed as a fixed amount, or percentage of/or room nights.",
- "$ref": "#/definitions/policyAmountPercentType"
+ "minLength": 0,
+ "maxLength": 40
},
- "deadline": {
- "description": "Cancellation deadline, absolute or relative.",
- "$ref": "#/definitions/policyDeadlineType"
+ "middleName": {
+ "description": "Middle name of the person who consumed the certificate.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "effective": {
- "description": "Indicator if Cancellation Penalty is currently applicable or not.",
- "type": "boolean"
+ "email": {
+ "description": "Email of the person who consumed the certificate.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "formattedRule": {
- "description": "Formatted Text Rule of the Cancellation Penalty.",
+ "date": {
+ "description": "Date the certificate was consumed.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "manual": {
- "description": "Flag to indicate if the cancellation policy is manual.",
- "type": "boolean"
+ "userName": {
+ "description": "Application user who created the consumption.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "nonRefundable": {
- "description": "Indicates if the amount is refundable if booking is canceled.",
- "type": "boolean"
+ "userNotes": {
+ "description": "Any notes on the certificate entered at time of consumption.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
},
- "offsetUnit": {
- "$ref": "#/definitions/offsetUnitType"
+ "referenceId": {
+ "description": "Any reference like reservation no etc against which the certificate was consumed.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "penaltyDescription": {
- "description": "Text description of the Penalty in a given language.",
+ "locationType": {
+ "description": "Consumption location type.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "policyCode": {
- "description": "Policy Code.",
+ "authorizationCode": {
+ "description": "Authorization code for consumption.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 100
+ },
+ "serviceDate": {
+ "description": "Date on which the service is due (arrival date in case of reservation).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
}
}
},
- "resCancellationPoliciesType": {
- "description": "A list of reservation cancellation policies.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/resCancellationPolicyType"
- }
+ "eCertificateConsumeSourceType": {
+ "type": "string",
+ "description": "Indicates that OPERA E-Certificate is consumed by hotelPMS.",
+ "enum": [
+ "Central",
+ "Web",
+ "Hotel"
+ ]
},
- "resCancellationPolicyType": {
- "description": "A cancellation policy attached with the reservation.",
+ "eCertificateStatusType": {
+ "type": "string",
+ "description": "Indicates that OPERA E-Certificate is reserved.",
+ "enum": [
+ "Cancelled",
+ "Consumed",
+ "Deleted",
+ "Expired",
+ "Issued",
+ "Reserved"
+ ]
+ },
+ "awardId": {
"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": {
- "comments": {
- "description": "Comments attached with the reservation cancellation.",
+ "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",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "percentageDue": {
- "description": "The percentage amount due for reservation cancellation.",
- "type": "number",
- "maximum": 100,
- "minimum": 0
+ "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
},
- "policy": {
- "description": "Cancellation policy details.",
- "$ref": "#/definitions/resCancelPenaltyType"
+ "idContext": {
+ "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "policyId": {
- "description": "Unique ID of the Reservation Policy.",
- "$ref": "#/definitions/uniqueID_Type"
+ "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
},
- "revenueType": {
- "description": "Type of reservation.",
- "$ref": "#/definitions/depositCancelRevenueType"
+ "idExtension": {
+ "description": "Additional identifying value assigned by the creating system.",
+ "type": "integer"
}
}
},
- "resCashieringType": {
- "description": "Cashiering Information for the reservation.",
+ "eCertificateIssueSourceType": {
+ "type": "string",
+ "description": "Indicates that OPERA E-Certificate is issued by external system.",
+ "enum": [
+ "Opera",
+ "Web",
+ "Interface"
+ ]
+ },
+ "eCertificateIssueType": {
+ "type": "string",
+ "description": "Indicates that guest purchased OPERA E-Certificate.",
+ "enum": [
+ "Assigned",
+ "OptedIn",
+ "Purchased"
+ ]
+ },
+ "eCertificateGenerationType": {
"type": "object",
+ "description": "E-Certificates details.",
"properties": {
- "bedTaxReporting": {
- "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.",
- "$ref": "#/definitions/bedTaxReportingType"
- },
- "billingPrivileges": {
- "description": "Billing privileges set on the reservation.",
- "$ref": "#/definitions/billingPrivilegesType"
- },
- "compAccounting": {
- "description": "Information regarding comp accounting on the reservation.",
- "$ref": "#/definitions/resCompAccountingType"
- },
- "financiallyResponsible": {
- "description": "The guest from whom payment has to be recovered (direct guest).",
- "type": "boolean"
- },
- "folioTexts": {
- "description": "Additional text fields to display on the folio.",
- "$ref": "#/definitions/folioTextsType"
+ "ruleId": {
+ "description": "Key to identify the generation rule id.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "lastRoomAndTaxPostedDate": {
- "description": "Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.",
+ "generationDetail": {
+ "description": "Reason for which e-certificate was generated.",
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "periodicFolio": {
- "description": "Information regarding periodic folios set on the reservation.",
- "$ref": "#/definitions/resPeriodicFolioType"
- },
- "proratedBilling": {
- "description": "In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate.",
- "type": "boolean"
- },
- "reservationPreConfiguredRoutingInstruction": {
- "description": "Information regarding the selected preconfigured routing instruction on the reservation.",
- "$ref": "#/definitions/resPreConfiguredRoutingInstrType"
- },
- "revenuesAndBalances": {
- "description": "Revenues and Balances Amount summary for the reservation.",
- "$ref": "#/definitions/resRevenueBalanceType"
- },
- "reverseAdvanceCheckInAllowed": {
- "description": "This attribute is to verify if reverse advance check-in is allowed for the reservation.",
- "type": "boolean"
- },
- "reverseCheckInAllowed": {
- "description": "This attribute is to verify if reverse check-in is allowed for the reservation.",
- "type": "boolean"
- },
- "taxType": {
- "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.",
- "$ref": "#/definitions/reservationTaxTypeInfo"
+ "minLength": 0,
+ "maxLength": 4000
},
- "transactionsPosted": {
- "description": "Specifies whether reservation has a financial transaction associated with it.",
- "type": "boolean"
+ "referenceValue": {
+ "description": "Type of value that is in the certificate.valid values are membership_level.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "resCommunicationType": {
- "description": "Communication details for a reservation.",
+ "profileSubscriptionListType": {
+ "type": "array",
+ "description": "Details of the OPERA Profile subscription to external system",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/profileSubscriptionType"
+ }
+ },
+ "profileSubscriptionType": {
"type": "object",
+ "description": "Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular external system",
"properties": {
- "emails": {
- "description": "List of email address for the customer.",
+ "profileId": {
+ "description": "OPERA Profile ID that this subscription record corresponds to.",
+ "$ref": "#/definitions/profileId"
+ },
+ "externalProfileId": {
+ "description": "Profile ID within the external system.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "profileInfo": {
+ "description": "This provides name information for a person.",
"type": "object",
"properties": {
- "count": {
- "description": "Total number of rows returned",
- "type": "integer"
+ "name": {
+ "description": "Family name, last name or Company Name.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "emailInfo": {
- "description": "Collection of Detailed information on an eMail address for the customer.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/emailInfoType"
- }
+ "fullName": {
+ "description": "Full display Name.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
- "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"
+ "namePrefix": {
+ "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- }
- }
- },
- "telephones": {
- "description": "List of Telephone Number Information",
- "type": "object",
- "properties": {
- "count": {
- "description": "Total number of rows returned",
- "type": "integer"
+ "givenName": {
+ "description": "Given name, first name or names.",
+ "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"
+ "middleName": {
+ "description": "The middle name of the person 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"
- }
+ "nameSuffix": {
+ "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
+ "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"
+ },
+ "profileType": {
+ "description": "OPERA profile type such as Individual or Company",
+ "$ref": "#/definitions/profileTypeType"
}
}
- }
- }
- },
- "resCompAccountingType": {
- "description": "Information regarding comp accounting on the reservation.",
- "type": "object",
- "properties": {
- "authorizer": {
- "description": "ID of the employee who will act as the host for this guest.",
+ },
+ "distributed": {
+ "description": "Indicates if the profile was distributed to the external system.",
+ "type": "boolean"
+ },
+ "force": {
+ "description": "Indicates if the profile information should be overwritten by the external system.",
+ "type": "boolean"
+ },
+ "subscriptionDate": {
+ "description": "Timestamp when the profile was subscribed to.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "format": "date-time"
},
- "compPostings": {
- "description": "Indicates if the Comp Billing/posting Exist",
+ "lastDistributionDate": {
+ "description": "Timestamp of the most recent distribution of this profile to the external system.",
"type": "string",
- "maxLength": 5,
- "minLength": 0
+ "format": "date-time"
},
- "compType": {
- "description": "Code used to identify the casino comp type and ranking of a guest.",
+ "lastExternalUpdateDate": {
+ "description": "Timestamp of the most recent update of the subscription information by the external system.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "inactive": {
+ "description": "Indicates whether this subscription is active or inactive.",
+ "type": "boolean"
+ },
+ "systemCode": {
+ "description": "Code of system where profile is subscribed to.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "systemType": {
+ "description": "Type of system where profile is subscribed to.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "resDepositPoliciesType": {
- "description": "A list of deposit policies attached with the reservation.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/resDepositPolicyType"
- }
- },
- "resDepositPolicyType": {
- "description": "A deposit policy attached with the reservation.",
+ "roomOwnershipType": {
"type": "object",
+ "description": "Define the search criteria for retrieving room ownership records",
"properties": {
- "amountDue": {
- "description": "Total amount due against the reservation deposit.",
- "$ref": "#/definitions/currencyAmountType"
+ "roomOwnershipId": {
+ "description": "Unique Id for Room Owner record.",
+ "type": "integer"
},
- "amountPaid": {
- "description": "Total amount paid against the reservation deposit.",
- "$ref": "#/definitions/currencyAmountType"
+ "contractNumber": {
+ "description": "Contract number for room owner.",
+ "type": "string"
},
- "comments": {
- "description": "Comments attached with a deposit.",
+ "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",
- "maxLength": 2000,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "policy": {
- "description": "Reservation deposit policy details.",
- "$ref": "#/definitions/depositPolicyType"
+ "endDate": {
+ "description": "End Date of the room ownership record.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "policyId": {
- "description": "Unique ID of the Reservation Policy.",
+ "profileId": {
+ "description": "Profile ID of the room ownership record.",
"$ref": "#/definitions/uniqueID_Type"
},
- "revenueType": {
- "description": "Type of reservation.",
- "$ref": "#/definitions/depositCancelRevenueType"
+ "status": {
+ "description": "Status of the room ownership record.",
+ "type": "string"
}
}
},
- "resExpectedTimesType": {
- "description": "Holds the Arrival and Departure Time Information",
+ "guestCountsType": {
"type": "object",
+ "description": "A collection of GuestCount by age group.",
"properties": {
- "reservationExpectedArrivalTime": {
- "description": "Arrival Time",
- "type": "string",
- "format": "date-time"
+ "childAges": {
+ "description": "Defines Children's Ages. Number of children ages mentioned may mot match with children counts.",
+ "$ref": "#/definitions/childAgesType"
},
- "reservationExpectedDepartureTime": {
- "description": "Departure Time",
- "type": "string",
- "format": "date-time"
+ "childBuckets": {
+ "description": "Defines children counts with Age Qualifying Group(Child Bucket#1) classification.",
+ "$ref": "#/definitions/childBucketsType"
+ },
+ "adults": {
+ "description": "Defines the number of Adults.",
+ "type": "integer"
+ },
+ "children": {
+ "description": "Defines the number of Children.",
+ "type": "integer"
}
}
},
- "resGuaranteeType": {
- "description": "Validations type record returned after Validations are done.",
+ "childAgesType": {
+ "type": "array",
+ "description": "Age of a child in years.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/childAgeType"
+ }
+ },
+ "childAgeType": {
"type": "object",
+ "description": "Defines Child's Age.",
"properties": {
- "guaranteeCode": {
- "description": "Guarantee Code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "onHold": {
- "description": "Guarantee Code.",
- "type": "boolean"
- },
- "shortDescription": {
- "description": "Guarantee Code.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "age": {
+ "description": "Age of a child in years.",
+ "type": "integer"
}
}
},
- "resGuestAdditionalInfoType": {
+ "childBucketsType": {
"type": "object",
+ "description": "Defines children counts with Age Qualifying Group(Child Bucket) classification.",
"properties": {
- "dateOfEntry": {
- "description": "Entry Date into the country. (Croatian Requirements).",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "bucket1Count": {
+ "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1).",
+ "type": "integer"
},
- "guestClassification": {
- "description": "Guest Classification for the data export.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "bucket2Count": {
+ "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2).",
+ "type": "integer"
},
- "guestStatus": {
- "description": "Guest Status for the data export.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "bucket3Count": {
+ "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3).",
+ "type": "integer"
},
- "lastStay": {
- "description": "Last Stay information of the guest.",
- "$ref": "#/definitions/guestLastStayInfoType"
+ "bucket4Count": {
+ "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).",
+ "type": "integer"
},
- "nextDestination": {
- "description": "Entry Date into the country. (Croatian Requirements).",
- "type": "string"
+ "bucket5Count": {
+ "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).",
+ "type": "integer"
+ }
+ }
+ },
+ "resAwardsType": {
+ "type": "object",
+ "description": "Membership Awards code applied on the reservation.",
+ "properties": {
+ "membershipNo": {
+ "description": "Membership program under which the award is applied.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "portOfEntry": {
- "description": "Entry point into the country. (Croatian Requirements).",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "awardVouchers": {
+ "$ref": "#/definitions/awardVouchersType"
},
- "preferredRoomType": {
- "description": "Preferred Room Type of the guest.",
+ "originalRoomType": {
+ "description": "Room Type before the Upgrade Award.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "purposeOfStay": {
- "description": "Purpose of stay.",
+ "upgradeRoomType": {
+ "description": "Room Type after the Upgrade Award.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "resGuestExternalInfoType": {
- "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.",
- "type": "object",
- "properties": {
- "givenName": {
- "description": "Given name, first name or names",
- "$ref": "#/definitions/givenNameType"
- },
- "surname": {
- "description": "Family name, last name.",
- "$ref": "#/definitions/surnameType"
+ "awardVouchersType": {
+ "type": "array",
+ "description": "This stores the Membership Awards code applied on the reservation.",
+ "maxItems": 5,
+ "items": {
+ "type": "object",
+ "properties": {
+ "awardCode": {
+ "description": "Membership Award code applied on the reservation.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "voucherNo": {
+ "description": "Membership Award number.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ }
}
}
},
- "resGuestInfoType": {
- "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.",
+ "foreignExchangeType": {
"type": "object",
+ "description": "Foreign Exchange info.",
"properties": {
- "accompanyGuests": {
- "description": "List of guest names that are accompanying the reservation guest",
- "$ref": "#/definitions/resAccompanyGuestListType"
- },
- "address": {
- "description": "Address information that is attached to the reservation guest",
- "$ref": "#/definitions/addressSearchType"
- },
- "alternateFullName": {
- "description": "Altername full display name",
- "type": "string"
- },
- "alternateGivenName": {
- "description": "Alternate given name, first name or names",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "alternateSurname": {
- "description": "Alternate family name, last name.",
+ "type": {
+ "description": "Exchange Type for the postings.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "anonymization": {
- "description": "Provides information about the guest's anonymization status",
- "$ref": "#/definitions/anonymizationType"
+ "minLength": 0,
+ "maxLength": 20
},
- "birthDate": {
- "description": "Date of birth",
+ "effectiveDate": {
+ "description": "Effective Exchange date for the foreign currency posting.",
"type": "string",
"format": "date",
"maxLength": 8
- },
- "email": {
- "description": "Email address",
- "$ref": "#/definitions/basicEmailType"
- },
- "externalInfo": {
- "description": "External information about the guest associated with the reservation.",
- "$ref": "#/definitions/resGuestExternalInfoType"
- },
- "fullName": {
- "description": "Full display name",
- "type": "string"
- },
- "givenName": {
- "description": "Given name, first name or names",
- "$ref": "#/definitions/givenNameType"
- },
- "guestLastStayInfo": {
- "description": "Contains information regarding the last stay of this guest.",
- "$ref": "#/definitions/guestLastStayInfoType"
- },
- "guestRestricted": {
- "description": "True indicates there are restrictions associated with the current profile.",
- "type": "boolean"
- },
- "guestRestrictedCode": {
- "description": "Guest profile restricted reason code",
- "type": "string"
- },
- "guestRestrictedReasonDesc": {
- "description": "Guest profile restricted reason description",
- "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",
- "maxLength": 80,
- "minLength": 0
- },
- "language": {
- "description": "Language identification.",
- "type": "string",
- "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
- },
- "membership": {
- "description": "The Membership object identifying the frequent customer reward program.",
- "$ref": "#/definitions/membershipInfoType"
- },
- "middleName": {
- "description": "The middle name of the person name",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- },
- "namePrefix": {
- "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)",
- "$ref": "#/definitions/namePrefixType"
- },
- "nameSuffix": {
- "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.).",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "nameTitle": {
- "description": "Degree or honors (e.g., Ph.D., M.D.)",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "nameType": {
- "$ref": "#/definitions/nameTypeType"
- },
- "nationality": {
- "description": "Affiliation or ethnicity to a particular country.",
- "$ref": "#/definitions/countryNameType"
- },
- "phoneNumber": {
- "description": "Phone number",
- "$ref": "#/definitions/phoneNumberType"
- },
- "registrationCardNo": {
- "description": "Unique identifier of the police registration card number.",
+ }
+ }
+ },
+ "mealPlansType": {
+ "type": "array",
+ "description": "Meal plan codes associated with the rate codes.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/mealPlanCodeType"
+ }
+ },
+ "mealPlanCodeType": {
+ "type": "object",
+ "description": "Meal plan codes associated with the rate codes.",
+ "properties": {
+ "code": {
+ "description": "Meal plan code.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "surname": {
- "description": "Family name, last name.",
- "$ref": "#/definitions/surnameType"
+ "included": {
+ "description": "Represents if the meal plan code is included in rate code or not.",
+ "type": "boolean"
},
- "surnamePrefix": {
- "description": "e.g \"van der\", \"von\", \"de\"",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "breakfastIncluded": {
+ "description": "Represents if the meal plan code is available for breakfast or not.",
+ "type": "boolean"
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "lunchIncluded": {
+ "description": "Represents if the meal plan code is available for lunch or not.",
+ "type": "boolean"
},
- "vip": {
- "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).",
- "$ref": "#/definitions/vIPType"
+ "dinnerIncluded": {
+ "description": "Represents if the meal plan code is available for dinner or not.",
+ "type": "boolean"
}
}
},
- "resGuestType": {
- "description": "A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection.",
+ "roomRateAvailReasonType": {
+ "type": "string",
+ "description": "Indicates the Room Rate is not available due to unavailability of enough items for the rate code.",
+ "enum": [
+ "Available",
+ "Restricted",
+ "RestrictedDueToInventory",
+ "RestrictedDueToOccupancy",
+ "RestrictedDueToItemInventory"
+ ]
+ },
+ "upsellInfoType": {
"type": "object",
+ "description": "Information regarding upsell for a reservation.",
"properties": {
- "arrivalTransport": {
- "$ref": "#/definitions/transportInfoType"
- },
- "departureTransport": {
- "$ref": "#/definitions/transportInfoType"
- },
- "primary": {
- "description": "When true indicates this is the primary guest.",
- "type": "boolean"
- },
- "profileInfo": {
- "description": "A collection of Profiles or Unique IDs of Profiles.",
+ "originalInfo": {
+ "description": "Original Values of the reservation prior to upgrade.",
"type": "object",
"properties": {
- "profile": {
- "description": "Provides detailed information regarding either a company or a customer profile.",
- "$ref": "#/definitions/profileType"
+ "rateCode": {
+ "description": "The Rate Code of the Reservation before it was upgraded",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "profileCashieringDetail": {
- "description": "Cashiering details for the profile.",
- "$ref": "#/definitions/profileCashieringDetailType"
+ "totalAmount": {
+ "description": "Total Amount of the reservation before it was upgraded.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "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"
+ "roomType": {
+ "description": "Original Reservation Room Type before being upgraded.",
+ "$ref": "#/definitions/codeDescriptionType"
},
- "registrationCardNo": {
- "description": "Unique identifier of the police registration card number.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "nights": {
+ "description": "The number of nights of the reservation before being upgraded.",
+ "type": "integer"
}
}
},
- "reservationGuestRPH": {
- "description": "This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service.",
- "type": "string",
- "maxLength": 8,
- "minLength": 1
- },
- "visaInfo": {
- "$ref": "#/definitions/visaInfoType"
- }
- }
- },
- "resHousekeepingType": {
- "description": "Holds housekeeping turndown service information for the room.",
- "type": "object",
- "properties": {
- "expectedServiceTime": {
- "description": "Expected Start Time for housekeeping task(s).",
- "type": "string"
+ "upsellInfo": {
+ "description": "Information of a reservation during the process of upgrade.",
+ "type": "object",
+ "properties": {
+ "totalUpsellCharge": {
+ "description": "Amount that was charged for the upsell.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "totalUpsellMoneyAmount": {
+ "description": "Total Amount that was charged including upsell.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "firstNightUpsellAmount": {
+ "description": "First Night Total Amount including Upsell.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "firstNightUpsellCharge": {
+ "description": "First Night Upsell Charges.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "totalUpsellPoints": {
+ "description": "Total Upsell Points.",
+ "type": "integer"
+ },
+ "totalActualRateAmount": {
+ "description": "Actual Total Room Rate for the Target Upsell Room Type.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "roomType": {
+ "description": "Reservation Room Type for Upsell.",
+ "$ref": "#/definitions/codeDescriptionType"
+ },
+ "roomLongDescription": {
+ "description": "Detail description of the Room Type.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "ruleId": {
+ "description": "Upsell Rule Id.",
+ "type": "integer"
+ },
+ "ruleCode": {
+ "description": "Upsell rule code",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "ruleDescription": {
+ "description": "Upsell rule description",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "percentageSavings": {
+ "description": "Percentage savings resulting from accepting upsell offer. This will be calculated as the ratio of the amount saved by accepting the upsell offer to the actual room rate (i.e. room rate when upsell is not offered)",
+ "type": "number",
+ "minimum": 0,
+ "maximum": 100
+ },
+ "upsellDate": {
+ "description": "The date on which reservation is upgraded.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "upsellUser": {
+ "description": "User who upgraded the reservation.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
+ }
+ }
+ }
+ }
+ },
+ "ownerResTypeType": {
+ "type": "string",
+ "enum": [
+ "Owner",
+ "AuthorizedUser"
+ ]
+ },
+ "primaryShareTypeType": {
+ "type": "string",
+ "enum": [
+ "Primary",
+ "NonPrimary"
+ ]
+ },
+ "compAuthorizerInfoType": {
+ "type": "object",
+ "description": "Authorizer Information",
+ "properties": {
+ "authorizerId": {
+ "$ref": "#/definitions/uniqueID_Type"
},
- "facilityTaskInfo": {
- "description": "The facility task applicable for the current day. This will be information only and not used for any updates.",
- "$ref": "#/definitions/facilityTaskType"
+ "authorizerUserName": {
+ "description": "Application user name of the authorizer",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "instructions": {
- "description": "Turndown instructions for the room.",
- "type": "string"
+ "authorizerName": {
+ "description": "Full name of the authorizer.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 100
+ }
+ }
+ },
+ "resGuestType": {
+ "type": "object",
+ "description": "A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection.",
+ "properties": {
+ "profileInfo": {
+ "description": "A collection of Profiles or Unique IDs of Profiles.",
+ "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"
+ },
+ "profileCashieringDetail": {
+ "description": "Cashiering details for the profile.",
+ "$ref": "#/definitions/profileCashieringDetailType"
+ },
+ "registrationCardNo": {
+ "description": "Unique identifier of the police registration card number.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
+ }
+ }
},
- "linenChange": {
- "description": "Indicates if a linen change is necessary.",
- "type": "boolean"
+ "arrivalTransport": {
+ "$ref": "#/definitions/transportInfoType"
},
- "roomStatus": {
- "description": "Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house.",
- "$ref": "#/definitions/housekeepingRoomStatusType"
+ "departureTransport": {
+ "$ref": "#/definitions/transportInfoType"
},
- "serviceTime": {
- "description": "This is the Turndown room service time.",
+ "visaInfo": {
+ "$ref": "#/definitions/visaInfoType"
+ },
+ "reservationGuestRPH": {
+ "description": "This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service.",
"type": "string",
- "format": "date",
+ "minLength": 1,
"maxLength": 8
},
- "turndownRequested": {
- "description": "Indicates whether guest wants turndown facility or not.",
+ "primary": {
+ "description": "When true indicates this is the primary guest.",
"type": "boolean"
}
}
},
- "resInventoryItemSourceType": {
- "description": "Defines whether the item is setup due to a Rate Plan, Package or a Block.",
+ "profileCashieringDetailType": {
"type": "object",
+ "description": "The type contains routing instructions for the profile.",
"properties": {
- "blockId": {
- "description": "Block Unique ID, If populated specifies that the item is setup due to a Block.",
- "$ref": "#/definitions/blockId"
+ "paymentMethod": {
+ "description": "Payment Method Details.",
+ "$ref": "#/definitions/codeDescriptionType"
},
- "packageCode": {
- "description": "Package Code, If populated specifies that the item is setup due to a Package.",
+ "eCommerceId": {
+ "description": "E-Commerce ID of the Profile",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "routingInstructions": {
+ "description": "Set of preconfigured transaction codes.",
+ "$ref": "#/definitions/profileRoutingInstructionsType"
+ },
+ "taxType": {
+ "description": "Tax type code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "packageInternalID": {
- "description": "Source Reservation Package Opera Internal Unique Id. This is the unique Id used for the reservation package associated with this item.",
- "type": "number"
+ "fiscalGuestType": {
+ "description": "Guest type code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "ratePlanCode": {
- "description": "Rate Plan Code, If populated specifies that the item is setup due to a Rate Plan.",
+ "hotelId": {
+ "description": "Hotel Code for which the routing instructions are provided for a profile.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "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"
},
- "welcomeOffer": {
- "description": "If true, it implies that the item has been attached to the reservation as part of a Welcome Offer",
+ "billingInstructions": {
+ "description": "Set of preconfigured Billing Instruction results.",
+ "$ref": "#/definitions/billingInstructionsType"
+ },
+ "autoPopulateRouting": {
+ "description": "A flag which determines whether the instructions has to be automatically populated for this profile or not.",
"type": "boolean"
}
}
},
- "resInventoryItemType": {
- "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).",
+ "trxCodesInfoType": {
+ "type": "array",
+ "description": "List of Transaction codes info.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/trxInfoType"
+ }
+ },
+ "trxInfoType": {
"type": "object",
+ "description": "Transaction codes info.",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
+ "description": {
+ "description": "Transaction codes info.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "transactionGroup": {
+ "description": "Category of the transaction code.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "transactionSubGroup": {
+ "description": "Sub category of the transaction code.",
+ "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.",
+ "universalProductCode": {
+ "description": "Unique Universal product code of the transaction code.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "item": {
- "description": "Specifies Items and its attributes. When used for data manipulation for Items setup on reservation, etc only code is considered. Other Attributes are for used to provide information during fetch operation.",
- "$ref": "#/definitions/itemInfoType"
+ "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"
},
- "quantity": {
- "description": "Number of items booked.",
- "type": "integer"
+ "articles": {
+ "description": "The List of Articles defined for this transaction code, when using the Articles functionality.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/articleInfoType"
+ }
},
- "source": {
- "description": "If exists specifies whether the item is setup due to a Rate Plan, Package or a Block.",
- "$ref": "#/definitions/resInventoryItemSourceType"
+ "trxServiceType": {
+ "description": "Contains service type for transaction code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "timeSpan": {
- "description": "Begin and end date and time of the items applicability.",
- "$ref": "#/definitions/dateRangeType"
+ "transactionCode": {
+ "description": "Unique identifier for the Transaction code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "hotelId": {
+ "description": "Hotel context of the Transaction code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "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"
}
}
},
- "resInventoryItemsType": {
- "description": "Defines a collection of inventory items attached to a reservation.",
+ "articleInfoType": {
"type": "object",
+ "description": "Information regarding an article.",
"properties": {
- "item": {
- "description": "Inventory item attached to a reservation.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/resInventoryItemType"
- }
+ "description": {
+ "description": "Description of the article.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "itemClassCode": {
- "description": "The Item Class ID which the item belongs to.",
+ "transactionCode": {
+ "description": "Transaction code to which the article belongs.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "price": {
+ "description": "Default price of the article.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "postIt": {
+ "description": "Post it information of the article.",
+ "$ref": "#/definitions/articlePostItType"
+ },
+ "universalProductCode": {
+ "description": "Unique Universal product code of the article.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "hotelId": {
+ "description": "Hotel code to which the article belongs.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "articleCode": {
+ "description": "Unique code of the article.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "inactive": {
+ "description": "Indicates whether the article is inactive or not.",
+ "type": "boolean"
+ },
+ "orderSequence": {
+ "description": "Display Order sequence.",
+ "type": "number"
}
}
},
- "resMobileNotificationsType": {
- "description": "Contains the status of Room Ready and Key Ready messages.",
+ "articlePostItType": {
"type": "object",
+ "description": "Post it information of an article.",
"properties": {
- "checkoutMessageReceived": {
- "description": "Indicates if the Mobile checkout message is received.",
- "type": "boolean"
- },
- "errorMessage": {
- "description": "Error message when Mobile Notification has failed.",
- "type": "string"
- },
- "keyReady": {
- "description": "Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED",
- "$ref": "#/definitions/communicationStatusType"
- },
- "requiresAction": {
- "description": "Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout",
+ "availableForPostIt": {
+ "description": "Indicates whether the article is available for post it.",
"type": "boolean"
},
- "roomReady": {
- "description": "Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED",
- "$ref": "#/definitions/communicationStatusType"
+ "color": {
+ "description": "Color indicator which is only configurable if article is available for post it.",
+ "$ref": "#/definitions/colorType"
}
}
},
- "resPaymentCardType": {
- "description": "Information on a credit card for the customer.",
+ "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"
+ ]
+ },
+ "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": {
- "approvalAmountNeeded": {
- "$ref": "#/definitions/currencyAmountType"
- },
- "approvalCode": {
- "description": "Approval code sent by the credit card company on a successful authorization.",
+ "desc": {
+ "description": "Billing Instruction code description.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "attachCreditCardToProfile": {
- "description": "Attach the credit card to profile.",
- "type": "boolean"
+ "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"
},
- "cardHolderName": {
+ "billingCode": {
+ "description": "Unique identifier for the Billing Instruction.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "cardId": {
- "description": "credit card id",
- "$ref": "#/definitions/uniqueID_Type"
+ "minLength": 0,
+ "maxLength": 20
},
- "cardNumber": {
+ "hotelId": {
+ "description": "Hotel context of the Billing Instruction.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "cardNumberLast4Digits": {
+ "minLength": 0,
+ "maxLength": 20
+ }
+ }
+ },
+ "transportInfoType": {
+ "type": "object",
+ "properties": {
+ "comments": {
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "cardNumberMasked": {
+ "type": {
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "cardOrToken": {
- "description": "This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type.",
- "$ref": "#/definitions/cardNumberTypeType"
- },
- "cardPresent": {
- "description": "Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.",
- "type": "boolean"
- },
- "cardType": {
- "description": "Indicates the type of credit card from a defined list",
- "$ref": "#/definitions/cardTypeType"
+ "minLength": 0,
+ "maxLength": 20
},
- "citId": {
- "description": "Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.",
+ "transportCode": {
"type": "string",
- "maxLength": 30,
- "minLength": 0
- },
- "currentAuthorizedAmount": {
- "$ref": "#/definitions/currencyAmountType"
+ "minLength": 0,
+ "maxLength": 20
},
- "expirationDate": {
- "description": "Expiration date of the credit card",
+ "carrierCode": {
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "expirationDateExpired": {
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 20
},
- "expirationDateMasked": {
- "description": "Masked Expiration date of the credit card",
+ "stationCode": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "processing": {
- "description": "This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type.",
- "$ref": "#/definitions/cardProcessingType"
+ "dateTime": {
+ "type": "string",
+ "format": "date-time"
},
- "swiped": {
+ "transportationReqd": {
"type": "boolean"
- },
- "userDefinedCardType": {
- "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided",
- "type": "string",
- "maxLength": 2,
- "minLength": 0
}
}
},
- "resPeriodicFolioType": {
- "description": "Information regarding periodic folios set on the reservation.",
+ "visaInfoType": {
"type": "object",
"properties": {
- "frequency": {
- "description": "Frequency in number of days when folios should be printed for this reservation.",
- "type": "integer"
- },
- "lastFolioDate": {
- "description": "Latest date when a folio was printed using the \"Periodic Batch Folios\" option",
+ "visaIssueDate": {
"type": "string",
"format": "date",
"maxLength": 8
},
- "lastSettlementDate": {
- "description": "Latest date when a direct bill settlement was automatically done using the \"Direct Bill Batch Folios\" option.",
+ "visaExpiryDate": {
"type": "string",
"format": "date",
"maxLength": 8
+ },
+ "visaNumber": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "resPreConfiguredRoutingInstrType": {
- "description": "Instruction to attach Pre-Configured Routing Instructions to a Reservation.",
+ "resGuestAdditionalInfoType": {
"type": "object",
"properties": {
- "authorizerInfo": {
- "description": "The authorizer information for Promotion Code with attached Complimentary Routing",
- "$ref": "#/definitions/authorizerInfoType"
+ "portOfEntry": {
+ "description": "Entry point into the country. (Croatian Requirements).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "profileType": {
- "description": "Profile Type with attached Routing Instruction.",
- "$ref": "#/definitions/resProfileTypeType"
+ "dateOfEntry": {
+ "description": "Entry Date into the country. (Croatian Requirements).",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "promotionCode": {
- "description": "Promotion Code with attached Complimentary Routing.",
+ "nextDestination": {
+ "description": "Entry Date into the country. (Croatian Requirements).",
+ "type": "string"
+ },
+ "preferredRoomType": {
+ "description": "Preferred Room Type of the guest.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "lastStay": {
+ "description": "Last Stay information of the guest.",
+ "$ref": "#/definitions/guestLastStayInfoType"
+ },
+ "purposeOfStay": {
+ "description": "Purpose of stay.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "ratePlanCode": {
- "description": "Rate Code with attached Routing Instruction.",
+ "guestClassification": {
+ "description": "Guest Classification for the data export.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "guestStatus": {
+ "description": "Guest Status for the data export.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "resProfileTypeType": {
- "type": "string",
- "enum": [
- "Guest",
- "Company",
- "Group",
- "TravelAgent",
- "Source",
- "ReservationContact",
- "BillingContact",
- "Addressee"
- ]
+ "awardsType": {
+ "type": "array",
+ "description": "List of awards.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/awardType"
+ }
},
- "resRevenueBalanceType": {
- "description": "Revenue and Balance Amount summary for the reservation.",
+ "awardType": {
"type": "object",
+ "description": "Detailed information of the awards.",
"properties": {
- "balance": {
- "description": "Balance amount on the reservation.",
- "$ref": "#/definitions/currencyAmountType"
+ "awardCode": {
+ "description": "Award category.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "compBalance": {
- "description": "Comp Balance amount",
- "$ref": "#/definitions/currencyAmountType"
+ "awardType": {
+ "description": "Can be P (Paper) or E (E-Certificate).",
+ "$ref": "#/definitions/awardKindType"
},
- "foodAndBevRevenue": {
- "description": "Food and Beverage Revenue generated by the reservation.",
- "$ref": "#/definitions/currencyAmountType"
+ "description": {
+ "description": "Description of the award/certificate.",
+ "type": "string"
},
- "nonRevenue": {
- "description": "Total Non Revenue posted on the reservation.",
- "$ref": "#/definitions/currencyAmountType"
+ "certificateNo": {
+ "description": "Certificate No.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "otherRevenue": {
- "description": "Other Revenue generated by the reservation.",
- "$ref": "#/definitions/currencyAmountType"
+ "masterCertificiateNo": {
+ "description": "Master Certificate No.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "roomRevenue": {
- "description": "Room Revenue generated by the reservation.",
- "$ref": "#/definitions/currencyAmountType"
+ "membershipNo": {
+ "description": "Membership No.",
+ "type": "string"
},
- "totalFixedCharge": {
- "description": "Total Fixed Charges on the reservation.",
- "$ref": "#/definitions/currencyAmountType"
+ "hotelId": {
+ "description": "Hotel Code for which the routing instructions are provided for a profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "totalPayment": {
- "description": "Total payment received for the reservation.",
- "$ref": "#/definitions/currencyAmountType"
+ "hotelCategory": {
+ "description": "Indicates the lowest hotel category for which the certificate is valid.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "totalRevenue": {
- "description": "Total Revenue generated by the reservation.",
- "$ref": "#/definitions/currencyAmountType"
- }
- }
- },
- "resSharedGuestInfoType": {
- "description": "Contains information regarding the share reservation.",
- "type": "object",
- "properties": {
- "firstName": {
- "description": "Given name, first name or names",
- "type": "string"
+ "externalHotelCode": {
+ "description": "Hotel Code of the CRS application that this certificate belongs to.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "fullName": {
- "description": "String representation of the full name",
- "type": "string"
+ "externalConfirmationNo": {
+ "description": "Confirmation Number given by a CRS application for this reservation.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "lastName": {
- "description": "Family name, last name.",
+ "categoryValid": {
+ "description": "Indicates whether the category of certificate is valid or not for this resort.",
+ "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"
+ },
+ "status": {
+ "description": "Status of the award aka available.",
+ "$ref": "#/definitions/awardStatusType"
+ },
+ "expirationDate": {
+ "description": "Expiration Date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "gift": {
+ "description": "Signifies whether award is gift or not.",
+ "type": "boolean"
+ },
+ "upgrade": {
+ "description": "Signifies whether upgrade award or not.",
+ "type": "boolean"
+ },
+ "package": {
+ "description": "Signifies whether upgrade is package or not.",
+ "type": "boolean"
+ },
+ "instantlyRedeemable": {
+ "description": "Indicates if the award is an Instant Redemption award.",
+ "type": "boolean"
+ },
+ "paidUpgrade": {
+ "description": "Indicates if this certificate was ordered using the \"Paid Upgrade\" option in the E-Certs screen.",
+ "type": "boolean"
+ },
+ "detailedCertificate": {
+ "description": "Indicates if this certificate is detailed or not.",
+ "type": "boolean"
+ },
+ "nights": {
+ "description": "Award Nights.",
+ "type": "integer"
+ },
+ "sourceType": {
+ "description": "MRW : From MRW MAN:Entered manually.",
"type": "string"
},
+ "points": {
+ "description": "No. of points used to order this award.",
+ "type": "number"
+ },
+ "fBAInfo": {
+ "description": "FBA related fields.",
+ "$ref": "#/definitions/fBAInfoType"
+ },
+ "reservationId": {
+ "description": "Reservation IDs will be empty if award is not attached.",
+ "$ref": "#/definitions/reservationId"
+ },
"profileId": {
+ "description": "Unique profile identifier requested to be fetched.",
"$ref": "#/definitions/profileId"
- }
- }
- },
- "resSharedGuestListType": {
- "description": "Collection of shared guest reservations.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/resSharedGuestInfoType"
- }
- },
- "resStatClassificationType": {
- "description": "Statistical Classification information for the reservation.",
- "type": "object",
- "properties": {
- "rateTier": {
- "description": "Rate Tier used calculate statistics for export(DRS).",
+ },
+ "quantity": {
+ "description": "Quantity of such awards needed to be ordered.",
"type": "integer"
},
- "roomType": {
- "description": "Room Type used to calculate statistics for export(DRS).",
+ "displaySequence": {
+ "description": "Indicates the order in which the certificates received from MRW.",
+ "type": "number"
+ },
+ "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
+ },
+ "purgeDate": {
+ "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
}
}
},
- "reservation": {
- "description": "Validation checks includes the following: - Reservation is not valid to be checked in. - Split is still required before the reservation can be checked in. - Room information is missing. - Payment information is missing. - The status of the room needs to be reviewed. - Sharers was impacted. The check-in process affected the reservation details of shared guests on the reservation. - Sharers was not impacted. The check-in process has not affected the reservation details of shared guests on the reservation.",
+ "awardKindType": {
+ "type": "string",
+ "description": "Indicates that this is electronic certificate.",
+ "enum": [
+ "Paper",
+ "ECertificate"
+ ]
+ },
+ "reservationCertificateType": {
+ "type": "string",
+ "description": "Certificate is incentive.",
+ "enum": [
+ "Reward",
+ "Incentive"
+ ]
+ },
+ "rewardCertificateType": {
+ "type": "string",
+ "description": "Point Saver reward.",
+ "enum": [
+ "Regular",
+ "StayAnytime",
+ "PointSaver"
+ ]
+ },
+ "awardStatusType": {
+ "type": "string",
+ "description": "Indicates that certificate is in use.",
+ "enum": [
+ "Available",
+ "NotAvailable",
+ "InUse"
+ ]
+ },
+ "fBAInfoType": {
"type": "object",
+ "description": "FBA ( Flexible Benefits Awards ) related fields.",
"properties": {
- "fetchReservationInstruction": {
- "description": "Instructions to fetch reservations .",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/checkedInReservationInstructionType"
- }
+ "status": {
+ "description": "Possible FBA statuses.",
+ "$ref": "#/definitions/fBAStatusType"
},
- "includeNotifications": {
- "description": "When \"true\" alerts and comments are fetched. When \"false\", these alerts and comments are not retrieved.",
+ "monetaryValue": {
+ "description": "Award's FBA monetary values.",
+ "type": "number"
+ },
+ "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",
+ "format": "date",
+ "maxLength": 8
+ },
+ "postingBusinessDate": {
+ "description": "Business date of the FBA posting.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "settlementDateTime": {
+ "description": "Date and time of the FBA settlement.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "settlementBusinessDate": {
+ "description": "Business date of the FBA settlement.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "reimbursementDateTime": {
+ "description": "Date and time of the FBA reimbursement.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "reimbursementBusinessDate": {
+ "description": "Business date of the FBA reimbursement.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "fbaBillGenDate": {
+ "description": "Business date of the FBA bill generation.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "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"
+ },
+ "flexibleBenefitAward": {
+ "description": "Indicates if this certificate is a Flexible Benefit Award certificate.",
"type": "boolean"
},
- "links": {
- "$ref": "#/definitions/links"
+ "posted": {
+ "description": "Indicates whether FBA has been posted.",
+ "type": "boolean"
},
- "reservation": {
- "description": "Criteria element to check-in a reservation",
- "type": "object",
- "properties": {
- "checkOutTime": {
- "description": "Request to update the checkout time.",
- "type": "string",
- "format": "date-time"
- },
- "endCheckInProcessTime": {
- "description": "Represents the time the user compeletes the check in process.",
- "type": "string",
- "format": "date-time"
- },
- "ignoreWarnings": {
- "description": "Dictates whether to ignore warnings ( e.g. room availability ) before check in.",
- "type": "boolean"
- },
- "lockHandle": {
- "description": "An id representing the record lock for this reservation. When passed, update operation will verify that this lock is still valid.",
- "type": "number"
- },
- "overrideAdvancePaymentValidation": {
- "description": "Flag to override advance payment validation.",
- "type": "boolean"
- },
- "printRegistration": {
- "description": "Flag for Print Registration Card",
- "type": "boolean"
- },
- "profilePrivacyPrompted": {
- "description": "Dictates whether Profile privacy stop in check in is prompted.",
- "type": "boolean"
- },
- "roomId": {
- "description": "Expected room no. If this attribute is included, then Opera will check if the currently configured room no in the database matches this value.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "startCheckInProcessTime": {
- "description": "Represents the time the user starts the check in process.",
- "type": "string",
- "format": "date-time"
- },
- "stopCheckin": {
- "description": "Indicates the Stop Check In reservation Global Alert flag.",
- "type": "boolean"
- }
- }
+ "settled": {
+ "description": "Indicates whether FBA has been settled.",
+ "type": "boolean"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "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"
}
}
},
- "reservationAllowedActionType": {
- "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.",
+ "fBAStatusType": {
"type": "string",
+ "description": "Flexible benefit award has been reimbursed.",
"enum": [
- "Cancel",
- "Move",
- "PreCharge",
- "PostCharge",
- "FacilitySchedule",
- "Upsell",
- "PreCheckIn",
- "PostToNoShowCancel",
- "NoShow",
- "NameChange",
- "Discount",
- "HouseKeeping",
- "EnrollToPrimaryMembership",
- "EnrollInProgress"
+ "Ordered",
+ "Attached",
+ "Posted",
+ "Settled",
+ "Reimbursed"
]
},
- "reservationAllowedActionsType": {
- "description": "Allowed action.",
+ "trackItItemsType": {
"type": "array",
- "maxItems": 11,
+ "description": "",
+ "maxItems": 4000,
"items": {
- "$ref": "#/definitions/reservationAllowedActionType"
+ "$ref": "#/definitions/trackItItemType"
}
},
- "reservationAutoRoomAssignRequestType": {
- "description": "Request criteria for auto assignment of rooms to reserved reservations.",
+ "trackItItemType": {
"type": "object",
+ "description": "Detailed information of a Track It item.",
"properties": {
- "reservationCriteria": {
- "description": "A list of reservation ids which will be used to auto assign rooms.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationIdList"
- }
+ "hotelId": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "roomNumberLocked": {
- "description": "Update the do not move flag used to locking the reservation room number.",
- "type": "boolean"
+ "trackItId": {
+ "$ref": "#/definitions/trackItId"
},
- "roomSelectionCriteria": {
- "description": "Search type for the rooms which will be used to assign.",
- "type": "object",
- "properties": {
- "connectingRoomsOnly": {
- "description": "This flag when set to true will include only connecting rooms.",
- "type": "boolean"
- },
- "departureTime": {
- "description": "When IncludeDueOut is enable,it is the departure time before which to search.",
- "type": "string",
- "format": "date-time"
- },
- "excludeFloorPreferences": {
- "description": "It indicates to exclude rooms with the selected Floor(s).It allows alphanumeric values(e.g.,01,02,03,GROUND,five)",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- },
- "excludeRoomFeatures": {
- "description": "It indicates to exclude rooms with the selected Room Feature(s). It allows alphanumeric values(e.g.,TUB,BOLCONY,MV)",
- "$ref": "#/definitions/roomFeaturesType"
- },
- "floor": {
- "description": "The floor of room to be fetched.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "hotelId": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "hotelRoomDateRange": {
- "description": "Date range instructions.",
- "$ref": "#/definitions/timeSpanType"
- },
- "includeAllRoomConditions": {
- "description": "This flag when set to true will include all room conditions, when set to false then room with \"General Assignment\" condition type will be excluded from the result.",
- "type": "boolean"
- },
- "includeAttendentInRoom": {
- "description": "This flag when set to true will includes attendent in Rooms",
- "type": "boolean"
- },
- "includeComponentRooms": {
- "description": "This flag when set to true will include all component rooms",
- "type": "boolean"
- },
- "includeDepartureRooms": {
- "description": "Indicates if departure rooms are to be included in the auto assignment.",
- "type": "boolean"
- },
- "includeDueOut": {
- "description": "This flag when set to true will include rooms assigned to due out reservations.",
- "type": "boolean"
- },
- "includeOORoomCheck": {
- "description": "This flag when set to true will work for Available Rooms functionality",
- "type": "boolean"
- },
- "includePseudoRooms": {
- "description": "This flag when set to true will include all pseudo rooms",
- "type": "boolean"
- },
- "limit": {
- "description": "Indicates maximum number of records a Web Service should return.",
- "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"
- },
- "orderBy": {
- "description": "When Forecast Rotation is checked, the room rotation order will consider any future reservations for point calculation and reorder the rooms accordingly.This is supported when OPERA Control Room Rotation and Forecast Rotation Points are active.",
- "$ref": "#/definitions/hotelRoomsOrderBy"
- },
- "perfectFitRoomsOnly": {
- "description": "When this flag is set to true, it will fetch only rooms that have exactly Y nights free with the reservation guest(s) points. This will prevent any gaps in room assignment. This is supported when OPERA Control Room Rotation and Forecast Rotation Points are active.",
- "type": "boolean"
- },
- "pseudoRoomsOnly": {
- "description": "This flag when set to true will include only pseudo rooms",
- "type": "boolean"
- },
- "reservationId": {
- "$ref": "#/definitions/reservationId"
- },
- "roomClass": {
- "description": "The room class of hotel rooms to be fetched.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomFeatures": {
- "description": "The Room Features of the room to be fetched.",
- "$ref": "#/definitions/roomFeaturesType"
- },
- "roomNumberWildcard": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomRange": {
- "description": "Room range instructions.",
- "$ref": "#/definitions/roomRangeType"
- },
- "roomStatusFilter": {
- "description": "Fetch instructions that should be used to get hotel rooms.",
- "type": "object",
- "properties": {
- "hotelFORoomStatusList": {
- "description": "Front office room status instructions to be used in requests for fetching housekeeping rooms.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/frontOfficeRoomStatusType"
- }
- },
- "hotelRoomStatusList": {
- "description": "Hotel room status instructions to be used in requests for fetching rooms.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/housekeepingRoomStatusType"
- }
- }
- }
- },
- "roomTypes": {
- "description": "The room types of hotel rooms to be fetched.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- },
- "smokingPreference": {
- "description": "The smoking preference of room to be fetched.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "useAIRoomAssignment": {
- "description": "If the AI ROOM ASSIGNMENT application parameter is set to Y, this flag when set to true will use the AI Room Assignment algorithm to fetch the results in order of suitability.",
- "type": "boolean"
- },
- "useAssociatedProfilePreferences": {
- "description": "Indicates if preferences on the profile associated to the reservation should be used to determine the room type. The preferences for FLOOR, SMOKING and ROOM FEATURES will be used.",
- "type": "boolean"
- }
- }
+ "group": {
+ "$ref": "#/definitions/trackItGroup"
+ },
+ "ticketNumber": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "referenceNumber": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "type": {
+ "$ref": "#/definitions/trackItType"
+ },
+ "action": {
+ "$ref": "#/definitions/trackItActionType"
+ },
+ "location": {
+ "$ref": "#/definitions/codeDescriptionType"
+ },
+ "quantity": {
+ "type": "integer"
+ },
+ "followUpDate": {
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "description": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "assignedTo": {
+ "$ref": "#/definitions/applicationUserType"
+ },
+ "reservationInfo": {
+ "$ref": "#/definitions/trackItReservationInfoType"
+ },
+ "trackItLogList": {
+ "$ref": "#/definitions/trackItLogListType"
}
}
},
- "reservationBlockType": {
- "description": "Key information about the block for a reservation.",
+ "trackItId": {
"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": {
- "blockIdList": {
- "description": "Collection of unique block identifiers for the reservation.",
- "$ref": "#/definitions/blockIdList"
+ "url": {
+ "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "type": "string"
},
- "blockName": {
- "description": "The Name of the block that is attached to the reservation.",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "hotelId": {
- "description": "This is the HotelCode of the Block.",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "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"
}
}
},
- "reservationCertificateType": {
- "description": "Certificate is incentive.",
+ "trackItGroup": {
"type": "string",
+ "description": "Group to which the Track It items belong.",
"enum": [
- "Reward",
- "Incentive"
+ "Parcel",
+ "Valet",
+ "Baggage",
+ "Lost"
]
},
- "reservationDepositType": {
- "description": "Reservation Deposit Type.",
+ "trackItType": {
"type": "object",
+ "description": "Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.",
"properties": {
- "amountOwed": {
- "description": "Deposit Amount Owed.",
- "type": "number"
+ "type": {
+ "$ref": "#/definitions/codeDescriptionType"
},
- "amountPaid": {
- "description": "Deposit Amount Paid.",
- "type": "number"
+ "url": {
+ "$ref": "#/definitions/uRLType"
+ }
+ }
+ },
+ "trackItActionType": {
+ "type": "object",
+ "description": "Identifies the response expected from staff or other parties relative to a Track It ticket.",
+ "properties": {
+ "trackItAction": {
+ "$ref": "#/definitions/codeDescriptionType"
},
- "amountRequired": {
- "description": "Deposit Amount Required.",
- "type": "number"
+ "status": {
+ "$ref": "#/definitions/actionStatusType"
+ }
+ }
+ },
+ "actionStatusType": {
+ "type": "string",
+ "description": "Action status of the Track It item(Open, Closed).",
+ "enum": [
+ "Open",
+ "Closed"
+ ]
+ },
+ "trackItReservationInfoType": {
+ "type": "object",
+ "description": "Reservation info associated with a Track It item.",
+ "properties": {
+ "reservationIdList": {
+ "$ref": "#/definitions/reservationIdList"
},
- "dueDate": {
- "description": "Deposit Due Date.",
+ "timeSpan": {
+ "$ref": "#/definitions/timeSpanType"
+ },
+ "guestInfo": {
+ "$ref": "#/definitions/resGuestInfoType"
+ },
+ "roomType": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "roomId": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "roomStatus": {
+ "$ref": "#/definitions/housekeepingRoomStatusType"
+ },
+ "guarantee": {
+ "$ref": "#/definitions/resGuaranteeType"
+ },
+ "reservationStatus": {
+ "$ref": "#/definitions/pMS_ResStatusType"
+ },
+ "computedReservationStatus": {
+ "$ref": "#/definitions/pMS_ResStatusType"
+ }
+ }
+ },
+ "trackItLogListType": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/trackItLogType"
+ }
+ },
+ "trackItLogType": {
+ "type": "object",
+ "description": "Individual activity log related to the Track It ticket.",
+ "properties": {
+ "hotelId": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "trackItLogId": {
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "trackItId": {
+ "$ref": "#/definitions/trackItId"
+ },
+ "type": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "description": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ },
+ "businessDate": {
"type": "string",
"format": "date",
"maxLength": 8
},
- "hasOutstanding": {
- "description": "Resolves whether reservation has outstanding deposit.",
+ "logUserId": {
+ "type": "integer"
+ },
+ "logUserName": {
+ "type": "string"
+ },
+ "logDate": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "hotelReservationsType": {
+ "type": "object",
+ "description": "A collection of Reservation objects and Unique IDs of Reservation.",
+ "properties": {
+ "reservation": {
+ "description": "A collection of Reservations.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/hotelReservationType"
+ }
+ },
+ "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"
},
- "hasPaid": {
- "description": "Resolves whether reservation has paid deposit.",
+ "totalResults": {
+ "description": "Total number of rows queried",
+ "type": "integer"
+ },
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
+ }
+ }
+ },
+ "reservationLocatorsType": {
+ "type": "array",
+ "description": "Holds the Locator Information.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationLocatorType"
+ }
+ },
+ "reservationLocatorType": {
+ "type": "object",
+ "description": "Holds the information for a Reservation Guest Locator",
+ "properties": {
+ "dateSpan": {
+ "description": "Begin and End date range of the Guest Locator.",
+ "$ref": "#/definitions/dateRangeType"
+ },
+ "timeSpan": {
+ "description": "Time span for the Guest Locator.",
+ "$ref": "#/definitions/dateTimeSpanType"
+ },
+ "locatorText": {
+ "description": "The Locator Text for the guest.",
+ "type": "string"
+ },
+ "locatorOn": {
+ "description": "Date and time of the Guest Locator.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "locatorBy": {
+ "description": "User that entered this Guest Locator.",
+ "type": "string"
+ },
+ "locatorId": {
+ "description": "Unique Id of the Guest Locator ( Locator Id )",
+ "$ref": "#/definitions/uniqueID_Type"
+ }
+ }
+ },
+ "dateTimeSpanType": {
+ "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": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "endDateTime": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "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": 2000
+ },
+ "fileSize": {
+ "description": "Size of the file.",
+ "type": "integer"
+ },
+ "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"
},
- "postingDate": {
- "description": "Deposit Posting Date.",
+ "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.",
+ "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"
+ }
+ }
+ },
+ "dateTimeStampGroupType": {
+ "type": "object",
+ "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
+ },
+ "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
+ },
+ "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
}
}
},
- "reservationDisplayColorInfoType": {
- "description": "Information of reservation display color, determined based on OPERA parameter RESERVATION_COLOR_DEFINITION ",
+ "serviceRequests": {
+ "type": "array",
+ "description": "Service request.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/serviceRequest"
+ }
+ },
+ "serviceRequest": {
"type": "object",
+ "description": "Service request.",
"properties": {
- "colorDefinition": {
- "description": "Definition populated based on OPERA setting RESERVATION_COLOR_DEFINITION.",
- "$ref": "#/definitions/colorDefinitionType"
+ "serviceRequestId": {
+ "description": "Unique identifier of the service request.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "colorDescription": {
- "description": "Description populated based on DisplayColor.",
+ "hotelId": {
+ "description": "Hotel Code of the service request.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "displayColor": {
- "description": "Display Color of Reservation.",
- "$ref": "#/definitions/colorType"
+ "code": {
+ "description": "Service request code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "status": {
+ "description": "The status of the service request.",
+ "$ref": "#/definitions/serviceRequestStatusType"
+ },
+ "priority": {
+ "description": "The priority level of the service request.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "department": {
+ "description": "The department that is associated with the service request code.",
+ "$ref": "#/definitions/codeDescriptionType"
+ },
+ "reservationIdList": {
+ "description": "Unique identifier of the reservation.",
+ "$ref": "#/definitions/reservationIdList"
+ },
+ "profileId": {
+ "description": "Unique identifier of the guest.",
+ "$ref": "#/definitions/profileId"
+ },
+ "guestName": {
+ "description": "The guest name.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ },
+ "room": {
+ "description": "The room number in which the service request was created.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "openDate": {
+ "description": "The date-time in which the service request was opened.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "guaranteedBy": {
+ "description": "The user who guaranteed the completion of the service request.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 100
+ },
+ "comment": {
+ "description": "Description of the service request.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "action": {
+ "description": "Description of the action taken to complete the request.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ },
+ "guestContactMethod": {
+ "description": "Communication method picked from guest profile.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 100
+ },
+ "completionDate": {
+ "description": "The date-time in which the service request was completed.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closedDate": {
+ "description": "The date-time in which the service request was closed.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "closedBy": {
+ "description": "The user who closed the service request.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "closeDescription": {
+ "description": "The follow up description.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "reservationECertificateType": {
- "description": "Reservation ECertificate Type Information.",
+ "serviceRequestStatusType": {
+ "type": "string",
+ "enum": [
+ "Open",
+ "PendingFollowUp",
+ "Closed",
+ "DoNotDisturb",
+ "MakeUpRoom"
+ ]
+ },
+ "activityLookUpList": {
+ "type": "array",
+ "description": "Criteria for fetching Activity Bookings.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/fetchActivityBookingsType"
+ }
+ },
+ "fetchActivityBookingsType": {
"type": "object",
+ "description": "Used in the request message to describe the \"filtering Criteria\" when executing an activity lookup.",
"properties": {
- "actionType": {
- "description": "ECertificate status for the reservation.",
- "$ref": "#/definitions/requestActionType"
+ "profileId": {
+ "description": "ProfileID associated with the Activity under lookup.",
+ "$ref": "#/definitions/uniqueIDListType"
},
- "eCertificateNo": {
- "description": "ECertificate Number for the reservation.",
+ "personName": {
+ "description": "Detailed name information for the customer.",
+ "$ref": "#/definitions/personNameType"
+ },
+ "address": {
+ "description": "Detailed Address information for the customer.",
+ "$ref": "#/definitions/addressType"
+ },
+ "activities": {
+ "description": "The specific acitvity information to be used for filtering the Look-up.",
+ "$ref": "#/definitions/activityList"
+ },
+ "hotelId": {
+ "description": "Hotel Code, It is used to filter hotel specific children to this specific hotel code.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ }
+ }
+ },
+ "activityList": {
+ "type": "array",
+ "description": "A collection of Activity objects.",
+ "maxItems": 4000,
+ "items": {
+ "type": "object",
+ "properties": {
+ "activityIds": {
+ "description": "A collection of reference ID values that identify this uniquely scheduled activity instance. May contain one ID per external system plus an internal identifier.",
+ "$ref": "#/definitions/uniqueIDListType"
+ },
+ "type": {
+ "description": "The Type of the activity. Eg: SPA, Golf etc.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The Location where the activity takes place. Eg: Salon",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ }
+ },
+ "numberOfPersons": {
+ "description": "The total number of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons",
+ "type": "integer"
+ },
+ "timeSpan": {
+ "description": "The time with-in which an activity falls (Starts/Ends/Spans)",
+ "$ref": "#/definitions/dateTimeSpanType"
+ },
+ "duration": {
+ "description": "The time span of the activity falls",
+ "$ref": "#/definitions/dateTimeSpanType"
+ },
+ "description": {
+ "description": "Description of the activity",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ }
+ },
+ "note": {
+ "description": "Any additional notes or comments regarding the scheduled activity.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ }
+ },
+ "groupCode": {
+ "description": "Any Block code associated with the activity if its a Group booking.",
+ "type": "string"
+ },
+ "amount": {
+ "description": "The amount charged for the activity.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "deposit": {
+ "description": "A monetary value expressed with a currency code.",
+ "type": "object",
+ "properties": {
+ "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
+ },
+ "collectedBy": {
+ "type": "string",
+ "enum": [
+ "Vendor",
+ "Agent",
+ "Other"
+ ]
+ }
+ }
+ },
+ "inactiveDate": {
+ "description": "The Date by which the activity is deemed Cancelled/Deleted.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "participants": {
+ "description": "The names of the participants.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/personNameType"
+ }
+ },
+ "uRLLink": {
+ "description": "The URL link to launch the Activity Reservation System to view or edit full details of this activity.",
+ "type": "string"
+ },
+ "extensions": {
+ "description": "Vendor extensions to the activity record.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string"
+ }
+ },
+ "status": {
+ "description": "Activity reservation status. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.",
+ "type": "string"
+ },
+ "statusDescription": {
+ "description": "Activity reservation status description. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.",
+ "type": "string"
+ },
+ "link": {
+ "description": "When true indicates that activity link only needs to be inserted or deleted for this record.",
+ "type": "boolean"
+ }
},
- "eCertificateType": {
- "description": "ECertificate Type where value can be PROMOTION,AWARD,BENEFIT and OTHER",
- "$ref": "#/definitions/eCertificateClassficationType"
- }
+ "description": "Represents a single instance of a scheduled activity."
}
},
- "reservationECertificatesType": {
- "description": "Collection of ECertificateType object.",
+ "prepaidCardsType": {
"type": "array",
+ "description": "Holds fixed charge detail.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/reservationECertificateType"
+ "$ref": "#/definitions/prepaidCardType"
}
},
- "reservationFolioWindowType": {
- "description": "Folio window view which holds the set of folios for a reservation.",
+ "prepaidCardType": {
"type": "object",
+ "description": "Holds fixed charge information.",
"properties": {
- "balance": {
- "description": "Running balance of the window.",
- "$ref": "#/definitions/currencyAmountType"
+ "hotelId": {
+ "description": "Hotel context for the Reservations.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "folioWindowNo": {
- "type": "integer"
+ "reservationId": {
+ "description": "The unique ID of the reservation to which this record applies.",
+ "$ref": "#/definitions/reservationId"
},
- "payeeInfo": {
- "description": "The window's configured payee information.",
- "$ref": "#/definitions/payeeInfoType"
+ "name": {
+ "description": "Family name, last name or Company Name.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "paymentMethod": {
- "description": "Payment Method Type",
+ "firstName": {
+ "description": "Given name, first name or names.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "reservationFolioWindowsType": {
- "description": "Collection of reservation folio windows.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationFolioWindowType"
- }
- },
- "reservationForCCAuthType": {
- "description": "Reservation details, including a list of the associated payment methods.",
- "type": "object",
- "properties": {
- "guestFirstName": {
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "profileId": {
+ "description": "Card / Account holder name ID",
+ "$ref": "#/definitions/profileId"
+ },
+ "cardNo": {
+ "description": "Prepaid card / account number.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "guestName": {
- "description": "Guest name that is registered for the reservation.",
+ "cardNumberMasked": {
+ "description": "Masked Prepaid card / account number.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "paymentMethods": {
- "$ref": "#/definitions/reservationPaymentMethodsType"
+ "amount": {
+ "description": "Prepaid Card Amount.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "profileId": {
- "description": "ProfileId of the guest.",
+ "pinCode": {
+ "description": "Prepaid card pin code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 10
+ },
+ "interfaceId": {
+ "description": "The unique ID for the Interface.",
"$ref": "#/definitions/uniqueID_Type"
},
- "reservationId": {
- "$ref": "#/definitions/reservationId"
+ "cardDetails": {
+ "description": "Prepaid Card details from vendor.",
+ "$ref": "#/definitions/prepaidCardDetailsType"
},
- "reservationStatusInfo": {
- "$ref": "#/definitions/housekeepingRoomReservationStatusType"
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
+ "type": "string",
+ "format": "date-time"
},
- "room": {
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "stayDateInfo": {
- "$ref": "#/definitions/stayDateInfoType"
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
+ "type": "string",
+ "format": "date-time"
},
- "vipStatus": {
- "description": "VIP status of the guest.",
- "$ref": "#/definitions/vIPStatusType"
- }
- }
- },
- "reservationHistoryFutureInfoType": {
- "description": "Information of History and Future Reservation details attached to Profiles.",
- "type": "object",
- "properties": {
- "futureList": {
- "description": "Refer to Future list type document.",
- "$ref": "#/definitions/futureListType"
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
- "historyList": {
- "description": "Refer to History list type document.",
- "$ref": "#/definitions/historyListType"
+ "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
+ },
+ "giftCard": {
+ "description": "Indicates a gift card type.",
+ "type": "boolean"
}
}
},
- "reservationId": {
- "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).",
+ "prepaidCardDetailsType": {
"type": "object",
+ "description": "Prepaid Card Details.",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
+ "initialLoadDate": {
+ "description": "Holds fixed charge detail.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "activateDate": {
+ "description": "Holds fixed charge detail.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
+ "initialCreditTotal": {
+ "description": "Holds fixed charge detail.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "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.",
+ "creditTotal": {
+ "description": "Holds fixed charge detail.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "debitTotal": {
+ "description": "Holds fixed charge detail.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "reservedTotal": {
+ "description": "Holds fixed charge detail.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "balanceTotal": {
+ "description": "Holds fixed charge detail.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "validUntilDate": {
+ "description": "Holds fixed charge detail.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "expiredDate": {
+ "description": "Holds fixed charge detail.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "transactions": {
+ "description": "Holds fixed charge detail.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/prepaidCardTransactionType"
+ }
}
}
},
- "reservationIdList": {
- "description": "Unique Id that references an object uniquely in the system.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/uniqueID_Type"
- }
- },
- "reservationInfoType": {
- "description": "The Reservation class contains the current reservation being created or altered.",
+ "prepaidCardTransactionType": {
"type": "object",
+ "description": "Prepaid Card transaction.",
"properties": {
- "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"
- },
- "advanceCheckIn": {
- "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return",
- "$ref": "#/definitions/advanceCheckInType"
- },
- "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"
- },
- "allowMobileViewFolio": {
- "description": "Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.",
- "type": "boolean"
- },
- "allowedActions": {
- "description": "Collection of reservation allowed actions.",
- "$ref": "#/definitions/reservationAllowedActionsType"
- },
- "attachedProfiles": {
- "description": "List of attached profiles",
- "$ref": "#/definitions/resAttachedProfileListType"
- },
- "cancellationInfo": {
- "description": "Information regarding why reservation has been/was cancelled.",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "date": {
- "description": "Date when reservation was last cancelled.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "description": {
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- }
- }
+ "transactionType": {
+ "description": "Transaction type enumeration.",
+ "$ref": "#/definitions/prepaidCardTrxTypeType"
},
- "cashiering": {
- "description": "Holds cashiering related information for the reservation.",
- "$ref": "#/definitions/resCashieringType"
+ "transactionDate": {
+ "description": "Transaction number of the Prepaid card transaction.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "commissionPayoutTo": {
- "description": "If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.",
- "$ref": "#/definitions/commissionPayoutToType"
+ "transactionNo": {
+ "description": "Transaction number of the Prepaid card transaction.",
+ "type": "number"
},
- "computedReservationStatus": {
- "description": "Indicates the status of the reservation.",
- "$ref": "#/definitions/pMS_ResStatusType"
+ "amount": {
+ "description": "Prepaid Card Amount.",
+ "$ref": "#/definitions/currencyAmountType"
},
"createDateTime": {
"description": "Time stamp of the creation.",
@@ -33764,539 +32469,670 @@
"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",
- "maxLength": 200,
- "minLength": 0
- },
- "deposit": {
- "description": "Holds reservation deposit information.",
- "$ref": "#/definitions/reservationDepositType"
- },
- "displayColor": {
- "description": "Color setting of the reservation.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "expectedServiceTime": {
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "externalReferences": {
- "description": "External Reference information for Reservation.",
- "$ref": "#/definitions/externalReferencesType"
+ "format": "date-time"
},
- "guestPreferredCurrency": {
- "description": "Currency code preferred by guest.",
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "hotelId": {
+ "purgeDate": {
+ "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
+ }
+ }
+ },
+ "prepaidCardTrxTypeType": {
+ "type": "string",
+ "description": "Reload transaction.",
+ "enum": [
+ "Activate",
+ "Cancel",
+ "Cashout",
+ "Inquiry",
+ "Issue",
+ "Redeem",
+ "Reload"
+ ]
+ },
+ "reservationPackageType": {
+ "type": "object",
+ "description": "A ReservationPackageType class.",
+ "properties": {
+ "packageHeaderType": {
+ "description": "Package information from configuration.",
+ "$ref": "#/definitions/packageCodeHeaderType"
},
- "hotelInterfaceStatusList": {
- "description": "Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.",
+ "scheduleList": {
+ "description": "A HotelPackageSchedule type.",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/reservationInterfaceStatusType"
+ "$ref": "#/definitions/reservationPackageScheduleType"
}
},
- "hotelName": {
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "housekeeping": {
- "description": "Information regarding housekeeping for this reservation.",
- "$ref": "#/definitions/resHousekeepingType"
+ "newTimeSpan": {
+ "description": "The changed dates(Start and End dates) for this product.",
+ "$ref": "#/definitions/timeSpanType"
},
- "keyCount": {
- "description": "Number of keys created for the reservation.",
- "type": "integer"
+ "consumptionDetails": {
+ "description": "Package consumption details. Includes information for quantity , allowance etc.",
+ "$ref": "#/definitions/packageConsumptionType"
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "packageCode": {
+ "description": "Package code. This is the unique code used for the package and is a required element.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
+ "internalID": {
+ "description": "Reservation Package Opera Internal Unique Id. This is the unique Id used for this reservation package.",
+ "type": "number"
+ },
+ "ratePlanCode": {
+ "description": "The rate code which contains this package. If the package is not part of a rate code, this will be empty. Required element and part of the key to fetch the correct package record on the reservation.",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 20
},
- "lastPrivacyPromptDate": {
- "description": "Last Privacy Prompt Date",
+ "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
},
- "mobileNotifications": {
- "description": "Denotes the status of Room Ready, Key Ready messages.",
- "$ref": "#/definitions/resMobileNotificationsType"
- },
- "openFolio": {
- "description": "Returns true when reservation has an open folio.",
- "type": "boolean"
- },
- "optedForCommunication": {
- "description": "Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.",
- "type": "boolean"
- },
- "paymentMethod": {
- "description": "Payment Method.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "preRegistered": {
- "description": "Defines if the reservation is pre-registered or not.",
- "type": "boolean"
- },
- "purgeDate": {
- "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
+ "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
},
- "queue": {
- "description": "Information about the time and duration this reservation was on Queue for Checkin.",
- "$ref": "#/definitions/reservationQueueInformationType"
- },
- "reservationCommunication": {
- "description": "Collection of reservation communication details.",
- "$ref": "#/definitions/resCommunicationType"
- },
- "reservationFolioWindows": {
- "description": "Collection of reservation folio windows.",
- "$ref": "#/definitions/reservationFolioWindowsType"
- },
- "reservationGuest": {
- "description": "Collection of guests associated with the reservation.",
- "$ref": "#/definitions/resGuestInfoType"
- },
- "reservationIdList": {
- "description": "Unique identifiers for the reservation for both internal and external systems",
- "$ref": "#/definitions/reservationIdList"
- },
- "reservationIndicators": {
- "description": "Indicators of additional information attached to the reservation",
- "$ref": "#/definitions/indicatorsType"
- },
- "reservationPaymentMethod": {
- "description": "Payment method used for this reservation",
- "$ref": "#/definitions/reservationPaymentMethodType"
- },
- "reservationStatus": {
- "description": "Indicates the status of the reservation.",
- "$ref": "#/definitions/pMS_ResStatusType"
- },
- "revenuesAndBalances": {
- "description": "Revenues and Balances Amount summary for the reservation.",
- "$ref": "#/definitions/resRevenueBalanceType"
- },
- "roomStatus": {
- "description": "Current room status",
- "$ref": "#/definitions/housekeepingRoomStatusType"
+ "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 .",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "roomStay": {
- "description": "Collection of room stays.",
- "$ref": "#/definitions/stayInfoType"
+ "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"
},
- "roomStayReservation": {
- "description": "Boolean True if this reservation is reserving rooms. False if it is only reserving services.",
- "type": "boolean"
+ "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
},
- "searchMatches": {
- "description": "Super Search matching terms.",
- "$ref": "#/definitions/searchMatchesType"
+ "points": {
+ "description": "Indicates the points used to redeem the redemption package.",
+ "type": "integer"
+ }
+ }
+ },
+ "packageCodeHeaderType": {
+ "type": "object",
+ "properties": {
+ "primaryDetails": {
+ "description": "Package code header primary details.",
+ "$ref": "#/definitions/configPackagePrimaryDetailsType"
},
- "sharedGuests": {
- "description": "Collection of guests who share this reservation.",
- "$ref": "#/definitions/resSharedGuestListType"
+ "transactionDetails": {
+ "description": "Package code header transaction information.",
+ "$ref": "#/definitions/configPackageTransactionType"
},
- "sourceOfSale": {
- "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.",
- "$ref": "#/definitions/sourceOfSaleType"
+ "postingAttributes": {
+ "description": "Package code posting attributes.",
+ "$ref": "#/definitions/configPostingAttributesType"
},
- "specials": {
- "description": "Set of reservation preferences which belongs to the Specials group.",
+ "usageDetails": {
+ "description": "Package code usage information.",
+ "$ref": "#/definitions/configPackageUsageDetailType"
+ }
+ }
+ },
+ "configPackagePrimaryDetailsType": {
+ "type": "object",
+ "description": "A Config Package Info type.",
+ "properties": {
+ "description": {
+ "description": "The description of the package.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
- },
- "taxType": {
- "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.",
- "$ref": "#/definitions/taxTypeType"
- },
- "turndownInfo": {
- "description": "Currency code preferred by guest.",
- "$ref": "#/definitions/reservationTurndownInfoType"
+ "minLength": 0,
+ "maxLength": 2000
},
- "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"
+ "shortDescription": {
+ "description": "The short description of the package.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "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"
+ "forecastGroup": {
+ "description": "The Forecast group package belongs to.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "welcomeOffer": {
- "description": "This flag will determine wheather the reservation is eligible for Welcome Offer or not.",
- "type": "boolean"
- }
- }
- },
- "reservationInterface": {
- "description": "Request to change the interface status for a reservation.",
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "arrangementCode": {
+ "description": "Arrangement Code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "reservationInterfaceStatus": {
- "description": "Contains collection of reservation and interface information",
- "type": "object",
- "properties": {
- "interfaceStatusList": {
- "description": "Collection of reservation and interface information.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/changeInterfaceStatusType"
- }
- },
- "logo": {
- "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.",
- "$ref": "#/definitions/codeType"
- }
- }
+ "beginSellDate": {
+ "description": "Indicates the begin sell date of the package.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "endSellDate": {
+ "description": "Indicates the end sell date of the package.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
}
}
},
- "reservationInterfaceStatusType": {
- "description": "Hotel Interface Type for a reservation and status of the various services",
+ "configPackageTransactionType": {
"type": "object",
+ "description": "A HotelPackageTransaction type.",
"properties": {
- "hotelInterface": {
- "description": "Hotel interface information for the reservation",
- "$ref": "#/definitions/hotelInterfaceType"
+ "allowance": {
+ "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"
},
- "interfaceRights": {
- "description": "Contains a list of status/rights for the various services under this interface",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/interfaceRightsStatusType"
- }
+ "currency": {
+ "description": "The currency code for this package.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "roomExtension": {
- "description": "Identifier for the room extension",
+ "postingType": {
+ "description": "The posting frequency for this package, e.g., daily, arrival, departure, etc.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "calculationRule": {
+ "description": "The price calculation rule for this package.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "packagePostingRules": {
+ "description": "The package posting rule details.",
+ "$ref": "#/definitions/packagePostingRulesType"
}
}
},
- "reservationList": {
- "description": "A collection of reservation details attached to Profiles.",
+ "packagePostingRulesType": {
"type": "object",
"properties": {
- "count": {
- "description": "Total number of rows returned",
- "type": "integer"
+ "transactionCode": {
+ "description": "The Transaction code used to post the package price.",
+ "$ref": "#/definitions/packageTransactionCodeType"
},
- "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"
+ "overageCode": {
+ "description": "The overage code to record over consumed allowance.",
+ "$ref": "#/definitions/packageTransactionCodeType"
},
- "reservationInfo": {
- "description": "Additional reservation information attached to the profile . Eg : History,Future reservations",
+ "profitCode": {
+ "description": "The transaction code to record package profit, if any, from un-consumed allowance.",
+ "$ref": "#/definitions/packageTransactionCodeType"
+ },
+ "lossCode": {
+ "description": "The transaction code to record package Loss, if any, from un-consumed allowance.",
+ "$ref": "#/definitions/packageTransactionCodeType"
+ },
+ "alternateCodesList": {
+ "description": "The alternate transaction code that can be consumed by the guest in place of the transaction code.",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/reservationInfoType"
+ "$ref": "#/definitions/packageTransactionCodeType"
}
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
}
}
},
- "reservationLocatorType": {
- "description": "Holds the information for a Reservation Guest Locator",
+ "packageTransactionCodeType": {
"type": "object",
"properties": {
- "dateSpan": {
- "description": "Begin and End date range of the Guest Locator.",
- "$ref": "#/definitions/dateRangeType"
- },
- "locatorBy": {
- "description": "User that entered this Guest Locator.",
- "type": "string"
- },
- "locatorId": {
- "description": "Unique Id of the Guest Locator ( Locator Id )",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "locatorOn": {
- "description": "Date and time of the Guest Locator.",
+ "description": {
+ "description": "The description of the code.",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 200
},
- "locatorText": {
- "description": "The Locator Text for the guest.",
- "type": "string"
+ "code": {
+ "description": "Posting / transaction code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "timeSpan": {
- "description": "Time span for the Guest Locator.",
- "$ref": "#/definitions/dateTimeSpanType"
+ "type": {
+ "description": "Code is inclusive or exclusive of other chanrges such as taxes.",
+ "$ref": "#/definitions/amountDeterminationType"
}
}
},
- "reservationLocatorsType": {
- "description": "Holds the Locator Information.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationLocatorType"
- }
- },
- "reservationMembershipType": {
- "description": "Detailed information of the memberships.",
+ "configPostingAttributesType": {
"type": "object",
+ "description": "A config Package posting attributes type.",
"properties": {
- "benefits": {
- "description": "benefits for the membership.",
- "$ref": "#/definitions/benefitsType"
+ "addToRate": {
+ "description": "The package price is added to the room rate.",
+ "type": "boolean"
},
- "centralSetup": {
- "description": "Indicates how the award points for this membership type will be managed.",
+ "printSeparateLine": {
+ "description": "The package price is printed on separate line of the folio.",
"type": "boolean"
},
- "comment": {
- "description": "Additional comments regarding to the membership.",
- "$ref": "#/definitions/paragraphType"
+ "sellSeparate": {
+ "description": "Can the package be sold separate from rate plan code?",
+ "type": "boolean"
},
- "createDateTime": {
- "description": "Time stamp of the creation.",
- "type": "string",
- "format": "date-time"
+ "postNextDay": {
+ "description": "package charges will be posted next business day.",
+ "type": "boolean"
},
- "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",
- "maxLength": 200,
- "minLength": 0
+ "forecastNextDay": {
+ "description": "Package will be forecasted for consumption the next business day.",
+ "type": "boolean"
},
- "currentPoints": {
- "description": "Profile MemberShip Points.",
- "type": "number"
+ "deliveryTimeRequired": {
+ "description": "Indicates whether a delivery time is required for the package.",
+ "type": "boolean"
},
- "downgrade": {
- "description": "Defines how downgrading will be handled for this membership.",
- "$ref": "#/definitions/downgradeType"
+ "webBookable": {
+ "description": "Can package be sold via Web channel.",
+ "type": "boolean"
},
- "downgradeDescription": {
- "description": "Indicates information regarding the member's possible downgrades.",
+ "formula": {
+ "description": "The custom formula used for this package, if any.",
"type": "string",
- "maxLength": 32000,
- "minLength": 0
- },
- "earningPreference": {
- "description": "Earning preference to the membership.",
- "$ref": "#/definitions/membershipEarningPreferenceType"
+ "minLength": 0,
+ "maxLength": 2000
},
- "effectiveDate": {
- "description": "Indicates the starting date.",
+ "formulaFunctionName": {
+ "description": "The custom formula function name used for this package, if any.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 2000
},
- "enrollmentResort": {
- "description": "Resort/CRO where enrollment is done.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "formulaFunctionArguments": {
+ "description": "The function argument name-value combination accepted by the custom formula used for this package.",
+ "$ref": "#/definitions/functionArgumentsType"
},
- "enrollmentSource": {
- "description": "Source from where the enrollment is done.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "startTime": {
+ "description": "Start time the package is valid.",
+ "type": "string"
},
- "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.",
+ "endTime": {
+ "description": "End time the package is valid.",
+ "type": "string"
+ },
+ "catering": {
+ "description": "Is package used for catering?",
"type": "boolean"
},
- "expireDate": {
- "description": "Indicates the ending date.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "postingRhythm": {
+ "description": "The posting rhythm for this package.",
+ "$ref": "#/definitions/packagePostingRhythmType"
},
- "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"
+ "priceCalculationRule": {
+ "description": "The price calculation rule for this package.",
+ "$ref": "#/definitions/packageCalculationRuleType"
},
- "inactive": {
- "description": "Indicates whether membership is active or inactive.",
+ "ticket": {
+ "description": "Indicates whether a package is configured as a ticket or not.",
"type": "boolean"
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "inventoryItems": {
+ "description": "Package Code Inventory Items type.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/pkgInventoryItemType"
+ }
+ },
+ "calculatedPrice": {
+ "description": "Calculated Package Price based from Number of Adults, Children and Calculation Rule.",
+ "type": "number"
+ }
+ }
+ },
+ "functionArgumentsType": {
+ "type": "array",
+ "description": "Collection of function arguments and their corresponding values.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/functionArgumentType"
+ }
+ },
+ "functionArgumentType": {
+ "type": "object",
+ "description": "This type provided details of a function argument and the value it holds.",
+ "properties": {
+ "name": {
+ "description": "Specifies the name of the function argument.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
+ "value": {
+ "description": "Specifies the value held by the function argument.",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 200
},
- "linkMembership": {
+ "position": {
+ "description": "Specifies the position of the function argument in the argument list.",
+ "type": "integer"
+ },
+ "dataType": {
+ "description": "Specifies the datatype of the function argument.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "required": {
+ "description": "Argument of the function mandatory or not.",
"type": "boolean"
+ }
+ }
+ },
+ "packagePostingRhythmType": {
+ "type": "object",
+ "description": "Package Posting rhythm type.",
+ "properties": {
+ "everyXNightsStartingNightY": {
+ "description": "Post the package every X nights Staring from Night Y.",
+ "type": "object",
+ "properties": {
+ "startOnNightY": {
+ "description": "Starting night for consumption and posting prices.",
+ "type": "integer"
+ },
+ "postEveryXNights": {
+ "description": "Occurance of nights when the package needs to be posted and consumed.",
+ "type": "integer"
+ }
+ }
},
- "memberStatus": {
- "description": "Indicates where the guest is in the membership enrollment process.",
+ "certainNightsOfTheWeek": {
+ "description": "Post the package on certain nights of the week.",
+ "type": "object",
+ "properties": {
+ "sunday": {
+ "type": "boolean"
+ },
+ "monday": {
+ "type": "boolean"
+ },
+ "tuesday": {
+ "type": "boolean"
+ },
+ "wednesday": {
+ "type": "boolean"
+ },
+ "thursday": {
+ "type": "boolean"
+ },
+ "friday": {
+ "type": "boolean"
+ },
+ "saturday": {
+ "type": "boolean"
+ }
+ }
+ },
+ "customStaySchedule": {
+ "description": "This user defined schedule lets you enter a posting rhythm over a 14-day period, starting with the arrival date, by assigning the day (number) within a guest stay for posting this package price.",
+ "type": "object",
+ "properties": {
+ "night1": {
+ "description": "Night 1 indicator.",
+ "type": "boolean"
+ },
+ "night2": {
+ "description": "Night 2 indicator.",
+ "type": "boolean"
+ },
+ "night3": {
+ "description": "Night 3 indicator.",
+ "type": "boolean"
+ },
+ "night4": {
+ "description": "Night 4 indicator.",
+ "type": "boolean"
+ },
+ "night5": {
+ "description": "Night 5 indicator.",
+ "type": "boolean"
+ },
+ "night6": {
+ "description": "Night 6 indicator.",
+ "type": "boolean"
+ },
+ "night7": {
+ "description": "Night 7 indicator.",
+ "type": "boolean"
+ },
+ "night8": {
+ "description": "Night 8 indicator.",
+ "type": "boolean"
+ },
+ "night9": {
+ "description": "Night 9 indicator.",
+ "type": "boolean"
+ },
+ "night10": {
+ "description": "Night 10 indicator.",
+ "type": "boolean"
+ },
+ "night11": {
+ "description": "Night 11 indicator.",
+ "type": "boolean"
+ },
+ "night12": {
+ "description": "Night 12 indicator.",
+ "type": "boolean"
+ },
+ "night13": {
+ "description": "Night 13 indicator.",
+ "type": "boolean"
+ },
+ "night14": {
+ "description": "Night 14 indicator.",
+ "type": "boolean"
+ }
+ }
+ },
+ "customNightSchedule": {
+ "description": "The start and end of the posting period is determined as follows: If the package is attached to a rate code: The period starts with the date when the rate code to which the package is attached becomes effective for the stay. The period ends with the date of the last night for that rate code (or the last night of the stay if the rate code remains in effect until the departure date). If the package is attached separately to the reservation: The Begin Date specified on the reservation when the package was attached is the start date for the period. The End Date specified on the reservation when the package was attached is the end date for the period. If no Begin Date and/or End Date are specified when the package is attached to the reservation, the Begin Date is assumed to be the arrival date and the End Date is assumed to be the departure date of the reservation, irrespective of when the package is attached to the reservation.",
+ "type": "object",
+ "properties": {
+ "night1": {
+ "description": "Night 1 indicator.",
+ "type": "boolean"
+ },
+ "night2": {
+ "description": "Night 2 indicator.",
+ "type": "boolean"
+ },
+ "night3": {
+ "description": "Night 3 indicator.",
+ "type": "boolean"
+ },
+ "night4": {
+ "description": "Night 4 indicator.",
+ "type": "boolean"
+ },
+ "night5": {
+ "description": "Night 5 indicator.",
+ "type": "boolean"
+ },
+ "night6": {
+ "description": "Night 6 indicator.",
+ "type": "boolean"
+ },
+ "night7": {
+ "description": "Night 7 indicator.",
+ "type": "boolean"
+ },
+ "night8": {
+ "description": "Night 8 indicator.",
+ "type": "boolean"
+ },
+ "night9": {
+ "description": "Night 9 indicator.",
+ "type": "boolean"
+ },
+ "night10": {
+ "description": "Night 10 indicator.",
+ "type": "boolean"
+ },
+ "night11": {
+ "description": "Night 11 indicator.",
+ "type": "boolean"
+ },
+ "night12": {
+ "description": "Night 12 indicator.",
+ "type": "boolean"
+ },
+ "night13": {
+ "description": "Night 13 indicator.",
+ "type": "boolean"
+ },
+ "night14": {
+ "description": "Night 14 indicator.",
+ "type": "boolean"
+ }
+ }
+ },
+ "type": {
+ "description": "Posting Rhythm for the package.",
+ "$ref": "#/definitions/postingRhythmType"
+ }
+ }
+ },
+ "postingRhythmType": {
+ "type": "string",
+ "description": "Simple type for posting Rhythm types.",
+ "enum": [
+ "EveryNight",
+ "ArrivalNight",
+ "EveryXNightsStartingNightY",
+ "CertainNightsOfTheWeek",
+ "LastNight",
+ "EveryNightExceptArrivalNight",
+ "EveryNightExceptLast",
+ "EveryNightExceptFirstAndLast",
+ "CustomStaySchedule",
+ "CustomNightSchedule",
+ "FloatingAllowancePerStay",
+ "TicketPosting"
+ ]
+ },
+ "packageCalculationRuleType": {
+ "type": "string",
+ "description": "Simple type for package caluculation rules.",
+ "enum": [
+ "FlatRate",
+ "PerPerson",
+ "PerAdult",
+ "PerChild",
+ "PerRoom"
+ ]
+ },
+ "pkgInventoryItemType": {
+ "type": "object",
+ "properties": {
+ "articleNumber": {
+ "description": "Article Number of the inventory item.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "membershipClass": {
- "description": "Indicates the membership class.",
- "type": "string"
+ "minLength": 0,
+ "maxLength": 20
},
- "membershipEnrollmentCode": {
- "description": "Indicates how the guest enrolled in the program.",
+ "description": {
+ "description": "Description of the inventory item.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "membershipId": {
- "description": "Card Number of the membership.",
- "type": "string"
+ "minLength": 0,
+ "maxLength": 200
},
- "membershipIdNo": {
- "description": "Membership ID Number.",
+ "quantity": {
+ "description": "Quantity of the inventory item allocated to the package.",
"type": "integer"
},
- "membershipLevel": {
- "description": "Indicates the membership level.",
- "type": "string"
- },
- "membershipLevelDescription": {
- "description": "Indicates the membership level description.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "membershipType": {
- "description": "Type of membership.",
- "type": "string"
- },
- "nameOnCard": {
- "description": "Name to be displayed on the membership card.",
- "type": "string"
- },
- "newMembershipNumber": {
- "description": "Card Number of the membership.",
- "type": "string"
- },
- "orderSequence": {
- "description": "Display Order sequence.",
- "type": "number"
- },
- "playerRanking": {
- "description": "Ranking assigned to the Player Profile by the Gaming system.",
+ "itemId": {
+ "description": "Identifier for the inventory item.",
"type": "integer"
+ }
+ }
+ },
+ "configPackageUsageDetailType": {
+ "type": "object",
+ "description": "A Config Package Usage Detail type.",
+ "properties": {
+ "source": {
+ "description": "Indicates if the source of the product is Rate header, Rate Detail or Reservation.",
+ "$ref": "#/definitions/productSourceType"
},
- "pointsLabel": {
- "description": "Label used to refer to points for this membership type",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "preferredCard": {
- "description": "Preferred Card.",
+ "usedInReservations": {
+ "description": "Indicates if the package is used in, reserved or prospect reservations.",
"type": "boolean"
},
- "primary": {
+ "usedInRates": {
+ "description": "Indicates if the package is used in any rate code.",
"type": "boolean"
},
- "primaryMembership": {
- "description": "Boolean indicator set to True implies membership is a Primary Membership.",
+ "usedInHouseReservations": {
+ "description": "Indicates if any checked in reservations are using this product.",
"type": "boolean"
- },
- "primaryMembershipYn": {
- "description": "Indicator if Membership is a Primary Membership.",
- "type": "string",
- "maxLength": 1,
- "minLength": 0
- },
- "programDescription": {
- "description": "Description of the membership program.",
- "type": "string"
- },
- "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
- },
- "rating": {
- "description": "Value Rating Type Description for this membership.",
- "type": "string"
- },
- "reIssueNewCard": {
- "description": "The status of issuing new membership card to the member.",
- "$ref": "#/definitions/cardReIssueType"
- },
- "signupDate": {
- "description": "Indicates when the member signed up for the loyalty program.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "tierAdministration": {
- "description": "Defines the degree of participation for this membership in the tier management portion of the program.",
- "$ref": "#/definitions/tierAdministrationType"
- },
- "upgradeDescription": {
- "description": "Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.",
- "type": "string",
- "maxLength": 32000,
- "minLength": 0
}
}
},
+ "productSourceType": {
+ "type": "string",
+ "description": "Sources of Products",
+ "enum": [
+ "Reservation",
+ "RateHeader",
+ "RateDetail"
+ ]
+ },
"reservationPackageScheduleType": {
- "description": "A HotelPackageSchedule type.",
"type": "object",
+ "description": "A HotelPackageSchedule type.",
"properties": {
- "computedResvPrice": {
- "description": "Computed Reservation Price of the package. Calculation Will Be Performed Based On Other Parameters.",
- "type": "number"
- },
"consumptionDate": {
"description": "The date the package was used or can be used.",
"type": "string",
"format": "date",
"maxLength": 8
},
- "originalUnitAllowance": {
- "description": "The original allowance per unit of the package if it has been changed.",
+ "unitPrice": {
+ "description": "The price per unit of the package.",
"type": "number"
},
- "originalUnitPrice": {
- "description": "The original price per unit of the package if it has been changed.",
+ "totalQuantity": {
+ "description": "The total quantity of the package for this date, calculated based on the calculation rule as defined in the PackageHeaderType",
+ "type": "integer"
+ },
+ "computedResvPrice": {
+ "description": "Computed Reservation Price of the package. Calculation Will Be Performed Based On Other Parameters.",
+ "type": "number"
+ },
+ "unitAllowance": {
+ "description": "The allowance per unit of the package.",
"type": "number"
},
"reservationDate": {
@@ -34305,3137 +33141,3294 @@
"format": "date",
"maxLength": 8
},
- "totalQuantity": {
- "description": "The total quantity of the package for this date, calculated based on the calculation rule as defined in the PackageHeaderType",
- "type": "integer"
- },
- "unitAllowance": {
- "description": "The allowance per unit of the package.",
+ "originalUnitPrice": {
+ "description": "The original price per unit of the package if it has been changed.",
"type": "number"
},
- "unitPrice": {
- "description": "The price per unit of the package.",
+ "originalUnitAllowance": {
+ "description": "The original allowance per unit of the package if it has been changed.",
"type": "number"
}
}
},
- "reservationPackageType": {
- "description": "A ReservationPackageType class.",
+ "packageConsumptionType": {
"type": "object",
+ "description": "Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.",
"properties": {
- "awardCode": {
- "description": "This is the Award code used to redeem the package if the package is a redemption package.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "consumptionDetails": {
- "description": "Package consumption details. Includes information for quantity , allowance etc.",
- "$ref": "#/definitions/packageConsumptionType"
- },
- "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
- },
- "internalID": {
- "description": "Reservation Package Opera Internal Unique Id. This is the unique Id used for this reservation package.",
- "type": "number"
- },
- "newTimeSpan": {
- "description": "The changed dates(Start and End dates) for this product.",
- "$ref": "#/definitions/timeSpanType"
- },
- "packageCode": {
- "description": "Package code. This is the unique code used for the package and is a required element.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "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 .",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "packageHeaderType": {
- "description": "Package information from configuration.",
- "$ref": "#/definitions/packageCodeHeaderType"
+ "defaultQuantity": {
+ "description": "The default quantity attached in the package.",
+ "type": "integer"
},
- "points": {
- "description": "Indicates the points used to redeem the redemption package.",
+ "excludedQuantity": {
+ "description": "The quantity which has been excluded in the package.",
"type": "integer"
},
- "ratePlanCode": {
- "description": "The rate code which contains this package. If the package is not part of a rate code, this will be empty. Required element and part of the key to fetch the correct package record on the reservation.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "totalQuantity": {
+ "description": "The total quantity of the package, calculated based on the calculation rule as defined in the PackageHeaderType.",
+ "type": "integer"
},
- "scheduleList": {
- "description": "A HotelPackageSchedule type.",
+ "allowanceConsumed": {
+ "description": "Indicates if Allowance(for POS packages) has been consumed/posted for today.",
+ "type": "boolean"
+ }
+ }
+ },
+ "resInventoryItemsType": {
+ "type": "object",
+ "description": "Defines a collection of inventory items attached to a reservation.",
+ "properties": {
+ "item": {
+ "description": "Inventory item attached to a reservation.",
"type": "array",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/reservationPackageScheduleType"
+ "$ref": "#/definitions/resInventoryItemType"
}
},
- "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"
- },
- "startDate": {
- "description": "Required value when changing a reservation package. If the original start date was null, then null is required.",
+ "itemClassCode": {
+ "description": "The Item Class ID which the item belongs to.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "reservationPaymentMethodType": {
+ "resInventoryItemType": {
"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": {
- "authorizationRule": {
- "$ref": "#/definitions/authorizationRuleType"
+ "url": {
+ "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "type": "string"
},
- "balance": {
- "$ref": "#/definitions/currencyAmountType"
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "description": {
+ "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",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "emailFolioInfo": {
- "description": "Information on an email for the customer.",
- "type": "object",
- "properties": {
- "email": {
- "description": "eMail deatils for the profile.",
- "$ref": "#/definitions/emailType"
- },
- "emailFolio": {
- "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",
- "maxLength": 80,
- "minLength": 0
- },
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- }
- }
+ "idContext": {
+ "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "folioView": {
- "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.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "paymentCard": {
- "$ref": "#/definitions/resPaymentCardType"
+ "idExtension": {
+ "description": "Additional identifying value assigned by the creating system.",
+ "type": "integer"
},
- "paymentMethod": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "reservationPaymentMethodsType": {
- "description": "Defines reservation payment methods.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationPaymentMethodType"
- }
- },
- "reservationPoliciesType": {
- "description": "A collection of reservation deposit and cancellation policies.",
- "type": "object",
- "properties": {
- "cancellationPolicies": {
- "description": "A collection of reservation cancellation policies..",
- "$ref": "#/definitions/resCancellationPoliciesType"
+ "item": {
+ "description": "Specifies Items and its attributes. When used for data manipulation for Items setup on reservation, etc only code is considered. Other Attributes are for used to provide information during fetch operation.",
+ "$ref": "#/definitions/itemInfoType"
},
- "depositPolicies": {
- "description": "A collection of reservation deposit policies.",
- "$ref": "#/definitions/resDepositPoliciesType"
+ "quantity": {
+ "description": "Number of items booked.",
+ "type": "integer"
},
- "name": {
- "description": "Name identifier for the reservation.",
- "type": "string"
+ "timeSpan": {
+ "description": "Begin and end date and time of the items applicability.",
+ "$ref": "#/definitions/dateRangeType"
},
- "reservationIdList": {
- "description": "A list of Ids for reservation.",
- "$ref": "#/definitions/uniqueIDListType"
+ "source": {
+ "description": "If exists specifies whether the item is setup due to a Rate Plan, Package or a Block.",
+ "$ref": "#/definitions/resInventoryItemSourceType"
}
}
},
- "reservationProfileType": {
+ "itemInfoType": {
"type": "object",
+ "description": "Basic information regarding an Item.",
"properties": {
- "profile": {
- "description": "Provides detailed information regarding either a company or a customer profile.",
- "$ref": "#/definitions/profileType"
+ "description": {
+ "description": "Detail description of an item.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "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"
+ "availabilityPeriod": {
+ "description": "Defines a Time period when the item is available.",
+ "$ref": "#/definitions/timeWindowType"
},
- "reservationProfileType": {
- "$ref": "#/definitions/resProfileTypeType"
- }
- }
- },
- "reservationQueueInformationType": {
- "description": "Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.",
- "type": "object",
- "properties": {
- "averageQueueTimeCurrentReservations": {
- "description": "The average time, in seconds, of the reservations currently in queue.",
- "type": "integer"
+ "timeSpan": {
+ "description": "Date Range to get the inventories of the items.",
+ "$ref": "#/definitions/timeSpanType"
},
- "averageQueueTimeToCheckIn": {
- "description": "The average time, in seconds, a reservation was on queue prior to Check-In.",
+ "quantity": {
+ "description": "Quantity of hold Item",
"type": "integer"
},
- "guestTextInfo": {
- "description": "Information for the message sent to the user",
- "$ref": "#/definitions/queueTextInfoType"
+ "itemHoldId": {
+ "description": "ID reference for the hold Item",
+ "type": "number"
},
- "priority": {
- "description": "The Queue Priority given to this reservation.",
- "type": "integer"
+ "code": {
+ "description": "Item Code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "queueDate": {
- "description": "The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In.",
+ "name": {
+ "description": "Name of an item.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 200
},
- "timeSpan": {
- "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.",
- "type": "object",
- "properties": {
- "duration": {
- "type": "string"
- },
- "durationInSeconds": {
- "description": "The total duration, in seconds, the reservation is on Queue.",
- "type": "integer"
- },
- "endDate": {
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "startDate": {
- "type": "string",
- "format": "date",
- "maxLength": 8
- }
- }
- }
- }
- },
- "reservationQueuePriority": {
- "description": "Response to the request to add a reservation to the Queue for Check-In.",
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "itemPool": {
+ "description": "Indicates if it is an item pool. Not applicable for Item within the Item Pool.",
+ "type": "boolean"
},
- "queueInfo": {
- "description": "Queue Information for this reservation.",
- "$ref": "#/definitions/reservationQueueInformationType"
+ "sellSeparate": {
+ "description": "If true indicates that item is allowed to sell separately.",
+ "type": "boolean"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "sellInReservation": {
+ "description": "If true indicates that item can be sold in reservation.",
+ "type": "boolean"
+ },
+ "sellInEvent": {
+ "description": "If true indicates that item can be sold in event.",
+ "type": "boolean"
+ },
+ "requiredForBooking": {
+ "description": "If true indicates that item is required for the reservation.",
+ "type": "boolean"
+ },
+ "fixedCharge": {
+ "description": "If true indicates that item has fixed charge when it is attached to a reservation.",
+ "type": "boolean"
+ },
+ "outsideStay": {
+ "description": "If true indicates that item could be held outside of the reservation stay days.",
+ "type": "boolean"
+ },
+ "defaultDuration": {
+ "description": "Define the default duration in days when booking the item.",
+ "type": "integer"
}
}
},
- "reservationQueuePriorityNumber": {
- "description": "Request to change the current priority of a reservation in Queue for Check-In.",
+ "timeWindowType": {
"type": "object",
+ "description": "Defines a Time period with start time and an end time.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
- },
- "priority": {
- "description": "Priority which should be assigned to the reservation in Queue. If null, the topmost priority(1) will be assigned. All other reservations in the queue will be adjusted accordingly.",
- "type": "integer"
+ "startTime": {
+ "description": "Start Time of the Time window.",
+ "type": "string"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "endTime": {
+ "description": "End Time of the Time window.",
+ "type": "string"
}
}
},
- "reservationQueueRoomTypeStatisticsType": {
- "description": "Type for Room Type statistics for reservations currently in Queue for Check-In. Statistics would be the number of rooms for each room type which is currently in Queue. Statistics will also include the current number of rooms for each room status for the resort at the current time i.e the number of dirty rooms, clean rooms for each room type. In addition, the statistics will include the number of rooms per room type which are Vacant / Occupied.",
+ "resInventoryItemSourceType": {
"type": "object",
+ "description": "Defines whether the item is setup due to a Rate Plan, Package or a Block.",
"properties": {
- "fOStatus": {
- "description": "The number of rooms for the room type grouped by their FO status i.e Vacant or Occupied.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "object",
- "properties": {
- "frontOfficeStatus": {
- "description": "The FO status code i.e Vacant, Occupied.",
- "$ref": "#/definitions/frontOfficeRoomStatusType"
- },
- "roomStatus": {
- "description": "The total number of rooms for the room type grouped by their Room Status i.e Clean, Dirty etc..",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "object",
- "properties": {
- "housekeepingRoomStatus": {
- "description": "The room status code example Clean, Dirty etc.",
- "$ref": "#/definitions/housekeepingRoomStatusType"
- },
- "totalRooms": {
- "description": "The total number of rooms for the room status.",
- "type": "integer"
- }
- }
- }
- },
- "totalRooms": {
- "description": "The total number of rooms for the Front Office status.",
- "type": "integer"
- }
- }
- }
+ "ratePlanCode": {
+ "description": "Rate Plan Code, If populated specifies that the item is setup due to a Rate Plan.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "roomType": {
- "description": "The room type for the statistics.",
+ "packageCode": {
+ "description": "Package Code, If populated specifies that the item is setup due to a Package.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "blockId": {
+ "description": "Block Unique ID, If populated specifies that the item is setup due to a Block.",
+ "$ref": "#/definitions/blockId"
+ },
+ "welcomeOffer": {
+ "description": "If true, it implies that the item has been attached to the reservation as part of a Welcome Offer",
+ "type": "boolean"
},
- "totalInQueue": {
- "description": "The total number of reservations in Queue for this room type.",
- "type": "integer"
+ "packageInternalID": {
+ "description": "Source Reservation Package Opera Internal Unique Id. This is the unique Id used for the reservation package associated with this item.",
+ "type": "number"
}
}
},
- "reservationQueueStatistics": {
- "description": "Response for the fetch of current Reservations In Queue statistics. Contains the statistic information.",
+ "blockId": {
"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": {
- "links": {
- "$ref": "#/definitions/links"
+ "url": {
+ "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "type": "string"
},
- "statistics": {
- "description": "Queue Reservation statistics. Currently statistic is by Room Type.",
- "$ref": "#/definitions/reservationQueueStatisticsType"
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "reservationQueueStatisticsType": {
- "description": "Type for statistics of the reservations currently in Queue for Check-In.",
- "type": "object",
- "properties": {
- "averageQueueTimeCurrentReservations": {
- "description": "The average time, in seconds, of the reservations currently in queue.",
- "type": "integer"
+ "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
},
- "averageQueueTimeToCheckIn": {
- "description": "The average time, in seconds, a reservation was on queue prior to Check-In.",
- "type": "integer"
+ "idContext": {
+ "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "roomType": {
- "description": "Room Type statistics for the reservations currently in Queue for Check-In.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationQueueRoomTypeStatisticsType"
- }
+ "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"
}
}
},
- "reservationRoomOwnershipType": {
- "description": "Indicates if the assigned reservation room is an Owner/Referral or Regular room.",
- "type": "string",
- "enum": [
- "Owner",
- "Referral",
- "Regular"
- ]
- },
- "reservationRoomSelectionOverrideType": {
- "description": "Define the override flag which will be used when configuring a room to a reservation.",
+ "membershipType": {
"type": "object",
+ "description": "Detailed information of the memberships.",
"properties": {
- "dayUseReserved": {
- "description": "If the current reservation is a Day Use, then check on Reserved rooms can be overridden when assigning rooms.",
- "type": "boolean"
+ "comment": {
+ "description": "Additional comments regarding to the membership.",
+ "$ref": "#/definitions/paragraphType"
},
- "dirtyRoom": {
- "description": "Override the room selection even if the selected room has a \"dirty\" state.",
- "type": "boolean"
+ "newMembershipNumber": {
+ "description": "Card Number of the membership.",
+ "type": "string"
},
- "holdRoom": {
- "description": "Override the Hold Room flag in the database and use the value passed.",
- "type": "boolean"
+ "nameOnCard": {
+ "description": "Name to be displayed on the membership card.",
+ "type": "string"
},
- "inventoryRestriction": {
- "description": "Override the room selection even when there is no inventory.",
- "type": "boolean"
+ "programDescription": {
+ "description": "Description of the membership program.",
+ "type": "string"
},
- "occupancyRestriction": {
- "description": "Override the room selection even when room occupancy is exceeded.",
- "type": "boolean"
+ "membershipLevel": {
+ "description": "Indicates the membership level.",
+ "type": "string"
},
- "outOfServiceRoom": {
- "description": "Override the room selection even if the selected room has an \"out-of-service\" state.",
- "type": "boolean"
+ "membershipLevelDescription": {
+ "description": "Indicates the membership level description.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
- "overrideExternalChecks": {
- "description": "Forcefully override update. For real-time CRS interfaces, this element is used as force selling indicator.",
- "type": "boolean"
+ "membershipClass": {
+ "description": "Indicates the membership class.",
+ "type": "string"
},
- "overrideInstruction": {
- "description": "Contains user information for the override action performed while booking a reservation.",
- "$ref": "#/definitions/overrideInstructionType"
+ "earningPreference": {
+ "description": "Earning preference to the membership.",
+ "$ref": "#/definitions/membershipEarningPreferenceType"
},
- "overrideRoomOwnership": {
- "description": "Override the room ownership indicator in the reservation when assigning rooms. This is applicable when Room Rotation OPERA Control is active.",
+ "inactive": {
+ "description": "Indicates whether membership is active or inactive.",
"type": "boolean"
},
- "overrideRotationRoom": {
- "description": "Override the rotation room with the selected room when assigning rooms.",
- "type": "boolean"
+ "benefits": {
+ "description": "benefits for the membership.",
+ "$ref": "#/definitions/benefitsType"
},
- "rateChange": {
- "description": "Defines override rate type.",
- "$ref": "#/definitions/rateChangeInstructionType"
+ "tierAdministration": {
+ "description": "Defines the degree of participation for this membership in the tier management portion of the program.",
+ "$ref": "#/definitions/tierAdministrationType"
},
- "rateRestriction": {
- "description": "Override the room selection even when there is rate restriction present for this room type.",
- "type": "boolean"
+ "downgrade": {
+ "description": "Defines how downgrading will be handled for this membership.",
+ "$ref": "#/definitions/downgradeType"
},
- "roomNumberLocked": {
- "description": "Override the room number locked flag in the database and use the value passed.",
+ "reIssueNewCard": {
+ "description": "The status of issuing new membership card to the member.",
+ "$ref": "#/definitions/cardReIssueType"
+ },
+ "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"
},
- "roomOwnershipType": {
- "description": "Indicates if the reservation room is an owner or referral or regular room. This is applicable when Room Rotation OPERA Control is active.",
- "$ref": "#/definitions/reservationRoomOwnershipType"
+ "upgradeDescription": {
+ "description": "Indicates Upgrade information which includes member's next tier level, requirements for the next upgrade.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 32000
},
- "sleepDiscrepantRoom": {
- "description": "Override the room selection even when HouseKeeping configured the room to still be occupied.",
- "type": "boolean"
- }
- }
- },
- "reservationRoomSelectionType": {
- "description": "Defines search criteria needed to configure a room to a reservation.",
- "type": "object",
- "properties": {
- "hotelId": {
+ "downgradeDescription": {
+ "description": "Indicates information regarding the member's possible downgrades.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 32000
},
- "includeDepartureRooms": {
- "description": "Indicates if departure rooms are to be included for room assignment.",
- "type": "boolean"
+ "rating": {
+ "description": "Value Rating Type Description for this membership.",
+ "type": "string"
},
- "includedSharers": {
- "description": "Valid share reservation identifier.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationIdList"
- }
+ "membershipEnrollmentCode": {
+ "description": "Indicates how the guest enrolled in the program.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "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"
+ "memberStatus": {
+ "description": "Indicates where the guest is in the membership enrollment process.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "overrideInstructions": {
- "description": "If this element is present, override flags will be set when configuring the room to the reservation.",
- "$ref": "#/definitions/reservationRoomSelectionOverrideType"
+ "currentPoints": {
+ "description": "Profile MemberShip Points.",
+ "type": "number"
},
- "reservationIdList": {
- "$ref": "#/definitions/reservationIdList"
+ "pointsLabel": {
+ "description": "Label used to refer to points for this membership type",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "roomId": {
- "description": "Room identifier which the reservation will hold.",
+ "enrollmentSource": {
+ "description": "Source from where the enrollment is done.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "enrollmentResort": {
+ "description": "Resort/CRO where enrollment is done.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "roomNumberLocked": {
- "description": "Update the do not move flag used to locking the reservation room number.",
+ "preferredCard": {
+ "description": "Preferred Card.",
"type": "boolean"
},
- "updateRoomTypeCharged": {
- "description": "Update the Room Type used for the Rate calculation.",
+ "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.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 1
+ },
+ "primaryMembership": {
+ "description": "Boolean indicator set to True implies membership is a Primary Membership.",
"type": "boolean"
- }
- }
- },
- "reservationShortInfoType": {
- "type": "object",
- "properties": {
- "guestName": {
- "description": "Guest name that is registered for the reservation.",
+ },
+ "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.",
+ "type": "boolean"
+ },
+ "signupDate": {
+ "description": "Indicates when the member signed up for the loyalty program.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "profileId": {
- "description": "ProfileId of the guest.",
- "$ref": "#/definitions/uniqueID_Type"
+ "effectiveDate": {
+ "description": "Indicates the starting date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "reservationId": {
- "$ref": "#/definitions/reservationId"
+ "expireDate": {
+ "description": "Indicates the ending date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "reservationStatusInfo": {
- "$ref": "#/definitions/housekeepingRoomReservationStatusType"
+ "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"
},
- "stayDateInfo": {
- "$ref": "#/definitions/stayDateInfoType"
+ "orderSequence": {
+ "description": "Display Order sequence.",
+ "type": "number"
},
- "vipStatus": {
- "description": "VIP status of the guest.",
- "$ref": "#/definitions/vIPStatusType"
- }
- }
- },
- "reservationStatusEnumType": {
- "description": "Reservation Status Enum Type",
- "type": "string",
- "enum": [
- "DueIn",
- "DueOut",
- "CheckedIn",
- "CheckedOut"
- ]
- },
- "reservationStatusStatisticsResponseType": {
- "description": "Reservation Status Statistics",
- "type": "object",
- "properties": {
- "reservationStatusStatistics": {
- "description": "Statistics for each Reservation Status",
- "type": "array",
- "maxItems": 4,
- "items": {
- "$ref": "#/definitions/reservationStatusStatisticsType"
- }
- }
- }
- },
- "reservationStatusStatisticsType": {
- "description": "Reservation Statistics for a Reservation Status",
- "type": "object",
- "properties": {
- "reservationStatus": {
- "description": "Reservation Status.",
- "$ref": "#/definitions/reservationStatusEnumType"
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
+ "type": "string",
+ "format": "date-time"
},
- "roomClasses": {
- "description": "Reservation Statistics for each Room Class",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomClassStatisticsType"
- }
+ "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
},
- "total": {
- "description": "Number of reservations.",
- "type": "integer",
- "maximum": 4000,
- "minimum": 0
- }
- }
- },
- "reservationStayHistoryFutureInfoType": {
- "description": "Information of History and Future Reservation details attached to Profiles.",
- "type": "object",
- "properties": {
- "futureList": {
- "description": "Refer to Future list type document.",
- "$ref": "#/definitions/stayFutureListType"
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
+ "type": "string",
+ "format": "date-time"
},
- "historyList": {
- "description": "Refer to History list type document.",
- "$ref": "#/definitions/stayHistoryListType"
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ },
+ "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
}
}
},
- "reservationTaxTypeInfo": {
- "description": "Provides information about the Tax Type.",
+ "reservationMembershipType": {
"type": "object",
"properties": {
- "code": {
- "description": "Code of the Tax Type.",
+ "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"
+ },
+ "membershipLevelDescription": {
+ "description": "Indicates the membership level description.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "collectingAgentTax": {
- "description": "A boolean flag for Collecting Agent Tax",
+ "membershipClass": {
+ "description": "Indicates the membership class.",
+ "type": "string"
+ },
+ "earningPreference": {
+ "description": "Earning preference to the membership.",
+ "$ref": "#/definitions/membershipEarningPreferenceType"
+ },
+ "inactive": {
+ "description": "Indicates whether membership is active or inactive.",
"type": "boolean"
},
- "description": {
- "description": "Description of the Tax Type.",
+ "benefits": {
+ "description": "benefits for the membership.",
+ "$ref": "#/definitions/benefitsType"
+ },
+ "tierAdministration": {
+ "description": "Defines the degree of participation for this membership in the tier management portion of the program.",
+ "$ref": "#/definitions/tierAdministrationType"
+ },
+ "downgrade": {
+ "description": "Defines how downgrading will be handled for this membership.",
+ "$ref": "#/definitions/downgradeType"
+ },
+ "reIssueNewCard": {
+ "description": "The status of issuing new membership card to the member.",
+ "$ref": "#/definitions/cardReIssueType"
+ },
+ "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",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 32000
},
- "hotelId": {
- "description": "Code of the Hotel.",
+ "downgradeDescription": {
+ "description": "Indicates information regarding the member's possible downgrades.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 32000
},
- "minimumLengthOfStay": {
- "description": "Minimun Length of Stay.",
- "type": "integer"
+ "rating": {
+ "description": "Value Rating Type Description for this membership.",
+ "type": "string"
},
- "printAutoAdjust": {
- "description": "Print auto adjust information for this tax type on the tax exempt report.",
- "type": "boolean"
+ "membershipEnrollmentCode": {
+ "description": "Indicates how the guest enrolled in the program.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "reportExemptDays": {
- "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.",
- "type": "integer"
+ "memberStatus": {
+ "description": "Indicates where the guest is in the membership enrollment process.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "reportTaxPercentage": {
- "description": "Tax percentage. Only used for tax exempt report.",
- "type": "number",
- "maximum": 100,
- "minimum": 0
+ "currentPoints": {
+ "description": "Profile MemberShip Points.",
+ "type": "number"
},
- "taxExemptNo": {
- "description": "Tax exempt number on the profile.",
+ "pointsLabel": {
+ "description": "Label used to refer to points for this membership type",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "reservationTransactionDiversionType": {
- "description": "A Transaction Diversion Rule Type",
- "type": "object",
- "properties": {
- "code": {
- "description": "Transaction Diversion Code",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "enrollmentSource": {
+ "description": "Source from where the enrollment is done.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "dailyDetails": {
- "description": "Collection of daily details of a Transaction diversion rule for a particular reservation.",
- "$ref": "#/definitions/transactionDiversionDailyDetailsType"
+ "enrollmentResort": {
+ "description": "Resort/CRO where enrollment is done.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "description": {
- "description": "User defined message for the Transaction Diversion Rule.",
+ "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.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 1
},
- "displaySequence": {
- "description": "User configured Sequence number.",
- "type": "number"
+ "primaryMembership": {
+ "description": "Boolean indicator set to True implies membership is a Primary Membership.",
+ "type": "boolean"
},
- "diverted": {
- "description": "Transaction diversions that are diverted .",
+ "membershipIdNo": {
+ "description": "Membership ID Number.",
+ "type": "integer"
+ },
+ "playerRanking": {
+ "description": "Ranking assigned to the Player Profile by the Gaming system.",
"type": "integer"
},
- "hotelId": {
- "description": "Hotel code with which Transaction Diversion Rule is associated.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "inactive": {
- "description": "Indicator that tells whether the transaction diversion rule is active or not.",
+ "centralSetup": {
+ "description": "Indicates how the award points for this membership type will be managed.",
"type": "boolean"
},
- "level": {
- "description": "Level of the Transaction Diversion rule that can be Property or Reservation.",
- "$ref": "#/definitions/transactionDiversionRuleLevelType"
+ "signupDate": {
+ "description": "Indicates when the member signed up for the loyalty program.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "membership": {
- "description": "Membership type to consider while applying Diversion Instruction.",
- "$ref": "#/definitions/membershipTypeLevelType"
+ "effectiveDate": {
+ "description": "Indicates the starting date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "notes": {
- "description": "The Note details related to the Transaction Diversion Rule.",
- "$ref": "#/definitions/commentInfoType"
+ "expireDate": {
+ "description": "Indicates the ending date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "posted": {
- "description": "Transaction diversions that are posted.",
- "type": "integer"
+ "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"
},
- "targetRoom": {
- "description": "Room number to receive all the diverted transactions configured for this instruction.",
+ "orderSequence": {
+ "description": "Display Order sequence.",
+ "type": "number"
+ },
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "thresholds": {
- "description": "Threshold Details related to the Transaction diversion rule.",
- "$ref": "#/definitions/thresholdDetailsType"
+ "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
},
- "transactionCodes": {
- "description": "Collection of Transaction Code List",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/codeDescriptionType"
- }
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
+ "type": "string",
+ "format": "date-time"
},
- "type": {
- "description": "Transaction Diversion Rule Types",
- "$ref": "#/definitions/transactionDiversionRuleTypeType"
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
- "vipCode": {
- "description": "VIP code to consider while applying Diversion Instruction.",
+ "purgeDate": {
+ "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "reservationTransactionDiversionsType": {
- "description": "List of Transaction Diversion rules.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationTransactionDiversionType"
- }
- },
- "reservationTurndownInfoType": {
- "description": "Turndown information for a reservation",
- "type": "object",
- "properties": {
- "allowed": {
- "description": "Indicates if turndown is allowed or not",
+ "format": "date",
+ "maxLength": 8
+ },
+ "linkMembership": {
"type": "boolean"
},
- "status": {
- "description": "Indicates turndown status, values could be required, not required, completed",
- "$ref": "#/definitions/turndownStatusType"
+ "primary": {
+ "type": "boolean"
}
- }
+ },
+ "description": "Detailed information of the memberships."
},
- "reservationsForCCAuthType": {
- "description": "List of reservations with their payment methods.",
+ "routingInfoListType": {
"type": "array",
+ "description": "A routing info object can either be of type Folio OR of type Room with its corresponding instructions.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/reservationForCCAuthType"
+ "$ref": "#/definitions/routingInfoType"
}
},
- "reservationsInQueue": {
- "description": "Response for the operation to fetch Reservations in Queue",
+ "routingInfoType": {
"type": "object",
+ "description": "A routing info object can either be of type Folio OR of type Room with its corresponding object.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
- },
- "reservations": {
- "description": "List of reservation currently in queue.",
- "$ref": "#/definitions/reservationList"
- },
- "roomStatusInfo": {
- "description": "Master Information regarding the room status for each of the rooms included in the response.",
- "$ref": "#/definitions/hotelRoomsType"
+ "folio": {
+ "description": "Folio routing type.",
+ "type": "object",
+ "properties": {
+ "guestInfo": {
+ "description": "Guest details",
+ "type": "object",
+ "properties": {
+ "profileIdList": {
+ "description": "Unique identifiers for the Profile for both internal and external systems.",
+ "$ref": "#/definitions/profileIdList"
+ }
+ }
+ },
+ "payeeInfo": {
+ "$ref": "#/definitions/payeeInfoType"
+ },
+ "aRNumber": {
+ "description": "Accounts Receivable.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "instructions": {
+ "description": "Set of routing instructions associated to this routing type.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/routingInstructionType"
+ }
+ },
+ "folioWindowNo": {
+ "type": "integer"
+ },
+ "paymentMethod": {
+ "type": "string",
+ "maxLength": 2000
+ }
+ }
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "reservationsInfo": {
- "description": "Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.",
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "room": {
+ "description": "Room routing type.",
+ "type": "object",
+ "properties": {
+ "roomId": {
+ "description": "Room number to route the instructions.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "guestNameId": {
+ "description": "Guest unique identifier to which the instruction will be routed.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "guestDisplayName": {
+ "description": "Display Name for the guest.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "reservationNameId": {
+ "description": "Reservation name id to which the instruction will be routed.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "instructions": {
+ "description": "Set of routing instructions associated to this routing type.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/routingInstructionType"
+ }
+ }
+ }
},
- "masterInfoList": {
- "description": "Refer to Generic common types document",
- "type": "array",
- "items": {
- "$ref": "#/definitions/masterInfoType"
+ "comp": {
+ "description": "Comp Accounting Routing Info",
+ "type": "object",
+ "properties": {
+ "compAccountingInfo": {
+ "$ref": "#/definitions/compAccountingType"
+ },
+ "compRequestInfo": {
+ "$ref": "#/definitions/compRoutingRequestType"
+ },
+ "payeeInfo": {
+ "$ref": "#/definitions/payeeInfoType"
+ },
+ "instructions": {
+ "description": "Set of routing instructions associated to this routing type.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/routingInstructionType"
+ }
+ },
+ "folioWindowNo": {
+ "type": "integer"
+ }
}
},
- "reservationInfoList": {
- "description": "Collection of Reservations and their information.",
+ "request": {
+ "description": "Comp Accounting Request routing",
"type": "object",
"properties": {
- "reservationInfo": {
- "description": "Contains details of the reservation.",
+ "compRequestInfo": {
+ "$ref": "#/definitions/compRoutingRequestType"
+ },
+ "instructions": {
+ "description": "Set of routing instructions associated to this routing type.",
"type": "array",
+ "maxItems": 4000,
"items": {
- "$ref": "#/definitions/reservationInfoType"
+ "$ref": "#/definitions/routingInstructionType"
}
}
}
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "refreshFolio": {
+ "description": "On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions.",
+ "type": "boolean"
}
}
},
- "reservationsSummaryType": {
- "description": "Type which shows all fetched reservations summary depends on Fetch Summary Instruction.",
+ "routingInstructionType": {
"type": "object",
+ "description": "Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit",
"properties": {
- "blockSummary": {
- "description": "Holds reservation information related to block(s) searched.",
- "$ref": "#/definitions/blockResvSummaryType"
+ "duration": {
+ "description": "Duration of this instruction.",
+ "type": "object",
+ "properties": {
+ "timeSpan": {
+ "$ref": "#/definitions/timeSpanType"
+ },
+ "sunday": {
+ "type": "boolean"
+ },
+ "monday": {
+ "type": "boolean"
+ },
+ "tuesday": {
+ "type": "boolean"
+ },
+ "wednesday": {
+ "type": "boolean"
+ },
+ "thursday": {
+ "type": "boolean"
+ },
+ "friday": {
+ "type": "boolean"
+ },
+ "saturday": {
+ "type": "boolean"
+ },
+ "daily": {
+ "description": "Flag to indicate if the routing instruction is a daily instruction.",
+ "type": "boolean"
+ }
+ }
},
- "paymentMethodSummary": {
- "description": "Payment methods summary of the reservations.",
- "$ref": "#/definitions/paymentMethodsSummaryType"
+ "transactionCodes": {
+ "description": "Set of Transaction Codes configured in this time span.",
+ "$ref": "#/definitions/trxCodesInfoType"
},
- "roomSummary": {
- "description": "Room Summary of the reservations.",
- "$ref": "#/definitions/roomSummaryType"
- }
- }
- },
- "resvForBatchCCAut": {
- "description": "Response which contains a listing of reservations, and associated payment methods, that require credit card authorization.",
- "type": "object",
- "properties": {
- "hotelId": {
- "$ref": "#/definitions/codeType"
+ "billingInstructions": {
+ "description": "Set of Billing Instructions configured in this time span.",
+ "$ref": "#/definitions/billingInstructionsType"
},
- "links": {
- "$ref": "#/definitions/links"
+ "creditLimit": {
+ "description": "Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero.",
+ "type": "number"
},
- "reservations": {
- "$ref": "#/definitions/reservationsForCCAuthType"
+ "percentageLimit": {
+ "description": "The routing limit percentage allowed for this routing instruction.",
+ "type": "number"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "covers": {
+ "description": "Number of covers for this routing instruction.",
+ "type": "number"
+ },
+ "limitUsed": {
+ "description": "Amount of Credit used for this routing instruction.",
+ "type": "number"
+ },
+ "routingLinkId": {
+ "description": "Internal Routing Link Id identifier to which limit group the instruction belongs.",
+ "$ref": "#/definitions/uniqueID_Type"
}
}
},
- "rewardCertificateType": {
- "description": "Point Saver reward.",
- "type": "string",
- "enum": [
- "Regular",
- "StayAnytime",
- "PointSaver"
- ]
- },
- "roleUserEntryType": {
- "description": "Role or User in which the log book entry belongs to.",
+ "compAccountingType": {
"type": "object",
+ "description": "Authorizer Information",
"properties": {
- "role": {
- "$ref": "#/definitions/codeDescriptionType"
+ "authorizerId": {
+ "$ref": "#/definitions/uniqueID_Type"
},
- "user": {
+ "authorizerUserName": {
+ "description": "Application user name of the authorizer",
"type": "string",
- "maxLength": 60,
- "minLength": 0
- }
- }
- },
- "room": {
- "description": "The reservation must still be reserved to use this operation.",
- "type": "object",
- "properties": {
- "criteria": {
- "description": "Criteria for assigning a room to a reservation.",
- "$ref": "#/definitions/reservationRoomSelectionType"
+ "minLength": 0,
+ "maxLength": 40
},
- "links": {
- "$ref": "#/definitions/links"
+ "authorizerName": {
+ "description": "Full name of the authorizer.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 100
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "roomClassStatisticsType": {
- "description": "Reservation Statistics for a Room Class",
- "type": "object",
- "properties": {
- "roomClass": {
- "description": "Room Class name. Available room classes can be retrieved via /listOfValues/hotels/{hotelId}/roomClasses",
+ "authorizerRateCode": {
+ "description": "Rate code of the authorizer.",
"type": "string",
+ "minLength": 0,
"maxLength": 20
},
- "roomTypes": {
- "description": "Reservation Statistics for each Room Type",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomTypeStatisticsType"
- }
+ "inheritAuthorizerRateCode": {
+ "description": "Indicates whether user has the choice to have reservation inherit rate code from the authorizer.",
+ "type": "boolean"
},
- "total": {
- "description": "Number of reservations.",
- "type": "integer",
- "maximum": 4000,
- "minimum": 0
+ "aRNumber": {
+ "description": "AR Account Number of the authorizer",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "compTypeCode": {
+ "description": "The Comp Type for this Account. Used when using the Comp types functionality",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "compVoucherNo": {
+ "description": "The coupon or voucher number used by the external gaming system to track postings made to this routing.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 30
+ },
+ "dateRange": {
+ "description": "Arrival date range for comp routing",
+ "$ref": "#/definitions/dateRangeType"
+ },
+ "membershipId": {
+ "description": "Membership number",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 100
+ },
+ "membershipIdNo": {
+ "description": "Unique Id of membership",
+ "type": "integer"
+ },
+ "membershipNameOnCard": {
+ "description": "Name displayed on the membership card",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
}
}
},
- "roomCleaningPriorityType": {
- "description": "Type to indicate the cleaning priority for a room.",
+ "compRoutingRequestType": {
"type": "object",
+ "description": "Type for the details of a Comp Routing Request",
"properties": {
- "prioritySequence": {
- "description": "Priority sequence of the room for cleaning.",
- "type": "integer"
+ "requestedBy": {
+ "description": "User who requested the Comp Routing",
+ "$ref": "#/definitions/userInfoType"
+ },
+ "comments": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "declinedBy": {
+ "description": "User information of user who declined comp routing request",
+ "$ref": "#/definitions/userInfoType"
+ },
+ "status": {
+ "description": "Comp routing status",
+ "$ref": "#/definitions/compRoutingStatusType"
}
}
},
- "roomConditionAssigmentType": {
- "description": "Simple type for Room Condition assignment type. Valid values are Available and NotAvailable Only.",
- "type": "string",
- "enum": [
- "Available",
- "NotAvailable"
- ]
- },
- "roomConditionType": {
- "description": "Condition to be assigned on the room.",
+ "userInfoType": {
"type": "object",
+ "description": "Opera User Information",
"properties": {
- "assignmentType": {
- "description": "Determine if room, after applying condition, is available or not in Room Assignment listing.",
- "$ref": "#/definitions/roomConditionAssigmentType"
+ "userId": {
+ "description": "User Id of the Opera User",
+ "type": "integer"
},
- "remarks": {
- "description": "Remarks on room condition assignment.",
+ "userName": {
+ "description": "Name of the Opera User",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "roomCondition": {
- "description": "Code and Decription of Condition to be assigned on the room.",
- "$ref": "#/definitions/codeDescriptionType"
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "roomDiscrepanciesType": {
- "description": "Room Discrepancies between front office and housekeeping room status and number of persons in the room.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomDiscrepancyType"
- }
- },
- "roomDiscrepancyType": {
- "description": "Simple type for discrepant room status instructions to be used in requests for fetching housekeeping and front office room discrepancy. Valid values are Sleep, Skip, Person Discrepancy, Due Out Only.",
+ "compRoutingStatusType": {
"type": "string",
+ "description": "Status which indicates that the Request of Comp Routing was declined",
"enum": [
- "Sleep",
- "Skip",
- "PersonDiscrepancy"
+ "Request",
+ "Comp",
+ "Declined"
]
},
- "roomFeatureType": {
- "description": "Room Feature Information.",
+ "reservationPoliciesType": {
"type": "object",
+ "description": "A collection of reservation deposit and cancellation policies.",
"properties": {
- "code": {
- "description": "A code representing a room feature.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "cancellationPolicies": {
+ "description": "A collection of reservation cancellation policies..",
+ "$ref": "#/definitions/resCancellationPoliciesType"
},
- "description": {
- "description": "A code representing a room feature.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "depositPolicies": {
+ "description": "A collection of reservation deposit policies.",
+ "$ref": "#/definitions/resDepositPoliciesType"
},
- "orderSequence": {
- "description": "Display Order sequence.",
- "type": "number"
+ "reservationIdList": {
+ "description": "A list of Ids for reservation.",
+ "$ref": "#/definitions/uniqueIDListType"
},
- "quantity": {
- "description": "Indicates quantity.",
- "type": "integer"
+ "name": {
+ "description": "Name identifier for the reservation.",
+ "type": "string"
}
}
},
- "roomFeaturesType": {
- "description": "A recurring element that identifies the room features.",
+ "resCancellationPoliciesType": {
"type": "array",
+ "description": "A list of reservation cancellation policies.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/roomFeatureType"
+ "$ref": "#/definitions/resCancellationPolicyType"
}
},
- "roomHoldType": {
+ "resCancellationPolicyType": {
"type": "object",
+ "description": "A cancellation policy attached with the reservation.",
"properties": {
- "comments": {
- "description": "Comments of the room hold.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "revenueType": {
+ "description": "Type of reservation.",
+ "$ref": "#/definitions/depositCancelRevenueType"
},
- "holdUntil": {
- "description": "The date and time when hold will expire.",
- "type": "string",
- "format": "date-time"
+ "policy": {
+ "description": "Cancellation policy details.",
+ "$ref": "#/definitions/resCancelPenaltyType"
},
- "holdUser": {
- "description": "User who placed room on hold.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- }
- }
- },
- "roomInterfaceStatus": {
- "description": "Response object for fetching room interface status",
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "percentageDue": {
+ "description": "The percentage amount due for reservation cancellation.",
+ "type": "number",
+ "minimum": 0,
+ "maximum": 100
},
- "roomInterfaceStatusList": {
- "description": "Collection of room, reservation and interface status information.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/reservationInfoType"
- }
+ "comments": {
+ "description": "Comments attached with the reservation cancellation.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "policyId": {
+ "description": "Unique ID of the Reservation Policy.",
+ "$ref": "#/definitions/uniqueID_Type"
}
}
},
- "roomKey": {
- "description": "Request for generation of room key.",
+ "depositCancelRevenueType": {
+ "type": "string",
+ "description": "The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.",
+ "enum": [
+ "Rooms",
+ "Catering",
+ "All"
+ ]
+ },
+ "resCancelPenaltyType": {
"type": "object",
+ "description": "The CancelPenalty class defines the cancellation policy of the hotel facility.",
"properties": {
- "additionalRooms": {
- "description": "Collection of additional rooms to be included in key creation of reservation room.",
- "$ref": "#/definitions/codeListType"
+ "deadline": {
+ "description": "Cancellation deadline, absolute or relative.",
+ "$ref": "#/definitions/policyDeadlineType"
},
- "encoderId": {
- "$ref": "#/definitions/uniqueID_Type"
+ "amountPercent": {
+ "description": "Cancellation fee expressed as a fixed amount, or percentage of/or room nights.",
+ "$ref": "#/definitions/policyAmountPercentType"
},
- "encoderTerminal": {
+ "penaltyDescription": {
+ "description": "Text description of the Penalty in a given language.",
"type": "string",
+ "minLength": 0,
"maxLength": 2000
},
- "keyCardType": {
- "$ref": "#/definitions/keyCardType"
- },
- "keyCardUId": {
- "type": "string",
- "maxLength": 2000
+ "offsetUnit": {
+ "$ref": "#/definitions/offsetUnitType"
},
- "keyOptions": {
+ "formattedRule": {
+ "description": "Formatted Text Rule of the Cancellation Penalty.",
"type": "string",
+ "minLength": 0,
"maxLength": 2000
},
- "keyTrack": {
- "description": "KeyTrack Data.",
- "$ref": "#/definitions/keyTrackType"
- },
- "keyType": {
- "$ref": "#/definitions/roomKeyType"
- },
- "keyValidityEnd": {
- "type": "string",
- "format": "date-time"
- },
- "keyValidityStart": {
- "type": "string",
- "format": "date-time"
- },
- "links": {
- "$ref": "#/definitions/links"
- },
- "noOfKeys": {
- "type": "integer"
- },
- "reservationIdList": {
- "description": "Collection of unique reservation identifiers for the reservation we are trying to make a room key for.",
- "$ref": "#/definitions/uniqueIDListType"
- },
- "resort": {
+ "policyCode": {
+ "description": "Policy Code.",
"type": "string",
- "maxLength": 2000
+ "minLength": 0,
+ "maxLength": 20
},
- "roomKeyGuests": {
- "description": "Collection of of Room key guests for multiple guest room key functionality.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomKeyGuest"
- }
+ "manual": {
+ "description": "Flag to indicate if the cancellation policy is manual.",
+ "type": "boolean"
},
- "roomNumber": {
- "description": "A room number to generate a key for. When creating keys using just the room number, the interface may allow only one-shot keys.",
- "type": "string",
- "maxLength": 2000
+ "nonRefundable": {
+ "description": "Indicates if the amount is refundable if booking is canceled.",
+ "type": "boolean"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "effective": {
+ "description": "Indicator if Cancellation Penalty is currently applicable or not.",
+ "type": "boolean"
}
}
},
- "roomKeyDetails": {
- "description": "Response for room key creation.",
+ "policyDeadlineType": {
"type": "object",
+ "description": "Cancellation deadline, absolute or relative.",
"properties": {
- "keyCardData": {
+ "absoluteDeadline": {
+ "description": "Defines the absolute deadline. Either this or the offset attributes may be used.",
"type": "string",
- "maxLength": 2000
+ "format": "date-time"
},
- "keyTrack": {
- "description": "KeyTrack Data.",
- "$ref": "#/definitions/keyTrackType"
+ "offsetFromArrival": {
+ "description": "The number of days before arrival that allows cancellation without penalties.",
+ "type": "integer"
},
- "links": {
- "$ref": "#/definitions/links"
+ "offsetDropTime": {
+ "description": "Time on offset day the cancellation penalties applies.",
+ "type": "string",
+ "format": "date-time"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "offsetFromBookingDate": {
+ "description": "The number of days after booking deposit must be paid.",
+ "type": "integer"
}
}
},
- "roomKeyEncoderType": {
+ "policyAmountPercentType": {
"type": "object",
+ "description": "Defines the percentage basis for calculating the fee amount or the amount.",
"properties": {
- "deviceArea": {
- "type": "string"
+ "basisType": {
+ "description": "Provides the basis for how the amount of the guarantee is calculated.",
+ "$ref": "#/definitions/policyBasisTypeType"
},
- "encoderId": {
- "type": "string"
+ "nights": {
+ "description": "The number of nights of the hotel stay that are used to calculate the fee amount.",
+ "type": "integer"
},
- "interfaceId": {
- "type": "string"
+ "percent": {
+ "description": "The percentage used to calculate the amount.",
+ "type": "number",
+ "minimum": 0,
+ "maximum": 100
},
- "location": {
- "type": "string"
+ "amount": {
+ "description": "A monetary amount.",
+ "type": "number"
},
- "workstation": {
- "type": "string"
+ "currencyCode": {
+ "description": "Provides a currency code to reflect the currency in which an amount may be expressed.",
+ "type": "string",
+ "minLength": 3,
+ "maxLength": 3
}
}
},
- "roomKeyEncodersType": {
- "description": "Holds the key encoder right.",
+ "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"
+ ]
+ },
+ "resDepositPoliciesType": {
"type": "array",
+ "description": "A list of deposit policies attached with the reservation.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/roomKeyEncoderType"
+ "$ref": "#/definitions/resDepositPolicyType"
}
},
- "roomKeyGuest": {
- "description": "Information about the guest for whom a key can be created.",
+ "resDepositPolicyType": {
"type": "object",
+ "description": "A deposit policy attached with the reservation.",
"properties": {
- "firstName": {
- "description": "First Name of the guest.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "guestKeyOptions": {
- "type": "string",
- "maxLength": 4000,
- "minLength": 0
- },
- "guestNameId": {
- "description": "Guest unique identifier to which the instruction will be routed.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "isAdult": {
- "description": "Flag to indicate wheter the guest is an Adult or a child.",
- "type": "boolean"
- },
- "isInactive": {
- "description": "Flag to indicate wheter the guest is an Adult or a child.",
- "type": "boolean"
+ "revenueType": {
+ "description": "Type of reservation.",
+ "$ref": "#/definitions/depositCancelRevenueType"
},
- "keyNumber": {
- "description": "Key Number of the card.",
- "type": "number"
+ "policy": {
+ "description": "Reservation deposit policy details.",
+ "$ref": "#/definitions/depositPolicyType"
},
- "lastName": {
- "description": "Last Name of the guest.",
+ "comments": {
+ "description": "Comments attached with a deposit.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "originalBalance": {
- "description": "Original Balance on the Key card.",
- "type": "number"
- },
- "remainingBalance": {
- "description": "Remaining Balance on the Key card.",
- "type": "number"
- }
- }
- },
- "roomKeyInfo": {
- "description": "Response of fetch room keys operation.",
- "type": "object",
- "properties": {
- "incidentalLimit": {
- "description": "Incidental limit on a reservation.",
- "type": "number"
- },
- "links": {
- "$ref": "#/definitions/links"
+ "minLength": 0,
+ "maxLength": 2000
},
- "roomKeysInfoList": {
- "description": "Collection of Room Keys information.",
- "$ref": "#/definitions/roomKeysInfoListType"
+ "amountPaid": {
+ "description": "Total amount paid against the reservation deposit.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "totalAuthorization": {
- "description": "Total Authorization on a reservation.",
- "type": "number"
+ "amountDue": {
+ "description": "Total amount due against the reservation deposit.",
+ "$ref": "#/definitions/currencyAmountType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "policyId": {
+ "description": "Unique ID of the Reservation Policy.",
+ "$ref": "#/definitions/uniqueID_Type"
}
}
},
- "roomKeyInfoType": {
- "description": "Contains detail information of room keys .",
+ "depositPolicyType": {
"type": "object",
+ "description": "Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.",
"properties": {
- "additionalRooms": {
- "description": "Additional rooms included in the key creation of reservation room.",
- "$ref": "#/definitions/codeListType"
+ "amountPercent": {
+ "description": "Payment expressed as a fixed amount, or a percentage of/or room nights.",
+ "$ref": "#/definitions/policyAmountPercentType"
},
- "guestInfo": {
- "description": "Guest information on the key. This information is available when multiple_guest_key is active.",
- "$ref": "#/definitions/roomKeyGuest"
+ "deadline": {
+ "description": "Payment deadline, absolute or relative.",
+ "$ref": "#/definitions/policyDeadlineType"
},
- "hotelId": {
- "description": "Name of the resort .",
+ "description": {
+ "description": "Text description of the Payment in a given language.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "keyCount": {
- "description": "Number of keys has been created for the reservation .",
- "type": "string",
- "maxLength": 3,
- "minLength": 1
+ "depositReceiptNo": {
+ "description": "Receipt number associated with the deposit policy",
+ "type": "integer"
},
- "keyExpiryDate": {
- "description": "Expiry date and time of the key.",
+ "transactionDate": {
+ "description": "Transaction Date associated with the deposit policy",
"type": "string",
- "format": "date-time"
+ "format": "date",
+ "maxLength": 8
},
- "keyOptions": {
- "description": "Key options of the key.",
- "$ref": "#/definitions/codeListType"
+ "depositReqReversed": {
+ "description": "Flag to indicate if deposit policy is reversed",
+ "type": "boolean"
},
- "keyStartDate": {
- "description": "Start date and time of the key.",
+ "formattedRule": {
+ "description": "Formatted Text Rule of the deposit policy.",
"type": "string",
- "format": "date-time"
- },
- "keyTrack": {
- "description": "KeyTrack Data.",
- "$ref": "#/definitions/keyTrackType"
+ "minLength": 0,
+ "maxLength": 2000
},
- "reservationId": {
- "description": "Reservation ID of the reservation of the room key .",
- "$ref": "#/definitions/reservationId"
+ "typeOfCharges": {
+ "description": "Defines if the deposit amount is calculated based on Room Charges, Catering Charges or both",
+ "$ref": "#/definitions/depositCancelRevenueType"
},
- "roomId": {
- "description": "Room Number.",
+ "policyCode": {
+ "description": "Deposit Policy Code",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "manual": {
+ "description": "Flag to indicate if the cancellation policy is manual.",
+ "type": "boolean"
}
}
},
- "roomKeyInterfaceDetailType": {
+ "linkedReservationsInfoType": {
"type": "object",
+ "description": "Linked Reservations.",
"properties": {
- "additionalRoomsLimit": {
- "description": "Maximum number of additional rooms allowed.",
- "type": "integer",
- "maximum": 999,
- "minimum": 1
+ "reservationInfo": {
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/linkedReservationInfoType"
+ }
},
- "encoders": {
- "description": "Available room key interface encoders.",
- "$ref": "#/definitions/roomKeyEncodersType"
+ "url": {
+ "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "type": "string"
},
- "hotelId": {
- "description": "Hotel code of the interface.",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "interfaceDescription": {
- "description": "Description of the interface.",
+ "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",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "interfaceName": {
- "description": "Name of the interface.",
+ "idContext": {
+ "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "interfaceRights": {
- "description": "Room key interface rights.",
- "$ref": "#/definitions/roomKeyInterfaceRightsType"
- },
- "multipleRoomKeys": {
- "description": "Indicator if additional rooms are allowed to be included in key creation.",
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 80
},
- "propertyDateTime": {
- "description": "Current property date and time.",
+ "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",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 80
},
- "sendValidStartDateTime": {
- "description": "Indicator if the DLS Interface allows to send valid start date and time.",
- "type": "boolean"
+ "idExtension": {
+ "description": "Additional identifying value assigned by the creating system.",
+ "type": "integer"
}
}
},
- "roomKeyInterfaceDetails": {
- "description": "Response with the configuration details of active room key interfaces including the available key encoders.",
+ "linkedReservationInfoType": {
"type": "object",
"properties": {
- "keyInterfaceDetails": {
- "description": "Collection of configuration details of active room key interfaces.",
- "$ref": "#/definitions/roomKeyInterfaceDetailsType"
+ "reservationIdList": {
+ "$ref": "#/definitions/reservationIdList"
},
- "links": {
- "$ref": "#/definitions/links"
+ "timeSpan": {
+ "$ref": "#/definitions/timeSpanType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "roomKeyInterfaceDetailsType": {
- "description": "Configuration details of room key interface.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomKeyInterfaceDetailType"
- }
- },
- "roomKeyInterfaceRightType": {
- "type": "object",
- "properties": {
- "description": {
+ "givenName": {
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "right": {
- "type": "integer"
- },
- "rightsCode": {
+ "surname": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "roomKeyInterfaceRightsType": {
- "description": "Holds the key encoder right.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomKeyInterfaceRightType"
- }
- },
- "roomKeyMultipleGuests": {
- "description": "Short room key information containing information about the multiple guests and room key options .",
- "type": "object",
- "properties": {
- "keyOptions": {
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "title": {
"type": "string",
- "maxLength": 2000
+ "minLength": 0,
+ "maxLength": 20
},
- "reservationIdList": {
- "description": "Collection of unique reservation identifiers for the reservation we are trying to make a room key for.",
- "$ref": "#/definitions/uniqueIDListType"
+ "roomType": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "roomKeyGuests": {
- "description": "Collection of of Room key guests for multiple guest room key functionality.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomKeyGuest"
- }
+ "room": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "roomNumber": {
- "description": "A room number to generate a key for. When creating keys using just the room number, the interface may allow only one-shot keys.",
+ "ratePlanCode": {
"type": "string",
- "maxLength": 2000
- }
- }
- },
- "roomKeyStatus": {
- "description": "Respose for the reading of room key.",
- "type": "object",
- "properties": {
- "guestDepartureDate": {
- "$ref": "#/definitions/dateRangeType"
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "rate": {
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "guarantee": {
+ "$ref": "#/definitions/resGuaranteeType"
},
- "guestDepartureTime": {
- "$ref": "#/definitions/dateTimeRangeType"
+ "balance": {
+ "$ref": "#/definitions/currencyAmountType"
},
- "guestFirstName": {
- "type": "string",
- "maxLength": 2000
+ "reservationBlock": {
+ "description": "Key information about the block for the linked reservation.",
+ "$ref": "#/definitions/reservationBlockType"
},
- "guestLastName": {
+ "displayColor": {
"type": "string",
- "maxLength": 2000
+ "minLength": 0,
+ "maxLength": 20
},
- "keyOptions": {
- "type": "string",
- "maxLength": 2000
+ "allowedActions": {
+ "description": "Collection of allowed actions for the linked reservation.",
+ "$ref": "#/definitions/reservationAllowedActionsType"
},
- "links": {
- "$ref": "#/definitions/links"
+ "reservationStatus": {
+ "description": "Indicates the Actual status of the reservation.",
+ "$ref": "#/definitions/pMS_ResStatusType"
},
- "room": {
+ "hotelId": {
"type": "string",
- "maxLength": 2000
+ "minLength": 0,
+ "maxLength": 20
},
- "validUntil": {
- "type": "string",
- "format": "date-time"
+ "linkReservationType": {
+ "$ref": "#/definitions/linkedReservationType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "reverseCheckInAllowed": {
+ "description": "This attribute is to verify if reverse check-in is allowed for the reservation.",
+ "type": "boolean"
+ },
+ "roomNumberLocked": {
+ "description": "This attribute is to verify if room number is locked for the reservation. When true the room number cannot be changed",
+ "type": "boolean"
+ },
+ "suppressRate": {
+ "description": "This attribute checks if rate is suppressed or not in order to properly show strike through.",
+ "type": "boolean"
}
}
},
- "roomKeyType": {
- "description": "Simple type for representing room key type.",
+ "linkedReservationType": {
"type": "string",
+ "description": "Enumeration of the different Linked Reservation Types.",
"enum": [
- "New",
- "Duplicate",
- "Lost",
- "OneShot",
- "RoomMove",
- "ReEncode",
- "Remove",
- "ModifyStay"
+ "Linked",
+ "Shared",
+ "Default"
]
},
- "roomKeysInfoListType": {
- "description": "Contains details of Room key.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomKeyInfoType"
+ "cateringResInfoType": {
+ "type": "object",
+ "description": "Information regarding catering event and catering revenue type associated to the reservation.",
+ "properties": {
+ "eventId": {
+ "description": "Unique ID on a catering event associated to the reservation.",
+ "$ref": "#/definitions/eventId"
+ },
+ "revenueType": {
+ "description": "Catering revenue type associated to the reservation.",
+ "type": "string"
+ }
}
},
- "roomMoveDetailType": {
- "description": "Room move history information.",
+ "eventId": {
"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": {
- "date": {
- "description": "Business date on which room is moved.",
- "type": "string",
- "format": "date-time"
+ "url": {
+ "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "type": "string"
},
- "description": {
- "description": "Description of why room is moved.",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "fromRoom": {
- "description": "Room from which guest is moved.",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "hotelId": {
- "description": "Identifies the hotel code under which room is moved.",
+ "idContext": {
+ "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "movedBy": {
- "description": "The user who moved the guest.",
+ "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",
- "maxLength": 100,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "reasonCode": {
- "description": "Identifies the room move reason code.",
+ "idExtension": {
+ "description": "Additional identifying value assigned by the creating system.",
+ "type": "integer"
+ }
+ }
+ },
+ "resStatClassificationType": {
+ "type": "object",
+ "description": "Statistical Classification information for the reservation.",
+ "properties": {
+ "roomType": {
+ "description": "Room Type used to calculate statistics for export(DRS).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "reservationId": {
- "description": "Unique identifier of the reservation.",
- "$ref": "#/definitions/reservationId"
+ "minLength": 0,
+ "maxLength": 20
},
- "toRoom": {
- "description": "Room to which guest is moved.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "rateTier": {
+ "description": "Rate Tier used calculate statistics for export(DRS).",
+ "type": "integer"
}
}
},
- "roomMoveDetailsType": {
- "description": "List of room move details",
+ "alertsType": {
"type": "array",
+ "description": "List of alerts.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/roomMoveDetailType"
+ "$ref": "#/definitions/alertType"
}
},
- "roomMoveHistory": {
- "description": "Response for the fetch room move history of a reservation.",
+ "alertType": {
"type": "object",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "code": {
+ "description": "Code identifying the type of alert.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "roomMoveHistoryDetails": {
- "description": "List of room move history.",
- "$ref": "#/definitions/roomMoveDetailsType"
+ "global": {
+ "description": "Indicate whether the alert is a global that is automatically and dynamically attached to all reservations that meet the alert criteria.",
+ "type": "boolean"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "roomOutOfOrderType": {
- "description": "Out Of Order and Out Of Service Room information.",
- "type": "object",
- "properties": {
- "end": {
- "description": "The ending value of the date range.",
+ "area": {
+ "description": "The Area where the alert will be attached and shown.",
+ "$ref": "#/definitions/alertAreaType"
+ },
+ "description": {
+ "description": "The alert message.",
+ "type": "string"
+ },
+ "screenNotification": {
+ "description": "Notify by showing the alert on the screen",
+ "type": "boolean"
+ },
+ "printerNotification": {
+ "description": "Notify by sending the message to the printer.",
+ "type": "boolean"
+ },
+ "printerName": {
+ "description": "Printer used to print the alert notification.",
+ "type": "string"
+ },
+ "reportId": {
+ "description": "The module id of the report. This is used to printer the alert.",
+ "$ref": "#/definitions/uniqueID_Type"
+ },
+ "reportName": {
+ "description": "Report name of the report type.",
+ "type": "string"
+ },
+ "reportDescription": {
+ "description": "Report description. Mainly used for as a parameter for printing the alerts.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 1000
},
- "newDateRange": {
- "description": "The new start date and end date, if the dates were changed as part of an update. This would be blank for new OO/OS rooms.",
- "$ref": "#/definitions/dateRangeType"
+ "guestInfo": {
+ "description": "Contains information regarding the guest.",
+ "$ref": "#/definitions/alertGuestInfoType"
},
- "reasonCode": {
- "description": "Reason Code why the room is OO/OS.",
+ "userDefinedFields": {
+ "description": "Collections of user defined fields.",
+ "$ref": "#/definitions/userDefinedFieldsType"
+ },
+ "welcomeOffer": {
+ "description": "Contains information regarding welcome offer.",
+ "$ref": "#/definitions/welcomeOfferType"
+ },
+ "stopCheckInCheckOut": {
+ "description": "Indicates the Reservation Stop Check In/Check Out Global Alert.",
+ "type": "boolean"
+ },
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "reasonDesc": {
- "description": "Reason Description why the room is OO/OS.",
+ "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",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "repairRemarks": {
- "description": "Notes or Remarks on the OO/OS room",
+ "idContext": {
+ "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "returnStatus": {
- "description": "Room Status which will be used on completion of OO/OS.",
- "$ref": "#/definitions/housekeepingRoomStatusType"
+ "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
},
- "roomStatus": {
- "description": "The out of order or out of service room status OO/OS.",
- "$ref": "#/definitions/housekeepingRoomStatusType"
+ "idExtension": {
+ "description": "Additional identifying value assigned by the creating system.",
+ "type": "integer"
},
- "start": {
- "description": "The starting value of the date range.",
+ "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
+ },
+ "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
}
}
},
- "roomOwnershipType": {
- "description": "Define the search criteria for retrieving room ownership records",
+ "alertAreaType": {
+ "type": "string",
+ "enum": [
+ "CheckIn",
+ "CheckOut",
+ "Reservation",
+ "Billing",
+ "InHouse"
+ ]
+ },
+ "alertGuestInfoType": {
"type": "object",
"properties": {
- "contractNumber": {
- "description": "Contract number for room owner.",
- "type": "string"
+ "guestName": {
+ "description": "Guest Name.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
- "endDate": {
- "description": "End Date of the room ownership record.",
+ "membership": {
+ "description": "Membership information of the guest.",
+ "$ref": "#/definitions/membershipType"
+ },
+ "vipStatus": {
+ "description": "VIP status of the guest.",
+ "$ref": "#/definitions/vIPStatusType"
+ },
+ "lastHotelCode": {
+ "description": "Hotel code of the last stay location of the guest.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "lastStayDate": {
+ "description": "Last stay date at the property.",
"type": "string",
"format": "date",
"maxLength": 8
},
- "profileId": {
- "description": "Profile ID of the room ownership record.",
- "$ref": "#/definitions/uniqueID_Type"
+ "totalStay": {
+ "description": "Holds total number of days that the guest have stayed in the property.",
+ "type": "integer"
},
- "roomCategory": {
- "description": "Room Category of the room ownership record.",
+ "comments": {
+ "description": "Additional alert information regarding the membership of the guest.",
"type": "string"
},
- "roomId": {
- "description": "Room Id of room owner.",
+ "preference": {
+ "description": "Additional alert information regarding the guest.",
"type": "string"
},
- "roomOwnershipId": {
- "description": "Unique Id for Room Owner record.",
- "type": "integer"
- },
- "roomType": {
- "description": "Room Type of the room ownership record.",
+ "preference2": {
+ "description": "Additional mandatory alert information regarding the guest preferences.",
"type": "string"
},
- "startDate": {
- "description": "Start Date of the room ownership record.",
+ "guestPreferredLanguage": {
+ "description": "Holds the language preferred by the guest.",
+ "$ref": "#/definitions/languageType"
+ },
+ "totalBrandStay": {
+ "description": "Holds total number of days that the guest have stayed in the properties for the same brand.",
+ "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
},
- "status": {
- "description": "Status of the room ownership record.",
+ "birthDateMasked": {
+ "description": "Indicates the date of birth as masked.",
"type": "string"
}
}
},
- "roomPersonsType": {
- "type": "object",
- "properties": {
- "frontOfficePersons": {
- "type": "integer"
- },
- "houseKeepingPersons": {
- "type": "integer"
- }
- }
+ "languageType": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "roomRangeType": {
+ "welcomeOfferType": {
"type": "object",
"properties": {
- "fromRoomNumber": {
+ "status": {
+ "description": "Determines the status of the welcome offer.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "toRoomNumber": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "type": {
+ "description": "Determines the welcome offer option selected while availing the welcome offer.",
+ "$ref": "#/definitions/welcomeOfferOptionsType"
}
}
},
- "roomRateAvailReasonType": {
- "description": "Indicates the Room Rate is not available due to unavailability of enough items for the rate code.",
+ "welcomeOfferOptionsType": {
"type": "string",
+ "description": "None of the Welcome Offer option is selected.",
"enum": [
- "Available",
- "Restricted",
- "RestrictedDueToInventory",
- "RestrictedDueToOccupancy",
- "RestrictedDueToItemInventory"
+ "BonusPoints",
+ "Ecoupons",
+ "Items",
+ "PostIt",
+ "NotSelected"
]
},
- "roomRateType": {
+ "hotelReservationTracesType": {
+ "type": "array",
+ "description": "List of Reservation Traces.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/hotelReservationTraceType"
+ }
+ },
+ "hotelReservationTraceType": {
"type": "object",
+ "description": "Extended Trace object to hold information for a reservation.",
"properties": {
- "availability": {
- "description": "Used to specify an availability status for the room rate. When available value could be either not specified or \"Available\".",
- "$ref": "#/definitions/roomRateAvailReasonType"
- },
- "awards": {
- "description": "Membership Awards code applied on the reservation.",
- "$ref": "#/definitions/resAwardsType"
- },
- "barRanking": {
- "description": "Best Available rates ranking.",
- "type": "integer"
- },
- "bogoDiscount": {
- "description": "Indicates if the Rate Code has BOGO(Bye one Get one) indicator.",
- "type": "boolean"
- },
- "commissionAmount": {
- "description": "Indicates commission amount used by the rate plan.",
- "type": "integer"
- },
- "commissionCode": {
- "description": "Commission Code applicable for commission calculation for Travel Agent/Company.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "commissionPercentage": {
- "description": "Indicates commission percentage used by the rate plan.",
- "type": "integer"
- },
- "commissionable": {
- "description": "Indicates Commission is applicable for commission calculation for Travel Agent/Company.",
- "type": "boolean"
- },
- "complimentary": {
- "description": "Indicates this reservation rate is complimentary.",
- "type": "boolean"
- },
- "credentialsRequired": {
- "description": "If true, indicates that credentials is required to sell the rate code.",
- "type": "boolean"
+ "timeInfo": {
+ "description": "Date of the trace.",
+ "$ref": "#/definitions/traceTimeInfoType"
},
- "discountAllowed": {
- "description": "Indicates if the Rate Code is discountable i.e discounts are allowed on the rate code.",
- "type": "boolean"
+ "reservationId": {
+ "description": "Reservation ID of the reservation for which the traces are to be retrieved.",
+ "$ref": "#/definitions/reservationId"
},
- "end": {
- "description": "The ending value of the date range.",
+ "departmentId": {
+ "description": "Indicates the Department code.",
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "fixedRate": {
- "description": "Fixed Rate Indicator.",
- "type": "boolean"
- },
- "foreignExchange": {
- "description": "Exchange Type information for the postings.",
- "$ref": "#/definitions/foreignExchangeType"
- },
- "guestCounts": {
- "description": "A collection of Guest Counts associated with the room rate.",
- "$ref": "#/definitions/guestCountsType"
- },
- "houseUseOnly": {
- "description": "Indicates this reservation is for House use.",
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 20
},
- "inventoryLender": {
- "description": "Indicates whether the room type inventory was taken from the allotment or House availability.",
+ "traceText": {
+ "description": "The information this trace contains.",
"type": "string"
},
- "marketCode": {
- "description": "The code that relates to the market being sold to (e.g., the corporate market, packages).",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "marketCodeDescription": {
- "description": "Description of the market code.",
- "type": "string",
- "maxLength": 4000,
- "minLength": 0
- },
- "mealPlans": {
- "description": "Meal plan codes for rate plan code.",
- "$ref": "#/definitions/mealPlansType"
- },
- "numberOfUnits": {
- "description": "The number of rooms.",
- "type": "integer"
- },
- "packages": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/packageElementType"
- }
- },
- "promotionCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "pseudoRoom": {
- "description": "True indicates as pseudo room type. This is usually used for a posting master reservation.",
- "type": "boolean"
- },
- "rateDescription": {
- "description": "Rate code description.",
- "type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "resolveInfo": {
+ "description": "Information regarding the status of the trace",
+ "$ref": "#/definitions/traceResolveType"
},
- "rateGroup": {
- "description": "For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "url": {
+ "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "type": "string"
},
- "rateLevel": {
- "description": "Rate plan type like Corporate,Regular,Military,Weekend etc.",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "ratePlanCode": {
+ "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",
- "maxLength": 20,
- "minLength": 0
- },
- "rates": {
- "$ref": "#/definitions/ratesType"
- },
- "reservationBlock": {
- "description": "Key information about the block for this reservation.",
- "$ref": "#/definitions/reservationBlockType"
+ "minLength": 0,
+ "maxLength": 80
},
- "roomId": {
- "description": "A string value representing the unique identification of a room.",
+ "idContext": {
+ "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "roomRateInfo": {
- "description": "Information about the Room Rate Combination.",
+ "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",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "roomType": {
+ "idExtension": {
+ "description": "Additional identifying value assigned by the creating system.",
+ "type": "integer"
+ },
+ "createDateTime": {
+ "description": "Time stamp of the creation.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "roomTypeCharged": {
- "description": "Room Type used for the Rate calculation.",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "sourceCode": {
- "description": "To specify where the business came from e.g. radio, newspaper ad, etc.",
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "sourceCodeDescription": {
- "description": "Description of the source of business.",
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "start": {
- "description": "The starting value of the date range.",
+ "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
- },
- "stayProfiles": {
- "description": "Profile associated with the room Stay.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationProfileType"
- }
- },
- "suppressRate": {
- "type": "boolean"
- },
- "taxFreeGuestCounts": {
- "description": "A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts.",
- "$ref": "#/definitions/guestCountsType"
- },
- "taxIncluded": {
- "description": "If true, indicates if tax is included in the rate code.",
- "type": "boolean"
- },
- "total": {
- "$ref": "#/definitions/totalType"
- },
- "totalPoints": {
- "$ref": "#/definitions/pointsType"
}
}
},
- "roomRoomType": {
- "description": "This type represents the primary room attributes.",
+ "traceTimeInfoType": {
"type": "object",
"properties": {
- "accessible": {
- "description": "Indicates whether the room is accessibility compliant.",
- "type": "boolean"
- },
- "building": {
- "description": "Building associated with the room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "description": {
- "description": "Description of the room.",
- "$ref": "#/definitions/translationTextType2000"
- },
- "floor": {
- "description": "Floor of the Room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "floorDescription": {
- "description": "Description for the Floor of the Room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "meetingRoom": {
- "description": "Indicates whether the room is a Meeting Room",
- "type": "boolean"
- },
- "roomAssignmentRating": {
- "description": "Assignment Rating associated with the room.",
- "$ref": "#/definitions/ratePlanRatingType"
- },
- "roomCondition": {
- "description": "Code and description of condition assigned on the room.",
- "$ref": "#/definitions/codeDescriptionType"
- },
- "roomDescription": {
- "description": "Detail Long Description Of The Room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomFeatures": {
- "description": "Room Features for the room.",
- "$ref": "#/definitions/roomFeaturesType"
+ "dateTimeSpan": {
+ "description": "Time span for the trace.",
+ "$ref": "#/definitions/dateTimeSpanType"
},
- "roomId": {
- "description": "Code of the room.",
+ "traceOn": {
+ "description": "Date of the trace.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomType": {
- "description": "Room type basic information of the room.",
- "$ref": "#/definitions/roomTypeShortInfoType"
+ "format": "date-time"
},
- "smokingPreference": {
- "description": "This indicates room smoking preference.",
+ "traceTime": {
+ "description": "Time of the trace",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "smokingPreferenceDescription": {
- "description": "This indicates the description of the room smoking preference.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "enteredBy": {
+ "description": "User that entered this trace.",
+ "type": "string"
}
}
},
- "roomRoomsType": {
- "description": "Collection of rooms.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomRoomType"
- }
- },
- "roomSectionType": {
+ "traceResolveType": {
"type": "object",
"properties": {
- "daySectionCode": {
+ "resolvedOn": {
+ "description": "Date the trace was resolved",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "eveningSectionCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "resolvedBy": {
+ "description": "User that resolved the trace",
+ "type": "string"
}
}
},
- "roomStatusListType": {
- "description": "Room Status Type.",
+ "confirmationsType": {
"type": "array",
+ "description": "List of confirmation letters.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/housekeepingRoomStatusType"
+ "$ref": "#/definitions/confirmationType"
}
},
- "roomStatusStatisticsCountType": {
+ "confirmationType": {
"type": "object",
"properties": {
- "housekeepingRoomStatus": {
- "type": "string"
+ "recipientInfo": {
+ "description": "Receipient's information.",
+ "$ref": "#/definitions/confRecipientInfoType"
},
- "housekeepingRoomStatusCount": {
- "type": "integer"
- }
- }
- },
- "roomStatusStatisticsListType": {
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "deliveryInfo": {
+ "description": "The status of the confirmation letter sent via the specified CommunicationType.",
+ "$ref": "#/definitions/confDeliveryInfoTypes"
},
- "roomStatusStatistics": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/roomStatusStatisticsType"
- }
+ "confirmationStyleInfo": {
+ "description": "Confirmation style.",
+ "$ref": "#/definitions/confirmationStyle"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "roomStatusStatisticsType": {
- "type": "object",
- "properties": {
- "frontOfficeStatus": {
- "type": "string"
+ "fromEmail": {
+ "description": "Senders Email address.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "roomClass": {
+ "sendTextMessage": {
+ "description": "Flag to indicate sending confirmation letter as text message.",
+ "type": "boolean"
+ },
+ "url": {
+ "description": "URL that identifies the location associated with the record identified by the UniqueID.",
"type": "string"
},
- "roomStats": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/roomStatusStatisticsCountType"
- }
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "roomType": {
- "type": "string"
+ "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"
}
}
},
- "roomStatusType": {
+ "confRecipientInfoType": {
"type": "object",
"properties": {
- "frontOfficeStatus": {
- "description": "Front office status ( Occupied/Vacant ).",
- "$ref": "#/definitions/frontOfficeRoomStatusType"
+ "profileId": {
+ "description": "name id of the recipient.",
+ "$ref": "#/definitions/profileId"
},
- "housekeepingStatus": {
- "description": "Housekeeping status ( Occupied/Vacant ).",
- "$ref": "#/definitions/frontOfficeRoomStatusType"
+ "formerName": {
+ "description": "Last Name of recipient.",
+ "$ref": "#/definitions/profileNameType"
},
- "reservationStatusList": {
- "description": "List of status of the reservation to which this Room is assigned..",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/housekeepingRoomReservationStatusType"
- }
+ "addressInfo": {
+ "description": "id of the address where to send confirmation letter.",
+ "$ref": "#/definitions/addressInfoType"
},
- "roomStatus": {
- "description": "Status of the room (Dirty/Clean/Inspected/Pickup).",
- "$ref": "#/definitions/housekeepingRoomStatusType"
+ "emailInfo": {
+ "description": "id of the Email where to send confirmation letter.",
+ "$ref": "#/definitions/emailInfoType"
+ },
+ "faxInfo": {
+ "description": "id of the Fax where to send confirmation letter.",
+ "$ref": "#/definitions/telephoneInfoType"
+ },
+ "telephoneInfo": {
+ "description": "id of the Mobile where to send confirmation letter.",
+ "$ref": "#/definitions/telephoneInfoType"
+ },
+ "recipientType": {
+ "$ref": "#/definitions/profileTypeType"
}
}
},
- "roomStayType": {
+ "profileNameType": {
"type": "object",
+ "description": "This provides name information for a person.",
"properties": {
- "arrivalDate": {
+ "name": {
+ "description": "Family name, last name or Company Name.",
"type": "string",
- "format": "date"
- },
- "availableUpsellOfferCount": {
- "description": "Number of Upsell Offers Available for this stay. This will only be populated if the Upsell Instruction is included in the Allowed Instruction request",
- "type": "integer"
+ "minLength": 0,
+ "maxLength": 40
},
- "bookingMedium": {
- "description": "Classifies the medium(Channel field on reservation screen) through which the reservation is made.",
+ "fullName": {
+ "description": "Full display Name.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "bookingMediumDescription": {
- "description": "Description of the booking medium.",
+ "namePrefix": {
+ "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "currentRoomInfo": {
- "description": "Room information of the reservation for the current day.",
- "$ref": "#/definitions/currentRoomInfoType"
- },
- "departureDate": {
+ "givenName": {
+ "description": "Given name, first name or names.",
"type": "string",
- "format": "date"
- },
- "expectedTimes": {
- "description": "The Expected Arrival and Departure Times.",
- "$ref": "#/definitions/resExpectedTimesType"
- },
- "guarantee": {
- "description": "The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.",
- "$ref": "#/definitions/resGuaranteeType"
- },
- "guestCounts": {
- "$ref": "#/definitions/guestCountsType"
- },
- "mobileNotifications": {
- "description": "Denotes the status of Room Ready and Key Ready messages.",
- "$ref": "#/definitions/resMobileNotificationsType"
- },
- "multiValueAttrs": {
- "description": "Informative indicators indicating different values of an attribute exists over the stay.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 2000
- }
- },
- "originalTimeSpan": {
- "description": "The Original Time Span(Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same.",
- "$ref": "#/definitions/timeSpanType"
- },
- "ownerReservationType": {
- "description": "Indicates whether reservation is for Unit/Room Owner or Authorized User. If this attribute is not define it is a regular/rental reservation.",
- "$ref": "#/definitions/ownerResTypeType"
- },
- "primaryShareType": {
- "description": "This is populated in case of primary share scenario. This indicates whether this reservation is primary or non primary. Changes or postings to the 'non-primary' share reservation is not allowed.",
- "$ref": "#/definitions/primaryShareTypeType"
- },
- "printRate": {
- "description": "This control whether rate info will be printed in confirmation letter.",
- "type": "boolean"
- },
- "promotion": {
- "description": "Promotions applied to the reservation to get the promotional rate.",
- "$ref": "#/definitions/promotionType"
- },
- "registrationNumber": {
- "description": "Registration Number of the reservation for the current day.",
- "$ref": "#/definitions/uniqueID_Type"
+ "minLength": 0,
+ "maxLength": 40
},
- "remoteCheckInAllowed": {
- "description": "Indicates whether the reservation is pre-registered for internet check-in or not.",
- "type": "boolean"
- },
- "roomNumberLocked": {
- "description": "When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.",
- "type": "boolean"
- },
- "roomRates": {
- "description": "A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomRateType"
- }
- },
- "suiteWith": {
- "description": "Connecting Rooms.",
+ "middleName": {
+ "description": "The middle name of the person name.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "total": {
- "description": "The total amount charged for the Room Stay.",
- "$ref": "#/definitions/totalType"
+ "nameSuffix": {
+ "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "totalPoints": {
- "description": "The total number of Points charged for the Room Stay.",
- "$ref": "#/definitions/pointsType"
+ "nameTitle": {
+ "description": "Degree or honors (e.g., Ph.D., M.D.)",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "upsellInfo": {
- "description": "Indicates Upsell Information to be applied on Reservation.",
- "$ref": "#/definitions/upsellInfoType"
+ "nameType": {
+ "description": "Type of name of the individual, such as former, nickname, alternate or alias name.",
+ "$ref": "#/definitions/personNameTypeType"
}
}
},
- "roomSummaryType": {
+ "confDeliveryInfoTypes": {
+ "type": "array",
+ "description": "List of confirmation letter delivery methods and their status",
+ "maxItems": 4,
+ "items": {
+ "$ref": "#/definitions/confDeliveryInfoType"
+ }
+ },
+ "confDeliveryInfoType": {
"type": "object",
"properties": {
- "assignedRooms": {
- "description": "Indicates summary of the assigned rooms.",
- "$ref": "#/definitions/assignedRoomsSummaryType"
+ "communicationType": {
+ "description": "CommunicationType through which the confirmation letter was sent.",
+ "$ref": "#/definitions/confDeliveryMethod"
},
- "unassignedRooms": {
- "description": "Indicates summary of the unassigned rooms.",
- "$ref": "#/definitions/unassignedRoomsSummaryType"
+ "lastStatus": {
+ "description": "Status of last sent confirmation.",
+ "$ref": "#/definitions/sentConfirmationStatus"
+ },
+ "lastAttempted": {
+ "description": "Date of last attempt to send confirmation letter.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "successfulTries": {
+ "description": "Number of success letter sent.",
+ "type": "integer"
}
}
},
- "roomType": {
- "description": "This type represents the primary room attributes.",
+ "confDeliveryMethod": {
+ "type": "string",
+ "enum": [
+ "Print",
+ "Email",
+ "Fax",
+ "Text",
+ "NotConfigured"
+ ]
+ },
+ "sentConfirmationStatus": {
+ "type": "string",
+ "enum": [
+ "Pending",
+ "Succeeded",
+ "Failed"
+ ]
+ },
+ "confirmationStyle": {
"type": "object",
"properties": {
- "accessible": {
- "description": "Indicates whether the room is accessibility compliant.",
- "type": "boolean"
- },
- "attendant": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/currentServicingAttendantType"
- }
+ "url": {
+ "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "type": "string"
},
- "building": {
- "description": "Building associated with the room.",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "componentRoomNumber": {
- "description": "This flag indicates component room.",
+ "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",
- "maxLength": 20,
- "minLength": 0
- },
- "componentRoomNumbers": {
- "description": "List of component room numbers.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- },
- "componentRooms": {
- "description": "This flag indicates component rooms.",
- "$ref": "#/definitions/roomRoomsType"
- },
- "connectingRooms": {
- "description": "This flag indicates connecting rooms.",
- "$ref": "#/definitions/roomRoomsType"
- },
- "description": {
- "description": "Description of the room.",
- "$ref": "#/definitions/translationTextType2000"
- },
- "discrepancy": {
- "description": "Identifies the room discrepancy information.",
- "$ref": "#/definitions/roomDiscrepanciesType"
+ "minLength": 0,
+ "maxLength": 80
},
- "floor": {
- "description": "Floor of the Room.",
+ "idContext": {
+ "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "floorDescription": {
- "description": "Description for the Floor of the Room.",
+ "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",
- "maxLength": 20,
- "minLength": 0
- },
- "hold": {
- "description": "Hold attributes if any.",
- "$ref": "#/definitions/roomHoldType"
+ "minLength": 0,
+ "maxLength": 80
},
- "housekeeping": {
- "description": "Identifies the Housekeeping information..",
- "$ref": "#/definitions/housekeepingType"
+ "idExtension": {
+ "description": "Additional identifying value assigned by the creating system.",
+ "type": "integer"
},
- "meetingRoom": {
- "description": "Indicates whether the room is a Meeting Room",
- "type": "boolean"
+ "style": {
+ "description": "Name of the confirmation letter style.",
+ "type": "string"
+ }
+ }
+ },
+ "callHistoryType": {
+ "type": "array",
+ "description": "Holds call information.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/callType"
+ }
+ },
+ "callType": {
+ "type": "object",
+ "description": "Holds call information.",
+ "properties": {
+ "dateTimeSpan": {
+ "description": "Call Time Span. Start Date and End Date is used for the Call duration.",
+ "$ref": "#/definitions/dateTimeSpanType"
},
- "outOfOrder": {
- "description": "Identifies the room Out of Order/Out of Service information.",
- "$ref": "#/definitions/roomsOutOfOrderType"
+ "caller": {
+ "description": "Holds caller information.",
+ "$ref": "#/definitions/callerType"
},
- "resvInfo": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/reservationShortInfoType"
+ "reservation": {
+ "description": "Holds Reservation Id and Hotel Code.",
+ "type": "object",
+ "properties": {
+ "reservationIdList": {
+ "description": "Holds Reservation related Ids.",
+ "$ref": "#/definitions/reservationIdList"
+ },
+ "hotelId": {
+ "description": "Holds Hotel Code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
}
},
- "roomAssignmentRating": {
- "description": "Assignment Rating associated with the room.",
- "$ref": "#/definitions/ratePlanRatingType"
- },
- "roomDescription": {
- "description": "Detail Long Description Of The Room.",
+ "turnawayCode": {
+ "description": "Call turn away code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomFeatures": {
- "description": "Room Features for the room.",
- "$ref": "#/definitions/roomFeaturesType"
+ "minLength": 0,
+ "maxLength": 20
},
- "roomId": {
- "description": "Code of the room.",
+ "comments": {
+ "description": "Call comments.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomSection": {
- "description": "Room sections of the room.",
- "$ref": "#/definitions/roomSectionType"
+ "minLength": 0,
+ "maxLength": 200
},
- "roomType": {
- "description": "Room type basic information of the room.",
- "$ref": "#/definitions/roomTypeShortInfoType"
+ "url": {
+ "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "type": "string"
},
- "rotationRoomId": {
- "description": "Rotation room of the room type.",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "sitePlanSection": {
- "description": "Identifies the site plan location of the room.",
- "$ref": "#/definitions/sitePlanSectionType"
+ "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
},
- "smokingPreference": {
- "description": "This indicates room smoking preference.",
+ "idContext": {
+ "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "smokingPreferenceDescription": {
- "description": "This indicates the description of the room smoking preference.",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "turndownInfo": {
- "$ref": "#/definitions/turndownInfoType"
+ "idExtension": {
+ "description": "Additional identifying value assigned by the creating system.",
+ "type": "integer"
}
}
},
- "roomTypeShortInfoType": {
- "description": "Basic information of room type.",
+ "callerType": {
"type": "object",
+ "description": "Holds caller information.",
"properties": {
- "accessible": {
- "description": "Indicates if room type is accessible.",
- "type": "boolean"
- },
- "building": {
- "description": "Building associated with the room.",
+ "givenName": {
+ "description": "Caller First Name.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "houseKeeping": {
- "description": "Indicates if room type of the room is flagged as housekeeping. This is read-only.",
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 280
},
- "maximumOccupancy": {
- "description": "Maximum occupancy for the room type.",
- "type": "integer"
+ "surname": {
+ "description": "Caller Last Name.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "meetingRoom": {
- "description": "Indicates whether function space can be meeting room.",
- "type": "boolean"
+ "phone": {
+ "description": "Caller Phone Number.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "minimumOccupancy": {
- "description": "Minimum occupancy for the room type.",
- "type": "integer"
+ "email": {
+ "description": "Caller Email.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "pseudo": {
- "description": "Indicates if room is a pseudo. This is read-only.",
- "type": "boolean"
+ "fax": {
+ "description": "Caller Fax Number.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
},
- "roomAssignmentRating": {
- "description": "Assignment Rating associated with the room.",
- "$ref": "#/definitions/ratePlanRatingType"
+ "url": {
+ "description": "URL that identifies the location associated with the record identified by the UniqueID.",
+ "type": "string"
},
- "roomClass": {
- "description": "Room Class of the room. This is read-only.",
+ "type": {
+ "description": "A reference to the type of object defined by the UniqueID element.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomFeatures": {
- "description": "Room Features for the room.",
- "$ref": "#/definitions/roomFeaturesType"
+ "minLength": 0,
+ "maxLength": 20
},
- "roomType": {
- "description": "Room type of the room.",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "shortDescription": {
- "description": "Short Description of room type.",
+ "idContext": {
+ "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "smokingPreference": {
- "description": "Specifies the smoking preference for room type of the room.",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "suite": {
- "description": "Indicates if room is a suite. This is read-only.",
- "type": "boolean"
+ "idExtension": {
+ "description": "Additional identifying value assigned by the creating system.",
+ "type": "integer"
}
}
},
- "roomTypeStatisticsType": {
- "description": "Reservation Statistics for a Room Type",
+ "fixedChargesType": {
+ "type": "array",
+ "description": "Holds fixed charge detail.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/fixedChargeType"
+ }
+ },
+ "fixedChargeType": {
"type": "object",
+ "description": "Holds fixed charge information.",
"properties": {
- "roomType": {
- "description": "Room Type name. Available room types can be retrieved via /listOfValues/hotels/{hotelId}/roomTypes",
+ "schedule": {
+ "description": "Holds schedule of fixed charge.",
+ "$ref": "#/definitions/fixedChargeScheduleType"
+ },
+ "charge": {
+ "description": "Holds specific details of fixed charge.",
+ "$ref": "#/definitions/fixedChargeDetailType"
+ },
+ "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
},
- "total": {
- "description": "Number of reservations.",
- "type": "integer",
- "maximum": 4000,
- "minimum": 0
+ "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"
}
}
},
- "roomsAI": {
- "description": "Request to run AI Room Assignment and allocate rooms to incoming reservations.",
+ "fixedChargeScheduleType": {
"type": "object",
+ "description": "Holds schedule of fixed charge.",
"properties": {
- "hotelCodes": {
- "description": "List of resorts for which the room assignment algorithm needs to run.",
- "$ref": "#/definitions/codeListType"
+ "start": {
+ "description": "The starting value of the date range.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "end": {
+ "description": "The ending value of the date range.",
+ "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.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 3
+ },
+ "dateToExecute": {
+ "description": "Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
}
}
},
- "roomsHoldType": {
- "description": "Hold reason and the list of the rooms that are to be put on hold under that reason.",
+ "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": {
- "comments": {
- "description": "Comments to the rooms being put on hold.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "transaction": {
+ "description": "Transaction code and description of a fixed charge.",
+ "$ref": "#/definitions/codeDescriptionType"
},
- "hotelId": {
- "description": "Resort where room hold is to take place.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "quantity": {
+ "description": "Quantity of the product.",
+ "type": "integer"
},
- "reason": {
- "description": "List of rooms that are to be put on hold.",
+ "chargeAmount": {
+ "description": "Price of the product.",
+ "$ref": "#/definitions/currencyAmountType"
+ },
+ "percent": {
+ "description": "Percentage of the rate amount.",
+ "type": "number",
+ "minimum": 0,
+ "maximum": 100
+ },
+ "supplement": {
+ "description": "Additional information regarding the fixed charge.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "rooms": {
- "description": "Collection of room numbers that are to be placed on hold.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
+ "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"
}
}
},
- "roomsHoldsType": {
- "description": "List of rooms, reason, and comments.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/roomsHoldType"
- }
- },
- "roomsOutOfOrderType": {
- "description": "Date Range and reasons for a room being Out of Order/Out Of Service (If the room is OO/OS).",
+ "guestMessagesType": {
"type": "array",
+ "description": "Holds the Message Information",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/roomOutOfOrderType"
+ "$ref": "#/definitions/guestMessageType"
}
},
- "routingInfoListType": {
- "description": "A routing info object can either be of type Folio OR of type Room with its corresponding instructions.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/routingInfoType"
+ "guestMessageType": {
+ "type": "object",
+ "description": "Holds the Message information for a Reservation",
+ "properties": {
+ "message": {
+ "description": "Holds the Message Information",
+ "$ref": "#/definitions/messageType"
+ },
+ "delivery": {
+ "description": "Holds the Delivery Method Information",
+ "$ref": "#/definitions/messageDeliveryType"
+ },
+ "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"
+ },
+ "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
+ },
+ "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
+ }
}
},
- "routingInfoType": {
- "description": "A routing info object can either be of type Folio OR of type Room with its corresponding object.",
+ "messageType": {
"type": "object",
+ "description": "Holds the Message Information",
"properties": {
- "comp": {
- "description": "Comp Accounting Routing Info",
- "type": "object",
- "properties": {
- "compAccountingInfo": {
- "$ref": "#/definitions/compAccountingType"
- },
- "compRequestInfo": {
- "$ref": "#/definitions/compRoutingRequestType"
- },
- "folioWindowNo": {
- "type": "integer"
- },
- "instructions": {
- "description": "Set of routing instructions associated to this routing type.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/routingInstructionType"
- }
- },
- "payeeInfo": {
- "$ref": "#/definitions/payeeInfoType"
- }
- }
- },
- "folio": {
- "description": "Folio routing type.",
- "type": "object",
- "properties": {
- "aRNumber": {
- "description": "Accounts Receivable.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "folioWindowNo": {
- "type": "integer"
- },
- "guestInfo": {
- "description": "Guest details",
- "type": "object",
- "properties": {
- "profileIdList": {
- "description": "Unique identifiers for the Profile for both internal and external systems.",
- "$ref": "#/definitions/profileIdList"
- }
- }
- },
- "instructions": {
- "description": "Set of routing instructions associated to this routing type.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/routingInstructionType"
- }
- },
- "payeeInfo": {
- "$ref": "#/definitions/payeeInfoType"
- },
- "paymentMethod": {
- "type": "string",
- "maxLength": 2000
- }
- }
+ "messageText": {
+ "description": "Message Content",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "refreshFolio": {
- "description": "On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions.",
- "type": "boolean"
+ "messageDate": {
+ "description": "Date the message was created",
+ "type": "string",
+ "format": "date-time"
},
- "request": {
- "description": "Comp Accounting Request routing",
- "type": "object",
- "properties": {
- "compRequestInfo": {
- "$ref": "#/definitions/compRoutingRequestType"
- },
- "instructions": {
- "description": "Set of routing instructions associated to this routing type.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/routingInstructionType"
- }
- }
- }
+ "typeOfMessage": {
+ "description": "Type of message (Voice/Text)",
+ "$ref": "#/definitions/typeOfMessageType"
},
- "room": {
- "description": "Room routing type.",
- "type": "object",
- "properties": {
- "guestDisplayName": {
- "description": "Display Name for the guest.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "guestNameId": {
- "description": "Guest unique identifier to which the instruction will be routed.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "instructions": {
- "description": "Set of routing instructions associated to this routing type.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/routingInstructionType"
- }
- },
- "reservationNameId": {
- "description": "Reservation name id to which the instruction will be routed.",
- "$ref": "#/definitions/uniqueID_Type"
- },
- "roomId": {
- "description": "Room number to route the instructions.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
+ "recipient": {
+ "description": "Recipient of the Message",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 80
+ },
+ "operator": {
+ "description": "User who created the Message",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
}
}
},
- "routingInstructionType": {
- "description": "Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit",
+ "typeOfMessageType": {
+ "type": "string",
+ "description": "The type of Message for Guest Messages.",
+ "enum": [
+ "Tm",
+ "Vm"
+ ]
+ },
+ "messageDeliveryType": {
"type": "object",
+ "description": "Holds the Delivery Information of the Message",
"properties": {
- "billingInstructions": {
- "description": "Set of Billing Instructions configured in this time span.",
- "$ref": "#/definitions/billingInstructionsType"
+ "deliveryStatus": {
+ "description": "Status of the Message (Received or Not Received)",
+ "$ref": "#/definitions/messageStatusType"
},
- "covers": {
- "description": "Number of covers for this routing instruction.",
- "type": "number"
+ "deliveryDate": {
+ "description": "Date the message has been delivered (marked as received)",
+ "type": "string",
+ "format": "date-time"
},
- "creditLimit": {
- "description": "Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero.",
- "type": "number"
+ "deliveredBy": {
+ "description": "User who delivered the message (who marked message as received)",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "duration": {
- "description": "Duration of this instruction.",
- "type": "object",
- "properties": {
- "daily": {
- "description": "Flag to indicate if the routing instruction is a daily instruction.",
- "type": "boolean"
- },
- "friday": {
- "type": "boolean"
- },
- "monday": {
- "type": "boolean"
- },
- "saturday": {
- "type": "boolean"
- },
- "sunday": {
- "type": "boolean"
- },
- "thursday": {
- "type": "boolean"
- },
- "timeSpan": {
- "$ref": "#/definitions/timeSpanType"
- },
- "tuesday": {
- "type": "boolean"
- },
- "wednesday": {
- "type": "boolean"
- }
- }
+ "printDate": {
+ "description": "Date when message has been printed",
+ "type": "string",
+ "format": "date-time"
},
- "limitUsed": {
- "description": "Amount of Credit used for this routing instruction.",
- "type": "number"
+ "textMessageSentDate": {
+ "description": "Date when message has been sent via SMS",
+ "type": "string",
+ "format": "date-time"
},
- "percentageLimit": {
- "description": "The routing limit percentage allowed for this routing instruction.",
- "type": "number"
+ "textMessageSentBy": {
+ "description": "User who sent the message",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
},
- "routingLinkId": {
- "description": "Internal Routing Link Id identifier to which limit group the instruction belongs.",
- "$ref": "#/definitions/uniqueID_Type"
+ "textMessageSentById": {
+ "description": "User Id of who sent the message",
+ "type": "integer"
},
- "transactionCodes": {
- "description": "Set of Transaction Codes configured in this time span.",
- "$ref": "#/definitions/trxCodesInfoType"
+ "textMessageRecipientNo": {
+ "description": "Number in which the message is to be sent.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "salesInfoType": {
- "description": "Provides sales information about the profiles of type company, travel agent, source and contact.",
+ "messageStatusType": {
+ "type": "string",
+ "description": "Status of the Message.",
+ "enum": [
+ "Mr",
+ "Nr"
+ ]
+ },
+ "overrideInstructionsType": {
+ "type": "array",
+ "description": "List of override actions done.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/overrideInstructionType"
+ }
+ },
+ "overrideInstructionType": {
"type": "object",
+ "description": "Type for Overrides. Contains information for the override action performed while booking a reservation.",
"properties": {
- "accountSource": {
- "description": "Defines the account source.",
+ "description": {
+ "description": "The description of the restriction for which the override was done.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "accountType": {
- "description": "Defines the account type.",
+ "date": {
+ "description": "The date when the override was done.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "actionCode": {
- "description": "Defines the action code.",
+ "type": {
+ "description": "The type of override done. If done for Availability, then it will be AVAILABILITY.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "businessSegments": {
- "description": "Defines the Business segments.",
+ "userId": {
+ "description": "Login ID of the user who performed the override.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "competitionCode": {
- "description": "Defines the competition code.",
+ "reasonCode": {
+ "description": "The override reason code.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "hotelId": {
- "description": "Hotel Code used to filter the sales information.",
+ "reasonDescription": {
+ "description": "The override reason description.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
+ }
+ }
+ },
+ "eCouponsType": {
+ "type": "array",
+ "description": "Collection of ECouponType object.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/eCouponType"
+ }
+ },
+ "eCouponType": {
+ "type": "object",
+ "description": "Reservation eCoupon Type Information.",
+ "properties": {
+ "eCouponId": {
+ "description": "ECouponID to attach the eCoupon to Reservation.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "industryCode": {
- "description": "Defines the industry code.",
+ "code": {
+ "description": "Code to attach the eCoupon to Reservation.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "influence": {
- "description": "Defines the influence for the contact profile.",
+ "description": {
+ "description": "Description of the eCoupon attached to the Reservation.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "preferredRoom": {
- "description": "Defines the Preferred Room for profile.",
+ "autoAttached": {
+ "description": "Determines whether the eCoupon is attached through the Rate Code or not.",
+ "type": "boolean"
+ },
+ "issuedQuantity": {
+ "description": "Assigned Quantity for the eCoupon when attached to Reservation.",
+ "type": "integer"
+ },
+ "usedQuantity": {
+ "description": "Used Quantity of the eCoupon for the Reservation.",
+ "type": "integer"
+ },
+ "reason": {
+ "description": "Reason for attaching/modifing eCoupon.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 4000
},
- "priority": {
- "description": "Defines the priority.",
+ "ratePlanCode": {
+ "description": "Rate plan of the attached eCoupon to Reservation.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "roomsPotential": {
- "description": "Defines the rooms potential.",
+ "welcomeOffer": {
+ "description": "Determines whether this eCoupon is eligible for welcome offer or not.",
+ "type": "boolean"
+ }
+ }
+ },
+ "reservationTransactionDiversionsType": {
+ "type": "array",
+ "description": "List of Transaction Diversion rules.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationTransactionDiversionType"
+ }
+ },
+ "reservationTransactionDiversionType": {
+ "type": "object",
+ "description": "A Transaction Diversion Rule Type",
+ "properties": {
+ "vipCode": {
+ "description": "VIP code to consider while applying Diversion Instruction.",
"type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "scope": {
- "description": "Defines the scope.",
+ "membership": {
+ "description": "Membership type to consider while applying Diversion Instruction.",
+ "$ref": "#/definitions/membershipTypeLevelType"
+ },
+ "targetRoom": {
+ "description": "Room number to receive all the diverted transactions configured for this instruction.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "scopeCity": {
- "description": "Defines the scope city.",
+ "transactionCodes": {
+ "description": "Collection of Transaction Code List",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/codeDescriptionType"
+ }
+ },
+ "description": {
+ "description": "User defined message for the Transaction Diversion Rule.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
+ },
+ "level": {
+ "description": "Level of the Transaction Diversion rule that can be Property or Reservation.",
+ "$ref": "#/definitions/transactionDiversionRuleLevelType"
+ },
+ "thresholds": {
+ "description": "Threshold Details related to the Transaction diversion rule.",
+ "$ref": "#/definitions/thresholdDetailsType"
+ },
+ "type": {
+ "description": "Transaction Diversion Rule Types",
+ "$ref": "#/definitions/transactionDiversionRuleTypeType"
+ },
+ "hotelId": {
+ "description": "Hotel code with which Transaction Diversion Rule is associated.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "code": {
+ "description": "Transaction Diversion Code",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "displaySequence": {
+ "description": "User configured Sequence number.",
+ "type": "number"
+ },
+ "inactive": {
+ "description": "Indicator that tells whether the transaction diversion rule is active or not.",
+ "type": "boolean"
+ },
+ "notes": {
+ "description": "The Note details related to the Transaction Diversion Rule.",
+ "$ref": "#/definitions/commentInfoType"
+ },
+ "posted": {
+ "description": "Transaction diversions that are posted.",
+ "type": "integer"
+ },
+ "diverted": {
+ "description": "Transaction diversions that are diverted .",
+ "type": "integer"
+ },
+ "dailyDetails": {
+ "description": "Collection of daily details of a Transaction diversion rule for a particular reservation.",
+ "$ref": "#/definitions/transactionDiversionDailyDetailsType"
+ }
+ }
+ },
+ "membershipTypeLevelType": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Code type for Rule Details",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "level": {
+ "description": "Description type for Rule Details",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
+ }
+ },
+ "transactionDiversionRuleLevelType": {
+ "type": "string",
+ "description": "Reservation level.",
+ "enum": [
+ "Property",
+ "Reservation"
+ ]
+ },
+ "thresholdDetailsType": {
+ "type": "object",
+ "description": "Type for the threshold elements.",
+ "properties": {
+ "entity": {
+ "description": "Diversion entity type associated with the charge for the transaction diversion rule .",
+ "$ref": "#/definitions/entityType"
+ },
+ "scope": {
+ "description": "Diversion scope for the transaction diversion rule.",
+ "$ref": "#/definitions/scopeType"
+ },
+ "minRequired": {
+ "description": "Minimum required number of quantities, counts or minutes that must be posted.",
+ "type": "integer"
+ },
+ "complimentary": {
+ "description": "The number of quantities, counts or minutes for which transaction diversion is allowed .",
+ "type": "integer"
+ },
+ "isEditable": {
+ "description": "Configuring this flag to be TRUE will make the thresholds editable.",
+ "type": "boolean"
}
}
},
+ "entityType": {
+ "type": "string",
+ "description": "Indicates the rule is based on Minutes associated with the charge.",
+ "enum": [
+ "ThresholdCount",
+ "ThresholdQuantity",
+ "ThresholdMinutes"
+ ]
+ },
"scopeType": {
- "description": "Minimum required and complimentary values are applicable Per Stay.",
"type": "string",
+ "description": "Minimum required and complimentary values are applicable Per Stay.",
"enum": [
"PerDay",
"PerStay"
]
},
- "searchMatchType": {
- "description": "Search match indicating attribute and the matching value.",
+ "transactionDiversionRuleTypeType": {
+ "type": "string",
+ "description": "The rule type on which the Transaction Diversion Rule is based. If a reservation has any of the following code, Transaction Diversion rule gets active for that reservation",
+ "enum": [
+ "Vip",
+ "Membership"
+ ]
+ },
+ "transactionDiversionDailyDetailsType": {
+ "type": "array",
+ "description": "List of daily details for Transaction Diversion rule.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/transactionDiversionDailyDetailType"
+ }
+ },
+ "transactionDiversionDailyDetailType": {
"type": "object",
+ "description": "List of daily details for Transaction Diversion rule.",
"properties": {
- "attribute": {
- "description": "Search match attribute.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "posted": {
+ "description": "Transaction diversion rules that are posted.",
+ "type": "integer"
},
- "value": {
- "description": "Search match value.",
+ "diverted": {
+ "description": "Transaction diversion rules that are diverted .",
+ "type": "integer"
+ },
+ "date": {
+ "description": "Daily details Date about when the rules are posted or diverted.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
}
}
},
- "searchMatchesType": {
- "description": "List of Generic Name-Value-Pair Parameters used for super search matches.",
+ "ticketsType": {
"type": "array",
+ "description": "Collection of TicketType objects.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/searchMatchType"
+ "$ref": "#/definitions/ticketType"
}
},
- "sentConfirmationStatus": {
- "type": "string",
- "enum": [
- "Pending",
- "Succeeded",
- "Failed"
- ]
- },
- "serviceRequest": {
- "description": "Service request.",
+ "ticketType": {
"type": "object",
+ "description": "Reservation Ticket Type Information.",
"properties": {
- "action": {
- "description": "Description of the action taken to complete the request.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "closeDescription": {
- "description": "The follow up description.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "ticketId": {
+ "description": "Internal Unique ID.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "closedBy": {
- "description": "The user who closed the service request.",
+ "packageCode": {
+ "description": "Package Code.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "closedDate": {
- "description": "The date-time in which the service request was closed.",
- "type": "string",
- "format": "date-time"
+ "reservationProductId": {
+ "description": "Reference to the reservation product.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "code": {
- "description": "Service request code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "ticketNumber": {
+ "description": "Ticket number.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "comment": {
- "description": "Description of the service request.",
+ "description": {
+ "description": "Package description.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "completionDate": {
- "description": "The date-time in which the service request was completed.",
+ "issueDate": {
+ "description": "Tickets issue date.",
"type": "string",
- "format": "date-time"
+ "format": "date",
+ "maxLength": 8
},
- "department": {
- "description": "The department that is associated with the service request code.",
- "$ref": "#/definitions/codeDescriptionType"
+ "price": {
+ "description": "Tickets price.",
+ "type": "number"
},
- "guaranteedBy": {
- "description": "The user who guaranteed the completion of the service request.",
+ "consumptionDate": {
+ "description": "Tickets comsumption date.",
"type": "string",
- "maxLength": 100,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "guestContactMethod": {
- "description": "Communication method picked from guest profile.",
+ "rateCode": {
+ "description": "The Rate Code to which tickets belong to.",
"type": "string",
- "maxLength": 100,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "guestName": {
- "description": "The guest name.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "quantity": {
+ "description": "Number of tickets used to create multiple tickets.",
+ "type": "integer"
},
- "hotelId": {
- "description": "Hotel Code of the service request.",
+ "reference": {
+ "description": "Free text field for reference information.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
},
- "openDate": {
- "description": "The date-time in which the service request was opened.",
+ "status": {
+ "description": "The Status Code for outbound WS call.",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 20
},
- "priority": {
- "description": "The priority level of the service request.",
+ "statusDescription": {
+ "description": "The Status Description for outbound WS call.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "profileId": {
- "description": "Unique identifier of the guest.",
- "$ref": "#/definitions/profileId"
- },
- "reservationIdList": {
- "description": "Unique identifier of the reservation.",
- "$ref": "#/definitions/reservationIdList"
- },
- "room": {
- "description": "The room number in which the service request was created.",
+ "minLength": 0,
+ "maxLength": 2000
+ }
+ }
+ },
+ "reservationECertificatesType": {
+ "type": "array",
+ "description": "Collection of ECertificateType object.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationECertificateType"
+ }
+ },
+ "reservationECertificateType": {
+ "type": "object",
+ "description": "Reservation ECertificate Type Information.",
+ "properties": {
+ "eCertificateNo": {
+ "description": "ECertificate Number for the reservation.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 40
},
- "serviceRequestId": {
- "description": "Unique identifier of the service request.",
- "$ref": "#/definitions/uniqueID_Type"
+ "actionType": {
+ "description": "ECertificate status for the reservation.",
+ "$ref": "#/definitions/requestActionType"
},
- "status": {
- "description": "The status of the service request.",
- "$ref": "#/definitions/serviceRequestStatusType"
+ "eCertificateType": {
+ "description": "ECertificate Type where value can be PROMOTION,AWARD,BENEFIT and OTHER",
+ "$ref": "#/definitions/eCertificateClassficationType"
}
}
},
- "serviceRequestStatusType": {
+ "requestActionType": {
"type": "string",
"enum": [
- "Open",
- "PendingFollowUp",
- "Closed",
- "DoNotDisturb",
- "MakeUpRoom"
+ "Create",
+ "Remove",
+ "Query"
]
},
- "serviceRequests": {
- "description": "Service request.",
+ "eCertificateClassficationType": {
+ "type": "string",
+ "description": "Enumeration of the different type of Ecertificate.",
+ "enum": [
+ "Promotion",
+ "Award",
+ "Benefit",
+ "Other"
+ ]
+ },
+ "nameValueDetailType": {
+ "type": "object",
+ "description": "Detailed information returned during name value search.",
+ "properties": {
+ "nameValues": {
+ "description": "Name Value List.",
+ "$ref": "#/definitions/nameValuesType"
+ }
+ }
+ },
+ "nameValuesType": {
"type": "array",
+ "description": "List of name value pairs.",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/serviceRequest"
+ "$ref": "#/definitions/nameValueType"
}
},
- "serviceRequestsInfo": {
- "description": "Response object for service requests.",
+ "nameValueType": {
"type": "object",
+ "description": "Contains name value pair.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "name": {
+ "description": "Contains unique key which represents for record field.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 100
},
- "serviceRequestsDetails": {
- "description": "List of service requests.",
- "$ref": "#/definitions/serviceRequests"
+ "value": {
+ "description": "Contains value for the record/column.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 4000
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "formatString": {
+ "description": "Contains format string for values.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 100
+ },
+ "dataType": {
+ "description": "Contains data type for values.",
+ "$ref": "#/definitions/nameValueDataTypeType"
+ },
+ "origin": {
+ "description": "Contains Origin information.",
+ "$ref": "#/definitions/nameValueOriginType"
+ },
+ "usageInstruction": {
+ "description": "Contains value(s) to identify the reports to include the collected information in e.g. PFH=Print Folio Header, PFD=Print Folio Detail.",
+ "$ref": "#/definitions/codeListType"
}
}
},
- "servicingAttendantStatusType": {
- "description": "Possible values for the Status of a Servicing Attendant.",
+ "nameValueDataTypeType": {
"type": "string",
"enum": [
- "Standby",
- "Break",
- "Working",
- "Completed"
+ "String",
+ "Number",
+ "Date",
+ "Datetime",
+ "Time",
+ "Integer"
]
},
- "setProcessingInstructions": {
- "description": "Request Type for setting instructions for commission processing on Agent or Reservation level.",
+ "nameValueOriginType": {
"type": "object",
+ "description": "Contains origin details.",
"properties": {
- "agents": {
- "description": "List of commission processing instructions for agents and/or its associated reservations.",
- "$ref": "#/definitions/commissionProcessingAgentsType"
+ "originName": {
+ "description": "Contains origin i.e. Reseravtion, Profile, Folio or FinTrx.",
+ "$ref": "#/definitions/nameValueModuleType"
},
- "links": {
- "$ref": "#/definitions/links"
+ "destination": {
+ "description": "Contains destination column for Origin.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
- "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
}
}
},
- "shareDistributionInstructionType": {
- "description": "The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL -> Full Rate for each Sharer. SPLIT-> Split the Rate amount between Sharer Reservations. ENTIRE -> This Sharer will get the total amount of the rate code for all the Sharer Reservations.",
+ "nameValueModuleType": {
"type": "string",
"enum": [
- "Full",
- "Entire",
- "Split",
- "CustomSplit"
+ "Reservation",
+ "Folio",
+ "Profile",
+ "Fintrix"
]
},
- "shiftRooms": {
- "description": "To quickly shift rooms for two reservations that are for the same arrival date and room type",
+ "customChargeExemptionsType": {
+ "type": "array",
+ "description": "List of Custom Charge Exemptions.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/customChargeExemptionType"
+ }
+ },
+ "customChargeExemptionType": {
"type": "object",
+ "description": "Contains custom charges exemption information.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "customChargesExemption": {
+ "description": "Contains exemption code and description.",
+ "$ref": "#/definitions/codeDescriptionType"
},
- "sourceRoom": {
- "description": "Source Room request which defines parameters needed to shift rooms.",
- "$ref": "#/definitions/stayRoominfo"
+ "customChargeQuantity": {
+ "description": "Contains exemption quantity for the stay. When this value is configured, daily exemption quantities are not permitted.",
+ "$ref": "#/definitions/customChargeQuantityType"
},
- "targetRoom": {
- "description": "Target Room request which defines parameters needed to shift rooms.",
- "$ref": "#/definitions/stayRoominfo"
+ "customChargeDates": {
+ "description": "Contains exemption detail information for each date.",
+ "$ref": "#/definitions/customChargeExemptionDatesType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "excludedDates": {
+ "description": "Contains list of dates which are not valid for custom charge exemptions.",
+ "$ref": "#/definitions/excludedDatesType"
+ },
+ "percentage": {
+ "description": "Exemption Percentage",
+ "type": "number",
+ "minimum": 0,
+ "maximum": 100
+ },
+ "propertyExemption": {
+ "description": "Flag specifying if custom charge exemptions is property level or not.",
+ "type": "boolean"
}
}
},
- "shortReservation": {
+ "customChargeQuantityType": {
"type": "object",
+ "description": "Contains quantity of custom charge exemptions.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
- },
- "reservationInfoList": {
- "description": "Short reservation information response.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/reservationInfoType"
- }
- },
- "reservationsSummary": {
- "description": "Collection of Reservations summary and their information.",
- "$ref": "#/definitions/reservationsSummaryType"
+ "quantity": {
+ "description": "Contains number of Custom Charge Exemption for a day.",
+ "type": "integer"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "available": {
+ "description": "Indicates if Custom Charges Exemption information is editable.",
+ "type": "boolean"
}
}
},
- "sitePlanSectionType": {
- "description": "Represents the site plan section record.",
+ "customChargeExemptionDatesType": {
+ "type": "array",
+ "description": "Contains List of Custom Charge Exemption information for a day.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/customChargeExemptionDateType"
+ }
+ },
+ "customChargeExemptionDateType": {
"type": "object",
+ "description": "Contains Custom Charge Exemption information for a day.",
"properties": {
- "coordinates": {
- "description": "The coordinates for this section.",
- "type": "string"
- },
- "description": {
- "description": "The description of this section.",
- "type": "string"
- },
- "linkCode": {
- "description": "The link code for the section.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "sectionCode": {
- "description": "The site plan section code.",
+ "date": {
+ "description": "Contains Custom Charge Exemption date.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "sectionType": {
- "description": "The section type.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "quantity": {
+ "description": "Contains number of Custom Charge Exemption for a day.",
+ "type": "integer"
}
}
},
- "sourceOfSaleType": {
- "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.",
+ "excludedDatesType": {
+ "type": "array",
+ "description": "Contains list of dates which are valid for custom charge exemptions.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/excludedDateType"
+ }
+ },
+ "excludedDateType": {
"type": "object",
+ "description": "Specifies all the enabled dates.",
"properties": {
- "sourceCode": {
- "description": "The entity/channel who made the reservation.",
+ "date": {
+ "description": "Contains exclusion date.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "sourceType": {
- "description": "Type of entity/channel who made the reservation..",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "reason": {
+ "description": "Contains reason for exclusion.",
+ "$ref": "#/definitions/exclusionReasonType"
}
}
},
- "statUnitCategoryType": {
- "description": "Supported statistical units.",
+ "exclusionReasonType": {
"type": "string",
+ "description": "Custom Charge has already been Processed for this date within the reservation stay.",
"enum": [
- "Numeric",
- "Amount"
+ "NotConfigured",
+ "CustomChargeProcessed"
]
},
- "statistics": {
- "description": "Response element for frontOffice statistics.",
+ "foliosShortInfoType": {
+ "type": "array",
+ "description": "This type contains a list of generated bills for a reservation.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/folioShortInfoType"
+ }
+ },
+ "folioShortInfoType": {
"type": "object",
+ "description": "This type contains information of generated bills.",
"properties": {
- "calendarDate": {
- "description": "Statistical date of the requested report.",
+ "folioNo": {
+ "description": "Folio No of the bill generated.",
+ "type": "number"
+ },
+ "folioType": {
+ "description": "Folio type of the bill generated.",
"type": "string",
- "format": "date"
+ "minLength": 0,
+ "maxLength": 200
},
- "links": {
- "$ref": "#/definitions/links"
+ "folioView": {
+ "description": "The folio window where the settlement is applied.",
+ "type": "integer"
},
- "metricSet": {
- "description": "Base statistic set holder which defines the span of the statistical data.",
- "type": "array",
- "items": {
- "description": ".",
- "type": "object",
- "properties": {
- "code": {
- "type": "string",
- "maxLength": 2000
- },
- "end": {
- "type": "string",
- "format": "date"
- },
- "metrics": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/hSKStatType"
- }
- },
- "start": {
- "type": "string",
- "format": "date"
- }
- }
- }
+ "autoGenerated": {
+ "description": "Flag to indicate if the folio is auto generated or not.",
+ "type": "boolean"
},
- "statisticsCode": {
- "description": ".",
- "$ref": "#/definitions/hSKStatReportCodeType"
+ "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
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
+ "invoiceNo": {
+ "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios",
+ "type": "number"
+ },
+ "folioDate": {
+ "description": "Date of Folio Generation.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "folioStatus": {
+ "$ref": "#/definitions/folioStatusType"
}
}
},
- "status": {
- "description": "Existing Operations Responses will eventually be modified to be extended from this type.",
+ "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"
+ ]
+ },
+ "commissionNotesDetails": {
"type": "object",
+ "description": "Response type for fetching commission notes.",
"properties": {
+ "hotelId": {
+ "description": "Property code against which commissions notes are fetched.",
+ "$ref": "#/definitions/codeType"
+ },
+ "reservationId": {
+ "description": "Reservation Id for which the commission notes are fetched.",
+ "$ref": "#/definitions/reservationId"
+ },
+ "commissionNotesList": {
+ "description": "List of commission notes for reservation.",
+ "$ref": "#/definitions/commissionNotesListType"
+ },
"links": {
"$ref": "#/definitions/links"
},
@@ -37444,1359 +36437,1249 @@
}
}
},
- "stayDateInfoType": {
- "description": "Room attached with stay detail information",
- "type": "object",
- "properties": {
- "expectedTimes": {
- "$ref": "#/definitions/resExpectedTimesType"
- },
- "timeSpan": {
- "$ref": "#/definitions/timeSpanType"
- }
- }
- },
- "stayFutureListType": {
- "description": "A collection of reservation history details attached to Profiles.",
- "type": "object",
- "properties": {
- "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"
- },
- "reservationInfo": {
- "description": "Additional reservation information attached to the profile . Eg : Future reservation details",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/stayReservationInfoType"
- }
- },
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
- }
+ "commissionNotesListType": {
+ "type": "array",
+ "description": "Commission Note for the reservation.",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
}
},
- "stayHistoryListType": {
- "description": "A collection of reservation history details attached to Profiles.",
+ "linkedReservations": {
"type": "object",
"properties": {
- "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"
+ "linkedReservationList": {
+ "description": "Set of reservations linked to the requested Reservation.",
+ "$ref": "#/definitions/linkedReservationsInfoType"
},
- "reservationInfo": {
- "description": "Additional reservation information attached to the profile . Eg : History reservation details",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/stayReservationInfoType"
- }
+ "links": {
+ "$ref": "#/definitions/links"
},
- "totalResults": {
- "description": "Total number of rows queried",
- "type": "integer"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "stayInfoType": {
- "description": "Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.",
+ "room": {
"type": "object",
+ "description": "The reservation must still be reserved to use this operation.",
"properties": {
- "adultCount": {
- "description": "A collection of Guest Counts associated with Room Stay.",
- "type": "integer"
- },
- "arrivalDate": {
- "type": "string",
- "format": "date"
- },
- "assignedByAI": {
- "description": "Represents the room was assigned by AI Room Assignment.",
- "type": "boolean"
- },
- "balance": {
- "description": "Balance amount",
- "$ref": "#/definitions/currencyAmountType"
- },
- "bookingChannelCode": {
- "description": "Booking channel code",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "childCount": {
- "description": "A collection of Child Counts associated with Room Stay.",
- "type": "integer"
- },
- "compBalance": {
- "description": "Comp Balance amount",
- "$ref": "#/definitions/currencyAmountType"
- },
- "componentRoomType": {
- "description": "True indicates room type is a component type.",
- "type": "boolean"
- },
- "departureDate": {
- "type": "string",
- "format": "date"
- },
- "depositPayments": {
- "description": "A collection of deposit and/or payments for the Room Stay.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "expectedTimes": {
- "description": "The expected arrival, return and departure times of the guest.",
- "$ref": "#/definitions/resExpectedTimesType"
- },
- "fixedRate": {
- "description": "True if the rate is a fixed rate, otherwise false",
- "type": "boolean"
- },
- "guarantee": {
- "description": "The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.",
- "$ref": "#/definitions/resGuaranteeType"
- },
- "guestServiceStatus": {
- "description": "Service Status of In House guest like DND or MUP",
- "$ref": "#/definitions/guestHousekeepingServiceRequestType"
+ "criteria": {
+ "description": "Criteria for assigning a room to a reservation.",
+ "$ref": "#/definitions/reservationRoomSelectionType"
},
- "linkCode": {
- "description": "Party code",
- "type": "string",
- "maxLength": 2000
+ "links": {
+ "$ref": "#/definitions/links"
},
- "marketCode": {
- "description": "Market code",
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "reservationRoomSelectionType": {
+ "type": "object",
+ "description": "Defines search criteria needed to configure a room to a reservation.",
+ "properties": {
+ "hotelId": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "marketDescription": {
- "description": "Description of Market code",
- "type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "reservationIdList": {
+ "$ref": "#/definitions/reservationIdList"
},
- "numberOfRooms": {
- "description": "Room Id",
- "type": "integer"
+ "roomId": {
+ "description": "Room identifier which the reservation will hold.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "originalTimeSpan": {
- "description": "The Original Time Span covers the Room Stay dates of the original reservation.",
- "$ref": "#/definitions/timeSpanType"
+ "overrideInstructions": {
+ "description": "If this element is present, override flags will be set when configuring the room to the reservation.",
+ "$ref": "#/definitions/reservationRoomSelectionOverrideType"
},
- "points": {
- "description": "The Points contains the number of points used to book a particular room type.",
- "$ref": "#/definitions/pointsType"
+ "includedSharers": {
+ "description": "Valid share reservation identifier.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/reservationIdList"
+ }
},
- "promotion": {
- "description": "Promotion Codes",
- "$ref": "#/definitions/promotionType"
+ "updateRoomTypeCharged": {
+ "description": "Update the Room Type used for the Rate calculation.",
+ "type": "boolean"
},
- "pseudoRoom": {
- "description": "True indicates as pseudo room type. This is usually used for a posting master reservation.",
+ "includeDepartureRooms": {
+ "description": "Indicates if departure rooms are to be included for room assignment.",
"type": "boolean"
},
- "rateAmount": {
- "description": "Rate amount",
- "$ref": "#/definitions/currencyAmountType"
+ "roomNumberLocked": {
+ "description": "Update the do not move flag used to locking the reservation room number.",
+ "type": "boolean"
},
- "ratePlanCode": {
- "description": "Rate plan code",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "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"
},
- "rateSuppressed": {
- "description": "Whether this rate should be suppressed from view",
+ "scheduledRoomSegmentNumber": {
+ "description": "Indicates the Room Segment number the room is assigned to.",
+ "type": "number"
+ }
+ }
+ },
+ "reservationRoomSelectionOverrideType": {
+ "type": "object",
+ "description": "Define the override flag which will be used when configuring a room to a reservation.",
+ "properties": {
+ "dirtyRoom": {
+ "description": "Override the room selection even if the selected room has a \"dirty\" state.",
"type": "boolean"
},
- "reservationBlock": {
- "description": "Key information about the block for this reservation.",
- "$ref": "#/definitions/reservationBlockType"
- },
- "roomClass": {
- "description": "Room class code",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "outOfServiceRoom": {
+ "description": "Override the room selection even if the selected room has an \"out-of-service\" state.",
+ "type": "boolean"
},
- "roomId": {
- "description": "Room Id",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "sleepDiscrepantRoom": {
+ "description": "Override the room selection even when HouseKeeping configured the room to still be occupied.",
+ "type": "boolean"
},
- "roomNumberLocked": {
- "description": "When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.",
+ "occupancyRestriction": {
+ "description": "Override the room selection even when room occupancy is exceeded.",
"type": "boolean"
},
- "roomType": {
- "description": "Room type code",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "rateRestriction": {
+ "description": "Override the room selection even when there is rate restriction present for this room type.",
+ "type": "boolean"
},
- "roomTypeCharged": {
- "description": "Room type code that was charged",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "inventoryRestriction": {
+ "description": "Override the room selection even when there is no inventory.",
+ "type": "boolean"
},
- "scheduledCheckoutTime": {
- "description": "Indicates that this reservation is scheduled for automated check out.",
- "type": "string",
- "format": "date"
+ "roomNumberLocked": {
+ "description": "Override the room number locked flag in the database and use the value passed.",
+ "type": "boolean"
},
- "sourceCode": {
- "description": "Source of business",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "holdRoom": {
+ "description": "Override the Hold Room flag in the database and use the value passed.",
+ "type": "boolean"
},
- "sourceCodeDescription": {
- "description": "Description of the source of business.",
- "type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "rateChange": {
+ "description": "Defines override rate type.",
+ "$ref": "#/definitions/rateChangeInstructionType"
},
- "totalAmount": {
- "description": "The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.",
- "$ref": "#/definitions/currencyAmountType"
+ "overrideExternalChecks": {
+ "description": "Forcefully override update. For real-time CRS interfaces, this element is used as force selling indicator.",
+ "type": "boolean"
},
- "upgradedByAI": {
- "description": "Represents the room was assigned by AI Room Assignment.",
+ "dayUseReserved": {
+ "description": "If the current reservation is a Day Use, then check on Reserved rooms can be overridden when assigning rooms.",
"type": "boolean"
- }
- }
- },
- "stayReservationInfoType": {
- "description": "The Reservation class contains the current reservation being created or altered.",
- "type": "object",
- "properties": {
- "attachedProfiles": {
- "description": "List of attached profiles",
- "$ref": "#/definitions/resAttachedProfileListType"
},
- "computedReservationStatus": {
- "description": "Indicates the status of the reservation.",
- "$ref": "#/definitions/pMS_ResStatusType"
+ "overrideInstruction": {
+ "description": "Contains user information for the override action performed while booking a reservation.",
+ "$ref": "#/definitions/overrideInstructionType"
},
- "hotelId": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "overrideRotationRoom": {
+ "description": "Override the rotation room with the selected room when assigning rooms.",
+ "type": "boolean"
},
- "reservationIdList": {
- "description": "Unique identifiers for the reservation for both internal and external systems",
- "$ref": "#/definitions/reservationIdList"
+ "overrideRoomOwnership": {
+ "description": "Override the room ownership indicator in the reservation when assigning rooms. This is applicable when Room Rotation OPERA Control is active.",
+ "type": "boolean"
},
- "reservationStatus": {
- "description": "Indicates the status of the reservation.",
- "$ref": "#/definitions/pMS_ResStatusType"
+ "roomOwnershipType": {
+ "description": "Indicates if the reservation room is an owner or referral or regular room. This is applicable when Room Rotation OPERA Control is active.",
+ "$ref": "#/definitions/reservationRoomOwnershipType"
},
- "roomStay": {
- "description": "Collection of room stays.",
- "$ref": "#/definitions/stayInfoType"
+ "overrideRoomFeatures": {
+ "description": "This flag indicates true/false. When this is true, it will allow to override the room feature preference validation while assigning rooms. The Reservation Room Features OPERA Control will determine which room feature preferences will be validated. When Reservation Room Features is on, the validation will be against the Room Feature preferences attached to the reservation. If the parameter is off, the validation will be against the room feature preferences attached to the profile. This is applicable when the Room Feature Validation OPERA Control is on.",
+ "type": "boolean"
}
}
},
- "stayRoominfo": {
- "description": "Request which contains parameters needed to swap or shift rooms",
+ "rateChangeInstructionType": {
"type": "object",
+ "description": "Defines override rate type.",
"properties": {
- "arrivalDate": {
- "description": "Identifies Reservation arrival date.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "roomId": {
- "description": "Room identifier which the reservation will hold.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "discount": {
+ "description": "Discount percentage and/or amount, code and textual reason for discount.",
+ "$ref": "#/definitions/discountType"
},
- "roomType": {
- "description": "Identifies the reservations which are same room type/room category",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "rateChange": {
+ "description": "Rate change type.",
+ "$ref": "#/definitions/rateChangeType"
}
}
},
- "stringLength200": {
- "description": "Used for Character Strings, length 0 to 200.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "stringLength2000": {
- "description": "Used for Character Strings, length 0 to 2000.",
+ "rateChangeType": {
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "description": "Simple type for rate change type.",
+ "enum": [
+ "Verify",
+ "OldRate",
+ "NewRate"
+ ]
},
- "suggestedRoomType": {
- "description": "List of suggested rooms and component rooms.",
+ "assignedRoom": {
"type": "object",
+ "description": "Possible errors that the operation will generate: The reservation is not in Reserved state. The room being requested does not exist.",
"properties": {
- "componentRoomNumber": {
- "description": "List of component Room number belongs to a room.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
+ "oldRates": {
+ "description": "Collection of old room rate information on a daily basis.",
+ "$ref": "#/definitions/dailyRatesType"
+ },
+ "newRates": {
+ "description": "Collection of new room rate information on a daily basis.",
+ "$ref": "#/definitions/dailyRatesType"
+ },
+ "effectiveRates": {
+ "description": "Collection of effective rates per stay dates per guest to be applied on reservation including its shares.",
+ "$ref": "#/definitions/effectiveRatesType"
},
- "roomId": {
- "description": "Code of the room.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "suggestedRooms": {
- "description": "Response of fetch suggested rooms operation.",
- "type": "object",
- "properties": {
"links": {
"$ref": "#/definitions/links"
},
- "suggestedRoomsType": {
- "description": "List of suggested rooms for room assignment.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/suggestedRoomType"
- }
- },
"warnings": {
"$ref": "#/definitions/warningsType"
}
}
},
- "surnameType": {
- "description": "Family name, last name.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "dailyRatesType": {
+ "type": "array",
+ "description": "Defines room rate information on a daily basis.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/dailyRateType"
+ }
},
- "swapRooms": {
- "description": "To quickly swap or shift rooms for two reservations that are for the same arrival date and room type",
+ "dailyRateType": {
"type": "object",
+ "description": "The total amount charged for the service including additional amounts and fees.",
"properties": {
- "links": {
- "$ref": "#/definitions/links"
- },
- "sourceRoom": {
- "description": "Source Room request which defines parameters needed to swap rooms.",
- "$ref": "#/definitions/stayRoominfo"
+ "taxes": {
+ "description": "A collection of taxes.",
+ "$ref": "#/definitions/taxesType"
},
- "targetRoom": {
- "description": "Target Room request which defines parameters needed to swap rooms.",
- "$ref": "#/definitions/stayRoominfo"
+ "fees": {
+ "description": "A collection of fees or service charges.",
+ "$ref": "#/definitions/feesType"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "taskSheetStatistics": {
- "type": "object",
- "properties": {
- "links": {
- "$ref": "#/definitions/links"
+ "description": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 2000
},
- "taskStatisticsInfo": {
- "description": "Information regarding the Task Sheet statistics.",
- "$ref": "#/definitions/hSKTaskSheetStatisticsInfoType"
+ "amountBeforeTax": {
+ "description": "The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).",
+ "type": "number"
},
- "warnings": {
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "taskSheetType": {
- "description": "Task Sheet classification.",
- "type": "string",
- "enum": [
- "NoServiceRequired",
- "DoNotDisturb",
- "ManuallyCreated",
- "AutomaticGeneration",
- "Isolated",
- "ExtraRooms"
- ]
- },
- "taxType": {
- "description": "Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.",
- "type": "object",
- "properties": {
- "amount": {
- "description": "A monetary amount.",
+ "amountAfterTax": {
+ "description": "The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).",
"type": "number"
},
- "code": {
- "description": "Code identifying the fee (e.g.,agency fee, municipality fee).",
+ "currencyCode": {
+ "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "currencyCode": {
- "description": "Provides a currency code to reflect the currency in which an amount may be expressed.",
+ "currencySymbol": {
+ "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.",
"type": "string",
- "maxLength": 3,
- "minLength": 3
+ "minLength": 0,
+ "maxLength": 10
},
- "description": {
+ "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"
+ },
+ "code": {
+ "description": "Type of charge.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "type": {
- "description": "Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).",
- "$ref": "#/definitions/amountDeterminationType"
+ "rateOverride": {
+ "description": "When true indicates that the rate amount has been overridden.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "discount": {
+ "description": "Room rate discount percentage or amount, code and textual reason for discount.",
+ "$ref": "#/definitions/discountType"
+ },
+ "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
}
}
},
- "taxTypeType": {
- "description": "Provides information about the Tax Type.",
+ "effectiveRatesType": {
+ "type": "array",
+ "description": "Collection of effective rate amount per guest on specific dates.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/effectiveRateType"
+ }
+ },
+ "effectiveRateType": {
"type": "object",
+ "description": "Effective rate amount per guest on specific dates.",
"properties": {
- "code": {
- "description": "Code of the Tax Type.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "onePersonRate": {
+ "description": "Rate amount for one person.",
+ "type": "number"
},
- "collectingAgentTax": {
- "description": "A boolean flag for Collecting Agent Tax",
+ "twoPersonRate": {
+ "description": "Rate amount for two persons.",
+ "type": "number"
+ },
+ "threePersonRate": {
+ "description": "Rate amount for three persons.",
+ "type": "number"
+ },
+ "fourPersonRate": {
+ "description": "Rate amount for four persons.",
+ "type": "number"
+ },
+ "fivePersonRate": {
+ "description": "Rate amount for five persons.",
+ "type": "number"
+ },
+ "extraPersonRate": {
+ "description": "Rate amount for each extra person.",
+ "type": "number"
+ },
+ "extraChildRate": {
+ "description": "Rate amount for each extra Child.",
+ "type": "number"
+ },
+ "oneChildRate": {
+ "description": "Rate amount for one Child.",
+ "type": "number"
+ },
+ "twoChildrenRate": {
+ "description": "Rate amount for two Children.",
+ "type": "number"
+ },
+ "threeChildrenRate": {
+ "description": "Rate amount for three Children.",
+ "type": "number"
+ },
+ "fourChildrenRate": {
+ "description": "Rate amount for four Children.",
+ "type": "number"
+ },
+ "rateByAgeBuckets": {
+ "description": "Collection of rate amount by age bracket.",
+ "$ref": "#/definitions/rateByAgeBucketsType"
+ },
+ "minimumChildrenForFreeStay": {
+ "description": "Minimum number of children needed to get free stay.",
+ "type": "integer"
+ },
+ "pointsRequired": {
+ "description": "The number of award points required for applying this rate plan schedule.",
+ "type": "number"
+ },
+ "overrideFloorAmount": {
+ "description": "true if floor amount needs to be override",
"type": "boolean"
},
- "description": {
- "description": "Description of the Tax Type.",
+ "hotelId": {
+ "description": "",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "hotelId": {
- "description": "Code of the Hotel.",
+ "ratePlanCode": {
+ "description": "",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "roomType": {
+ "description": "",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "minimumLengthOfStay": {
- "description": "Minimun Length of Stay.",
+ "numberOfRooms": {
+ "description": "",
"type": "integer"
},
- "printAutoAdjust": {
- "description": "Print auto adjust information for this tax type on the tax exempt report.",
- "type": "boolean"
+ "amountBeforeTax": {
+ "description": "Rate amount Before Tax.",
+ "type": "number"
},
- "reportExemptDays": {
- "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.",
- "type": "integer"
+ "start": {
+ "description": "The starting value of the date range.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
},
- "reportTaxPercentage": {
- "description": "Tax percentage. Only used for tax exempt report.",
- "type": "number",
- "maximum": 100,
- "minimum": 0
+ "end": {
+ "description": "The ending value of the date range.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
}
}
},
- "taxesType": {
- "description": "A collection of taxes.",
+ "rateByAgeBucketsType": {
+ "type": "array",
+ "description": "Rate amount by age bucket.",
+ "maxItems": 3,
+ "items": {
+ "$ref": "#/definitions/rateByAgeBucketType"
+ }
+ },
+ "rateByAgeBucketType": {
"type": "object",
+ "description": "Rate amount by age bucket.",
"properties": {
- "amount": {
- "description": "A monetary amount.",
+ "rateAmount": {
+ "description": "Rate amount by age bucket.",
"type": "number"
},
- "currencyCode": {
- "description": "Provides a currency code to reflect the currency in which an amount may be expressed.",
- "type": "string",
- "maxLength": 3,
- "minLength": 3
- },
- "tax": {
- "description": "An individual tax.",
- "type": "array",
- "maxItems": 99,
- "items": {
- "$ref": "#/definitions/taxType"
- }
+ "minimumAge": {
+ "description": "Minimum age for age bucket.",
+ "type": "integer"
+ },
+ "maximumAge": {
+ "description": "Maximum age for age bucket.",
+ "type": "integer"
}
}
},
- "telephoneInfoType": {
- "description": "Information on a telephone number for the customer.",
+ "roomKeyInfo": {
"type": "object",
+ "description": "Response of fetch room keys operation.",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "totalAuthorization": {
+ "description": "Total Authorization on a reservation.",
+ "type": "number"
},
- "telephone": {
- "description": "Phone details for the profile.",
- "$ref": "#/definitions/telephoneType"
+ "incidentalLimit": {
+ "description": "Incidental limit on a reservation.",
+ "type": "number"
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "roomKeysInfoList": {
+ "description": "Collection of Room Keys information.",
+ "$ref": "#/definitions/roomKeysInfoListType"
+ },
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "telephoneType": {
- "description": "Information on a telephone number for the customer.",
+ "roomKeysInfoListType": {
+ "type": "array",
+ "description": "Contains details of Room key.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomKeyInfoType"
+ }
+ },
+ "roomKeyInfoType": {
"type": "object",
+ "description": "Contains detail information of room keys .",
"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.",
+ "hotelId": {
+ "description": "Name of the resort .",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "extension": {
- "description": "Extension to reach a specific party at the phone number.",
+ "keyCount": {
+ "description": "Number of keys has been created for the reservation .",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 1,
+ "maxLength": 3
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "keyStartDate": {
+ "description": "Start date and time of the key.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "format": "date-time"
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
+ "keyExpiryDate": {
+ "description": "Expiry date and time of the key.",
"type": "string",
"format": "date-time"
},
- "orderSequence": {
- "description": "Display Order sequence.",
- "type": "number"
- },
- "phoneNumber": {
- "description": "Telephone number assigned to a single location.",
+ "keyPin": {
+ "description": "PIN provided in keyTrack3 from the Door Lock System that is used to unlock a room. This is supported when Key Pin handling is active for the property and the Door Lock System in use.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "phoneTechType": {
- "description": "Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "keyOptions": {
+ "description": "Key options of the key.",
+ "$ref": "#/definitions/codeListType"
},
- "phoneUseType": {
- "description": "Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "additionalRooms": {
+ "description": "Additional rooms included in the key creation of reservation room.",
+ "$ref": "#/definitions/codeListType"
},
- "phoneUseTypeDescription": {
- "description": "Description of the PhoneUseType code",
+ "roomId": {
+ "description": "Room Number.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "primaryInd": {
- "description": "When true, indicates a primary information.",
- "type": "boolean"
+ "reservationId": {
+ "description": "Reservation ID of the reservation of the room key .",
+ "$ref": "#/definitions/reservationId"
},
- "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
+ "keyTrack": {
+ "description": "KeyTrack Data.",
+ "$ref": "#/definitions/keyTrackType"
+ },
+ "guestInfo": {
+ "description": "Guest information on the key. This information is available when multiple_guest_key is active.",
+ "$ref": "#/definitions/roomKeyGuest"
}
}
},
- "thresholdDetailsType": {
- "description": "Type for the threshold elements.",
+ "keyTrackType": {
"type": "object",
"properties": {
- "complimentary": {
- "description": "The number of quantities, counts or minutes for which transaction diversion is allowed .",
- "type": "integer"
- },
- "entity": {
- "description": "Diversion entity type associated with the charge for the transaction diversion rule .",
- "$ref": "#/definitions/entityType"
+ "keyTrack1": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
- "isEditable": {
- "description": "Configuring this flag to be TRUE will make the thresholds editable.",
- "type": "boolean"
+ "keyTrack2": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
- "minRequired": {
- "description": "Minimum required number of quantities, counts or minutes that must be posted.",
- "type": "integer"
+ "keyTrack3": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
},
- "scope": {
- "description": "Diversion scope for the transaction diversion rule.",
- "$ref": "#/definitions/scopeType"
+ "keyTrack4": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
}
}
},
- "ticketType": {
- "description": "Reservation Ticket Type Information.",
+ "roomKey": {
"type": "object",
+ "description": "Request for generation of room key.",
"properties": {
- "consumptionDate": {
- "description": "Tickets comsumption date.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "reservationIdList": {
+ "description": "Collection of unique reservation identifiers for the reservation we are trying to make a room key for.",
+ "$ref": "#/definitions/uniqueIDListType"
},
- "description": {
- "description": "Package description.",
+ "roomNumber": {
+ "description": "A room number to generate a key for. When creating keys using just the room number, the interface may allow only one-shot keys.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "maxLength": 2000
},
- "issueDate": {
- "description": "Tickets issue date.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "keyTrack": {
+ "description": "KeyTrack Data.",
+ "$ref": "#/definitions/keyTrackType"
},
- "packageCode": {
- "description": "Package Code.",
+ "resort": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "price": {
- "description": "Tickets price.",
- "type": "number"
+ "maxLength": 2000
},
- "quantity": {
- "description": "Number of tickets used to create multiple tickets.",
+ "noOfKeys": {
"type": "integer"
},
- "rateCode": {
- "description": "The Rate Code to which tickets belong to.",
+ "keyValidityStart": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "reference": {
- "description": "Free text field for reference information.",
+ "keyValidityEnd": {
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "format": "date-time"
},
- "reservationProductId": {
- "description": "Reference to the reservation product.",
+ "encoderTerminal": {
+ "type": "string",
+ "maxLength": 2000
+ },
+ "encoderId": {
"$ref": "#/definitions/uniqueID_Type"
},
- "status": {
- "description": "The Status Code for outbound WS call.",
+ "keyType": {
+ "$ref": "#/definitions/roomKeyType"
+ },
+ "keyCardType": {
+ "$ref": "#/definitions/keyCardType"
+ },
+ "keyCardUId": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "maxLength": 2000
},
- "statusDescription": {
- "description": "The Status Description for outbound WS call.",
+ "keyOptions": {
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "maxLength": 2000
},
- "ticketId": {
- "description": "Internal Unique ID.",
- "$ref": "#/definitions/uniqueID_Type"
+ "additionalRooms": {
+ "description": "Collection of additional rooms to be included in key creation of reservation room.",
+ "$ref": "#/definitions/codeListType"
},
- "ticketNumber": {
- "description": "Ticket number.",
- "$ref": "#/definitions/uniqueID_Type"
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ },
+ "roomKeyGuests": {
+ "type": "array",
+ "description": "Collection of of Room key guests for multiple guest room key functionality.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomKeyGuest"
+ }
}
}
},
- "ticketsType": {
- "description": "Collection of TicketType objects.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/ticketType"
- }
+ "roomKeyType": {
+ "type": "string",
+ "description": "Simple type for representing room key type.",
+ "enum": [
+ "New",
+ "Duplicate",
+ "Lost",
+ "OneShot",
+ "RoomMove",
+ "ReEncode",
+ "Remove",
+ "ModifyStay"
+ ]
},
- "tierAdministrationType": {
- "description": "Do not upgrade membership. The membership may be downgraded.",
+ "keyCardType": {
"type": "string",
+ "description": "Key card types.",
"enum": [
- "Disabled",
- "NoUpgrade"
+ "Mifare1K",
+ "Mifare4K",
+ "MifareUltralight"
]
},
- "timeSpanType": {
- "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.",
+ "roomKeyDetails": {
"type": "object",
+ "description": "Response for room key creation.",
"properties": {
- "duration": {
- "type": "string"
- },
- "endDate": {
+ "keyCardData": {
"type": "string",
- "format": "date",
- "maxLength": 8
+ "maxLength": 2000
},
- "startDate": {
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "keyTrack": {
+ "description": "KeyTrack Data.",
+ "$ref": "#/definitions/keyTrackType"
+ },
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "timeWindowType": {
- "description": "Defines a Time period with start time and an end time.",
+ "roomMoveHistory": {
"type": "object",
+ "description": "Response for the fetch room move history of a reservation.",
"properties": {
- "endTime": {
- "description": "End Time of the Time window.",
- "type": "string"
+ "roomMoveHistoryDetails": {
+ "description": "List of room move history.",
+ "$ref": "#/definitions/roomMoveDetailsType"
},
- "startTime": {
- "description": "Start Time of the Time window.",
- "type": "string"
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "totalType": {
- "description": "The total amount charged for the service including additional amounts and fees.",
+ "roomMoveDetailsType": {
+ "type": "array",
+ "description": "List of room move details",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomMoveDetailType"
+ }
+ },
+ "roomMoveDetailType": {
"type": "object",
+ "description": "Room move history information.",
"properties": {
- "amountAfterTax": {
- "description": "The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).",
- "type": "number"
- },
- "amountBeforeTax": {
- "description": "The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).",
- "type": "number"
- },
- "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"
- },
- "code": {
- "description": "Type of charge.",
+ "hotelId": {
+ "description": "Identifies the hotel code under which room is moved.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "currencyCode": {
- "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "reservationId": {
+ "description": "Unique identifier of the reservation.",
+ "$ref": "#/definitions/reservationId"
},
- "currencySymbol": {
- "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.",
+ "date": {
+ "description": "Business date on which room is moved.",
"type": "string",
- "maxLength": 10,
- "minLength": 0
+ "format": "date-time"
},
- "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"
+ "reasonCode": {
+ "description": "Identifies the room move reason code.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
"description": {
+ "description": "Description of why room is moved.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "fees": {
- "description": "A collection of fees or service charges.",
- "$ref": "#/definitions/feesType"
+ "minLength": 0,
+ "maxLength": 2000
},
- "rateOverride": {
- "description": "When true indicates that the rate amount has been overridden.",
- "type": "boolean"
+ "fromRoom": {
+ "description": "Room from which guest is moved.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "taxes": {
- "description": "A collection of taxes.",
- "$ref": "#/definitions/taxesType"
- }
- }
- },
- "traceResolveType": {
- "type": "object",
- "properties": {
- "resolvedBy": {
- "description": "User that resolved the trace",
- "type": "string"
+ "toRoom": {
+ "description": "Room to which guest is moved.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "resolvedOn": {
- "description": "Date the trace was resolved",
+ "movedBy": {
+ "description": "The user who moved the guest.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 100
}
}
},
- "traceTimeInfoType": {
+ "unAssignRoomCriteria": {
"type": "object",
+ "description": "Request to the remove a room(unassign) from a reserved reservation.",
"properties": {
- "dateTimeSpan": {
- "description": "Time span for the trace.",
- "$ref": "#/definitions/dateTimeSpanType"
+ "overrideRoomNumberLocked": {
+ "description": "Criteria for removing the room from a reservation.",
+ "type": "boolean"
},
- "enteredBy": {
- "description": "User that entered this trace.",
- "type": "string"
+ "overrideRoomOwnership": {
+ "description": "Override the room ownership indicator in the reservation when removing rooms. This is applicable when Room Rotation OPERA Control is active.",
+ "type": "boolean"
},
- "traceOn": {
- "description": "Date of the trace.",
- "type": "string",
- "format": "date-time"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "traceTime": {
- "description": "Time of the trace",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "trackItActionType": {
- "description": "Identifies the response expected from staff or other parties relative to a Track It ticket.",
+ "unAssignedRoom": {
"type": "object",
+ "description": "Response Body.",
"properties": {
- "status": {
- "$ref": "#/definitions/actionStatusType"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "trackItAction": {
- "$ref": "#/definitions/codeDescriptionType"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "trackItGroup": {
- "description": "Group to which the Track It items belong.",
- "type": "string",
- "enum": [
- "Parcel",
- "Valet",
- "Baggage",
- "Lost"
- ]
- },
- "trackItId": {
- "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).",
+ "moveInHouseGuest": {
"type": "object",
+ "description": "To move a reservation, the reservation needs to be in Checked-In state.",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "idContext": {
- "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "idExtension": {
- "description": "Additional identifying value assigned by the creating system.",
- "type": "integer"
- },
- "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",
- "maxLength": 80,
- "minLength": 0
+ "criteria": {
+ "description": "Defines search criteria needed to configure a room to a reservation.",
+ "type": "object",
+ "properties": {
+ "hotelId": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "reservationIdList": {
+ "$ref": "#/definitions/reservationIdList"
+ },
+ "roomId": {
+ "description": "Room identifier which the reservation will hold.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "overrideInstructions": {
+ "description": "If this element is present, override flags will be set when configuring the room to the reservation.",
+ "$ref": "#/definitions/reservationRoomSelectionOverrideType"
+ },
+ "includedSharers": {
+ "description": "Valid share reservation identifier.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/reservationIdList"
+ }
+ },
+ "updateRoomTypeCharged": {
+ "description": "Update the Room Type used for the Rate calculation.",
+ "type": "boolean"
+ },
+ "includeDepartureRooms": {
+ "description": "Indicates if departure rooms are to be included for room assignment.",
+ "type": "boolean"
+ },
+ "roomNumberLocked": {
+ "description": "Update the do not move flag used to locking the reservation room number.",
+ "type": "boolean"
+ },
+ "oldRoomStatus": {
+ "description": "On a successful RoomMove, this status will be configured in the reservation's previous room.",
+ "$ref": "#/definitions/housekeepingRoomStatusType"
+ },
+ "reasonCode": {
+ "description": "Identifies the room move reason code.",
+ "$ref": "#/definitions/codeType"
+ },
+ "description": {
+ "description": "Description of why room is moved.",
+ "$ref": "#/definitions/stringLength2000"
+ },
+ "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"
+ }
+ }
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
- "url": {
- "description": "URL that identifies the location associated with the record identified by the UniqueID.",
- "type": "string"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "trackItItemType": {
- "description": "Detailed information of a Track It item.",
+ "stringLength2000": {
+ "type": "string",
+ "description": "Used for Character Strings, length 0 to 2000.",
+ "maxLength": 2000,
+ "minLength": 0
+ },
+ "movedInHouseGuest": {
"type": "object",
+ "description": "Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is NOT valid for usage based on its current state. - The room's occupancy level has been compromised. - The room's pricing is NOT available.",
"properties": {
- "action": {
- "$ref": "#/definitions/trackItActionType"
- },
- "assignedTo": {
- "$ref": "#/definitions/applicationUserType"
- },
- "description": {
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "followUpDate": {
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "group": {
- "$ref": "#/definitions/trackItGroup"
- },
- "hotelId": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "location": {
- "$ref": "#/definitions/codeDescriptionType"
- },
- "quantity": {
- "type": "integer"
- },
- "referenceNumber": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "reservationInfo": {
- "$ref": "#/definitions/trackItReservationInfoType"
+ "oldRates": {
+ "description": "Collection of old room rate information on a daily basis.",
+ "$ref": "#/definitions/dailyRatesType"
},
- "ticketNumber": {
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "newRates": {
+ "description": "Collection of new room rate information on a daily basis.",
+ "$ref": "#/definitions/dailyRatesType"
},
- "trackItId": {
- "$ref": "#/definitions/trackItId"
+ "effectiveRates": {
+ "description": "Collection of effective rates per stay dates per guest to be applied on reservation including its shares.",
+ "$ref": "#/definitions/effectiveRatesType"
},
- "trackItLogList": {
- "$ref": "#/definitions/trackItLogListType"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "type": {
- "$ref": "#/definitions/trackItType"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "trackItItemsType": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/trackItItemType"
- }
- },
- "trackItLogListType": {
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/trackItLogType"
- }
- },
- "trackItLogType": {
- "description": "Individual activity log related to the Track It ticket.",
+ "suggestedRooms": {
"type": "object",
+ "description": "Response of fetch suggested rooms operation.",
"properties": {
- "businessDate": {
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "description": {
- "type": "string",
- "maxLength": 200,
- "minLength": 0
- },
- "hotelId": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "logDate": {
- "type": "string",
- "format": "date-time"
- },
- "logUserId": {
- "type": "integer"
- },
- "logUserName": {
- "type": "string"
- },
- "trackItId": {
- "$ref": "#/definitions/trackItId"
+ "suggestedRoomsType": {
+ "description": "List of suggested rooms for room assignment.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/suggestedRoomType"
+ }
},
- "trackItLogId": {
- "$ref": "#/definitions/uniqueID_Type"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "type": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "trackItReservationInfoType": {
- "description": "Reservation info associated with a Track It item.",
+ "suggestedRoomType": {
"type": "object",
+ "description": "List of suggested rooms and component rooms.",
"properties": {
- "computedReservationStatus": {
- "$ref": "#/definitions/pMS_ResStatusType"
- },
- "guarantee": {
- "$ref": "#/definitions/resGuaranteeType"
- },
- "guestInfo": {
- "$ref": "#/definitions/resGuestInfoType"
- },
- "reservationIdList": {
- "$ref": "#/definitions/reservationIdList"
- },
- "reservationStatus": {
- "$ref": "#/definitions/pMS_ResStatusType"
+ "componentRoomNumber": {
+ "description": "List of component Room number belongs to a room.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
},
"roomId": {
+ "description": "Code of the room.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomStatus": {
- "$ref": "#/definitions/housekeepingRoomStatusType"
- },
- "roomType": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "timeSpan": {
- "$ref": "#/definitions/timeSpanType"
+ "minLength": 0,
+ "maxLength": 20
}
}
},
- "trackItType": {
- "description": "Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.",
+ "deliverQueueRoomsTextMessage": {
"type": "object",
+ "description": "Request to deliver a text message via Queue Reservations (for a guest) or Queue Rush (for housekeeping).",
"properties": {
- "type": {
- "$ref": "#/definitions/codeDescriptionType"
+ "criteria": {
+ "$ref": "#/definitions/queueRoomsTextCriteriaType"
},
- "url": {
- "$ref": "#/definitions/uRLType"
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "transactionDiversionDailyDetailType": {
- "description": "List of daily details for Transaction Diversion rule.",
+ "queueRoomsTextCriteriaType": {
"type": "object",
+ "description": "Text message criteria type, used to deliver a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).",
"properties": {
- "date": {
- "description": "Daily details Date about when the rules are posted or diverted.",
+ "hotelId": {
+ "description": "Resort context of the text message.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "diverted": {
- "description": "Transaction diversion rules that are diverted .",
- "type": "integer"
+ "reservationId": {
+ "description": "Reservation ID, necessary if the text message will be delivered based on a queued reservation.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "posted": {
- "description": "Transaction diversion rules that are posted.",
- "type": "integer"
+ "mobileNumber": {
+ "description": "Mobile number that the text message will be delivered to.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 40
+ },
+ "messageType": {
+ "description": "Type of text message to be delivered.",
+ "$ref": "#/definitions/queueRoomsTextMessageType"
}
}
},
- "transactionDiversionDailyDetailsType": {
- "description": "List of daily details for Transaction Diversion rule.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/transactionDiversionDailyDetailType"
- }
- },
- "transactionDiversionRuleLevelType": {
- "description": "Reservation level.",
- "type": "string",
- "enum": [
- "Property",
- "Reservation"
- ]
- },
- "transactionDiversionRuleTypeType": {
- "description": "The rule type on which the Transaction Diversion Rule is based. If a reservation has any of the following code, Transaction Diversion rule gets active for that reservation",
+ "queueRoomsTextMessageType": {
"type": "string",
+ "description": "Text message will be delivered via Queue Rush, to housekeeping.",
"enum": [
- "Vip",
- "Membership"
+ "QueueReservation",
+ "QueueRush"
]
},
- "translationTextType2000": {
- "description": "Contains Multiple translated texts and language codes.",
+ "QueueRoomsTextMessage": {
"type": "object",
+ "description": "Response for delivering a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).",
"properties": {
- "defaultText": {
- "description": "Default text with Character length from 0 to 2000.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "guestTextInfo": {
+ "description": "Information regarding the message sent to guest.",
+ "$ref": "#/definitions/queueTextInfoType"
},
- "translatedTexts": {
- "description": "List of translated text and language codes.",
- "$ref": "#/definitions/translationsTextType"
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "translationsTextType": {
- "description": "Language code for the translation.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "description": "Language code for the translation.",
- "type": "object",
- "properties": {
- "language": {
- "description": "Language identification.",
- "type": "string",
- "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
- },
- "value": {
- "description": "Used for Character Strings, length 0 to 2000.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "verifiedCheckinReservation": {
+ "type": "object",
+ "properties": {
+ "reservation": {
+ "type": "array",
+ "description": "Reservation record showing the current state of the reservation.",
+ "items": {
+ "$ref": "#/definitions/hotelReservationType"
}
+ },
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "transportInfoType": {
+ "wakeUpCalls": {
"type": "object",
+ "description": "Fetch wake up calls response.",
"properties": {
- "carrierCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "comments": {
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "dateTime": {
- "type": "string",
- "format": "date-time"
- },
- "stationCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "transportCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "calls": {
+ "description": "List of the wake up calls.",
+ "$ref": "#/definitions/wakeUpCallsType"
},
- "transportationReqd": {
- "type": "boolean"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "type": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "trxCodesInfoType": {
- "description": "List of Transaction codes info.",
+ "wakeUpCallsType": {
"type": "array",
+ "description": "List of the wake up calls",
"maxItems": 4000,
"items": {
- "$ref": "#/definitions/trxInfoType"
+ "$ref": "#/definitions/wakeUpCallType"
}
},
- "trxInfoType": {
- "description": "Transaction codes info.",
+ "wakeUpCallType": {
"type": "object",
+ "description": "Criteria to search and retrieve wake up calls.",
"properties": {
- "articles": {
- "description": "The List of Articles defined for this transaction code, when using the Articles functionality.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/articleInfoType"
- }
+ "reservationInfo": {
+ "description": "Hotel room in which wake up call is to ring.",
+ "$ref": "#/definitions/wakeUpCallResvInfoType"
},
- "description": {
- "description": "Transaction codes info.",
+ "callTime": {
+ "description": "Time on which wake up call is set.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "format": "date-time"
},
- "hotelId": {
- "description": "Hotel context of the Transaction code.",
+ "followUpCallTime": {
+ "description": "Follow up call time.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "printTrxReceipt": {
- "description": "Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code.",
+ "isFollowUpCall": {
+ "description": "Is the call type follow up.",
"type": "boolean"
},
- "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"
+ "status": {
+ "description": "Time on which wake up call is set.",
+ "$ref": "#/definitions/wakeUpCallStatusType"
},
- "transactionCode": {
- "description": "Unique identifier for the Transaction code.",
+ "processedDate": {
+ "description": "Date on which wake up call was processed.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date",
+ "maxLength": 8
},
- "transactionGroup": {
- "description": "Category of the transaction code.",
+ "processedTime": {
+ "description": "Time on which wake up call was processed.",
+ "type": "string"
+ },
+ "instructions": {
+ "description": "Special instructions for the wake up call.",
+ "type": "string"
+ },
+ "timeSpan": {
+ "description": "Date Range to set the Wakeup calls. Only used to create a wake up call.",
+ "$ref": "#/definitions/timeSpanType"
+ },
+ "newCallTime": {
+ "description": "New Time on which wake up call is set. Used to change the Followup Call time",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "transactionSubGroup": {
- "description": "Sub category of the transaction code.",
+ "newFollowUpCallTime": {
+ "description": "New Follow up call time.Used to change the Followup Call time.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time"
},
- "trxServiceType": {
- "description": "Contains service type for transaction code.",
+ "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",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 200
},
- "universalProductCode": {
- "description": "Unique Universal product code of the transaction code.",
+ "lastModifyDateTime": {
+ "description": "Time stamp of last modification.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- }
- }
- },
- "turndownInfoType": {
- "type": "object",
- "properties": {
- "turndownStatusInfo": {
- "$ref": "#/definitions/turndownStatusType"
+ "format": "date-time"
+ },
+ "lastModifierId": {
+ "description": "Identifies the last software system or person to modify a record.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ },
+ "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
}
}
},
- "turndownStatusType": {
- "description": "Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed.",
- "type": "string",
- "enum": [
- "Required",
- "NotRequired",
- "Compeleted"
- ]
- },
- "typeOfMessageType": {
- "description": "The type of Message for Guest Messages.",
- "type": "string",
- "enum": [
- "Tm",
- "Vm"
- ]
- },
- "uRLInfoType": {
- "description": "Web site address.",
+ "wakeUpCallResvInfoType": {
"type": "object",
+ "description": "Criteria to search and retrieve wake up calls.",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
+ "reservationIdList": {
+ "description": "Collection of reservation identifiers like Reservation Name ID, Confirmation Number, etc.",
+ "$ref": "#/definitions/reservationIdList"
+ },
+ "hotelId": {
+ "description": "Hotel Code where wake up call is set.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "timezone": {
+ "description": "Timezone of hotel.",
+ "type": "string"
+ },
+ "guestName": {
+ "description": "Guest Name.",
+ "type": "string"
+ },
+ "profileId": {
+ "description": "ID of the Guest profile.",
+ "$ref": "#/definitions/profileId"
+ },
+ "vip": {
+ "description": "Guest Name.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "url": {
- "description": "Provides URL information.",
- "$ref": "#/definitions/uRLType"
- }
- }
- },
- "uRLType": {
- "description": "Web site address, in IETF(The Internet Engineering Task Force) specified format.",
- "type": "object",
- "properties": {
- "orderSequence": {
- "description": "Display Order sequence.",
- "type": "number"
+ "membershipLevel": {
+ "description": "Membership Level of the guest.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
},
- "primaryInd": {
- "description": "When true, indicates a primary information.",
- "type": "boolean"
+ "membershipType": {
+ "description": "Membership Type of the guest.",
+ "$ref": "#/definitions/codeDescriptionType"
},
- "type": {
- "description": "Defines the purpose of the URL address, such as personal, business, public, etc.",
+ "arrival": {
+ "description": "Reservation arrival date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "departure": {
+ "description": "Reservation departure date.",
+ "type": "string",
+ "format": "date",
+ "maxLength": 8
+ },
+ "room": {
+ "description": "Hotel room in which wake up call is to ring.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "roomPhoneNumber": {
+ "description": "Room phone number which wake up call is to ring.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "extensionNumber": {
+ "description": "Room Phone Extension Number.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
+ },
+ "blockId": {
+ "description": "Block id with which wake up call is associated.",
+ "$ref": "#/definitions/blockId"
},
- "typeDescription": {
- "description": "Describes the Type code",
+ "blockCode": {
+ "description": "Block code with which wake up call is associated.",
"type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 20
},
- "value": {
- "description": "Property Value",
- "type": "string"
+ "reservationStatus": {
+ "description": "Indicates the Actual status of the reservation.",
+ "$ref": "#/definitions/pMS_ResStatusType"
}
}
},
- "unAssignRoomCriteria": {
- "description": "Request to the remove a room(unassign) from a reserved reservation.",
+ "wakeUpCallStatusType": {
+ "type": "string",
+ "description": "Statuses of the wake up call.",
+ "enum": [
+ "Completed",
+ "NoAnswer",
+ "Cancelled",
+ "Pending"
+ ]
+ },
+ "changedWakeUpCalls": {
"type": "object",
+ "description": "Response Body.",
"properties": {
"links": {
"$ref": "#/definitions/links"
},
- "overrideRoomNumberLocked": {
- "description": "Criteria for removing the room from a reservation.",
- "type": "boolean"
- },
- "overrideRoomOwnership": {
- "description": "Override the room ownership indicator in the reservation when removing rooms. This is applicable when Room Rotation OPERA Control is active.",
- "type": "boolean"
- },
"warnings": {
"$ref": "#/definitions/warningsType"
}
}
},
- "unAssignedRoom": {
- "description": "Existing Operations Responses will eventually be modified to be extended from this type.",
+ "roomKeyStatus": {
"type": "object",
+ "description": "Respose for the reading of room key.",
"properties": {
+ "room": {
+ "type": "string",
+ "maxLength": 2000
+ },
+ "guestLastName": {
+ "type": "string",
+ "maxLength": 2000
+ },
+ "guestFirstName": {
+ "type": "string",
+ "maxLength": 2000
+ },
+ "validUntil": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "keyOptions": {
+ "type": "string",
+ "maxLength": 2000
+ },
+ "guestDepartureDate": {
+ "$ref": "#/definitions/dateRangeType"
+ },
+ "guestDepartureTime": {
+ "$ref": "#/definitions/dateTimeRangeType"
+ },
"links": {
"$ref": "#/definitions/links"
},
@@ -38805,583 +37688,421 @@
}
}
},
- "unassignedRoomsSummaryType": {
- "description": "Indicates summary of the unassigned rooms.",
- "type": "object",
- "properties": {
- "count": {
- "description": "Number of reservations with unassigned rooms.",
- "type": "string",
- "maxLength": 4,
- "minLength": 4
- }
- }
- },
- "uniqueIDListType": {
- "description": "Unique Id that references an object uniquely in the system.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/uniqueID_Type"
- }
- },
- "uniqueID_Type": {
- "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).",
+ "dateTimeRangeType": {
"type": "object",
+ "description": "Date Range with Start and End dates.",
"properties": {
- "id": {
- "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.",
+ "start": {
+ "description": "The starting value of the time span.",
"type": "string",
- "maxLength": 80,
- "minLength": 0
+ "format": "date-time"
},
- "type": {
- "description": "A reference to the type of object defined by the UniqueID element.",
+ "end": {
+ "description": "The ending value of the time span.",
"type": "string",
- "maxLength": 40,
- "minLength": 0
+ "format": "date-time"
}
}
},
- "updateRoomKeys": {
- "description": "Collection of error and warning if any.",
+ "hotelRooms": {
"type": "object",
"properties": {
- "errors": {
- "description": "Details of the errors.",
- "$ref": "#/definitions/errorsType"
+ "hotelRoomsDetails": {
+ "description": "Hotel rooms response based on criteria request.",
+ "$ref": "#/definitions/hotelRoomsType"
},
- "warnings": {
- "description": "Details of the warnings.",
- "$ref": "#/definitions/warningsType"
- }
- }
- },
- "upsellInfoType": {
- "description": "Information regarding upsell for a reservation.",
- "type": "object",
- "properties": {
- "originalInfo": {
- "description": "Original Values of the reservation prior to upgrade.",
- "type": "object",
- "properties": {
- "nights": {
- "description": "The number of nights of the reservation before being upgraded.",
- "type": "integer"
- },
- "rateCode": {
- "description": "The Rate Code of the Reservation before it was upgraded",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "roomType": {
- "description": "Original Reservation Room Type before being upgraded.",
- "$ref": "#/definitions/codeDescriptionType"
- },
- "totalAmount": {
- "description": "Total Amount of the reservation before it was upgraded.",
- "$ref": "#/definitions/currencyAmountType"
- }
- }
+ "totalPages": {
+ "description": "Evaluated total page count based on the requested max fetch count.",
+ "type": "integer"
},
- "upsellInfo": {
- "description": "Information of a reservation during the process of upgrade.",
- "type": "object",
- "properties": {
- "firstNightUpsellAmount": {
- "description": "First Night Total Amount including Upsell.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "firstNightUpsellCharge": {
- "description": "First Night Upsell Charges.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "percentageSavings": {
- "description": "Percentage savings resulting from accepting upsell offer. This will be calculated as the ratio of the amount saved by accepting the upsell offer to the actual room rate (i.e. room rate when upsell is not offered)",
- "type": "number",
- "maximum": 100,
- "minimum": 0
- },
- "roomLongDescription": {
- "description": "Detail description of the Room Type.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "roomType": {
- "description": "Reservation Room Type for Upsell.",
- "$ref": "#/definitions/codeDescriptionType"
- },
- "ruleCode": {
- "description": "Upsell rule code",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "ruleDescription": {
- "description": "Upsell rule description",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "ruleId": {
- "description": "Upsell Rule Id.",
- "type": "integer"
- },
- "totalActualRateAmount": {
- "description": "Actual Total Room Rate for the Target Upsell Room Type.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "totalUpsellCharge": {
- "description": "Amount that was charged for the upsell.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "totalUpsellMoneyAmount": {
- "description": "Total Amount that was charged including upsell.",
- "$ref": "#/definitions/currencyAmountType"
- },
- "totalUpsellPoints": {
- "description": "Total Upsell Points.",
- "type": "integer"
- },
- "upsellDate": {
- "description": "The date on which reservation is upgraded.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "upsellUser": {
- "description": "User who upgraded the reservation.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
- }
- }
- }
- }
- },
- "userDefinedFieldsType": {
- "description": "A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.",
- "type": "object",
- "properties": {
- "characterUDFs": {
- "description": "Collection of user defined fields of Character/String Type.",
- "$ref": "#/definitions/characterUDFsType"
+ "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"
},
- "dateUDFs": {
- "description": "Collection of user defined fields of Date Type.",
- "$ref": "#/definitions/dateUDFsType"
+ "limit": {
+ "description": "Indicates maximum number of records a Web Service should return.",
+ "type": "integer"
},
- "numericUDFs": {
- "description": "Collection of user defined fields of Numeric Type.",
- "$ref": "#/definitions/numericUDFsType"
- }
- }
- },
- "userInfoType": {
- "description": "Opera User Information",
- "type": "object",
- "properties": {
- "userId": {
- "description": "User Id of the Opera User",
+ "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"
},
- "userName": {
- "description": "Name of the Opera User",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "count": {
+ "description": "Total number of rows returned",
+ "type": "integer"
+ },
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "userSessionDefaultsType": {
+ "holdRooms": {
"type": "object",
+ "description": "Request to place rooms on hold.",
"properties": {
- "baseLanguage": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "currencyCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "currencyFormat": {
- "type": "string"
- },
- "dbDateFormat": {
- "type": "string"
- },
- "defaultLanguage": {
- "type": "string"
- },
- "javaDateFormat": {
- "type": "string"
+ "holdRoomsDetails": {
+ "description": "List of rooms, hold reason, and comments.",
+ "$ref": "#/definitions/roomsHoldsType"
},
- "javaTimeFormat": {
- "type": "string"
+ "overrideRoomHold": {
+ "description": "If trying to hold a room, which is held by a different user, then this flag will allow the current request to override that hold.",
+ "type": "boolean"
},
- "oracleDateFormat": {
- "type": "string"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "oracleTimeFormat": {
- "type": "string"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "userSessionInfoType": {
+ "roomsHoldsType": {
+ "type": "array",
+ "description": "List of rooms, reason, and comments.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomsHoldType"
+ }
+ },
+ "roomsHoldType": {
"type": "object",
+ "description": "Hold reason and the list of the rooms that are to be put on hold under that reason.",
"properties": {
- "businessDate": {
+ "hotelId": {
+ "description": "Resort where room hold is to take place.",
"type": "string",
- "format": "date",
- "maxLength": 8
+ "minLength": 0,
+ "maxLength": 20
},
- "cROCountryCode": {
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "rooms": {
+ "description": "Collection of room numbers that are to be placed on hold.",
+ "type": "array",
+ "maxItems": 4000,
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 20
+ }
},
- "chain": {
+ "reason": {
+ "description": "List of rooms that are to be put on hold.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "cro": {
- "$ref": "#/definitions/codeDescriptionType"
- },
- "hotel": {
- "$ref": "#/definitions/codeDescriptionType"
- },
- "parameters": {
- "$ref": "#/definitions/parametersType"
- },
- "runningApp": {
- "type": "string"
- },
- "sessionDefaults": {
- "$ref": "#/definitions/userSessionDefaultsType"
- },
- "shareProfiles": {
- "type": "boolean"
+ "minLength": 0,
+ "maxLength": 20
},
- "systemDate": {
+ "comments": {
+ "description": "Comments to the rooms being put on hold.",
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "terminal": {
- "type": "string"
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "vIPStatusType": {
- "description": "VIP status of the customer.",
+ "serviceRequestsInfo": {
"type": "object",
+ "description": "Response object for service requests.",
"properties": {
- "code": {
- "description": "VIP status of the customer.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "serviceRequestsDetails": {
+ "description": "List of service requests.",
+ "$ref": "#/definitions/serviceRequests"
},
- "value": {
- "description": "Used for Character Strings, length 0 to 2000.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "vIPType": {
- "description": "The supplier's ranking of the customer.",
+ "queuedRoomsTextMessage": {
"type": "object",
+ "description": "Response for retrieving a predefined text message, for Queue Reservations or Queue Rush.",
"properties": {
- "vipCode": {
- "description": "VIP Code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "messageText": {
+ "description": "Predefined message text, based on the message type defined in the request.",
+ "$ref": "#/definitions/stringLength200"
},
- "vipDescription": {
- "description": "VIP Description.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "verifiedCheckinReservation": {
+ "reservationQueuePriorityNumber": {
"type": "object",
+ "description": "Request to change the current priority of a reservation in Queue for Check-In.",
"properties": {
+ "priority": {
+ "description": "Priority which should be assigned to the reservation in Queue. If null, the topmost priority(1) will be assigned. All other reservations in the queue will be adjusted accordingly.",
+ "type": "integer"
+ },
"links": {
"$ref": "#/definitions/links"
},
- "reservation": {
- "description": "Reservation record showing the current state of the reservation.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/hotelReservationType"
- }
- },
"warnings": {
"$ref": "#/definitions/warningsType"
}
}
},
- "visaInfoType": {
+ "shiftRooms": {
"type": "object",
+ "description": "To quickly shift rooms for two reservations that are for the same arrival date and room type",
"properties": {
- "visaExpiryDate": {
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "sourceRoom": {
+ "description": "Source Room request which defines parameters needed to shift rooms.",
+ "$ref": "#/definitions/stayRoominfo"
},
- "visaIssueDate": {
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "targetRoom": {
+ "description": "Target Room request which defines parameters needed to shift rooms.",
+ "$ref": "#/definitions/stayRoominfo"
},
- "visaNumber": {
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "waitlistResType": {
- "description": "Information regarding why reservation is being /has been waitlisted.",
+ "swapRooms": {
"type": "object",
+ "description": "To quickly swap or shift rooms for two reservations that are for the same arrival date and room type",
"properties": {
- "description": {
- "description": "Description why the reservation is being /has been waitlisted.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
- },
- "priorityCode": {
- "description": "Waitlist Priority Code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "priorityDescription": {
- "description": "Waitlist priority Description.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "sourceRoom": {
+ "description": "Source Room request which defines parameters needed to swap rooms.",
+ "$ref": "#/definitions/stayRoominfo"
},
- "reasonCode": {
- "description": "Waitlist Reason Code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "targetRoom": {
+ "description": "Target Room request which defines parameters needed to swap rooms.",
+ "$ref": "#/definitions/stayRoominfo"
},
- "reasonDescription": {
- "description": "Waitlist Reason Description.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "links": {
+ "$ref": "#/definitions/links"
},
- "telephone": {
- "description": "Guest telephone number.",
- "type": "string",
- "maxLength": 40,
- "minLength": 0
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
}
}
},
- "wakeUpCallResvInfoType": {
- "description": "Criteria to search and retrieve wake up calls.",
+ "stayRoominfo": {
"type": "object",
+ "description": "Request which contains parameters needed to swap or shift rooms",
"properties": {
- "arrival": {
- "description": "Reservation arrival date.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "blockCode": {
- "description": "Block code with which wake up call is associated.",
+ "roomId": {
+ "description": "Room identifier which the reservation will hold.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "blockId": {
- "description": "Block id with which wake up call is associated.",
- "$ref": "#/definitions/blockId"
+ "minLength": 0,
+ "maxLength": 20
},
- "departure": {
- "description": "Reservation departure date.",
+ "arrivalDate": {
+ "description": "Identifies Reservation arrival date.",
"type": "string",
"format": "date",
"maxLength": 8
},
- "extensionNumber": {
- "description": "Room Phone Extension Number.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "guestName": {
- "description": "Guest Name.",
- "type": "string"
- },
- "hotelId": {
- "description": "Hotel Code where wake up call is set.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "membershipLevel": {
- "description": "Membership Level of the guest.",
+ "roomType": {
+ "description": "Identifies the reservations which are same room type/room category",
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "membershipType": {
- "description": "Membership Type of the guest.",
- "$ref": "#/definitions/codeDescriptionType"
- },
- "profileId": {
- "description": "ID of the Guest profile.",
- "$ref": "#/definitions/profileId"
+ "minLength": 0,
+ "maxLength": 20
+ }
+ }
+ },
+ "roomStatusStatisticsListType": {
+ "type": "object",
+ "properties": {
+ "roomStatusStatistics": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/roomStatusStatisticsType"
+ }
},
- "reservationIdList": {
- "description": "Collection of reservation identifiers like Reservation Name ID, Confirmation Number, etc.",
- "$ref": "#/definitions/reservationIdList"
+ "links": {
+ "$ref": "#/definitions/links"
},
- "reservationStatus": {
- "description": "Indicates the Actual status of the reservation.",
- "$ref": "#/definitions/pMS_ResStatusType"
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "roomStatusStatisticsType": {
+ "type": "object",
+ "properties": {
+ "roomClass": {
+ "type": "string"
},
- "room": {
- "description": "Hotel room in which wake up call is to ring.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "roomType": {
+ "type": "string"
},
- "roomPhoneNumber": {
- "description": "Room phone number which wake up call is to ring.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
+ "frontOfficeStatus": {
+ "type": "string"
},
- "timezone": {
- "description": "Timezone of hotel.",
+ "roomStats": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/roomStatusStatisticsCountType"
+ }
+ }
+ }
+ },
+ "roomStatusStatisticsCountType": {
+ "type": "object",
+ "properties": {
+ "housekeepingRoomStatus": {
"type": "string"
},
- "vip": {
- "description": "Guest Name.",
+ "housekeepingRoomStatusCount": {
+ "type": "integer"
+ }
+ }
+ },
+ "reservationDisplayColorInfoType": {
+ "description": "Information of reservation display color, determined based on OPERA parameter RESERVATION_COLOR_DEFINITION ",
+ "type": "object",
+ "properties": {
+ "displayColor": {
+ "description": "Display Color of Reservation.",
+ "$ref": "#/definitions/colorType"
+ },
+ "colorDefinition": {
+ "description": "Definition populated based on OPERA setting RESERVATION_COLOR_DEFINITION.",
+ "$ref": "#/definitions/colorDefinitionType"
+ },
+ "colorDescription": {
+ "description": "Description populated based on DisplayColor.",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "wakeUpCallStatusType": {
- "description": "Statuses of the wake up call.",
+ "colorDefinitionType": {
"type": "string",
+ "description": "Color definition type. This color definition type is used to determine the defintion of color ",
"enum": [
- "Completed",
- "NoAnswer",
- "Cancelled",
- "Pending"
+ "RESERVATION",
+ "MARKET_CODE",
+ "VIP_LEVEL",
+ "MEMBERSHIP_LEVEL"
]
},
- "wakeUpCallType": {
- "description": "Criteria to search and retrieve wake up calls.",
+ "roomKeyGuest": {
"type": "object",
+ "description": "Information about the guest for whom a key can be created.",
"properties": {
- "callTime": {
- "description": "Time on which wake up call is set.",
- "type": "string",
- "format": "date-time"
- },
- "createDateTime": {
- "description": "Time stamp of the creation.",
+ "firstName": {
+ "description": "First Name of the guest.",
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 80
},
- "creatorId": {
- "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.",
+ "lastName": {
+ "description": "Last Name of the guest.",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "minLength": 0,
+ "maxLength": 80
},
- "followUpCallTime": {
- "description": "Follow up call time.",
- "type": "string",
- "format": "date-time"
+ "isAdult": {
+ "description": "Flag to indicate wheter the guest is an Adult or a child.",
+ "type": "boolean"
},
- "instructions": {
- "description": "Special instructions for the wake up call.",
- "type": "string"
+ "originalBalance": {
+ "description": "Original Balance on the Key card.",
+ "type": "number"
},
- "isFollowUpCall": {
- "description": "Is the call type follow up.",
- "type": "boolean"
+ "remainingBalance": {
+ "description": "Remaining Balance on the Key card.",
+ "type": "number"
},
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
- "type": "string",
- "maxLength": 200,
- "minLength": 0
+ "keyNumber": {
+ "description": "Key Number of the card.",
+ "type": "number"
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
- "type": "string",
- "format": "date-time"
+ "guestNameId": {
+ "description": "Guest unique identifier to which the instruction will be routed.",
+ "$ref": "#/definitions/uniqueID_Type"
},
- "newCallTime": {
- "description": "New Time on which wake up call is set. Used to change the Followup Call time",
- "type": "string",
- "format": "date-time"
+ "isInactive": {
+ "description": "Flag to indicate wheter the guest is an Adult or a child.",
+ "type": "boolean"
},
- "newFollowUpCallTime": {
- "description": "New Follow up call time.Used to change the Followup Call time.",
+ "guestKeyOptions": {
"type": "string",
- "format": "date-time"
+ "minLength": 0,
+ "maxLength": 4000
+ }
+ }
+ },
+ "roomKeyMultipleGuests": {
+ "type": "object",
+ "description": "Short room key information containing information about the multiple guests and room key options .",
+ "properties": {
+ "reservationIdList": {
+ "description": "Collection of unique reservation identifiers for the reservation we are trying to make a room key for.",
+ "$ref": "#/definitions/uniqueIDListType"
},
- "processedDate": {
- "description": "Date on which wake up call was processed.",
+ "roomNumber": {
+ "description": "A room number to generate a key for. When creating keys using just the room number, the interface may allow only one-shot keys.",
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "processedTime": {
- "description": "Time on which wake up call was processed.",
- "type": "string"
+ "maxLength": 2000
},
- "purgeDate": {
- "description": "Date an item will be purged from a database (e.g., from a live database to an archive).",
+ "keyOptions": {
"type": "string",
- "format": "date",
- "maxLength": 8
- },
- "reservationInfo": {
- "description": "Hotel room in which wake up call is to ring.",
- "$ref": "#/definitions/wakeUpCallResvInfoType"
+ "maxLength": 2000
},
- "status": {
- "description": "Time on which wake up call is set.",
- "$ref": "#/definitions/wakeUpCallStatusType"
+ "roomKeyGuests": {
+ "type": "array",
+ "description": "Collection of of Room key guests for multiple guest room key functionality.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomKeyGuest"
+ }
+ }
+ }
+ },
+ "updateRoomKeys": {
+ "type": "object",
+ "description": "Collection of error and warning if any.",
+ "properties": {
+ "warnings": {
+ "description": "Details of the warnings.",
+ "$ref": "#/definitions/warningsType"
},
- "timeSpan": {
- "description": "Date Range to set the Wakeup calls. Only used to create a wake up call.",
- "$ref": "#/definitions/timeSpanType"
+ "errors": {
+ "description": "Details of the errors.",
+ "$ref": "#/definitions/errorsType"
}
}
},
- "wakeUpCalls": {
- "description": "Fetch wake up calls response.",
+ "reservationRoomOwnershipType": {
+ "type": "string",
+ "description": "Indicates if the assigned reservation room is an Owner/Referral or Regular room.",
+ "enum": [
+ "Owner",
+ "Referral",
+ "Regular"
+ ]
+ },
+ "commissionPaymentDetails": {
"type": "object",
+ "description": "Response to get the commission payment details.",
"properties": {
- "calls": {
- "description": "List of the wake up calls.",
- "$ref": "#/definitions/wakeUpCallsType"
+ "commissionPaymentInfoList": {
+ "type": "array",
+ "description": "Defines list of commission payment info.",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/commissionPaymentInfo"
+ }
},
"links": {
"$ref": "#/definitions/links"
@@ -39391,225 +38112,183 @@
}
}
},
- "wakeUpCallsType": {
- "description": "List of the wake up calls",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/wakeUpCallType"
- }
- },
- "warningType": {
- "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.",
+ "commissionPaymentInfo": {
"type": "object",
+ "description": "Information on a commission payment for a reservation.",
"properties": {
- "code": {
- "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "docURL": {
- "description": "If present, this URL refers to an online description of the error that occurred.",
+ "paymentId": {
"type": "string",
+ "description": "Payment id ",
+ "minLength": 0,
"maxLength": 2000
},
- "language": {
- "description": "Language identification.",
+ "paymentMethod": {
"type": "string",
- "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
+ "description": "Payment Method",
+ "minLength": 0,
+ "maxLength": 200
},
- "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.",
+ "commissionStatus": {
"type": "string",
- "maxLength": 2000
+ "description": "Commission status",
+ "minLength": 0,
+ "maxLength": 200
},
- "rph": {
- "description": "Reference Place Holder used as an index for this warning.",
+ "paymentDate": {
+ "description": "The payment date",
"type": "string",
- "maxLength": 8,
- "minLength": 1
+ "format": "date",
+ "maxLength": 8
},
- "shortText": {
- "description": "An abbreviated version of the error in textual format.",
+ "checkNo": {
+ "description": "Check number for the payment.",
"type": "string",
+ "minLength": 0,
"maxLength": 2000
},
- "status": {
- "description": "If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.",
- "type": "string",
- "maxLength": 2000
+ "commissionAmount": {
+ "description": "Commission amount",
+ "type": "number"
},
- "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].",
+ "batchId": {
"type": "string",
+ "description": "Batch Id for commission payment.",
+ "minLength": 0,
"maxLength": 2000
},
- "type": {
- "description": "The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".",
+ "remarks": {
"type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "value": {
- "description": "Property Value",
- "type": "string"
+ "description": "Remarks for the commission.",
+ "minLength": 0,
+ "maxLength": 2000
}
}
},
- "warningsType": {
- "description": "Used in conjunction with the Success element to define a business error.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/warningType"
- }
+ "reservationStatusEnumType": {
+ "type": "string",
+ "description": "Reservation Status Enum Type",
+ "enum": [
+ "DueIn",
+ "DueOut",
+ "CheckedIn",
+ "CheckedOut"
+ ]
},
- "webUserAccountType": {
- "description": "Web User Account of the guest.",
+ "reservationStatusStatisticsType": {
+ "description": "Reservation Statistics for a Reservation Status",
"type": "object",
"properties": {
- "autoGeneratePassword": {
- "description": "A flag which determines if the password is auto generated.",
- "type": "boolean"
- },
- "comments": {
- "description": "Comments.",
- "type": "string",
- "maxLength": 4000,
- "minLength": 0
- },
- "domainCode": {
- "description": "Domain code.",
- "type": "string",
- "maxLength": 20,
- "minLength": 0
- },
- "history": {
- "description": "Web User Account History.",
- "$ref": "#/definitions/webUserHistoryType"
- },
- "inactive": {
- "description": "Boolean flag that indicates whether the web account is inactive or not.",
- "type": "boolean"
- },
- "locked": {
- "description": "Boolean flag that indicates whether the web account is locked or not.",
- "type": "boolean"
- },
- "loginName": {
- "description": "Login Name of the guest.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "newLoginName": {
- "description": "New Login Name of the guest.",
- "type": "string",
- "maxLength": 80,
- "minLength": 0
- },
- "newPassword": {
- "description": "Login Password.",
- "type": "string",
- "maxLength": 2000,
- "minLength": 0
+ "reservationStatus": {
+ "description": "Reservation Status.",
+ "$ref": "#/definitions/reservationStatusEnumType"
},
- "securityAnswer": {
- "description": "Answer to the Security Question.",
- "type": "string",
- "maxLength": 4000,
- "minLength": 0
+ "total": {
+ "description": "Number of reservations.",
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 4000
},
- "securityQuestion": {
- "description": "Security Question and its Code associated with the account to verify the user.",
- "$ref": "#/definitions/codeDescriptionType"
+ "roomClasses": {
+ "type": "array",
+ "description": "Reservation Statistics for each Room Class",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomClassStatisticsType"
+ }
}
}
},
- "webUserAccountsType": {
- "description": "Web User Accounts List.",
- "type": "array",
- "maxItems": 4000,
- "items": {
- "$ref": "#/definitions/webUserAccountType"
+ "reservationStatusStatisticsResponseType": {
+ "type": "object",
+ "description": "Reservation Status Statistics",
+ "properties": {
+ "reservationStatusStatistics": {
+ "type": "array",
+ "maxItems": 4,
+ "description": "Statistics for each Reservation Status",
+ "items": {
+ "$ref": "#/definitions/reservationStatusStatisticsType"
+ }
+ }
}
},
- "webUserHistoryType": {
- "description": "Creation date time, Creator Id, last modification date time and last Modifier Id.",
+ "roomTypeStatisticsType": {
+ "description": "Reservation Statistics for a Room Type",
"type": "object",
"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",
- "maxLength": 200,
- "minLength": 0
- },
- "inactiveDate": {
- "description": "Inactive date.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "lastLogin": {
- "description": "Last login date.",
- "type": "string",
- "format": "date",
- "maxLength": 8
- },
- "lastModifierId": {
- "description": "Identifies the last software system or person to modify a record.",
+ "roomType": {
+ "description": "Room Type name. Available room types can be retrieved via /listOfValues/hotels/{hotelId}/roomTypes",
"type": "string",
- "maxLength": 200,
- "minLength": 0
+ "maxLength": 20
},
- "lastModifyDateTime": {
- "description": "Time stamp of last modification.",
+ "total": {
+ "description": "Number of reservations.",
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 4000
+ }
+ }
+ },
+ "roomClassStatisticsType": {
+ "description": "Reservation Statistics for a Room Class",
+ "type": "object",
+ "properties": {
+ "roomClass": {
+ "description": "Room Class name. Available room classes can be retrieved via /listOfValues/hotels/{hotelId}/roomClasses",
"type": "string",
- "format": "date-time"
+ "maxLength": 20
},
- "lastPasswordChange": {
- "description": "Last Password change date.",
- "type": "string",
- "format": "date",
- "maxLength": 8
+ "total": {
+ "description": "Number of reservations.",
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 4000
},
- "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
+ "roomTypes": {
+ "type": "array",
+ "description": "Reservation Statistics for each Room Type",
+ "maxItems": 4000,
+ "items": {
+ "$ref": "#/definitions/roomTypeStatisticsType"
+ }
}
}
},
- "welcomeOfferOptionsType": {
- "description": "None of the Welcome Offer option is selected.",
+ "hotelRoomsOrderBy": {
"type": "string",
+ "description": "This type is used to support various sortings for available rooms search results.",
"enum": [
- "BonusPoints",
- "Ecoupons",
- "Items",
- "PostIt",
- "NotSelected"
+ "ForecastRotationPoints"
]
},
- "welcomeOfferType": {
+ "airaLastRunStatusInfo": {
"type": "object",
+ "description": "Response of last execution status for AI Room Assignment",
"properties": {
- "status": {
- "description": "Determines the status of the welcome offer.",
+ "insertDate": {
+ "description": "When the AI Room Assignment starts execution",
"type": "string",
- "maxLength": 20,
- "minLength": 0
+ "format": "date-time",
+ "maxLength": 8
},
- "type": {
- "description": "Determines the welcome offer option selected while availing the welcome offer.",
- "$ref": "#/definitions/welcomeOfferOptionsType"
+ "updateDate": {
+ "description": "Date time of updated status of an executions",
+ "type": "string",
+ "format": "date-time"
+ },
+ "actionValue": {
+ "type": "string",
+ "description": "Actual run status of an AI room assignment"
+ },
+ "runId": {
+ "description": "Uniquely generated run-id for each execution of an algorithmn",
+ "type": "string"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ },
+ "links": {
+ "$ref": "#/definitions/links"
}
}
},
@@ -39832,20 +38511,80 @@
"responseCode",
"encoderTerminal"
]
+ },
+ "reservationKeyInfoType": {
+ "type": "object",
+ "description": "Holds the room key information provided by the Door Lock System.",
+ "properties": {
+ "keyPin": {
+ "description": "PIN provided in keyTrack3 from the Door Lock System that is used to unlock a room. This is supported when Key Pin handling is active for the property and the Door Lock System in use.",
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ }
+ }
+ },
+ "keyOptionsInfo": {
+ "type": "object",
+ "description": "Response of fetch keyOptions operation.",
+ "properties": {
+ "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
+ },
+ "links": {
+ "$ref": "#/definitions/links"
+ },
+ "warnings": {
+ "$ref": "#/definitions/warningsType"
+ }
+ }
+ },
+ "profileKeyOptionsType": {
+ "type": "object",
+ "properties": {
+ "profileId": {
+ "type": "string",
+ "description": "Unique profile Id attached to the reservation.",
+ "minLength": 0,
+ "maxLength": 200
+ },
+ "keyOptions": {
+ "type": "string",
+ "description": "Key option preferences of the specific profile Id attached to the reservation.",
+ "minLength": 0,
+ "maxLength": 200
+ }
+ }
}
},
"tags": [
{
- "description": "The Front Desk Statistics module will provide statistical data related to front desk operations in a property.",
- "name": "FOFStats"
+ "name": "FOFStats",
+ "description": "The Front Desk Statistics module will provide statistical data related to front desk operations in a property."
},
{
- "description": "Front Desk module provides APIs related to a guests stay in the property. For example, checking a guest into the property, providing room information, splitting reservations, as well as adding wake-up calls to a reservation. This module goes hand-in-hand with cashiering module.",
- "name": "FrontDeskOperations"
+ "name": "FrontDeskOperations",
+ "description": "Front Desk module provides APIs related to a guests stay in the property. For example, checking a guest into the property, providing room information, splitting reservations, as well as adding wake-up calls to a reservation. This module goes hand-in-hand with cashiering module."
},
{
- "description": "Commission web service provides commission processing service like payment processing, payment activity and search.",
- "name": "Commissions"
+ "name": "Commissions",
+ "description": "Commission web service provides commission processing service like payment processing, payment activity and search."
}
],
"externalDocs": {
diff --git a/rest-api-specs/property/fofcfg.json b/rest-api-specs/property/fofcfg.json
index beefdae..3a3c16f 100644
--- a/rest-api-specs/property/fofcfg.json
+++ b/rest-api-specs/property/fofcfg.json
@@ -2,8 +2,8 @@
"swagger": "2.0",
"info": {
"title": "OPERA Cloud Front Desk Configuration API",
- "description": "APIs to cater for Front Desk Configuration in OPERA Cloud. Here you can find operations to get, post, put and delete front desk codes such as commission codes, transaction groups, codes & subgroups, articles, payment methods and credit card types.
Compatible with OPERA Cloud release 23.5.
This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2024 Oracle and/or its affiliates.
", - "version": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -74,6 +74,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -138,6 +174,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -211,6 +283,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -277,6 +385,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -341,6 +485,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -439,6 +619,42 @@ }, "204": { "description": "Articles 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": [ @@ -630,6 +846,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -696,6 +948,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -760,6 +1048,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -886,6 +1210,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -945,6 +1305,42 @@ }, "204": { "description": "AuthorizationConfigRules 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": [ @@ -1060,6 +1456,42 @@ }, "204": { "description": "AuthorizationRule 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": [ @@ -1126,6 +1558,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1190,6 +1658,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1270,6 +1774,42 @@ }, "204": { "description": "AuthorizerGroups 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": [ @@ -1335,6 +1875,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1420,6 +1996,42 @@ }, "204": { "description": "AutoFolioSettlementTypes 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": [ @@ -1484,6 +2096,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1559,6 +2207,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1619,6 +2303,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1685,6 +2405,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2114,6 +2870,42 @@ }, "204": { "description": "BudForecast 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": [ @@ -2180,6 +2972,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2239,6 +3067,42 @@ }, "204": { "description": "CardReaderDelimiters 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": [ @@ -2345,6 +3209,42 @@ }, "204": { "description": "Cashiers 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": [ @@ -2430,6 +3330,42 @@ }, "204": { "description": "TemplateCashierShiftDropLocations 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": [ @@ -2494,6 +3430,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2569,6 +3541,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2629,188 +3637,42 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "ChainConfig" - ] - } - }, - "/cashiers": { - "put": { - "summary": "Operation to change CashiersDetails.", - "description": "This Operation to Change a Cashier.OperationId:putCashiers
", - "operationId": "putCashiers", - "parameters": [ - { - "name": "cashiers", - "in": "body", - "required": true, - "description": "Request objects for modifying cashiers", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/cashiers" - } - ] - } - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" }, - { - "$ref": "#/parameters/x-hotelid" - }, - { - "$ref": "#/parameters/x-externalsystem" + "400": { + "$ref": "#/responses/400" }, - { - "$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" - } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CashieringConfig" - ] - }, - "post": { - "summary": "Operation to create Cashiers.", - "description": "Operation to Create Cashier.OperationId:postCashiers
", - "operationId": "postCashiers", - "parameters": [ - { - "name": "cashiers", - "in": "body", - "required": true, - "description": "Request object for creating cashiers.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/cashiers" - } - ] - } + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/authKey" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-app-key" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-hotelid" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-externalsystem" + "406": { + "$ref": "#/responses/406" }, - { - "$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" - } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CashieringConfig" - ] - } - }, - "/cashiers/nextAvailable": { - "get": { - "summary": "Operation to fetch AvailableCashierNumber.", - "description": "The operation returns a next available Cashier Number to be used while creating a new Cashier.OperationId:getAvailableCashierNumber
", - "operationId": "getAvailableCashierNumber", - "parameters": [ - { - "$ref": "#/parameters/authKey" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-app-key" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-hotelid" + "415": { + "$ref": "#/responses/415" }, - { - "$ref": "#/parameters/x-externalsystem" + "500": { + "$ref": "#/responses/500" }, - { - "$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 that returns next available cashier number.", - "schema": { - "$ref": "#/definitions/cashierNumber" - } + "502": { + "$ref": "#/responses/502" }, - "204": { - "description": "AvailableCashierNumber not found." + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2820,25 +3682,25 @@ "application/json;charset=UTF-8" ], "tags": [ - "CashieringConfig" + "ChainConfig" ] } }, - "/collectingAgentTaxes": { + "/cashiers": { "put": { - "summary": "Operation to change CollectingAgentTaxes.", - "description": "Operation to change Collecting Agent Taxes.OperationId:putCollectingAgentTaxes
", - "operationId": "putCollectingAgentTaxes", + "summary": "Operation to change CashiersDetails.", + "description": "This Operation to Change a Cashier.OperationId:putCashiers
", + "operationId": "putCashiers", "parameters": [ { - "name": "collectingAgentTaxes", + "name": "cashiers", "in": "body", "required": true, - "description": "Request object to change Collecting Agent Taxes.", + "description": "Request objects for modifying cashiers", "schema": { "allOf": [ { - "$ref": "#/definitions/collectingAgentTaxes" + "$ref": "#/definitions/cashiers" } ] } @@ -2877,6 +3739,332 @@ "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 Cashiers.", + "description": "Operation to Create Cashier.OperationId:postCashiers
", + "operationId": "postCashiers", + "parameters": [ + { + "name": "cashiers", + "in": "body", + "required": true, + "description": "Request object for creating cashiers.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/cashiers" + } + ] + } + }, + { + "$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" + ] + } + }, + "/cashiers/nextAvailable": { + "get": { + "summary": "Operation to fetch AvailableCashierNumber.", + "description": "The operation returns a next available Cashier Number to be used while creating a new Cashier.OperationId:getAvailableCashierNumber
", + "operationId": "getAvailableCashierNumber", + "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 object that returns next available cashier number.", + "schema": { + "$ref": "#/definitions/cashierNumber" + } + }, + "204": { + "description": "AvailableCashierNumber 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" + ] + } + }, + "/collectingAgentTaxes": { + "put": { + "summary": "Operation to change CollectingAgentTaxes.", + "description": "Operation to change Collecting Agent Taxes.OperationId:putCollectingAgentTaxes
", + "operationId": "putCollectingAgentTaxes", + "parameters": [ + { + "name": "collectingAgentTaxes", + "in": "body", + "required": true, + "description": "Request object to change Collecting Agent Taxes.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/collectingAgentTaxes" + } + ] + } + }, + { + "$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": [ @@ -2941,6 +4129,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2976,6 +4200,18 @@ }, "required": false }, + { + "name": "taxType", + "description": "Parameter to fetch Collecting Agent Taxes based on tax types which are marked Collecting Agent. The list of tax types is fetched using getTaxTypes operation.", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 40 + }, + "required": false + }, { "$ref": "#/parameters/authKey" }, @@ -3009,6 +4245,42 @@ }, "204": { "description": "CollectingAgentTaxes 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": [ @@ -3095,6 +4367,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3169,6 +4477,42 @@ }, "204": { "description": "CommissionCodes 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": [ @@ -3233,6 +4577,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3297,6 +4677,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3370,6 +4786,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3436,6 +4888,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3502,6 +4990,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3566,6 +5090,42 @@ "schema": { "$ref": "#/definitions/compTypesStatus" } + }, + "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": [ @@ -3628,6 +5188,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3710,6 +5306,42 @@ }, "204": { "description": "ConfigBankAccounts 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": [ @@ -3774,6 +5406,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3847,6 +5515,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3911,6 +5615,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3996,6 +5736,42 @@ }, "204": { "description": "ContractBillingInstructions 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": [ @@ -4060,6 +5836,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4135,6 +5947,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4195,6 +6043,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4338,6 +6222,42 @@ }, "204": { "description": "CreditCardInfo 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": [ @@ -4772,6 +6692,42 @@ }, "204": { "description": "validateCreditCardType 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": [ @@ -4838,6 +6794,42 @@ }, "204": { "description": "decodeCard 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": [ @@ -4890,6 +6882,42 @@ }, "204": { "description": "CreditCardReaderDevices 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": [ @@ -4956,6 +6984,42 @@ "schema": { "$ref": "#/definitions/creditCardUniqueId" } + }, + "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": [ @@ -5022,6 +7086,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5086,6 +7186,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5158,6 +7294,42 @@ }, "204": { "description": "CurrencyExchangeServiceTaxes 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": [ @@ -5231,6 +7403,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5321,6 +7529,42 @@ }, "204": { "description": "CustomChargeExemptions 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": [ @@ -5406,6 +7650,42 @@ }, "204": { "description": "CustomTaxTypes 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": [ @@ -5470,6 +7750,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5545,6 +7861,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5605,6 +7957,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5671,6 +8059,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5759,6 +8183,42 @@ }, "204": { "description": "DailyPlanCodes 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": [ @@ -5877,6 +8337,42 @@ }, "204": { "description": "DefaultPaymentMethodRule 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": [ @@ -5957,6 +8453,42 @@ }, "204": { "description": "ExchangeRatesInfo 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": [ @@ -6021,6 +8553,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6087,6 +8655,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6136,7 +8740,107 @@ } ], "responses": { - "200": { + "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 ExpenseArrangementCodes.", + "description": "OperationId:postExpenseArrangementCodes
", + "operationId": "postExpenseArrangementCodes", + "parameters": [ + { + "name": "expenseArrangementCodes", + "in": "body", + "required": true, + "description": "Request object for creating new expense arrangement codes.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/expenseArrangementCodes" + } + ] + } + }, + { + "$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", @@ -6149,74 +8853,46 @@ "description": "Location of newly created resource" } }, - "description": "Response Body.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CashieringConfig" - ] - }, - "post": { - "summary": "Operation to create ExpenseArrangementCodes.", - "description": "OperationId:postExpenseArrangementCodes
", - "operationId": "postExpenseArrangementCodes", - "parameters": [ - { - "name": "expenseArrangementCodes", - "in": "body", - "required": true, - "description": "Request object for creating new expense arrangement codes.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/expenseArrangementCodes" - } - ] - } }, - { - "$ref": "#/parameters/authKey" + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/x-app-key" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-hotelid" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-externalsystem" + "404": { + "$ref": "#/responses/404" }, - { - "$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" - } + "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": [ @@ -6305,6 +8981,42 @@ }, "204": { "description": "ExpenseArrangementCodes 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": [ @@ -6378,6 +9090,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6444,6 +9192,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6510,6 +9294,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6609,6 +9429,42 @@ }, "204": { "description": "FiscalFolioParameters 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": [ @@ -6693,6 +9549,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6778,6 +9670,42 @@ }, "204": { "description": "FiscalGuestTypes 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": [ @@ -6842,6 +9770,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6917,6 +9881,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6977,6 +9977,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7043,6 +10079,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7107,6 +10179,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7190,6 +10298,42 @@ }, "204": { "description": "FiscalPeriods 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": [ @@ -7275,6 +10419,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7360,6 +10540,42 @@ }, "204": { "description": "FiscalRegions 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": [ @@ -7424,6 +10640,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7499,6 +10751,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7559,6 +10847,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7625,6 +10949,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7689,6 +11049,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7765,6 +11161,42 @@ }, "204": { "description": "FiscalYears 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": [ @@ -7838,6 +11270,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7935,6 +11403,42 @@ }, "204": { "description": "ARFlaggedReasons 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": [ @@ -7999,6 +11503,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8063,6 +11603,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8136,6 +11712,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8202,6 +11814,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8266,6 +11914,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8354,6 +12038,42 @@ }, "204": { "description": "FolioArrangementCodes 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": [ @@ -8427,6 +12147,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8493,6 +12249,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8549,84 +12341,156 @@ "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" + }, + "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" + ] + }, + "get": { + "summary": "Operation to fetch FolioCopyLegends.", + "description": "Operation to fetch folio copy legends.OperationId:getFolioCopyLegends
", + "operationId": "getFolioCopyLegends", + "parameters": [ + { + "name": "codes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "name": "languageCode", + "in": "query", + "required": false, + "description": "Language code to be searched.", + "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 Body.", + "description": "Response object for fetch folio copy legend", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/folioCopyLegends" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CashieringConfig" - ] - }, - "get": { - "summary": "Operation to fetch FolioCopyLegends.", - "description": "Operation to fetch folio copy legends.OperationId:getFolioCopyLegends
", - "operationId": "getFolioCopyLegends", - "parameters": [ - { - "name": "codes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false }, - { - "name": "languageCode", - "in": "query", - "required": false, - "description": "Language code to be searched.", - "type": "string" + "204": { + "description": "FolioCopyLegends not found." }, - { - "$ref": "#/parameters/authKey" + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/x-app-key" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-hotelid" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-externalsystem" + "404": { + "$ref": "#/responses/404" }, - { - "$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 folio copy legend", - "schema": { - "$ref": "#/definitions/folioCopyLegends" - } + "405": { + "$ref": "#/responses/405" }, - "204": { - "description": "FolioCopyLegends not found." + "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": [ @@ -8693,6 +12557,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8757,6 +12657,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8829,6 +12765,42 @@ }, "204": { "description": "FolioPrintQueues 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": [ @@ -8902,6 +12874,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8975,6 +12983,42 @@ }, "204": { "description": "FolioTypeLegendMappingsConfig 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": [ @@ -9039,6 +13083,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9103,6 +13183,42 @@ "schema": { "$ref": "#/definitions/folioTypeLegendMappingConfigStatus" } + }, + "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": [ @@ -9169,6 +13285,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9233,6 +13385,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9312,6 +13500,42 @@ }, "204": { "description": "FolioTypesConfig 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": [ @@ -9385,6 +13609,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9451,6 +13711,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9515,6 +13811,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9602,6 +13934,42 @@ }, "204": { "description": "ForeignCurrencies 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": [ @@ -9664,6 +14032,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9730,6 +14134,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9794,6 +14234,42 @@ "schema": { "$ref": "#/definitions/generatesInfoType" } + }, + "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": [ @@ -9858,6 +14334,42 @@ }, "204": { "description": "GlobalExchangeRatesInfo 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": [ @@ -9919,6 +14431,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9982,6 +14530,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10048,6 +14632,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10112,6 +14732,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10200,6 +14856,42 @@ }, "204": { "description": "GroupArrangementCodes 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": [ @@ -10273,6 +14965,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10329,144 +15057,252 @@ "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" + }, + "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" + ] + } + }, + "/guiNumberRules": { + "put": { + "summary": "Operation to change GUINumberRules.", + "description": "Operation to change GUI Number rulesOperationId:putGUINumberRules
", + "operationId": "putGUINumberRules", + "parameters": [ + { + "name": "gUINumberRulesDetails", + "in": "body", + "required": true, + "description": "Request object to edit GUI number rules.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/gUINumberRulesDetails" + } + ] + } + }, + { + "$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" + ] + }, + "get": { + "summary": "Operation to fetch GUINumberRules.", + "description": "Operation to fetch GUI Number rulesOperationId:getGUINumberRules
", + "operationId": "getGUINumberRules", + "parameters": [ + { + "name": "hotelIds", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Hotel code.", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": true + }, + { + "$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 Body.", - "schema": { - "$ref": "#/definitions/status" - } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CashieringConfig" - ] - } - }, - "/guiNumberRules": { - "put": { - "summary": "Operation to change GUINumberRules.", - "description": "Operation to change GUI Number rulesOperationId:putGUINumberRules
", - "operationId": "putGUINumberRules", - "parameters": [ - { - "name": "gUINumberRulesDetails", - "in": "body", - "required": true, - "description": "Request object to edit GUI number rules.", + "description": "Response object for fetch GUI number rules", "schema": { - "allOf": [ - { - "$ref": "#/definitions/gUINumberRulesDetails" - } - ] + "$ref": "#/definitions/gUINumberRulesDetails" } }, - { - "$ref": "#/parameters/authKey" + "204": { + "description": "GUINumberRules not found." }, - { - "$ref": "#/parameters/x-app-key" + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/x-hotelid" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-externalsystem" + "403": { + "$ref": "#/responses/403" }, - { - "$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" - } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CashieringConfig" - ] - }, - "get": { - "summary": "Operation to fetch GUINumberRules.", - "description": "Operation to fetch GUI Number rulesOperationId:getGUINumberRules
", - "operationId": "getGUINumberRules", - "parameters": [ - { - "name": "hotelIds", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Hotel code.", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": true + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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 GUI number rules", - "schema": { - "$ref": "#/definitions/gUINumberRulesDetails" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "GUINumberRules not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10533,6 +15369,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10597,6 +15469,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10677,6 +15585,42 @@ }, "204": { "description": "AdjustmentCodes 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": [ @@ -10742,6 +15686,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10808,6 +15788,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10874,6 +15890,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10938,6 +15990,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11054,6 +16142,42 @@ }, "204": { "description": "PaymentMethods 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": [ @@ -11120,6 +16244,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11186,6 +16346,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11250,6 +16446,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11330,6 +16562,42 @@ }, "204": { "description": "TaxTypes 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": [ @@ -11403,6 +16671,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11469,6 +16773,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11535,6 +16875,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11610,6 +16986,42 @@ }, "204": { "description": "ARAccountTypes 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": [ @@ -11716,6 +17128,42 @@ }, "204": { "description": "CashierShiftDropLocations 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": [ @@ -11789,6 +17237,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11873,6 +17357,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11942,6 +17462,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12012,6 +17568,42 @@ }, "204": { "description": "CommissionCode 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": [ @@ -12118,6 +17710,42 @@ }, "204": { "description": "CompAuthorizers 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": [ @@ -12210,6 +17838,42 @@ }, "204": { "description": "CompBucketRedemptionCodes 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": [ @@ -12283,6 +17947,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12361,6 +18061,42 @@ }, "204": { "description": "CompBucketRedemptionConfig 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": [ @@ -12443,6 +18179,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12502,84 +18274,156 @@ "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" + }, + "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" + ] + } + }, + "/hotels/{hotelId}/compTypes": { + "get": { + "summary": "Operation to Fetch Comp Types.", + "description": "Operation to Fetch Comp TYpes.OperationId:getCompTypes
", + "operationId": "getCompTypes", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the source hotel in OPERA" + }, + { + "name": "compTypeCode", + "in": "query", + "required": false, + "description": "Code is used to identify the CompType.", + "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": "HATEOAS links which help the consumer to navigate to resources", + "description": "Response object for fetching Comp Types.", "schema": { - "$ref": "#/definitions/status" + "$ref": "#/definitions/compTypesDetails" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CashieringConfig" - ] - } - }, - "/hotels/{hotelId}/compTypes": { - "get": { - "summary": "Operation to Fetch Comp Types.", - "description": "Operation to Fetch Comp TYpes.OperationId:getCompTypes
", - "operationId": "getCompTypes", - "parameters": [ - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the source hotel in OPERA" }, - { - "name": "compTypeCode", - "in": "query", - "required": false, - "description": "Code is used to identify the CompType.", - "type": "string" + "204": { + "description": "CompTypes not found." }, - { - "$ref": "#/parameters/authKey" + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/x-app-key" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-hotelid" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-externalsystem" + "404": { + "$ref": "#/responses/404" }, - { - "$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 Comp Types.", - "schema": { - "$ref": "#/definitions/compTypesDetails" - } + "405": { + "$ref": "#/responses/405" }, - "204": { - "description": "CompTypes not found." + "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": [ @@ -12679,6 +18523,42 @@ }, "204": { "description": "CustomChargeCodes 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": [ @@ -12752,6 +18632,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12830,6 +18746,42 @@ }, "204": { "description": "CustomChargesConfig 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": [ @@ -12912,6 +18864,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12981,6 +18969,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13056,6 +19080,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13141,6 +19201,42 @@ }, "204": { "description": "CustomChargeExemptionsConfig 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": [ @@ -13223,6 +19319,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13292,6 +19424,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13430,6 +19598,42 @@ }, "204": { "description": "CustomNumbers 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": [ @@ -13503,6 +19707,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13627,6 +19867,42 @@ }, "204": { "description": "CustomNumberConfig 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": [ @@ -13709,6 +19985,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13778,6 +20090,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13910,6 +20258,42 @@ }, "204": { "description": "ExchangeRates 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": [ @@ -14012,6 +20396,42 @@ }, "204": { "description": "FuturePastExchangeRates 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": [ @@ -14114,6 +20534,42 @@ }, "204": { "description": "FiscalCommands 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": [ @@ -14187,6 +20643,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14271,6 +20763,42 @@ }, "204": { "description": "FiscalPartners 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": [ @@ -14344,6 +20872,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14415,6 +20979,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14488,6 +21088,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14564,162 +21200,270 @@ "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 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" + ] + } + }, + "/hotels/{hotelId}/generates": { + "get": { + "summary": "Operation to fetch GenerateTaxTypes.", + "description": "Operation to fetch tax types.OperationId:getGenerateTaxTypes
", + "operationId": "getGenerateTaxTypes", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel in OPERA" + }, + { + "name": "transactionCode", + "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" + }, + { + "$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 tax types.", + "schema": { + "$ref": "#/definitions/taxTypesGenerate" + } + }, + "204": { + "description": "GenerateTaxTypes 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" + ] + } + }, + "/hotels/{hotelId}/interfaces/{interfaceLogoId}/customData": { + "put": { + "summary": "Operation to update hotel interface custom data.", + "description": "Operation to update hotel interface custom data.OperationId:updateInterfaceCustomData
", + "operationId": "updateInterfaceCustomData", + "parameters": [ + { + "name": "interfaceLogoId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel interface logo" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel in OPERA" + }, + { + "name": "hotelInterfaceDetail", + "in": "body", + "required": true, + "description": "Request object for updating a Hotel Interface.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/hotelInterfaceDetail" + } + ] + } + }, + { + "$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" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CashieringConfig" - ] - } - }, - "/hotels/{hotelId}/generates": { - "get": { - "summary": "Operation to fetch GenerateTaxTypes.", - "description": "Operation to fetch tax types.OperationId:getGenerateTaxTypes
", - "operationId": "getGenerateTaxTypes", - "parameters": [ - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel in OPERA" }, - { - "name": "transactionCode", - "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." + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/authKey" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-app-key" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-hotelid" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-externalsystem" + "405": { + "$ref": "#/responses/405" }, - { - "$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 tax types.", - "schema": { - "$ref": "#/definitions/taxTypesGenerate" - } + "406": { + "$ref": "#/responses/406" }, - "204": { - "description": "GenerateTaxTypes not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CashieringConfig" - ] - } - }, - "/hotels/{hotelId}/interfaces/{interfaceLogoId}/customData": { - "put": { - "summary": "Operation to update hotel interface custom data.", - "description": "Operation to update hotel interface custom data.OperationId:updateInterfaceCustomData
", - "operationId": "updateInterfaceCustomData", - "parameters": [ - { - "name": "interfaceLogoId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel interface logo" + "413": { + "$ref": "#/responses/413" }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel in OPERA" + "414": { + "$ref": "#/responses/414" }, - { - "name": "hotelInterfaceDetail", - "in": "body", - "required": true, - "description": "Request object for updating a Hotel Interface.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/hotelInterfaceDetail" - } - ] - } - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" + "415": { + "$ref": "#/responses/415" }, - { - "$ref": "#/parameters/x-hotelid" + "500": { + "$ref": "#/responses/500" }, - { - "$ref": "#/parameters/x-externalsystem" + "502": { + "$ref": "#/responses/502" }, - { - "$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" - } + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14810,6 +21554,42 @@ }, "204": { "description": "HotelInterfaceCustomData 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": [ @@ -14886,6 +21666,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14985,6 +21801,42 @@ }, "204": { "description": "TemplateCustomNumberConfig 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": [ @@ -15068,6 +21920,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15138,6 +22026,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15237,6 +22161,42 @@ }, "204": { "description": "TrackItActions 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": [ @@ -15310,6 +22270,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15394,6 +22390,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15463,6 +22495,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15562,6 +22630,42 @@ }, "204": { "description": "TrackItLocations 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": [ @@ -15635,6 +22739,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15719,6 +22859,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15788,6 +22964,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15887,6 +23099,42 @@ }, "204": { "description": "TrackItTypes 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": [ @@ -15960,6 +23208,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16044,6 +23328,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16113,6 +23433,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16181,6 +23537,42 @@ }, "204": { "description": "TransactionCodeAccessRoles 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": [ @@ -16282,6 +23674,42 @@ }, "204": { "description": "calculatePosting 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": [ @@ -16374,6 +23802,42 @@ }, "204": { "description": "TransactionCode 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": [ @@ -16445,6 +23909,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16529,6 +24029,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16583,6 +24119,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "produces": [ @@ -16662,111 +24234,183 @@ "x-example": "en-GB" } }, - "description": "Response object for fetching detailed transaction group configuration.", + "description": "Response object for fetching detailed transaction group configuration.", + "schema": { + "$ref": "#/definitions/transactionGroup" + } + }, + "204": { + "description": "TransactionGroup 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" + ] + } + }, + "/hotels/{hotelId}/transactionSubGroupCodes/{transactionSubGroupCode}/transactionGroupCodes/{transactionGroupCode}/transactionSubGroup": { + "get": { + "summary": "Operation to fetch TransactionGroup.", + "description": "Operation to fetch detailed transaction sub group.OperationId:getTransactionSubgroup
", + "operationId": "getTransactionSubgroup", + "parameters": [ + { + "name": "transactionGroupCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Transaction Group Code in OPERA" + }, + { + "name": "transactionSubGroupCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Transaction SubGroup Code in OPERA" + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of the hotel in OPERA" + }, + { + "name": "fetchInstructions", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Simple type for transaction sub group instructions that can be used for partial operations.", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "Header", + "Generates" + ] + }, + "x-example": [ + "Header" + ], + "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 detailed transaction subgroup configuration.", "schema": { - "$ref": "#/definitions/transactionGroup" + "$ref": "#/definitions/hotelTransactionSubgroup" } }, "204": { - "description": "TransactionGroup not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CashieringConfig" - ] - } - }, - "/hotels/{hotelId}/transactionSubGroupCodes/{transactionSubGroupCode}/transactionGroupCodes/{transactionGroupCode}/transactionSubGroup": { - "get": { - "summary": "Operation to fetch TransactionGroup.", - "description": "Operation to fetch detailed transaction sub group.OperationId:getTransactionSubgroup
", - "operationId": "getTransactionSubgroup", - "parameters": [ - { - "name": "transactionGroupCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Transaction Group Code in OPERA" + "description": "TransactionSubgroup not found." }, - { - "name": "transactionSubGroupCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Transaction SubGroup Code in OPERA" + "400": { + "$ref": "#/responses/400" }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of the hotel in OPERA" + "401": { + "$ref": "#/responses/401" }, - { - "name": "fetchInstructions", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Simple type for transaction sub group instructions that can be used for partial operations.", - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "Header", - "Generates" - ] - }, - "x-example": [ - "Header" - ], - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/authKey" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-app-key" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-hotelid" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-externalsystem" + "413": { + "$ref": "#/responses/413" }, - { - "$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 detailed transaction subgroup configuration.", - "schema": { - "$ref": "#/definitions/hotelTransactionSubgroup" - } + "414": { + "$ref": "#/responses/414" }, - "204": { - "description": "TransactionSubgroup not found." + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16868,6 +24512,42 @@ }, "204": { "description": "Vouchers 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": [ @@ -16935,6 +24615,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17008,6 +24724,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17081,6 +24833,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17156,6 +24944,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17231,6 +25055,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17306,81 +25166,153 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "HotelConfig" - ] - } - }, - "/hotels/{sourceHotelId}/trackItLocations/copy": { - "put": { - "summary": " Copy Track it Locations", - "description": "Copy Track it Locations.OperationId:copyTrackItLocations
", - "operationId": "copyTrackItLocations", - "parameters": [ - { - "name": "sourceHotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Unique ID of source hotel." }, - { - "name": "copyTrackItLocations", - "in": "body", - "required": true, - "description": "List of Track it Locations to be copied.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/copyTrackItLocations" - } - ] - } + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "HotelConfig" + ] + } + }, + "/hotels/{sourceHotelId}/trackItLocations/copy": { + "put": { + "summary": " Copy Track it Locations", + "description": "Copy Track it Locations.OperationId:copyTrackItLocations
", + "operationId": "copyTrackItLocations", + "parameters": [ + { + "name": "sourceHotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Unique ID of source hotel." + }, + { + "name": "copyTrackItLocations", + "in": "body", + "required": true, + "description": "List of Track it Locations to be copied.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/copyTrackItLocations" + } + ] + } + }, + { + "$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" }, - { - "$ref": "#/parameters/authKey" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-app-key" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-hotelid" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-externalsystem" + "405": { + "$ref": "#/responses/405" }, - { - "$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" - } + "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": [ @@ -17456,6 +25388,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17522,6 +25490,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17586,6 +25590,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17666,6 +25706,42 @@ }, "204": { "description": "NoShowPostingRules 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": [ @@ -17767,6 +25843,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17833,6 +25945,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17908,6 +26056,42 @@ }, "204": { "description": "NumberDescriptions 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": [ @@ -17974,6 +26158,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18077,6 +26297,42 @@ }, "204": { "description": "OperaControlSequences 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": [ @@ -18126,7 +26382,107 @@ } ], "responses": { - "200": { + "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 PackageArrangementCodes.", + "description": "OperationId:postPackageArrangementCodes
", + "operationId": "postPackageArrangementCodes", + "parameters": [ + { + "name": "packageArrangementCodes", + "in": "body", + "required": true, + "description": "Request object for creating new package arrangement codes.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/packageArrangementCodes" + } + ] + } + }, + { + "$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", @@ -18139,74 +26495,46 @@ "description": "Location of newly created resource" } }, - "description": "Response Body.", + "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CashieringConfig" - ] - }, - "post": { - "summary": "Operation to create PackageArrangementCodes.", - "description": "OperationId:postPackageArrangementCodes
", - "operationId": "postPackageArrangementCodes", - "parameters": [ - { - "name": "packageArrangementCodes", - "in": "body", - "required": true, - "description": "Request object for creating new package arrangement codes.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/packageArrangementCodes" - } - ] - } }, - { - "$ref": "#/parameters/authKey" + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/x-app-key" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-hotelid" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-externalsystem" + "404": { + "$ref": "#/responses/404" }, - { - "$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" - } + "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": [ @@ -18295,6 +26623,42 @@ }, "204": { "description": "PackageArrangementCodes 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": [ @@ -18368,6 +26732,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18434,6 +26834,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18500,6 +26936,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18601,6 +27073,42 @@ }, "204": { "description": "PrepaidCard 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": [ @@ -18695,136 +27203,208 @@ "x-example": "en-GB" } }, - "description": "Response for fetch Prepaid card balance.", + "description": "Response for fetch Prepaid card balance.", + "schema": { + "$ref": "#/definitions/prepaidCardBalanceDetails" + } + }, + "204": { + "description": "PrepaidCardBalance 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": [ + "CreditCard" + ] + } + }, + "/prepaidCards": { + "get": { + "summary": "Operation to fetch PrepaidCards.", + "description": "OperationId:getPrepaidCards
", + "operationId": "getPrepaidCards", + "parameters": [ + { + "name": "hotelId", + "in": "query", + "required": true, + "description": "Hotel code.", + "type": "string" + }, + { + "name": "includeCardDetails", + "in": "query", + "x-example": "false", + "required": false, + "description": "Configuring this flag to be TRUE will fetch and return card details from vendor interface.", + "type": "boolean" + }, + { + "name": "reservationId", + "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": "idExtension", + "in": "query", + "required": false, + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" + }, + { + "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": "cardNo", + "in": "query", + "required": false, + "description": "Prepaid card number.", + "type": "string" + }, + { + "name": "roomNo", + "in": "query", + "required": false, + "description": "Room No search criteria.", + "type": "string" + }, + { + "name": "nameWildCard", + "in": "query", + "required": false, + "description": "Last name search criteria.", + "type": "string" + }, + { + "name": "firstNameWildCard", + "in": "query", + "required": false, + "description": "First name search criteria.", + "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 for fetch Prepaid cards operation", "schema": { - "$ref": "#/definitions/prepaidCardBalanceDetails" + "$ref": "#/definitions/prepaidCards" } }, "204": { - "description": "PrepaidCardBalance not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "CreditCard" - ] - } - }, - "/prepaidCards": { - "get": { - "summary": "Operation to fetch PrepaidCards.", - "description": "OperationId:getPrepaidCards
", - "operationId": "getPrepaidCards", - "parameters": [ - { - "name": "hotelId", - "in": "query", - "required": true, - "description": "Hotel code.", - "type": "string" + "description": "PrepaidCards not found." }, - { - "name": "includeCardDetails", - "in": "query", - "x-example": "false", - "required": false, - "description": "Configuring this flag to be TRUE will fetch and return card details from vendor interface.", - "type": "boolean" + "400": { + "$ref": "#/responses/400" }, - { - "name": "reservationId", - "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" + "401": { + "$ref": "#/responses/401" }, - { - "name": "idExtension", - "in": "query", - "required": false, - "description": "Additional identifying value assigned by the creating system.", - "type": "integer" + "403": { + "$ref": "#/responses/403" }, - { - "name": "idContext", - "in": "query", - "required": false, - "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", - "type": "string" + "404": { + "$ref": "#/responses/404" }, - { - "name": "type", - "in": "query", - "required": false, - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string" + "405": { + "$ref": "#/responses/405" }, - { - "name": "cardNo", - "in": "query", - "required": false, - "description": "Prepaid card number.", - "type": "string" + "406": { + "$ref": "#/responses/406" }, - { - "name": "roomNo", - "in": "query", - "required": false, - "description": "Room No search criteria.", - "type": "string" + "413": { + "$ref": "#/responses/413" }, - { - "name": "nameWildCard", - "in": "query", - "required": false, - "description": "Last name search criteria.", - "type": "string" + "414": { + "$ref": "#/responses/414" }, - { - "name": "firstNameWildCard", - "in": "query", - "required": false, - "description": "First name search criteria.", - "type": "string" - }, - { - "$ref": "#/parameters/authKey" - }, - { - "$ref": "#/parameters/x-app-key" + "415": { + "$ref": "#/responses/415" }, - { - "$ref": "#/parameters/x-hotelid" + "500": { + "$ref": "#/responses/500" }, - { - "$ref": "#/parameters/x-externalsystem" + "502": { + "$ref": "#/responses/502" }, - { - "$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 fetch Prepaid cards operation", - "schema": { - "$ref": "#/definitions/prepaidCards" - } - }, - "204": { - "description": "PrepaidCards not found." + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18891,6 +27471,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18955,6 +27571,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19066,6 +27718,42 @@ }, "204": { "description": "RevenueBucketCodes 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": [ @@ -19166,6 +27854,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19232,6 +27956,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19298,6 +28058,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19362,6 +28158,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19454,6 +28286,42 @@ }, "204": { "description": "RevenueBucketTypes 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": [ @@ -19527,6 +28395,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19593,6 +28497,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19659,6 +28599,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19723,6 +28699,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19829,6 +28841,42 @@ }, "204": { "description": "RevenueTypeMapping 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": [ @@ -19979,6 +29027,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20045,6 +29129,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20111,6 +29231,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20175,6 +29331,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20260,6 +29452,42 @@ }, "204": { "description": "RoutingInstructions 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": [ @@ -20325,6 +29553,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20391,6 +29655,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20457,6 +29757,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20543,6 +29879,42 @@ }, "204": { "description": "StopProcessingReasons 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": [ @@ -20607,6 +29979,42 @@ "schema": { "$ref": "#/definitions/stopProcessingReasons" } + }, + "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": [ @@ -20671,6 +30079,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20733,6 +30177,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20799,6 +30279,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20863,6 +30379,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20935,6 +30487,42 @@ }, "204": { "description": "TaxBrackets 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": [ @@ -21008,6 +30596,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21074,6 +30698,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21159,6 +30819,42 @@ }, "204": { "description": "FetchTaxCategoryCodes 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": [ @@ -21223,6 +30919,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21298,6 +31030,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21358,6 +31126,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21443,6 +31247,42 @@ }, "204": { "description": "TaxOffices 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": [ @@ -21507,6 +31347,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21582,6 +31458,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21642,6 +31554,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21734,6 +31682,42 @@ }, "204": { "description": "TemplateCustomNumbers 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": [ @@ -21798,6 +31782,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21856,6 +31876,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21920,6 +31976,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21986,6 +32078,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22050,6 +32178,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22178,6 +32342,42 @@ }, "204": { "description": "TemplateTransactionCodes 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": [ @@ -22240,6 +32440,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22306,6 +32542,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22370,6 +32642,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22452,6 +32760,42 @@ }, "204": { "description": "TemplateTransactionGroups 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": [ @@ -22514,6 +32858,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22580,6 +32960,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22644,6 +33060,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22724,6 +33176,42 @@ }, "204": { "description": "TemplateTransactionSubgroups 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": [ @@ -22797,6 +33285,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22867,6 +33391,42 @@ }, "204": { "description": "TransactionArrangementCodes 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": [ @@ -22933,6 +33493,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -22999,6 +33595,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23065,6 +33697,42 @@ "schema": { "$ref": "#/definitions/transactionCodes" } + }, + "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": [ @@ -23129,6 +33797,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23268,6 +33972,42 @@ }, "204": { "description": "TransactionCodes 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": [ @@ -23334,6 +34074,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23400,6 +34176,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23539,6 +34351,42 @@ }, "204": { "description": "No transaction discounts 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" } }, "produces": [ @@ -23602,6 +34450,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23666,6 +34550,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23810,6 +34730,42 @@ }, "204": { "description": "TransactionDiversionRules 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": [ @@ -23876,6 +34832,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -23942,6 +34934,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24008,6 +35036,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24072,6 +35136,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24165,6 +35265,42 @@ }, "204": { "description": "TransactionGroups 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": [ @@ -24238,6 +35374,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24304,6 +35476,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24370,6 +35578,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24434,6 +35678,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24525,6 +35805,42 @@ }, "204": { "description": "TransactionSubgroups 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": [ @@ -24609,6 +35925,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24675,6 +36027,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -34255,6 +45643,10 @@ "lastFolioNumber": { "description": "Last folio number issued for a folio type", "type": "number" + }, + "proFormaFolio": { + "description": "To indicate if the folio type is to be used for a proforma folio.", + "type": "boolean" } } }, @@ -35022,7 +46414,8 @@ "Correction", "Deletion", "ServiceRecovery", - "CreditBill" + "CreditBill", + "VoidBill" ] }, "amountOrPercentage": { @@ -35793,7 +47186,8 @@ "description": "The Custom Charge is only posted for the maximum number of nights of the stay.", "enum": [ "Rate", - "RatePercWithLimit" + "RatePercWithLimit", + "RatePerPerson" ] }, "customChargesConfig": { @@ -41815,4 +53209,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/hsk.json b/rest-api-specs/property/hsk.json index 48690f4..18bdc23 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -85,6 +85,42 @@ }, "204": { "description": "HousekeepingAttendantsSchedule 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": [ @@ -164,6 +200,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -239,6 +311,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -499,6 +607,42 @@ }, "204": { "description": "RoomConditions 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": [ @@ -572,6 +716,42 @@ "schema": { "$ref": "#/definitions/roomConditionRequestStatus" } + }, + "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": [ @@ -671,6 +851,42 @@ }, "204": { "description": "FacilityForecast 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": [ @@ -742,6 +958,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2623,6 +2875,42 @@ }, "204": { "description": "HouseKeepingTasks 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": [ @@ -2760,6 +3048,42 @@ }, "204": { "description": "HousekeepingDiscrepancies 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": [ @@ -2910,14 +3234,15 @@ "in": "query", "type": "array", "collectionFormat": "multi", - "description": "Simple type for housekeeping instructions that can be used in requests for partial operations.", + "description": "Simple type for housekeeping instructions that can be used in requests for partial operations. When ScheduedRoomMoveInfo instruction is set to true, get only the rooms with a scheduled room move, along with the associated reservation information. When false, scheduled room move information is not included in the response. The scheduled room move information will assist housekeeping associates to prioritize rooms for cleaning.", "uniqueItems": true, "items": { "type": "string", "enum": [ "Summary", "ResvInfo", - "TurndownInfo" + "TurndownInfo", + "ScheduedRoomMoveInfo" ] }, "required": false @@ -3064,6 +3389,13 @@ "description": "Determines whether fetching cleaning priority rooms only.", "type": "boolean" }, + { + "name": "scheduledRoomMovesOnly", + "in": "query", + "required": false, + "description": "This flag indicates true or false. When it is set to true, get only the rooms with a scheduled room move, along with the associated reservation information. When false, scheduled room move information is not included in the response. The scheduled room move information will assist housekeeping associates to prioritize rooms for cleaning.", + "type": "boolean" + }, { "$ref": "#/parameters/authKey" }, @@ -3372,6 +3704,42 @@ }, "204": { "description": "HousekeepingOverview 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": [ @@ -3443,6 +3811,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3527,6 +3931,42 @@ "schema": { "$ref": "#/definitions/resolvedRoomMaintenance" } + }, + "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": [ @@ -3611,6 +4051,42 @@ "schema": { "$ref": "#/definitions/unresolvedRoomMaintenance" } + }, + "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": [ @@ -3686,6 +4162,42 @@ "schema": { "$ref": "#/definitions/movedTaskRoomsRS" } + }, + "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": [ @@ -3794,6 +4306,42 @@ }, "204": { "description": "GuestHousekeepingNotes 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": [ @@ -3876,6 +4424,42 @@ "schema": { "$ref": "#/definitions/guestHousekeepingService" } + }, + "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": [ @@ -3992,6 +4576,42 @@ }, "204": { "description": "ReservationHousekeepingSchedule 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": [ @@ -4074,6 +4694,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4156,6 +4812,42 @@ "schema": { "$ref": "#/definitions/schedule" } + }, + "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": [ @@ -4405,6 +5097,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4489,6 +5217,42 @@ "schema": { "$ref": "#/definitions/scheduledSearch" } + }, + "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": [ @@ -4573,6 +5337,42 @@ "schema": { "$ref": "#/definitions/scheduledShiftRequest" } + }, + "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": [ @@ -4647,6 +5447,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4731,6 +5567,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4929,6 +5801,42 @@ }, "204": { "description": "RoomMaintenance 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": [ @@ -5133,6 +6041,42 @@ }, "204": { "description": "OutOfOrderRooms 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": [ @@ -5251,6 +6195,42 @@ "schema": { "$ref": "#/definitions/completeRoomRepairStatus" } + }, + "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": [ @@ -5347,6 +6327,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5483,6 +6499,42 @@ "schema": { "$ref": "#/definitions/completeRoomRepairStatus" } + }, + "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": [ @@ -5714,6 +6766,42 @@ }, "204": { "description": "OutOfServiceRooms 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": [ @@ -5810,6 +6898,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5898,6 +7022,42 @@ "schema": { "$ref": "#/definitions/housekeepingRoomStatus" } + }, + "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": [ @@ -5982,6 +7142,42 @@ "schema": { "$ref": "#/definitions/roomCleaningPriorityRequestStatus" } + }, + "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": [ @@ -6075,6 +7271,42 @@ "schema": { "$ref": "#/definitions/changedRoomMaintenance" } + }, + "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": [ @@ -6168,6 +7400,42 @@ "schema": { "$ref": "#/definitions/canceledServicingTaskRoom" } + }, + "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": [ @@ -6261,6 +7529,42 @@ "schema": { "$ref": "#/definitions/completedServicingTaskRoom" } + }, + "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": [ @@ -6354,6 +7658,42 @@ "schema": { "$ref": "#/definitions/skipedServicingTaskRoom" } + }, + "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": [ @@ -6447,6 +7787,42 @@ "schema": { "$ref": "#/definitions/serviceTime" } + }, + "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": [ @@ -6522,6 +7898,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6597,6 +8009,42 @@ "schema": { "$ref": "#/definitions/guestHousekeepingServiceRequestStatus" } + }, + "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": [ @@ -8292,6 +9740,42 @@ }, "204": { "description": "TaskCompanion 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": [ @@ -8360,6 +9844,42 @@ }, "204": { "description": "TaskSheetTemplate 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": [ @@ -8444,6 +9964,42 @@ "schema": { "$ref": "#/definitions/changedTaskSheetTemplate" } + }, + "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": [ @@ -8513,6 +10069,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8588,6 +10180,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8661,6 +10289,42 @@ "schema": { "$ref": "#/definitions/changedTaskSheet" } + }, + "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": [ @@ -8747,6 +10411,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8822,6 +10522,42 @@ "schema": { "$ref": "#/definitions/changedTaskSheetRooms" } + }, + "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": [ @@ -8919,6 +10655,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8992,6 +10764,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9076,6 +10884,42 @@ "schema": { "$ref": "#/definitions/lockedTaskSheet" } + }, + "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": [ @@ -9160,6 +11004,42 @@ "schema": { "$ref": "#/definitions/unlockedTaskSheet" } + }, + "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": [ @@ -9244,6 +11124,42 @@ "schema": { "$ref": "#/definitions/endedServiceBreak" } + }, + "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": [ @@ -9328,6 +11244,42 @@ "schema": { "$ref": "#/definitions/startedServiceBreak" } + }, + "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": [ @@ -9412,6 +11364,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11621,6 +13609,44 @@ "type": "string", "minLength": 0, "maxLength": 20 + }, + "adultCount": { + "description": "Number of adults on the reservation.", + "type": "integer", + "minimum": 0 + }, + "childCount": { + "description": "Number of children on the reservation.", + "type": "integer", + "minimum": 0 + }, + "scheduledRoomMoveInfo": { + "description": "Indicates Scheduled Room Move In/Out information.", + "$ref": "#/definitions/scheduledRoomMoveInfoType" + }, + "scheduledMoveInRoomId": { + "description": "Indicates the scheduled Move-In Room Number.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "scheduledMoveOutRoomId": { + "description": "Indicates the scheduled Move-Out Room Number.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "nationality": { + "description": "Nationality code identification.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "alternateGivenName": { + "description": "Guest alternate given name, first name or any other names.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, @@ -12282,6 +14308,13 @@ "$ref": "#/definitions/reservationShortInfoType" } }, + "scheduledRoomMoveResvInfo": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationShortInfoType" + } + }, "componentRoomNumbers": { "description": "List of component room numbers.", "type": "array", @@ -12514,7 +14547,7 @@ }, "housekeepingCreditsDefinitionType": { "type": "string", - "description": "Type for the different kinds of Credits which will be used in Rooms Management.", + "description": "Type for the different kinds of Credits which will be used in Rooms Management. ", "enum": [ "Departure", "Pickup", @@ -12524,7 +14557,8 @@ "Travelling", "Miscellaneous", "Special", - "Total" + "Total", + "ItemInventory" ] }, "appUserOnBreakType": { @@ -17081,6 +19115,30 @@ "type": "integer" } } + }, + "scheduledRoomMoveInfoType": { + "type": "object", + "description": "Holds the scheduled room Move In/Out information.", + "properties": { + "scheduledRoomMoveInTime": { + "description": "Scheduled Room Move-In Time.", + "type": "string", + "format": "date-time" + }, + "scheduledRoomMoveOutTime": { + "description": "Scheduled Room Move-Out Time.", + "type": "string", + "format": "date-time" + }, + "scheduledRoomMoveIn": { + "description": "True indicates room is scheduled for move in.", + "type": "boolean" + }, + "scheduledRoomMoveOut": { + "description": "True indicates room is scheduled for move out.", + "type": "boolean" + } + } } }, "tags": [ @@ -17093,4 +19151,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/int.json b/rest-api-specs/property/int.json index 5939e79..41c24e9 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -150,6 +150,42 @@ }, "204": { "description": "BusinessEventsByExternalSystem 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": [ @@ -512,6 +548,42 @@ }, "204": { "description": "BusinessEvents 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": [ @@ -726,7 +798,8 @@ "Profile", "Rate", "Reservation", - "StayRecords" + "StayRecords", + "RoomRotation" ] }, "businessEventDetailsType": { @@ -1016,4 +1089,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/intcfg.json b/rest-api-specs/property/intcfg.json index 95cc120..f9d9463 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -226,6 +226,42 @@ }, "204": { "description": "ConfiguredExternalDevices 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": [ @@ -321,6 +357,42 @@ }, "204": { "description": "DeliveryMethods 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": [ @@ -385,6 +457,42 @@ "schema": { "$ref": "#/definitions/changedDeliveryMethods" } + }, + "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": [ @@ -490,6 +598,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -554,6 +698,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -640,6 +820,42 @@ }, "204": { "description": "TemplateDeviceLocations 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": [ @@ -704,6 +920,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -779,6 +1031,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -839,6 +1127,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -994,6 +1318,42 @@ }, "204": { "description": "ExternalDeviceConfigurations 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": [ @@ -1058,6 +1418,42 @@ "schema": { "$ref": "#/definitions/changedExternalDeviceConfigurations" } + }, + "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": [ @@ -1111,6 +1507,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1163,6 +1595,42 @@ }, "204": { "description": "ping 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": [ @@ -1247,6 +1715,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1328,6 +1832,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1395,6 +1935,42 @@ }, "204": { "description": "Publishers 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": [ @@ -1461,6 +2037,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1525,6 +2137,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1644,6 +2292,42 @@ }, "204": { "description": "HotelInterfaces 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": [ @@ -1712,6 +2396,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1796,6 +2516,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1889,6 +2645,42 @@ "schema": { "$ref": "#/definitions/changedInterfaceAccount" } + }, + "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": [ @@ -2016,6 +2808,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2086,6 +2914,42 @@ }, "204": { "description": "InterfaceRoomStatuses 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": [ @@ -2168,6 +3032,42 @@ "schema": { "$ref": "#/definitions/changedInterfaceRoomStatus" } + }, + "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": [ @@ -2279,6 +3179,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2385,6 +3321,42 @@ }, "204": { "description": "InterfaceRooms 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": [ @@ -2467,6 +3439,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2670,6 +3678,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2754,6 +3798,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2847,6 +3927,42 @@ "schema": { "$ref": "#/definitions/changedInterfaceRoom" } + }, + "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": [ @@ -2924,6 +4040,42 @@ }, "204": { "description": "InterfaceUnitCharges 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": [ @@ -3006,6 +4158,42 @@ "schema": { "$ref": "#/definitions/changedInterfaceUnitCharges" } + }, + "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": [ @@ -3102,6 +4290,42 @@ }, "204": { "description": "HotelInterfaceDetails 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": [ @@ -3161,6 +4385,42 @@ }, "204": { "description": "HotelInterfaceControllerRegistry 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": [ @@ -3288,6 +4548,42 @@ }, "204": { "description": "HotelInterfaceErrors 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": [ @@ -3415,6 +4711,42 @@ }, "204": { "description": "HotelInterfaceFailedMessages 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": [ @@ -3481,6 +4813,42 @@ "schema": { "$ref": "#/definitions/changedInterfaceRight" } + }, + "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": [ @@ -3595,6 +4963,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3680,6 +5084,42 @@ }, "204": { "description": "InterfaceRights 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": [ @@ -3807,6 +5247,42 @@ }, "204": { "description": "HotelInterfaceSchemas 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": [ @@ -3906,6 +5382,42 @@ }, "204": { "description": "ExternalDatabaseAvailableProperties 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": [ @@ -3958,6 +5470,42 @@ }, "204": { "description": "InterfaceMachines 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": [ @@ -4033,6 +5581,42 @@ "schema": { "$ref": "#/definitions/changedInterfaceMachine" } + }, + "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": [ @@ -4121,6 +5705,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4187,6 +5807,42 @@ }, "204": { "description": "UDFMappings 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": [ @@ -4251,6 +5907,42 @@ "schema": { "$ref": "#/definitions/changedUDFMapping" } + }, + "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": [ @@ -6396,6 +8088,10 @@ "minLength": 0, "maxLength": 200 }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" + }, "location": { "description": "Location of a workstation.", "type": "string", @@ -8297,4 +9993,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/inv.json b/rest-api-specs/property/inv.json index 468c8aa..d6b7cd9 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -276,6 +276,42 @@ }, "204": { "description": "BlockInventoryStatistics 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": [ @@ -533,6 +569,42 @@ }, "204": { "description": "BlockInventoryStatistics 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": [ @@ -660,6 +732,42 @@ }, "204": { "description": "HotelInventory 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": [ @@ -916,6 +1024,42 @@ }, "204": { "description": "InventoryStatistics 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": [ @@ -1095,6 +1239,42 @@ }, "204": { "description": "ItemInventory 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": [ @@ -1170,6 +1350,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1241,6 +1457,42 @@ }, "204": { "description": "HoldItemsInventory 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": [ @@ -1314,6 +1566,42 @@ "schema": { "$ref": "#/definitions/holdItemInventory" } + }, + "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": [ @@ -1389,6 +1677,42 @@ "schema": { "$ref": "#/definitions/sellLimitResponse" } + }, + "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": [ @@ -1464,6 +1788,42 @@ "schema": { "$ref": "#/definitions/sellLimitByDateResponse" } + }, + "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": [ @@ -1530,6 +1890,42 @@ "schema": { "$ref": "#/definitions/releasedItemInventoryHeld" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ diff --git a/rest-api-specs/property/invasync.json b/rest-api-specs/property/invasync.json index 56afad6..0825b98 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -44,6 +44,42 @@ } }, "description": "Location of process status resource" + }, + "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" } }, "parameters": [ @@ -147,6 +183,42 @@ } }, "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "parameters": [ @@ -215,6 +287,42 @@ "schema": { "$ref": "#/definitions/revenueInventoryStatisticsDetails" } + }, + "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" } }, "parameters": [ @@ -289,6 +397,42 @@ } }, "description": "Location of process status resource" + }, + "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" } }, "parameters": [ @@ -392,6 +536,42 @@ } }, "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "parameters": [ @@ -463,6 +643,42 @@ }, "204": { "description": "SetSellLimitByDate 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" } }, "parameters": [ diff --git a/rest-api-specs/property/lms.json b/rest-api-specs/property/lms.json index f3f4911..6d71b0b 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -74,6 +74,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -146,6 +182,42 @@ }, "204": { "description": "ActivityLocations 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": [ @@ -221,6 +293,42 @@ "schema": { "$ref": "#/definitions/changeActivityLocationsRS" } + }, + "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": [ @@ -288,6 +396,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -363,6 +507,42 @@ "schema": { "$ref": "#/definitions/copyActivityLocationsRS" } + }, + "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": [ @@ -429,6 +609,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -512,6 +728,42 @@ }, "204": { "description": "ActivityStatusCodes 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": [ @@ -587,6 +839,42 @@ "schema": { "$ref": "#/definitions/changeActivityStatusCodesRS" } + }, + "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": [ @@ -654,6 +942,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -728,6 +1052,42 @@ }, "204": { "description": "ActivityTypes not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -792,6 +1152,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -867,6 +1263,42 @@ "schema": { "$ref": "#/definitions/changeActivityTypesRS" } + }, + "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": [ @@ -934,6 +1366,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1009,6 +1477,42 @@ "schema": { "$ref": "#/definitions/copyActivityTypesRS" } + }, + "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": [ @@ -1181,6 +1685,42 @@ }, "204": { "description": "ActivityBookings 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": [ @@ -1265,6 +1805,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1347,6 +1923,42 @@ "schema": { "$ref": "#/definitions/activityBookingModified" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1431,6 +2043,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1515,6 +2163,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3101,4 +3785,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/lov.json b/rest-api-specs/property/lov.json index c295911..28d83fd 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -60,6 +60,42 @@ }, "204": { "description": "LOVNames 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": [ @@ -178,6 +214,42 @@ }, "204": { "description": "MembershipClassTypesLOV 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": [ @@ -283,6 +355,42 @@ }, "204": { "description": "PrintersLOV 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": [ @@ -384,6 +492,42 @@ }, "204": { "description": "BlockBookingStatusesLOV 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": [ @@ -485,107 +629,42 @@ }, "204": { "description": "BlockCurrentStatusesLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/bookingChannels/{bookingChannelCodes}/gdsRoomCategoryTemplates": { - "get": { - "summary": "Return list of values for gds room category templates", - "description": "Use this API to return the list of values for gds room category templates based on search criteria such as bookingChannelCodes, includeInactiveFlag, parameterName, parameterValue.OperationId:getGdsRoomCategoryTemplatesLOV
", - "operationId": "getGdsRoomCategoryTemplatesLOV", - "parameters": [ - { - "name": "bookingChannelCodes", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'bookingChannelCodes' which is required to fetch GdsRoomCategoryTemplates 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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "GdsRoomCategoryTemplatesLOV not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -599,20 +678,20 @@ ] } }, - "/listOfValues/bookingChannels/{bookingChannelCode}/gdsGuaranteeCodes": { + "/listOfValues/bookingChannels/{bookingChannelCodes}/gdsRoomCategoryTemplates": { "get": { - "summary": "Return list of values for gds guarantee codes", - "description": "Use this API to return the list of values for gds guarantee codes based on search criteria such as bookingChannelCode, includeInactiveFlag, parameterName, parameterValue.OperationId:getGdsGuaranteeCodesLOV
", - "operationId": "getGdsGuaranteeCodesLOV", + "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": [ { - "name": "bookingChannelCode", + "name": "bookingChannelCodes", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'bookingChannelCode' which is required to fetch GdsGuaranteeCodes LOV" + "description": "Value of the parameter 'bookingChannelCodes' which is required to fetch GdsRoomCategoryTemplates LOV" }, { "name": "includeInactiveFlag", @@ -686,108 +765,43 @@ } }, "204": { - "description": "GdsGuaranteeCodesLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/bookingChannels/{bookingChannelCode}/gdsRateCategories": { - "get": { - "summary": "Return list of values for gds rate categories", - "description": "Use this API to return the list of values for gds rate categories based on search criteria such as bookingChannelCode, includeInactiveFlag, parameterName, parameterValue.OperationId:getGdsRateCategoriesLOV
", - "operationId": "getGdsRateCategoriesLOV", - "parameters": [ - { - "name": "bookingChannelCode", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'bookingChannelCode' which is required to fetch GdsRateCategories LOV" + "description": "GdsRoomCategoryTemplatesLOV not found." }, - { - "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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "GdsRateCategoriesLOV not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -801,11 +815,11 @@ ] } }, - "/listOfValues/bookingChannels/{bookingChannelCode}/gdsRateLevels": { + "/listOfValues/bookingChannels/{bookingChannelCode}/gdsGuaranteeCodes": { "get": { - "summary": "Return list of values for gds rate levels", - "description": "Use this API to return the list of values for gds rate levels based on search criteria such as bookingChannelCode, includeInactiveFlag, parameterName, parameterValue.OperationId:getGdsRateLevelsLOV
", - "operationId": "getGdsRateLevelsLOV", + "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": [ { "name": "bookingChannelCode", @@ -814,7 +828,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'bookingChannelCode' which is required to fetch GdsRateLevels LOV" + "description": "Value of the parameter 'bookingChannelCode' which is required to fetch GdsGuaranteeCodes LOV" }, { "name": "includeInactiveFlag", @@ -888,7 +902,43 @@ } }, "204": { - "description": "GdsRateLevelsLOV not found." + "description": "GdsGuaranteeCodesLOV 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": [ @@ -902,11 +952,11 @@ ] } }, - "/listOfValues/bookingChannels/{bookingChannelCode}/templateBookingChannelRoomTypes": { + "/listOfValues/bookingChannels/{bookingChannelCode}/gdsRateCategories": { "get": { - "summary": "Return list of values for booking channel room type templates", - "description": " Use this API to return the list of values for booking channel room type templates based on search criteria such as bookingChannelCodes, includeInactiveFlag, parameterName, parameterValue.OperationId:getTemplateBookingChannelRoomTypesLOV
", - "operationId": "getTemplateBookingChannelRoomTypesLOV", + "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": [ { "name": "bookingChannelCode", @@ -915,7 +965,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'bookingChannelCode' which is required to fetch TemplateBookingChannelRoomTypes LOV" + "description": "Value of the parameter 'bookingChannelCode' which is required to fetch GdsRateCategories LOV" }, { "name": "includeInactiveFlag", @@ -989,7 +1039,43 @@ } }, "204": { - "description": "TemplateBookingChannelRoomTypesLOV not found." + "description": "GdsRateCategoriesLOV 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": [ @@ -1003,20 +1089,20 @@ ] } }, - "/listOfValues/bookingStatus/{bookingStatus}/blockNextStatuses": { + "/listOfValues/bookingChannels/{bookingChannelCode}/gdsRateLevels": { "get": { - "summary": "Return list of values for block next statuses", - "description": "Use this API to return the list of values for block next statuses based on search criteria such as bookingStatus, includeInactiveFlag, parameterName, parameterValue.OperationId:getBlockNextStatusesLOV
", - "operationId": "getBlockNextStatusesLOV", + "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": [ { - "name": "bookingStatus", + "name": "bookingChannelCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'bookingStatus' which is required to fetch BlockNextStatuses LOV" + "description": "Value of the parameter 'bookingChannelCode' which is required to fetch GdsRateLevels LOV" }, { "name": "includeInactiveFlag", @@ -1090,7 +1176,43 @@ } }, "204": { - "description": "BlockNextStatusesLOV not found." + "description": "GdsRateLevelsLOV 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": [ @@ -1104,11 +1226,148 @@ ] } }, - "/listOfValues/bookingStatus/{bookingStatus}/gridTypes": { + "/listOfValues/bookingChannels/{bookingChannelCode}/templateBookingChannelRoomTypes": { "get": { - "summary": "Return list of values for grid types", - "description": "Use this API to return the list of values for grid types based on search criteria such as bookingStatus, includeInactiveFlag, parameterName, parameterValue, excludeCodes.OperationId:getGridTypesLOV
", - "operationId": "getGridTypesLOV", + "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": [ + { + "name": "bookingChannelCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'bookingChannelCode' which is required to fetch TemplateBookingChannelRoomTypes 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": "TemplateBookingChannelRoomTypesLOV 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/bookingStatus/{bookingStatus}/blockNextStatuses": { + "get": { + "summary": "Return list of values for block next statuses", + "description": "Use this API to return the list of values for block next statuses based on search criteria such as bookingStatus, includeInactiveFlag, parameterName, parameterValue.OperationId:getBlockNextStatusesLOV
", + "operationId": "getBlockNextStatusesLOV", "parameters": [ { "name": "bookingStatus", @@ -1117,7 +1376,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'bookingStatus' which is required to fetch GridTypes LOV" + "description": "Value of the parameter 'bookingStatus' which is required to fetch BlockNextStatuses LOV" }, { "name": "includeInactiveFlag", @@ -1191,7 +1450,43 @@ } }, "204": { - "description": "GridTypesLOV not found." + "description": "BlockNextStatusesLOV 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": [ @@ -1205,20 +1500,20 @@ ] } }, - "/listOfValues/breakOutId/{breakOutId}/taskSheet": { + "/listOfValues/bookingStatus/{bookingStatus}/gridTypes": { "get": { - "summary": "Return list of values for task sheets", - "description": "Use this API to return the list of values for task sheets based on search criteria such as breakOutId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTaskSheetLOV
", - "operationId": "getTaskSheetLOV", + "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": [ { - "name": "breakOutId", + "name": "bookingStatus", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'breakOutId' which is required to fetch TaskSheet LOV" + "description": "Value of the parameter 'bookingStatus' which is required to fetch GridTypes LOV" }, { "name": "includeInactiveFlag", @@ -1292,7 +1587,43 @@ } }, "204": { - "description": "TaskSheetLOV not found." + "description": "GridTypesLOV 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": [ @@ -1306,20 +1637,20 @@ ] } }, - "/listOfValues/cashierId/{cashierId}/cashierHotels": { + "/listOfValues/breakOutId/{breakOutId}/taskSheet": { "get": { - "summary": "Return list of values for cashier hotels", - "description": "Use this API to return the list of values for cashier hotels based on search criteria such as cashierId, includeInactiveFlag, parameterName, parameterValue.OperationId:getCashierHotelsLOV
", - "operationId": "getCashierHotelsLOV", + "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": [ { - "name": "cashierId", + "name": "breakOutId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'cashierId' which is required to fetch CashierHotels LOV" + "description": "Value of the parameter 'breakOutId' which is required to fetch TaskSheet LOV" }, { "name": "includeInactiveFlag", @@ -1393,7 +1724,43 @@ } }, "204": { - "description": "CashierHotelsLOV not found." + "description": "TaskSheetLOV 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": [ @@ -1407,20 +1774,157 @@ ] } }, - "/listOfValues/catStatus/{catStatus}/blockCatNextStatuses": { + "/listOfValues/cashierId/{cashierId}/cashierHotels": { "get": { - "summary": "Return list of values for block cat next statuses", - "description": "Use this API to return the list of values for block cat next statuses based on search criteria such as catStatus, includeInactiveFlag, parameterName, parameterValue.OperationId:getBlockCatNextStatusesLOV
", - "operationId": "getBlockCatNextStatusesLOV", + "summary": "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": [ { - "name": "catStatus", + "name": "cashierId", "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 'cashierId' which is required to fetch CashierHotels 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": "CashierHotelsLOV 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/catStatus/{catStatus}/blockCatNextStatuses": { + "get": { + "summary": "Return list of values for block cat next statuses", + "description": "Use this API to return the list of values for block cat next statuses based on search criteria such as catStatus, includeInactiveFlag, parameterName, parameterValue.OperationId:getBlockCatNextStatusesLOV
", + "operationId": "getBlockCatNextStatusesLOV", + "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", @@ -1495,6 +1999,42 @@ }, "204": { "description": "BlockCatNextStatusesLOV 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": [ @@ -1596,6 +2136,42 @@ }, "204": { "description": "UserDbFunctionsLOV 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": [ @@ -1714,6 +2290,42 @@ }, "204": { "description": "CateringBudTypesLOV 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": [ @@ -1815,6 +2427,42 @@ }, "204": { "description": "HotelsForSnCLOV 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": [ @@ -1916,6 +2564,42 @@ }, "204": { "description": "ChainLanguagesLOV 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": [ @@ -2026,6 +2710,42 @@ }, "204": { "description": "PreferenceSubgroupsLOV 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": [ @@ -2136,6 +2856,42 @@ }, "204": { "description": "ScreenStyleCodesLOV 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": [ @@ -2255,6 +3011,42 @@ }, "204": { "description": "ScreenCodesLOV 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": [ @@ -2356,6 +3148,42 @@ }, "204": { "description": "FieldNameLOV 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": [ @@ -2457,6 +3285,42 @@ }, "204": { "description": "BookingChannelRoomTypesLOV 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": [ @@ -2558,6 +3422,42 @@ }, "204": { "description": "GdsHotelsLOV 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": [ @@ -2659,6 +3559,42 @@ }, "204": { "description": "CateringCodesLOV 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": [ @@ -2760,6 +3696,42 @@ }, "204": { "description": "PostalCodesLOV 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": [ @@ -2861,6 +3833,42 @@ }, "204": { "description": "ToPostalCodesLOV 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": [ @@ -2962,6 +3970,42 @@ }, "204": { "description": "ExchangeTypesLOV 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": [ @@ -3063,6 +4107,42 @@ }, "204": { "description": "CurrencyFormatsLOV 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": [ @@ -3164,6 +4244,42 @@ }, "204": { "description": "NoteTypesLOV 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": [ @@ -3292,6 +4408,42 @@ }, "204": { "description": "DeviceCodeMappingValuesLOV 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": [ @@ -3393,6 +4545,42 @@ }, "204": { "description": "ECertificateGroupEntityLOV 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": [ @@ -3494,6 +4682,42 @@ }, "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": [ @@ -3595,6 +4819,42 @@ }, "204": { "description": "ADSStatusLOV 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": [ @@ -3696,6 +4956,42 @@ }, "204": { "description": "CateringStatusCodesLOV 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": [ @@ -3797,6 +5093,42 @@ }, "204": { "description": "EventStatusCodesLOV 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": [ @@ -3907,6 +5239,42 @@ }, "204": { "description": "GdsConvAmenityCodesLOV 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": [ @@ -4012,107 +5380,42 @@ }, "204": { "description": "TemplateTransactionSubgroupsLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/fieldType/{fieldType}/globalAlertFunction": { - "get": { - "summary": "Return list of values for global alert functions", - "description": "Use this API to return the list of values for global alert functions based on search criteria such as fieldType, includeInactiveFlag, parameterName, parameterValue.OperationId:getGlobalAlertFunctionLOV
", - "operationId": "getGlobalAlertFunctionLOV", - "parameters": [ - { - "name": "fieldType", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'fieldType' which is required to fetch GlobalAlertFunction 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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "GlobalAlertFunctionLOV not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4126,29 +5429,20 @@ ] } }, - "/listOfValues/functionName/{functionName}/category/{category}/userDbFunctionArgs": { + "/listOfValues/fieldType/{fieldType}/globalAlertFunction": { "get": { - "summary": "Return list of values for user database function arguments", - "description": "Use this API to return the list of values for user database function arguments based on search criteria such as category, functionName, includeInactiveFlag, parameterName, parameterValue.OperationId:getUserDbFunctionArgsLOV
", - "operationId": "getUserDbFunctionArgsLOV", + "summary": "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": "category", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'category' which is required to fetch UserDbFunctionArgs LOV" - }, - { - "name": "functionName", + "name": "fieldType", "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 'fieldType' which is required to fetch GlobalAlertFunction LOV" }, { "name": "includeInactiveFlag", @@ -4222,7 +5516,43 @@ } }, "204": { - "description": "UserDbFunctionArgsLOV not found." + "description": "GlobalAlertFunctionLOV 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": [ @@ -4236,29 +5566,29 @@ ] } }, - "/listOfValues/gdsHost/{gdsHost}/cardType/{cardType}/channelCardTypeMappingChannelCardType": { + "/listOfValues/functionName/{functionName}/category/{category}/userDbFunctionArgs": { "get": { - "summary": "Return list of values for channel card type mappings", - "description": "Use this API to return the list of values for channel card type mappings based on search criteria such as cardType, gdsHost, includeInactiveFlag, parameterName, parameterValue.OperationId:getChannelCardTypeMappingChannelCardTypeLOV
", - "operationId": "getChannelCardTypeMappingChannelCardTypeLOV", + "summary": "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": "cardType", + "name": "category", "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 'category' which is required to fetch UserDbFunctionArgs LOV" }, { - "name": "gdsHost", + "name": "functionName", "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 'functionName' which is required to fetch UserDbFunctionArgs LOV" }, { "name": "includeInactiveFlag", @@ -4332,7 +5662,43 @@ } }, "204": { - "description": "ChannelCardTypeMappingChannelCardTypeLOV not found." + "description": "UserDbFunctionArgsLOV 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": [ @@ -4346,20 +5712,29 @@ ] } }, - "/listOfValues/groupName/{groupName}/repGroupReports": { + "/listOfValues/gdsHost/{gdsHost}/cardType/{cardType}/channelCardTypeMappingChannelCardType": { "get": { - "summary": "Return list of values for rep group reports", - "description": "Use this API to return the list of values for rep group reports based on search criteria such as groupName, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepGroupReportsLOV
", - "operationId": "getRepGroupReportsLOV", + "summary": "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": "groupName", + "name": "cardType", "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 '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", @@ -4433,7 +5808,43 @@ } }, "204": { - "description": "RepGroupReportsLOV not found." + "description": "ChannelCardTypeMappingChannelCardTypeLOV 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": [ @@ -4447,29 +5858,20 @@ ] } }, - "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequency": { + "/listOfValues/groupName/{groupName}/repGroupReports": { "get": { - "summary": "Return list of values for frequency", - "description": "Use this API to return the list of values for frequency based on search criteria such as defaultDepartureTask, guestRequested, includeInactiveFlag, parameterName, parameterValue.OperationId:getFrequencyLOV
", - "operationId": "getFrequencyLOV", + "summary": "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": "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": "groupName", "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 'groupName' which is required to fetch RepGroupReports LOV" }, { "name": "includeInactiveFlag", @@ -4543,7 +5945,43 @@ } }, "204": { - "description": "FrequencyLOV not found." + "description": "RepGroupReportsLOV 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": [ @@ -4557,11 +5995,11 @@ ] } }, - "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequencyType": { + "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequency": { "get": { - "summary": "Return list of values for frequency types", - "description": "Use this API to return the list of values for frequency types based on search criteria such as defaultDepartureTask, guestRequested, includeInactiveFlag, parameterName, parameterValue.OperationId:getFrequencyTypeLOV
", - "operationId": "getFrequencyTypeLOV", + "summary": "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": "defaultDepartureTask", @@ -4570,7 +6008,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'defaultDepartureTask' which is required to fetch FrequencyType LOV" + "description": "Value of the parameter 'defaultDepartureTask' which is required to fetch Frequency LOV" }, { "name": "guestRequested", @@ -4579,7 +6017,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'guestRequested' which is required to fetch FrequencyType LOV" + "description": "Value of the parameter 'guestRequested' which is required to fetch Frequency LOV" }, { "name": "includeInactiveFlag", @@ -4653,7 +6091,43 @@ } }, "204": { - "description": "FrequencyTypeLOV not found." + "description": "FrequencyLOV 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": [ @@ -4667,20 +6141,29 @@ ] } }, - "/listOfValues/hotelCodeList/{hotelCodeList}/queueName": { + "/listOfValues/guestRequested/{guestRequested}/defaultDepartureTask/{defaultDepartureTask}/frequencyType": { "get": { - "summary": "Return list of values for queue names", - "description": "Use this API to return the list of values for queue names based on search criteria such as hotelCodeList, includeInactiveFlag, parameterName, parameterValue.OperationId:getQueueNameLOV
", - "operationId": "getQueueNameLOV", + "summary": "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": "hotelCodeList", + "name": "defaultDepartureTask", "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 'defaultDepartureTask' which is required to fetch FrequencyType LOV" + }, + { + "name": "guestRequested", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'guestRequested' which is required to fetch FrequencyType LOV" }, { "name": "includeInactiveFlag", @@ -4754,7 +6237,43 @@ } }, "204": { - "description": "QueueNameLOV not found." + "description": "FrequencyTypeLOV 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": [ @@ -4768,11 +6287,11 @@ ] } }, - "/listOfValues/hotelCodeList/{hotelCodeList}/repRoomTypeMultiHotel": { + "/listOfValues/hotelCodeList/{hotelCodeList}/queueName": { "get": { - "summary": "Return list of values for rep room type multi hotel", - "description": "Use this API to return the list of values for rep room type multi hotel based on search criteria such as hotelCodeList, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepRoomTypeMultiHotelLOV
", - "operationId": "getRepRoomTypeMultiHotelLOV", + "summary": "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": "hotelCodeList", @@ -4781,7 +6300,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelCodeList' which is required to fetch RepRoomTypeMultiHotel LOV" + "description": "Value of the parameter 'hotelCodeList' which is required to fetch QueueName LOV" }, { "name": "includeInactiveFlag", @@ -4855,7 +6374,43 @@ } }, "204": { - "description": "RepRoomTypeMultiHotelLOV not found." + "description": "QueueNameLOV 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": [ @@ -4869,11 +6424,11 @@ ] } }, - "/listOfValues/hotelCodeList/{hotelCodeList}/roomClassMultiProperty": { + "/listOfValues/hotelCodeList/{hotelCodeList}/repRoomTypeMultiHotel": { "get": { - "summary": "Return list of values for room class multi property", - "description": "Use this API to return the list of values for room class multi property based on search criteria such as hotelCodeList, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomClassMultiPropertyLOV
", - "operationId": "getRoomClassMultiPropertyLOV", + "summary": "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": "hotelCodeList", @@ -4882,7 +6437,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelCodeList' which is required to fetch RoomClassMultiProperty LOV" + "description": "Value of the parameter 'hotelCodeList' which is required to fetch RepRoomTypeMultiHotel LOV" }, { "name": "includeInactiveFlag", @@ -4956,7 +6511,43 @@ } }, "204": { - "description": "RoomClassMultiPropertyLOV not found." + "description": "RepRoomTypeMultiHotelLOV 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": [ @@ -4970,20 +6561,20 @@ ] } }, - "/listOfValues/hotelCodesList/{hotelCodesList}/repOwnerCodes": { + "/listOfValues/hotelCodeList/{hotelCodeList}/roomClassMultiProperty": { "get": { - "summary": "Return list of values for rep owner codes", - "description": "Use this API to return the list of values for rep owner codes based on search criteria such as hotelCodeList, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepOwnerCodesLOV
", - "operationId": "getRepOwnerCodesLOV", + "summary": "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": "hotelCodesList", + "name": "hotelCodeList", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelCodesList' which is required to fetch RepOwnerCodes LOV" + "description": "Value of the parameter 'hotelCodeList' which is required to fetch RoomClassMultiProperty LOV" }, { "name": "includeInactiveFlag", @@ -5057,7 +6648,43 @@ } }, "204": { - "description": "RepOwnerCodesLOV not found." + "description": "RoomClassMultiPropertyLOV 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": [ @@ -5071,20 +6698,157 @@ ] } }, - "/listOfValues/hotels/{hotelId}/activities": { + "/listOfValues/hotelCodesList/{hotelCodesList}/repOwnerCodes": { "get": { - "summary": "Return list of values for hotel activities", - "description": "Use this API to return the list of values for activities for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getActivitiesLOV
", - "operationId": "getActivitiesLOV", + "summary": "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": "hotelId", + "name": "hotelCodesList", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch Activities LOV" + "description": "Value of the parameter 'hotelCodesList' which is required to fetch RepOwnerCodes 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": "RepOwnerCodesLOV 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}/activities": { + "get": { + "summary": "Return list of values for hotel activities", + "description": "Use this API to return the list of values for activities for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getActivitiesLOV
", + "operationId": "getActivitiesLOV", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch Activities LOV" }, { "name": "includeInactiveFlag", @@ -5159,6 +6923,42 @@ }, "204": { "description": "ActivitiesLOV 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": [ @@ -5260,6 +7060,42 @@ }, "204": { "description": "ActivityConfigTypesLOV 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": [ @@ -5370,6 +7206,42 @@ }, "204": { "description": "UserLogActivityTypesLOV 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": [ @@ -5471,6 +7343,42 @@ }, "204": { "description": "ActivityLocationsLOV 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": [ @@ -5572,6 +7480,42 @@ }, "204": { "description": "ActivityStatusLOV 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": [ @@ -5673,6 +7617,42 @@ }, "204": { "description": "ActivityTypesLOV 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": [ @@ -5810,6 +7790,42 @@ }, "204": { "description": "ReservationPackagesLOV 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": [ @@ -5947,6 +7963,42 @@ }, "204": { "description": "ReservationPackagesGroupItemsLOV 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": [ @@ -6048,6 +8100,42 @@ }, "204": { "description": "AgentAccountsLOV 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": [ @@ -6149,6 +8237,42 @@ }, "204": { "description": "AgentSourceCitiesLOV not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6250,6 +8374,42 @@ }, "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": [ @@ -6351,6 +8511,42 @@ }, "204": { "description": "AlertCodesLOV 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": [ @@ -6452,6 +8648,42 @@ }, "204": { "description": "AlternateHotelCodesLOV 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": [ @@ -6553,6 +8785,42 @@ }, "204": { "description": "AmenitiesLOV 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": [ @@ -6654,6 +8922,42 @@ }, "204": { "description": "ARAccountTypesLOV 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": [ @@ -6755,6 +9059,42 @@ }, "204": { "description": "ARCreditCardsLOV 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": [ @@ -6856,6 +9196,42 @@ }, "204": { "description": "ArrangementCodeLOV 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": [ @@ -6966,6 +9342,42 @@ }, "204": { "description": "PackageArrangementAssociationLOV 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": [ @@ -7094,6 +9506,42 @@ }, "204": { "description": "BlockRatesLOV 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": [ @@ -7213,6 +9661,42 @@ }, "204": { "description": "ReservationTicketsCodesLOV 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": [ @@ -7323,6 +9807,42 @@ }, "204": { "description": "BlockCodesByArrivalDateLOV 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": [ @@ -7424,6 +9944,42 @@ }, "204": { "description": "ArticleCodesLOV 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": [ @@ -7525,6 +10081,42 @@ }, "204": { "description": "AttractionsLOV 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": [ @@ -7626,6 +10218,42 @@ }, "204": { "description": "AuthorizerLOV 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": [ @@ -7727,6 +10355,42 @@ }, "204": { "description": "AvailableProfileOwnerRoomsLOV 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": [ @@ -7828,107 +10492,42 @@ }, "204": { "description": "AvailableScriptLanguagesLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/awardCodes": { - "get": { - "summary": "Return list of values for hotel award codes", - "description": "Use this API to return the list of values for award codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getAwardCodesLOV
", - "operationId": "getAwardCodesLOV", - "parameters": [ - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch AwardCodes 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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "AwardCodesLOV not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7942,11 +10541,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/awardCodesMultiHotel": { + "/listOfValues/hotels/{hotelId}/awardCodes": { "get": { - "summary": "Return list of values for hotel award codes multi hotel", - "description": "Use this API to return the list of values for award codes multi hotel for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getAwardCodesMultiHotelLOV
", - "operationId": "getAwardCodesMultiHotelLOV", + "summary": "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", @@ -7955,7 +10554,144 @@ "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 AwardCodes 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": "AwardCodesLOV 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}/awardCodesMultiHotel": { + "get": { + "summary": "Return list of values for hotel award codes multi hotel", + "description": "Use this API to return the list of values for award codes multi hotel for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getAwardCodesMultiHotelLOV
", + "operationId": "getAwardCodesMultiHotelLOV", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch AwardCodesMultiHotel LOV" }, { "name": "includeInactiveFlag", @@ -8030,6 +10766,42 @@ }, "204": { "description": "AwardCodesMultiHotelLOV 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": [ @@ -8131,6 +10903,42 @@ }, "204": { "description": "AwardMktgCodesLOV 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": [ @@ -8232,6 +11040,42 @@ }, "204": { "description": "BankAccountsLOV 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": [ @@ -8333,6 +11177,42 @@ }, "204": { "description": "BankAccountsForReportsLOV 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": [ @@ -8434,6 +11314,42 @@ }, "204": { "description": "BanquetPrintingMethodLOV 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": [ @@ -8548,6 +11464,42 @@ }, "204": { "description": "EndOfDayReportsLOV 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": [ @@ -8667,6 +11619,42 @@ }, "204": { "description": "BlockCodesLOV 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": [ @@ -8786,6 +11774,42 @@ }, "204": { "description": "BlockIdsLOV 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": [ @@ -8918,6 +11942,42 @@ }, "204": { "description": "BlockRateCodesLOV 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": [ @@ -9037,6 +12097,42 @@ }, "204": { "description": "ResStatReportRateCodeLOV 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": [ @@ -9156,6 +12252,42 @@ }, "204": { "description": "MembershipPromotionsLOV 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": [ @@ -9257,6 +12389,42 @@ }, "204": { "description": "BillingInstructionsLOV 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": [ @@ -9358,6 +12526,42 @@ }, "204": { "description": "BlockCodesFinOperationsLOV 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": [ @@ -9459,6 +12663,42 @@ }, "204": { "description": "BlockEventsLOV 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": [ @@ -9569,6 +12809,42 @@ }, "204": { "description": "BlockEventIdsLOV 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": [ @@ -9670,6 +12946,42 @@ }, "204": { "description": "BlockModeLovLOV 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": [ @@ -9771,6 +13083,42 @@ }, "204": { "description": "BlockPaymentMethodsLOV 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": [ @@ -9890,6 +13238,42 @@ }, "204": { "description": "ChannelConfigRateCodesLOV 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": [ @@ -10000,6 +13384,42 @@ }, "204": { "description": "BlockReservationTypesLOV 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": [ @@ -10101,6 +13521,42 @@ }, "204": { "description": "BookingTypesIndividualsLOV 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": [ @@ -10211,6 +13667,42 @@ }, "204": { "description": "HKTaskSheetsNoLOV 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": [ @@ -10321,6 +13813,42 @@ }, "204": { "description": "RevenueBucketTrxCodesLOV not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10422,6 +13950,42 @@ }, "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": [ @@ -10523,6 +14087,42 @@ }, "204": { "description": "BudRateCodesLOV 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": [ @@ -10633,6 +14233,42 @@ }, "204": { "description": "HKScheduledAttendantsLOV 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": [ @@ -10734,6 +14370,42 @@ }, "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": [ @@ -10835,6 +14507,42 @@ }, "204": { "description": "CashRegisterIDLOV 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": [ @@ -10945,6 +14653,42 @@ }, "204": { "description": "CatBudTypeEventCodesLOV 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": [ @@ -11055,6 +14799,42 @@ }, "204": { "description": "CatBudTypeMarketCodesLOV 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": [ @@ -11165,6 +14945,42 @@ }, "204": { "description": "CatBudTypeMealCodesLOV 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": [ @@ -11275,6 +15091,42 @@ }, "204": { "description": "CatBudTypeRevenueCodesLOV 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": [ @@ -11376,6 +15228,42 @@ }, "204": { "description": "CateringPackagePriceCodesLOV 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": [ @@ -11486,6 +15374,42 @@ }, "204": { "description": "BookingChannelRatePlansLOV 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": [ @@ -11587,6 +15511,42 @@ }, "204": { "description": "ChannelCardTypeMappingCardTypeLOV 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": [ @@ -11688,6 +15648,42 @@ }, "204": { "description": "ChannelCardTypeMappingGdsHostLOV not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11789,6 +15785,42 @@ }, "204": { "description": "CommissionCodeLOV 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": [ @@ -11890,6 +15922,42 @@ }, "204": { "description": "CommissionTxnCodesLOV 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": [ @@ -11991,6 +16059,42 @@ }, "204": { "description": "CompAuthorizersLOV not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12092,6 +16196,42 @@ }, "204": { "description": "CompTypesLOV 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": [ @@ -12193,6 +16333,42 @@ }, "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": [ @@ -12294,6 +16470,42 @@ }, "204": { "description": "ConfLetterReportsLOV 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": [ @@ -12404,6 +16616,42 @@ }, "204": { "description": "ExportMappingCodesToLinkLOV 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": [ @@ -12514,6 +16762,42 @@ }, "204": { "description": "HotelContactCommMethodLOV 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": [ @@ -12615,116 +16899,42 @@ }, "204": { "description": "CreditCardTypesLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/criteria/{criteria}/stageProfiles": { - "get": { - "summary": "Return list of values for hotel stage profiles", - "description": "Use this API to return the list of values for stage profiles for a specific property based on search criteria such as criteria, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getStageProfilesLOV
", - "operationId": "getStageProfilesLOV", - "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", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch StageProfiles LOV" + "400": { + "$ref": "#/responses/400" }, - { - "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" + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/authKey" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-app-key" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-hotelid" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-externalsystem" + "415": { + "$ref": "#/responses/415" }, - { - "$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" - } + "500": { + "$ref": "#/responses/500" }, - "204": { - "description": "StageProfilesLOV not found." + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12738,55 +16948,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/currentRateCode/{currentRateCode}/currencyCode/{currencyCode}/daily/{daily}/tiered/{tiered}/configBaseRatePlans": { + "/listOfValues/hotels/{hotelId}/criteria/{criteria}/stageProfiles": { "get": { - "summary": "Return list of values for hotel configuration base rate plans", - "description": "Use this API to return the list of values for configuration base rate plans for a specific property based on search criteria such as tiered, daily, currencyCode, currentRateCode, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getConfigBaseRatePlansLOV
", - "operationId": "getConfigBaseRatePlansLOV", + "summary": "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": "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", + "name": "criteria", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'currentRateCode' which is required to fetch ConfigBaseRatePlans LOV" + "description": "Value of the parameter 'criteria' which is required to fetch StageProfiles LOV" }, { "name": "hotelId", @@ -12795,7 +16970,188 @@ "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 StageProfiles 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": "StageProfilesLOV 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}/currentRateCode/{currentRateCode}/currencyCode/{currencyCode}/daily/{daily}/tiered/{tiered}/configBaseRatePlans": { + "get": { + "summary": "Return list of values for hotel configuration base rate plans", + "description": "Use this API to return the list of values for configuration base rate plans for a specific property based on search criteria such as tiered, daily, currencyCode, currentRateCode, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getConfigBaseRatePlansLOV
", + "operationId": "getConfigBaseRatePlansLOV", + "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", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch ConfigBaseRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -12870,6 +17226,42 @@ }, "204": { "description": "ConfigBaseRatePlansLOV 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": [ @@ -13006,6 +17398,42 @@ }, "204": { "description": "ConfigAdvDynamicBaseRatePlansLOV 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": [ @@ -13107,6 +17535,42 @@ }, "204": { "description": "CustomNumberConfigCodesLOV 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": [ @@ -13217,6 +17681,42 @@ }, "204": { "description": "CustomRoomTranslationLOV 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": [ @@ -13327,6 +17827,42 @@ }, "204": { "description": "QuickTextsLOV 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": [ @@ -13428,6 +17964,42 @@ }, "204": { "description": "DeviceLocationsLOV 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": [ @@ -13529,6 +18101,42 @@ }, "204": { "description": "DietaryPreferencesLOV 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": [ @@ -13630,6 +18238,42 @@ }, "204": { "description": "ECouponLOV 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": [ @@ -13731,6 +18375,42 @@ }, "204": { "description": "ECouponRateCodesLOV 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": [ @@ -13832,6 +18512,42 @@ }, "204": { "description": "EcouponResvRoomLOV 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": [ @@ -13933,6 +18649,42 @@ }, "204": { "description": "EventGroupsLOV 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": [ @@ -14034,6 +18786,42 @@ }, "204": { "description": "EventLocationsLOV 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": [ @@ -14144,6 +18932,42 @@ }, "204": { "description": "CurrencyExchangeRatesLOV 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": [ @@ -14245,6 +19069,42 @@ }, "204": { "description": "ExportMappingTypeCodesLOV 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": [ @@ -14364,6 +19224,42 @@ }, "204": { "description": "BusinessEventActionTypeLOV 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": [ @@ -14465,6 +19361,42 @@ }, "204": { "description": "ExternalReferenceTypesLOV 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": [ @@ -14566,6 +19498,42 @@ }, "204": { "description": "FacilityCodesLOV 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": [ @@ -14676,6 +19644,42 @@ }, "204": { "description": "FacilityCodesReservationLOV 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": [ @@ -14777,6 +19781,42 @@ }, "204": { "description": "FacilityTasksLOV 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": [ @@ -14887,6 +19927,42 @@ }, "204": { "description": "AvailableExportTemplatesLOV 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": [ @@ -14988,6 +20064,42 @@ }, "204": { "description": "FiscalPaymentMethodsLOV 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": [ @@ -15098,6 +20210,42 @@ }, "204": { "description": "RepFiscalMonthsLOV 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": [ @@ -15208,107 +20356,42 @@ }, "204": { "description": "RepFiscalWeeksLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/fixedChargesTransactionCodes": { - "get": { - "summary": "Return list of values for hotel fixed charges transaction codes", - "description": "Use this API to return the list of values for fixed charges transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getFixedChargesTransactionCodesLOV
", - "operationId": "getFixedChargesTransactionCodesLOV", - "parameters": [ - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch FixedChargesTransactionCodes 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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "FixedChargesTransactionCodesLOV not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15322,11 +20405,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/floors": { + "/listOfValues/hotels/{hotelId}/fixedChargesTransactionCodes": { "get": { - "summary": "Return list of values for hotel floors", - "description": "Use this API to return the list of values for floors for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getFloorsLOV
", - "operationId": "getFloorsLOV", + "summary": "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", @@ -15335,7 +20418,144 @@ "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 FixedChargesTransactionCodes 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": "FixedChargesTransactionCodesLOV 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}/floors": { + "get": { + "summary": "Return list of values for hotel floors", + "description": "Use this API to return the list of values for floors for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getFloorsLOV
", + "operationId": "getFloorsLOV", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch Floors LOV" }, { "name": "includeInactiveFlag", @@ -15410,6 +20630,42 @@ }, "204": { "description": "FloorsLOV 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": [ @@ -15511,6 +20767,42 @@ }, "204": { "description": "FolioStylesLOV 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": [ @@ -15612,6 +20904,42 @@ }, "204": { "description": "FolioTypesLOV 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": [ @@ -15713,6 +21041,42 @@ }, "204": { "description": "ForecastGroupsLOV 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": [ @@ -15823,6 +21187,42 @@ }, "204": { "description": "TaskBreakOutLOV 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": [ @@ -15942,6 +21342,42 @@ }, "204": { "description": "RepRoomsStatLOV 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": [ @@ -16052,6 +21488,42 @@ }, "204": { "description": "UpsellToRoomClassEditLOV 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": [ @@ -16153,6 +21625,42 @@ }, "204": { "description": "FromRoomNumberLOV 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": [ @@ -16263,6 +21771,42 @@ }, "204": { "description": "UpsellToRoomTypeEditLOV 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": [ @@ -16364,6 +21908,42 @@ }, "204": { "description": "GemMenuItemsLOV 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": [ @@ -16465,6 +22045,42 @@ }, "204": { "description": "GenericReportsLOV 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": [ @@ -16566,6 +22182,42 @@ }, "204": { "description": "GroupArrivalsLOV 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": [ @@ -16667,6 +22319,42 @@ }, "204": { "description": "GroupsLOV 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": [ @@ -16768,6 +22456,42 @@ }, "204": { "description": "GuestMessagesMultiHotelLOV 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": [ @@ -16869,6 +22593,42 @@ }, "204": { "description": "GuestMessagesQuickTextsLOV 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": [ @@ -16970,6 +22730,42 @@ }, "204": { "description": "HKAttendantsLOV 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": [ @@ -17071,6 +22867,42 @@ }, "204": { "description": "HKAttendantsMobileLOV 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": [ @@ -17172,6 +23004,42 @@ }, "204": { "description": "HkFloorsLOV 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": [ @@ -17273,6 +23141,42 @@ }, "204": { "description": "HkRoomTypesLOV 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": [ @@ -17374,6 +23278,42 @@ }, "204": { "description": "HkRoomsLOV 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": [ @@ -17475,6 +23415,42 @@ }, "204": { "description": "HKTaskBreakOutLOV 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": [ @@ -17576,6 +23552,42 @@ }, "204": { "description": "HKTaskCodesLOV not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17677,6 +23689,42 @@ }, "204": { "description": "HKTaskTemplatesLOV 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": [ @@ -17778,6 +23826,42 @@ }, "204": { "description": "HotelEventTypesLOV 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": [ @@ -17879,6 +23963,42 @@ }, "204": { "description": "HotelInterfaceImportRoomsLOV 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": [ @@ -17980,107 +24100,42 @@ }, "204": { "description": "HotelRateTierLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/houseKeepingRooms": { - "get": { - "summary": "Return list of values for hotel housekeeping rooms", - "description": "Use this API to return the list of values for housekeeping rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getHouseKeepingRoomsLOV
", - "operationId": "getHouseKeepingRoomsLOV", - "parameters": [ - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch HouseKeepingRooms 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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "HouseKeepingRoomsLOV not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -18094,11 +24149,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/houseKeepingSections": { + "/listOfValues/hotels/{hotelId}/houseKeepingRooms": { "get": { - "summary": "Return list of values for hotel housekeeping sections", - "description": "Use this API to return the list of values for housekeeping sections for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getHouseKeepingSectionsLOV
", - "operationId": "getHouseKeepingSectionsLOV", + "summary": "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", @@ -18107,7 +24162,144 @@ "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 HouseKeepingRooms 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": "HouseKeepingRoomsLOV 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}/houseKeepingSections": { + "get": { + "summary": "Return list of values for hotel housekeeping sections", + "description": "Use this API to return the list of values for housekeeping sections for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getHouseKeepingSectionsLOV
", + "operationId": "getHouseKeepingSectionsLOV", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch HouseKeepingSections LOV" }, { "name": "includeInactiveFlag", @@ -18182,6 +24374,42 @@ }, "204": { "description": "HouseKeepingSectionsLOV 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": [ @@ -18283,6 +24511,42 @@ }, "204": { "description": "HousekeepingCreditRulesLOV 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": [ @@ -18402,6 +24666,42 @@ }, "204": { "description": "IfcRightsViewLOV 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": [ @@ -18503,6 +24803,42 @@ }, "204": { "description": "ImbalanceVerificationTypesLOV 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": [ @@ -18613,6 +24949,42 @@ }, "204": { "description": "UpsellOccupancyLevelsLOV 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": [ @@ -18727,6 +25099,42 @@ }, "204": { "description": "SourceGroupsLOV 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": [ @@ -18828,6 +25236,42 @@ }, "204": { "description": "InterfaceAutoBalanceLOV 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": [ @@ -18929,6 +25373,42 @@ }, "204": { "description": "InterfaceDataRequestMarketCodeLOV 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": [ @@ -19030,6 +25510,42 @@ }, "204": { "description": "InterfaceDataRequestMarketGroupLOV 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": [ @@ -19131,6 +25647,42 @@ }, "204": { "description": "InterfaceDataRequestRoomClassLOV 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": [ @@ -19232,6 +25784,42 @@ }, "204": { "description": "InterfaceDataRequestRoomTypesLOV 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": [ @@ -19333,6 +25921,42 @@ }, "204": { "description": "InterfaceDataRequestSourceCodeLOV 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": [ @@ -19434,6 +26058,42 @@ }, "204": { "description": "InterfaceDataRequestSourceGroupLOV 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": [ @@ -19535,6 +26195,42 @@ }, "204": { "description": "InterfacePseudoRoomLOV 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": [ @@ -19636,6 +26332,42 @@ }, "204": { "description": "InterfaceResyncFunctionSpaceLOV 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": [ @@ -19737,6 +26469,42 @@ }, "204": { "description": "InterfaceResyncOwnerContractLOV 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": [ @@ -19838,6 +26606,42 @@ }, "204": { "description": "InterfaceResyncOwnerContractRoomLOV 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": [ @@ -19939,6 +26743,42 @@ }, "204": { "description": "InterfaceResyncProductsLOV 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": [ @@ -20040,6 +26880,42 @@ }, "204": { "description": "InterfaceTrxCodesAllChargesLOV 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": [ @@ -20141,6 +27017,42 @@ }, "204": { "description": "InterfaceTrxCodesMinibarLOV 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": [ @@ -20260,6 +27172,42 @@ }, "204": { "description": "AllowedHotelInterfaceRightsLOV 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": [ @@ -20361,6 +27309,42 @@ }, "204": { "description": "InvItemsClassesLOV 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": [ @@ -20462,6 +27446,42 @@ }, "204": { "description": "InvItemsPoolsLOV 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": [ @@ -20563,6 +27583,42 @@ }, "204": { "description": "InventoryItemTemplateItemsLOV 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": [ @@ -20664,6 +27720,42 @@ }, "204": { "description": "ItemClassesLOV 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": [ @@ -20765,6 +27857,42 @@ }, "204": { "description": "ItemCodesLOV 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": [ @@ -20875,6 +28003,42 @@ }, "204": { "description": "InventoryItemAttributesLOV 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": [ @@ -20985,6 +28149,42 @@ }, "204": { "description": "InventoryItemRatesLOV not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21095,6 +28295,42 @@ }, "204": { "description": "ItemPriceCodeLOV 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": [ @@ -21205,6 +28441,42 @@ }, "204": { "description": "ItemVendorLOV 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": [ @@ -21306,6 +28578,42 @@ }, "204": { "description": "JobTitlesLOV 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": [ @@ -21407,6 +28715,42 @@ }, "204": { "description": "KeyOptionsLOV 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": [ @@ -21508,6 +28852,42 @@ }, "204": { "description": "LicensesLOV 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": [ @@ -21609,6 +28989,42 @@ }, "204": { "description": "LocatorQuickTextsLOV 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": [ @@ -21719,6 +29135,42 @@ }, "204": { "description": "HotelInterfaceDataLineTypesLOV 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": [ @@ -21829,6 +29281,42 @@ }, "204": { "description": "InterfaceRevenueCodeLOV 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": [ @@ -21930,6 +29418,42 @@ }, "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": [ @@ -22031,6 +29555,42 @@ }, "204": { "description": "ManagersReportsLOV 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": [ @@ -22132,6 +29692,42 @@ }, "204": { "description": "MarketGroupsLOV 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": [ @@ -22233,6 +29829,42 @@ }, "204": { "description": "MarketSegmentLOV 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": [ @@ -22334,6 +29966,42 @@ }, "204": { "description": "MasterBlockLOV 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": [ @@ -22435,6 +30103,42 @@ }, "204": { "description": "MembershipAwardFinTrxLOV 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": [ @@ -22536,6 +30240,42 @@ }, "204": { "description": "MembershipAwardProductsLOV 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": [ @@ -22637,6 +30377,42 @@ }, "204": { "description": "MembershipAwardRateCodesLOV 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": [ @@ -22738,6 +30514,42 @@ }, "204": { "description": "MembershipAwardUpgradeRoomLOV 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": [ @@ -22839,6 +30651,42 @@ }, "204": { "description": "MembershipAwardUpgradeRoomGroupLOV 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": [ @@ -22949,6 +30797,42 @@ }, "204": { "description": "AwardPaymentLOV 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": [ @@ -23050,6 +30934,42 @@ }, "204": { "description": "MenuClassesLOV 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": [ @@ -23151,6 +31071,42 @@ }, "204": { "description": "MenuItemsLOV 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": [ @@ -23279,6 +31235,42 @@ }, "204": { "description": "BusinessEventActionTypeExtDBLOV 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": [ @@ -23398,6 +31390,42 @@ }, "204": { "description": "FormatLOV 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": [ @@ -23526,6 +31554,42 @@ }, "204": { "description": "TestUpsellRulesRateCodeLOV 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": [ @@ -23627,6 +31691,42 @@ }, "204": { "description": "OSAActivityTypesLOV 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": [ @@ -23728,6 +31828,42 @@ }, "204": { "description": "OXIInterfaceReferencesLOV 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": [ @@ -23829,6 +31965,42 @@ }, "204": { "description": "OXIInterfaceResortsLOV 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": [ @@ -23930,6 +32102,42 @@ }, "204": { "description": "OXIInterfacesLOV 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": [ @@ -24031,6 +32239,42 @@ }, "204": { "description": "PackForecastGroupCodeLOV 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": [ @@ -24132,6 +32376,42 @@ }, "204": { "description": "PaymentMethodsLOV 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": [ @@ -24233,6 +32513,42 @@ }, "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": [ @@ -24334,6 +32650,42 @@ }, "204": { "description": "PeriodSetupLOV 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": [ @@ -24435,6 +32787,42 @@ }, "204": { "description": "PeriodsSetupLOV 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": [ @@ -24545,208 +32933,42 @@ }, "204": { "description": "DepositCancelRulesLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/postingRoom": { - "get": { - "summary": "Return list of values for hotel posting rooms", - "description": "Use this API to return the list of values for posting rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getPostingRoomLOV
", - "operationId": "getPostingRoomLOV", - "parameters": [ - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PostingRoom 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" + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/x-hotelid" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-externalsystem" + "403": { + "$ref": "#/responses/403" }, - { - "$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": "PostingRoomLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/postingTransactionCodes": { - "get": { - "summary": "Return list of values for hotel posting transaction codes", - "description": "Use this API to return the list of values for posting transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getPostingTransactionCodesLOV
", - "operationId": "getPostingTransactionCodesLOV", - "parameters": [ - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch PostingTransactionCodes 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 + "404": { + "$ref": "#/responses/404" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "405": { + "$ref": "#/responses/405" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/authKey" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-app-key" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-hotelid" + "415": { + "$ref": "#/responses/415" }, - { - "$ref": "#/parameters/x-externalsystem" + "500": { + "$ref": "#/responses/500" }, - { - "$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" - } + "502": { + "$ref": "#/responses/502" }, - "204": { - "description": "PostingTransactionCodesLOV not found." + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -24760,11 +32982,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/prepaidCardInterfaces": { + "/listOfValues/hotels/{hotelId}/postingRoom": { "get": { - "summary": "Return list of values for hotel prepaid card interfaces", - "description": "Use this API to return the list of values for prepaid card interfaces for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getPrepaidCardInterfacesLOV
", - "operationId": "getPrepaidCardInterfacesLOV", + "summary": "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": "hotelId", @@ -24773,7 +32995,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 PostingRoom LOV" }, { "name": "includeInactiveFlag", @@ -24847,7 +33069,43 @@ } }, "204": { - "description": "PrepaidCardInterfacesLOV not found." + "description": "PostingRoomLOV 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": [ @@ -24861,11 +33119,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/priorities": { + "/listOfValues/hotels/{hotelId}/postingTransactionCodes": { "get": { - "summary": "Return list of values for hotel priorities", - "description": "Use this API to return the list of values for priorities for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getPrioritiesLOV
", - "operationId": "getPrioritiesLOV", + "summary": "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": "hotelId", @@ -24874,7 +33132,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 PostingTransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -24948,7 +33206,43 @@ } }, "204": { - "description": "PrioritiesLOV not found." + "description": "PostingTransactionCodesLOV 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": [ @@ -24962,21 +33256,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/profiles/{profileId}/profileIdentifications": { + "/listOfValues/hotels/{hotelId}/prepaidCardInterfaces": { "get": { - "summary": "Return list of values for hotel profile identifications", - "description": "Use this API to return the list of values for profile identifications for a specific property based on search criteria such as profileId, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getProfileIdentificationsLOV
", - "operationId": "getProfileIdentificationsLOV", + "summary": "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": "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", @@ -24984,7 +33269,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 PrepaidCardInterfaces LOV" }, { "name": "includeInactiveFlag", @@ -25058,7 +33343,43 @@ } }, "204": { - "description": "ProfileIdentificationsLOV not found." + "description": "PrepaidCardInterfacesLOV 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": [ @@ -25072,21 +33393,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/promoCode/{promoCode}/promoRates": { + "/listOfValues/hotels/{hotelId}/priorities": { "get": { - "summary": "Return list of values for hotel promotion rates", - "description": "Use this API to return the list of values for promotion rates for a specific property based on search criteria such as promoCode, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getPromoRatesLOV
", - "operationId": "getPromoRatesLOV", + "summary": "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": "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", @@ -25094,7 +33406,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 Priorities LOV" }, { "name": "includeInactiveFlag", @@ -25168,7 +33480,43 @@ } }, "204": { - "description": "PromoRatesLOV not found." + "description": "PrioritiesLOV 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": [ @@ -25182,12 +33530,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/promoGroups": { + "/listOfValues/hotels/{hotelId}/profiles/{profileId}/profileIdentifications": { "get": { - "summary": "Return list of values for hotel promotion groups", - "description": "Use this API to return the list of values for promotion groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getPromoGroupsLOV
", - "operationId": "getPromoGroupsLOV", + "summary": "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", @@ -25195,7 +33552,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 ProfileIdentifications LOV" }, { "name": "includeInactiveFlag", @@ -25269,7 +33626,43 @@ } }, "204": { - "description": "PromoGroupsLOV not found." + "description": "ProfileIdentificationsLOV 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": [ @@ -25283,12 +33676,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/propertyAmenities": { + "/listOfValues/hotels/{hotelId}/promoCode/{promoCode}/promoRates": { "get": { - "summary": "Return list of values for hotel property amenities", - "description": "Use this API to return the list of values for property amenities for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getPropertyAmenitiesLOV
", - "operationId": "getPropertyAmenitiesLOV", + "summary": "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", @@ -25296,7 +33698,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 PromoRates LOV" }, { "name": "includeInactiveFlag", @@ -25370,7 +33772,43 @@ } }, "204": { - "description": "PropertyAmenitiesLOV not found." + "description": "PromoRatesLOV 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": [ @@ -25384,11 +33822,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCategories": { + "/listOfValues/hotels/{hotelId}/promoGroups": { "get": { - "summary": "Return list of values for hotel rate categories", - "description": "Use this API to return the list of values for rate categories for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRateCategoriesLOV
", - "operationId": "getRateCategoriesLOV", + "summary": "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", @@ -25397,7 +33835,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 PromoGroups LOV" }, { "name": "includeInactiveFlag", @@ -25471,7 +33909,43 @@ } }, "204": { - "description": "RateCategoriesLOV not found." + "description": "PromoGroupsLOV 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": [ @@ -25485,21 +33959,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCode/{rateCode}/ratePlansForYieldAsConfig": { + "/listOfValues/hotels/{hotelId}/propertyAmenities": { "get": { - "summary": "Return list of values for hotel rate plans for yield as configuration", - "description": "Use this API to return the list of values for rate plans for yield as configuration for a specific property based on search criteria such as rateCode, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRatePlansForYieldAsConfigLOV
", - "operationId": "getRatePlansForYieldAsConfigLOV", + "summary": "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": "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", @@ -25507,7 +33972,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 PropertyAmenities LOV" }, { "name": "includeInactiveFlag", @@ -25581,7 +34046,43 @@ } }, "204": { - "description": "RatePlansForYieldAsConfigLOV not found." + "description": "PropertyAmenitiesLOV 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": [ @@ -25595,11 +34096,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCodeGlobalDescEdit": { + "/listOfValues/hotels/{hotelId}/rateCategories": { "get": { - "summary": "Return list of values for hotel rate code global description edit", - "description": "Use this API to return the list of values for rate code global description edit for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRateCodeGlobalDescEditLOV
", - "operationId": "getRateCodeGlobalDescEditLOV", + "summary": "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", @@ -25608,7 +34109,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 RateCategories LOV" }, { "name": "includeInactiveFlag", @@ -25682,7 +34183,43 @@ } }, "204": { - "description": "RateCodeGlobalDescEditLOV not found." + "description": "RateCategoriesLOV 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": [ @@ -25696,20 +34233,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/rateCodesByType": { + "/listOfValues/hotels/{hotelId}/rateCode/{rateCode}/ratePlansForYieldAsConfig": { "get": { - "summary": "Return list of values for hotel rate codes by type", - "description": "Use this API to return the list of values for rate codes by type for a specific property based on search criteria such as rateCodeType, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRateCodesByTypeLOV
", - "operationId": "getRateCodesByTypeLOV", + "summary": "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": "rateCodeType", + "name": "rateCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'rateCodeType' which is required to fetch RateCodesByType LOV" + "description": "Value of the parameter 'rateCode' which is required to fetch RatePlansForYieldAsConfig LOV" }, { "name": "hotelId", @@ -25718,7 +34255,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 RatePlansForYieldAsConfig LOV" }, { "name": "includeInactiveFlag", @@ -25792,117 +34329,43 @@ } }, "204": { - "description": "RateCodesByTypeLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/ratePlanForMassRate": { - "get": { - "summary": "Return list of values for hotel rate plans for mass rate", - "description": "Use this API to return the list of values for rate plans for mass rate for a specific property based on search criteria such as rateCodeType, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRatePlanForMassRateLOV
", - "operationId": "getRatePlanForMassRateLOV", - "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" + "description": "RatePlansForYieldAsConfigLOV not found." }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RatePlanForMassRate LOV" + "400": { + "$ref": "#/responses/400" }, - { - "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" + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/authKey" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-app-key" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-hotelid" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-externalsystem" + "415": { + "$ref": "#/responses/415" }, - { - "$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" - } + "500": { + "$ref": "#/responses/500" }, - "204": { - "description": "RatePlanForMassRateLOV not found." + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -25916,11 +34379,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCodesValid": { + "/listOfValues/hotels/{hotelId}/rateCodeGlobalDescEdit": { "get": { - "summary": "Return list of values for hotel valid rate codes", - "description": "Use this API to return the list of values for valid rate codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRateCodesValidLOV
", - "operationId": "getRateCodesValidLOV", + "summary": "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", @@ -25929,7 +34392,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 RateCodeGlobalDescEdit LOV" }, { "name": "includeInactiveFlag", @@ -26003,7 +34466,43 @@ } }, "204": { - "description": "RateCodesValidLOV not found." + "description": "RateCodeGlobalDescEditLOV 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": [ @@ -26017,12 +34516,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateCommissionCodes": { + "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/rateCodesByType": { "get": { - "summary": "Return list of values for hotel rate commission codes", - "description": "Use this API to return the list of values for rate commission codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRateCommissionCodesLOV
", - "operationId": "getRateCommissionCodesLOV", + "summary": "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": "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", @@ -26030,7 +34538,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 RateCodesByType LOV" }, { "name": "includeInactiveFlag", @@ -26104,7 +34612,43 @@ } }, "204": { - "description": "RateCommissionCodesLOV not found." + "description": "RateCodesByTypeLOV 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": [ @@ -26118,12 +34662,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateConfigCurrencies": { + "/listOfValues/hotels/{hotelId}/rateCodeType/{rateCodeType}/ratePlanForMassRate": { "get": { - "summary": "Return list of values for hotel rate configuration currencies", - "description": "Use this API to return the list of values for rate configuration currencies for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRateConfigCurrenciesLOV
", - "operationId": "getRateConfigCurrenciesLOV", + "summary": "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", @@ -26131,7 +34684,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 RatePlanForMassRate LOV" }, { "name": "includeInactiveFlag", @@ -26205,7 +34758,43 @@ } }, "204": { - "description": "RateConfigCurrenciesLOV not found." + "description": "RatePlanForMassRateLOV 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": [ @@ -26219,11 +34808,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rateGroups": { + "/listOfValues/hotels/{hotelId}/rateCodesValid": { "get": { - "summary": "Return list of values for hotel rate groups", - "description": "Use this API to return the list of values for rate groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRateGroupsLOV
", - "operationId": "getRateGroupsLOV", + "summary": "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", @@ -26232,7 +34821,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 RateCodesValid LOV" }, { "name": "includeInactiveFlag", @@ -26306,7 +34895,43 @@ } }, "204": { - "description": "RateGroupsLOV not found." + "description": "RateCodesValidLOV 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": [ @@ -26320,21 +34945,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/ratePlanCodes/{ratePlanCodes}/roomTypesForMassRate": { + "/listOfValues/hotels/{hotelId}/rateCommissionCodes": { "get": { - "summary": "Return list of values for hotel room types for mass rate", - "description": "Use this API to return the list of values for room types for mass rate for a specific property based on search criteria such as ratePlanCodes, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomTypesForMassRateLOV
", - "operationId": "getRoomTypesForMassRateLOV", + "summary": "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": "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", @@ -26342,7 +34958,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 RateCommissionCodes LOV" }, { "name": "includeInactiveFlag", @@ -26416,7 +35032,43 @@ } }, "204": { - "description": "RoomTypesForMassRateLOV not found." + "description": "RateCommissionCodesLOV 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": [ @@ -26430,11 +35082,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/ratePlans": { + "/listOfValues/hotels/{hotelId}/rateConfigCurrencies": { "get": { - "summary": "Return list of values for hotel rate plans", - "description": "Use this API to return the list of values for rate plans for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRatePlansLOV
", - "operationId": "getRatePlansLOV", + "summary": "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", @@ -26443,7 +35095,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 RateConfigCurrencies LOV" }, { "name": "includeInactiveFlag", @@ -26517,7 +35169,43 @@ } }, "204": { - "description": "RatePlansLOV not found." + "description": "RateConfigCurrenciesLOV 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": [ @@ -26531,21 +35219,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/relModuleName/{relModuleName}/applicationModules": { + "/listOfValues/hotels/{hotelId}/rateGroups": { "get": { - "summary": "Return list of values for hotel application modules", - "description": "Use this API to return the list of values for application modules for a specific property based on search criteria such as relModuleName, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getApplicationModulesLOV
", - "operationId": "getApplicationModulesLOV", + "summary": "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": "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", @@ -26553,7 +35232,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 RateGroups LOV" }, { "name": "includeInactiveFlag", @@ -26627,7 +35306,43 @@ } }, "204": { - "description": "ApplicationModulesLOV not found." + "description": "RateGroupsLOV 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": [ @@ -26641,12 +35356,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repBlockCodesParamOff": { + "/listOfValues/hotels/{hotelId}/ratePlanCodes/{ratePlanCodes}/roomTypesForMassRate": { "get": { - "summary": "Return list of values for hotel rep block codes parameter off", - "description": "Use this API to return the list of values for rep block codes parameter off for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepBlockCodesParamOffLOV
", - "operationId": "getRepBlockCodesParamOffLOV", + "summary": "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": "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", @@ -26654,7 +35378,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 RoomTypesForMassRate LOV" }, { "name": "includeInactiveFlag", @@ -26728,7 +35452,43 @@ } }, "204": { - "description": "RepBlockCodesParamOffLOV not found." + "description": "RoomTypesForMassRateLOV 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": [ @@ -26742,11 +35502,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repBlockCodesParamOn": { + "/listOfValues/hotels/{hotelId}/ratePlans": { "get": { - "summary": "Return list of values for hotel rep block codes parameter on", - "description": "Use this API to return the list of values for rep block codes parameter on for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepBlockCodesParamOnLOV
", - "operationId": "getRepBlockCodesParamOnLOV", + "summary": "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", @@ -26755,7 +35515,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 RatePlans LOV" }, { "name": "includeInactiveFlag", @@ -26829,7 +35589,43 @@ } }, "204": { - "description": "RepBlockCodesParamOnLOV not found." + "description": "RatePlansLOV 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": [ @@ -26843,12 +35639,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repCashiers": { + "/listOfValues/hotels/{hotelId}/relModuleName/{relModuleName}/applicationModules": { "get": { - "summary": "Return list of values for hotel rep cashiers", - "description": "Use this API to return the list of values for rep cashiers for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepCashiersLOV
", - "operationId": "getRepCashiersLOV", + "summary": "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", @@ -26856,7 +35661,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 ApplicationModules LOV" }, { "name": "includeInactiveFlag", @@ -26930,7 +35735,43 @@ } }, "204": { - "description": "RepCashiersLOV not found." + "description": "ApplicationModulesLOV 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": [ @@ -26944,11 +35785,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repContactList": { + "/listOfValues/hotels/{hotelId}/repBlockCodesParamOff": { "get": { - "summary": "Return list of values for hotel rep contact lists", - "description": "Use this API to return the list of values for rep contact lists for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepContactListLOV
", - "operationId": "getRepContactListLOV", + "summary": "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", @@ -26957,7 +35798,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 RepBlockCodesParamOff LOV" }, { "name": "includeInactiveFlag", @@ -27031,7 +35872,43 @@ } }, "204": { - "description": "RepContactListLOV not found." + "description": "RepBlockCodesParamOffLOV 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": [ @@ -27045,11 +35922,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repCurrencies": { + "/listOfValues/hotels/{hotelId}/repBlockCodesParamOn": { "get": { - "summary": "Return list of values for hotel rep currencies", - "description": "Use this API to return the list of values for rep currencies for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepCurrenciesLOV
", - "operationId": "getRepCurrenciesLOV", + "summary": "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": "hotelId", @@ -27058,7 +35935,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 RepBlockCodesParamOn LOV" }, { "name": "includeInactiveFlag", @@ -27132,7 +36009,43 @@ } }, "204": { - "description": "RepCurrenciesLOV not found." + "description": "RepBlockCodesParamOnLOV 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": [ @@ -27146,11 +36059,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repDepartments": { + "/listOfValues/hotels/{hotelId}/repCashiers": { "get": { - "summary": "Return list of values for hotel rep departments", - "description": "Use this API to return the list of values for rep departments for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepDepartmentsLOV
", - "operationId": "getRepDepartmentsLOV", + "summary": "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", @@ -27159,7 +36072,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 RepCashiers LOV" }, { "name": "includeInactiveFlag", @@ -27233,7 +36146,43 @@ } }, "204": { - "description": "RepDepartmentsLOV not found." + "description": "RepCashiersLOV 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": [ @@ -27247,11 +36196,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repFiscalYears": { + "/listOfValues/hotels/{hotelId}/repContactList": { "get": { - "summary": "Return list of values for hotel rep fiscal years", - "description": "Use this API to return the list of values for rep fiscal years for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepFiscalYearsLOV
", - "operationId": "getRepFiscalYearsLOV", + "summary": "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": "hotelId", @@ -27260,7 +36209,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 RepContactList LOV" }, { "name": "includeInactiveFlag", @@ -27334,7 +36283,43 @@ } }, "204": { - "description": "RepFiscalYearsLOV not found." + "description": "RepContactListLOV 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": [ @@ -27348,11 +36333,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repForeignCurrencies": { + "/listOfValues/hotels/{hotelId}/repCurrencies": { "get": { - "summary": "Return list of values for hotel rep foreign currencies", - "description": "Use this API to return the list of values for rep foreign currencies for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepForeignCurrenciesLOV
", - "operationId": "getRepForeignCurrenciesLOV", + "summary": "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": "hotelId", @@ -27361,7 +36346,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 RepCurrencies LOV" }, { "name": "includeInactiveFlag", @@ -27435,7 +36420,43 @@ } }, "204": { - "description": "RepForeignCurrenciesLOV not found." + "description": "RepCurrenciesLOV 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": [ @@ -27449,11 +36470,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repGroups": { + "/listOfValues/hotels/{hotelId}/repDepartments": { "get": { - "summary": "Return list of values for hotel rep groups", - "description": "Use this API to return the list of values for rep groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepGroupsLOV
", - "operationId": "getRepGroupsLOV", + "summary": "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", @@ -27462,7 +36483,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 RepDepartments LOV" }, { "name": "includeInactiveFlag", @@ -27536,7 +36557,43 @@ } }, "204": { - "description": "RepGroupsLOV not found." + "description": "RepDepartmentsLOV 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": [ @@ -27550,11 +36607,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repInventoryItemPools": { + "/listOfValues/hotels/{hotelId}/repFiscalYears": { "get": { - "summary": "Return list of values for hotel rep inventory item pools", - "description": "Use this API to return the list of values for rep inventory item pools for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepInventoryItemPoolsLOV
", - "operationId": "getRepInventoryItemPoolsLOV", + "summary": "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", @@ -27563,7 +36620,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 RepFiscalYears LOV" }, { "name": "includeInactiveFlag", @@ -27637,7 +36694,43 @@ } }, "204": { - "description": "RepInventoryItemPoolsLOV not found." + "description": "RepFiscalYearsLOV 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": [ @@ -27651,11 +36744,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repMarketCodes": { + "/listOfValues/hotels/{hotelId}/repForeignCurrencies": { "get": { - "summary": "Return list of values for hotel rep market codes", - "description": "Use this API to return the list of values for rep market codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepMarketCodesLOV
", - "operationId": "getRepMarketCodesLOV", + "summary": "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", @@ -27664,7 +36757,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 RepForeignCurrencies LOV" }, { "name": "includeInactiveFlag", @@ -27738,7 +36831,43 @@ } }, "204": { - "description": "RepMarketCodesLOV not found." + "description": "RepForeignCurrenciesLOV 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": [ @@ -27752,11 +36881,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repRoomStatuses": { + "/listOfValues/hotels/{hotelId}/repGroups": { "get": { - "summary": "Return list of values for hotel rep room statuses", - "description": "Use this API to return the list of values for rep room statuses for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepRoomStatusesLOV
", - "operationId": "getRepRoomStatusesLOV", + "summary": "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", @@ -27765,7 +36894,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 RepGroups LOV" }, { "name": "includeInactiveFlag", @@ -27839,7 +36968,43 @@ } }, "204": { - "description": "RepRoomStatusesLOV not found." + "description": "RepGroupsLOV 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": [ @@ -27853,11 +37018,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repRoomTypes": { + "/listOfValues/hotels/{hotelId}/repInventoryItemPools": { "get": { - "summary": "Return list of values for hotel rep room types", - "description": "Use this API to return the list of values forrep room types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepRoomTypesLOV
", - "operationId": "getRepRoomTypesLOV", + "summary": "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": "hotelId", @@ -27866,7 +37031,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 RepInventoryItemPools LOV" }, { "name": "includeInactiveFlag", @@ -27940,7 +37105,43 @@ } }, "204": { - "description": "RepRoomTypesLOV not found." + "description": "RepInventoryItemPoolsLOV 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": [ @@ -27954,11 +37155,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repRooms": { + "/listOfValues/hotels/{hotelId}/repMarketCodes": { "get": { - "summary": "Return list of values for hotel rep rooms", - "description": "Use this API to return the list of values for rep rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepRoomsLOV
", - "operationId": "getRepRoomsLOV", + "summary": "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", @@ -27967,7 +37168,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 RepMarketCodes LOV" }, { "name": "includeInactiveFlag", @@ -28041,7 +37242,43 @@ } }, "204": { - "description": "RepRoomsLOV not found." + "description": "RepMarketCodesLOV 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": [ @@ -28055,11 +37292,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repServiceRequestCodes": { + "/listOfValues/hotels/{hotelId}/repRoomStatuses": { "get": { - "summary": "Return list of values for hotel rep service request codes", - "description": "Use this API to return the list of values for rep service request codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepServiceRequestCodesLOV
", - "operationId": "getRepServiceRequestCodesLOV", + "summary": "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": "hotelId", @@ -28068,7 +37305,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 RepRoomStatuses LOV" }, { "name": "includeInactiveFlag", @@ -28142,7 +37379,43 @@ } }, "204": { - "description": "RepServiceRequestCodesLOV not found." + "description": "RepRoomStatusesLOV 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": [ @@ -28156,11 +37429,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repTransactionCodes": { + "/listOfValues/hotels/{hotelId}/repRoomTypes": { "get": { - "summary": "Return list of values for hotel rep transaction codes", - "description": "Use this API to return the list of values for rep transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepTransactionCodesLOV
", - "operationId": "getRepTransactionCodesLOV", + "summary": "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", @@ -28169,7 +37442,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 RepRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -28243,7 +37516,43 @@ } }, "204": { - "description": "RepTransactionCodesLOV not found." + "description": "RepRoomTypesLOV 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": [ @@ -28257,11 +37566,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/repTraveAgtCalendarYear": { + "/listOfValues/hotels/{hotelId}/repRooms": { "get": { - "summary": "Return list of values for hotel rep travel agent calendar years", - "description": "Use this API to return the list of values for rep travel agent calendar years for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepTraveAgtCalendarYearLOV
", - "operationId": "getRepTraveAgtCalendarYearLOV", + "summary": "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", @@ -28270,7 +37579,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 RepRooms LOV" }, { "name": "includeInactiveFlag", @@ -28344,7 +37653,43 @@ } }, "204": { - "description": "RepTraveAgtCalendarYearLOV not found." + "description": "RepRoomsLOV 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": [ @@ -28358,11 +37703,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationBasedBlocks": { + "/listOfValues/hotels/{hotelId}/repServiceRequestCodes": { "get": { - "summary": "Return list of values for hotel reservation based blocks", - "description": "Use this API to return the list of values for reservation based blocks for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getReservationBasedBlocksLOV
", - "operationId": "getReservationBasedBlocksLOV", + "summary": "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", @@ -28371,7 +37716,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 RepServiceRequestCodes LOV" }, { "name": "includeInactiveFlag", @@ -28445,7 +37790,43 @@ } }, "204": { - "description": "ReservationBasedBlocksLOV not found." + "description": "RepServiceRequestCodesLOV 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": [ @@ -28459,11 +37840,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationBasedProfiles": { + "/listOfValues/hotels/{hotelId}/repTransactionCodes": { "get": { - "summary": "Return list of values for hotel reservation based profiles", - "description": "Use this API to return the list of values for reservation based profiles for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getReservationBasedProfilesLOV
", - "operationId": "getReservationBasedProfilesLOV", + "summary": "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", @@ -28472,7 +37853,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 RepTransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -28546,7 +37927,43 @@ } }, "204": { - "description": "ReservationBasedProfilesLOV not found." + "description": "RepTransactionCodesLOV 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": [ @@ -28560,11 +37977,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationPreferences": { + "/listOfValues/hotels/{hotelId}/repTraveAgtCalendarYear": { "get": { - "summary": "Return list of values for hotel reservation preferences", - "description": "Use this API to return the list of values for reservation preferences for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getReservationPreferencesLOV
", - "operationId": "getReservationPreferencesLOV", + "summary": "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", @@ -28573,7 +37990,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 RepTraveAgtCalendarYear LOV" }, { "name": "includeInactiveFlag", @@ -28647,7 +38064,43 @@ } }, "204": { - "description": "ReservationPreferencesLOV not found." + "description": "RepTraveAgtCalendarYearLOV 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": [ @@ -28661,11 +38114,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/reservationStatusesHotel": { + "/listOfValues/hotels/{hotelId}/reservationBasedBlocks": { "get": { - "summary": "Return list of values for hotel reservation statuses", - "description": "Use this API to return the list of values for reservation statuses for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getReservationStatusesHotelLOV
", - "operationId": "getReservationStatusesHotelLOV", + "summary": "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", @@ -28674,7 +38127,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 ReservationBasedBlocks LOV" }, { "name": "includeInactiveFlag", @@ -28748,7 +38201,43 @@ } }, "204": { - "description": "ReservationStatusesHotelLOV not found." + "description": "ReservationBasedBlocksLOV 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": [ @@ -28762,11 +38251,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortAirports": { + "/listOfValues/hotels/{hotelId}/reservationBasedProfiles": { "get": { - "summary": "Return list of values for hotel resort airports", - "description": "Use this API to return the list of values for resort airports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResortAirportsLOV
", - "operationId": "getResortAirportsLOV", + "summary": "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", @@ -28775,7 +38264,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 ReservationBasedProfiles LOV" }, { "name": "includeInactiveFlag", @@ -28849,7 +38338,43 @@ } }, "204": { - "description": "ResortAirportsLOV not found." + "description": "ReservationBasedProfilesLOV 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": [ @@ -28863,11 +38388,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortCROs": { + "/listOfValues/hotels/{hotelId}/reservationPreferences": { "get": { - "summary": "Return list of values for hotel resort CROs", - "description": "Use this API to return the list of values for resort CROs for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResortCROsLOV
", - "operationId": "getResortCROsLOV", + "summary": "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", @@ -28876,7 +38401,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ResortCROs LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch ReservationPreferences LOV" }, { "name": "includeInactiveFlag", @@ -28950,7 +38475,43 @@ } }, "204": { - "description": "ResortCROsLOV not found." + "description": "ReservationPreferencesLOV 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": [ @@ -28964,11 +38525,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortGuaranteeCodes": { + "/listOfValues/hotels/{hotelId}/reservationStatusesHotel": { "get": { - "summary": "Return list of values for hotel resort guarantee codes", - "description": "Use this API to return the list of values for resort guarantee codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResortGuaranteeCodesLOV
", - "operationId": "getResortGuaranteeCodesLOV", + "summary": "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", @@ -28977,7 +38538,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 ReservationStatusesHotel LOV" }, { "name": "includeInactiveFlag", @@ -29051,7 +38612,43 @@ } }, "204": { - "description": "ResortGuaranteeCodesLOV not found." + "description": "ReservationStatusesHotelLOV 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": [ @@ -29065,11 +38662,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortMarketCodes": { + "/listOfValues/hotels/{hotelId}/resortAirports": { "get": { - "summary": "Return list of values for hotel resort market codes", - "description": "Use this API to return the list of values for resort market codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResortMarketCodesLOV
", - "operationId": "getResortMarketCodesLOV", + "summary": "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", @@ -29078,7 +38675,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 ResortAirports LOV" }, { "name": "includeInactiveFlag", @@ -29152,7 +38749,43 @@ } }, "204": { - "description": "ResortMarketCodesLOV not found." + "description": "ResortAirportsLOV 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": [ @@ -29166,21 +38799,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortNameId/{resortNameId}/stagedProfilePreferences": { + "/listOfValues/hotels/{hotelId}/resortCROs": { "get": { - "summary": "Return list of values for hotel staged profile preferences", - "description": "Use this API to return the list of values for staged profile preferences for a specific property based on search criteria such as resortNameId, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getStagedProfilePreferencesLOV
", - "operationId": "getStagedProfilePreferencesLOV", + "summary": "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": "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", @@ -29188,7 +38812,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 ResortCROs LOV" }, { "name": "includeInactiveFlag", @@ -29262,7 +38886,43 @@ } }, "204": { - "description": "StagedProfilePreferencesLOV not found." + "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" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -29276,11 +38936,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRateClasses": { + "/listOfValues/hotels/{hotelId}/resortGuaranteeCodes": { "get": { - "summary": "Return list of values for hotel resort rate classes", - "description": "Use this API to return the list of values for resort rate classes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResortRateClassesLOV
", - "operationId": "getResortRateClassesLOV", + "summary": "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", @@ -29289,7 +38949,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 ResortGuaranteeCodes LOV" }, { "name": "includeInactiveFlag", @@ -29363,7 +39023,43 @@ } }, "204": { - "description": "ResortRateClassesLOV not found." + "description": "ResortGuaranteeCodesLOV 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": [ @@ -29377,11 +39073,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRestrictionStatuses": { + "/listOfValues/hotels/{hotelId}/resortMarketCodes": { "get": { - "summary": "Return list of values for hotel resort restriction statuses", - "description": "Use this API to return the list of values for resort restriction statuses for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResortRestrictionStatusesLOV
", - "operationId": "getResortRestrictionStatusesLOV", + "summary": "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", @@ -29390,7 +39086,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 ResortMarketCodes LOV" }, { "name": "includeInactiveFlag", @@ -29464,7 +39160,43 @@ } }, "204": { - "description": "ResortRestrictionStatusesLOV not found." + "description": "ResortMarketCodesLOV 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": [ @@ -29478,12 +39210,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRoomNumbers": { + "/listOfValues/hotels/{hotelId}/resortNameId/{resortNameId}/stagedProfilePreferences": { "get": { - "summary": "Return list of values for hotel resort room numbers", - "description": "Use this API to return the list of values for resort room numbers for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResortRoomNumbersLOV
", - "operationId": "getResortRoomNumbersLOV", + "summary": "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", @@ -29491,7 +39232,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 StagedProfilePreferences LOV" }, { "name": "includeInactiveFlag", @@ -29565,7 +39306,43 @@ } }, "204": { - "description": "ResortRoomNumbersLOV not found." + "description": "StagedProfilePreferencesLOV 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": [ @@ -29579,11 +39356,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortRoomTypes": { + "/listOfValues/hotels/{hotelId}/resortRateClasses": { "get": { - "summary": "Return list of values for hotel resort room types", - "description": "Use this API to return the list of values for resort room types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResortRoomTypesLOV
", - "operationId": "getResortRoomTypesLOV", + "summary": "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", @@ -29592,7 +39369,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 ResortRateClasses LOV" }, { "name": "includeInactiveFlag", @@ -29666,7 +39443,43 @@ } }, "204": { - "description": "ResortRoomTypesLOV not found." + "description": "ResortRateClassesLOV 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": [ @@ -29680,11 +39493,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resortTransportationLabels": { + "/listOfValues/hotels/{hotelId}/resortRestrictionStatuses": { "get": { - "summary": "Return list of values for hotel resort transportation labels", - "description": "Use this API to return the list of values for resort transportation labels for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResortTransportationLabelsLOV
", - "operationId": "getResortTransportationLabelsLOV", + "summary": "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", @@ -29693,7 +39506,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 ResortRestrictionStatuses LOV" }, { "name": "includeInactiveFlag", @@ -29767,7 +39580,43 @@ } }, "204": { - "description": "ResortTransportationLabelsLOV not found." + "description": "ResortRestrictionStatusesLOV 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": [ @@ -29781,11 +39630,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resourceItemClasses": { + "/listOfValues/hotels/{hotelId}/resortRoomNumbers": { "get": { - "summary": "Return list of values for hotel resource item classes", - "description": "Use this API to return the list of values for resource item classes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResourceItemClassesLOV
", - "operationId": "getResourceItemClassesLOV", + "summary": "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", @@ -29794,7 +39643,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 ResortRoomNumbers LOV" }, { "name": "includeInactiveFlag", @@ -29868,7 +39717,43 @@ } }, "204": { - "description": "ResourceItemClassesLOV not found." + "description": "ResortRoomNumbersLOV 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": [ @@ -29882,11 +39767,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesCodes": { + "/listOfValues/hotels/{hotelId}/resortRoomTypes": { "get": { - "summary": "Return list of values for hotel reservation auto attach rule codes", - "description": "Use this API to return the list of values for reservation auto attach rule codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResvAutoAttachRulesCodesLOV
", - "operationId": "getResvAutoAttachRulesCodesLOV", + "summary": "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", @@ -29895,7 +39780,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 ResortRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -29969,7 +39854,43 @@ } }, "204": { - "description": "ResvAutoAttachRulesCodesLOV not found." + "description": "ResortRoomTypesLOV not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -29983,11 +39904,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesRuleType": { + "/listOfValues/hotels/{hotelId}/resortTransportationLabels": { "get": { - "summary": "Return list of values for hotel reservation auto attach rule types", - "description": "Use this API to return the list of values for reservation auto attach rule types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResvAutoAttachRulesRuleTypeLOV
", - "operationId": "getResvAutoAttachRulesRuleTypeLOV", + "summary": "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", @@ -29996,7 +39917,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 ResortTransportationLabels LOV" }, { "name": "includeInactiveFlag", @@ -30070,7 +39991,43 @@ } }, "204": { - "description": "ResvAutoAttachRulesRuleTypeLOV not found." + "description": "ResortTransportationLabelsLOV 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": [ @@ -30084,11 +40041,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvBasedProfiles": { + "/listOfValues/hotels/{hotelId}/resourceItemClasses": { "get": { - "summary": "Return list of values for hotel reservation based profiles", - "description": "Use this API to return the list of values for reservation based profiles for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResvBasedProfilesLOV
", - "operationId": "getResvBasedProfilesLOV", + "summary": "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", @@ -30097,7 +40054,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 ResourceItemClasses LOV" }, { "name": "includeInactiveFlag", @@ -30171,117 +40128,43 @@ } }, "204": { - "description": "ResvBasedProfilesLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/reservationTickets": { - "get": { - "summary": "Return list of values for hotel reservation tickets", - "description": "Use this API to return the list of values for reservation tickets for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getReservationTicketsLOV
", - "operationId": "getReservationTicketsLOV", - "parameters": [ - { - "name": "resvNameId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'resvNameId' which is required to fetch ReservationTickets LOV" + "description": "ResourceItemClassesLOV not found." }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ReservationTickets LOV" + "400": { + "$ref": "#/responses/400" }, - { - "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" + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/authKey" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-app-key" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-hotelid" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-externalsystem" + "415": { + "$ref": "#/responses/415" }, - { - "$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" - } + "500": { + "$ref": "#/responses/500" }, - "204": { - "description": "ReservationTicketsLOV not found." + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -30295,21 +40178,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/resvTransactionDiversionCodes": { + "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesCodes": { "get": { - "summary": "Return list of values for hotel reservation transaction diversion codes", - "description": "Use this API to return the list of values for reservation transaction diversion codes for a specific property based on search criteria such as resvNameId, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResvTransactionDiversionCodesLOV
", - "operationId": "getResvTransactionDiversionCodesLOV", + "summary": "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": "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", @@ -30317,7 +40191,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 ResvAutoAttachRulesCodes LOV" }, { "name": "includeInactiveFlag", @@ -30391,7 +40265,43 @@ } }, "204": { - "description": "ResvTransactionDiversionCodesLOV not found." + "description": "ResvAutoAttachRulesCodesLOV 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": [ @@ -30405,11 +40315,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/revenueTypeMappingSpace": { + "/listOfValues/hotels/{hotelId}/resvAutoAttachRulesRuleType": { "get": { - "summary": "Return list of values for hotel revenue type mapping space", - "description": "Use this API to return the list of values for revenue type mapping space for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRevenueTypeMappingSpaceLOV
", - "operationId": "getRevenueTypeMappingSpaceLOV", + "summary": "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", @@ -30418,7 +40328,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 ResvAutoAttachRulesRuleType LOV" }, { "name": "includeInactiveFlag", @@ -30492,7 +40402,43 @@ } }, "204": { - "description": "RevenueTypeMappingSpaceLOV not found." + "description": "ResvAutoAttachRulesRuleTypeLOV 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": [ @@ -30506,11 +40452,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/revenueTypeMappingTrxCodes": { + "/listOfValues/hotels/{hotelId}/resvBasedProfiles": { "get": { - "summary": "Return list of values for hotel revenue type mapping transaction codes", - "description": "Use this API to return the list of values for revenue type mapping transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRevenueTypeMappingTrxCodesLOV
", - "operationId": "getRevenueTypeMappingTrxCodesLOV", + "summary": "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", @@ -30519,7 +40465,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 ResvBasedProfiles LOV" }, { "name": "includeInactiveFlag", @@ -30593,121 +40539,43 @@ } }, "204": { - "description": "RevenueTypeMappingTrxCodesLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/roleWithDepartment/{roleWithDepartment}/userRoles": { - "get": { - "summary": "Return list of values for hotel user roles", - "description": "Use this API to return the list of values for user roles for a specific property based on search criteria such as roleWithDepartment, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUserRolesLOV
", - "operationId": "getUserRolesLOV", - "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" - ] + "description": "ResvBasedProfilesLOV not found." }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UserRoles LOV" + "400": { + "$ref": "#/responses/400" }, - { - "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" + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/authKey" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-app-key" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-hotelid" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-externalsystem" + "415": { + "$ref": "#/responses/415" }, - { - "$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" - } + "500": { + "$ref": "#/responses/500" }, - "204": { - "description": "UserRolesLOV not found." + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -30721,20 +40589,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/room/{room}/assignRooms": { + "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/reservationTickets": { "get": { - "summary": "Return list of values for hotel assign rooms", - "description": "Use this API to return the list of values for assign rooms for a specific property based on search criteria such as room, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getAssignRoomsLOV
", - "operationId": "getAssignRoomsLOV", + "summary": "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": "room", + "name": "resvNameId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'room' which is required to fetch AssignRooms LOV" + "description": "Value of the parameter 'resvNameId' which is required to fetch ReservationTickets LOV" }, { "name": "hotelId", @@ -30743,7 +40611,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 ReservationTickets LOV" }, { "name": "includeInactiveFlag", @@ -30817,7 +40685,43 @@ } }, "204": { - "description": "AssignRoomsLOV not found." + "description": "ReservationTicketsLOV 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": [ @@ -30831,20 +40735,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/room/{room}/eventSetupStyles": { + "/listOfValues/hotels/{hotelId}/resvNameId/{resvNameId}/resvTransactionDiversionCodes": { "get": { - "summary": "Return list of values for hotel event setup styles", - "description": "Use this API to return the list of values for event setup styles for a specific property based on search criteria such as room, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getEventSetupStylesLOV
", - "operationId": "getEventSetupStylesLOV", + "summary": "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": "room", + "name": "resvNameId", "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 'resvNameId' which is required to fetch ResvTransactionDiversionCodes LOV" }, { "name": "hotelId", @@ -30853,7 +40757,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 ResvTransactionDiversionCodes LOV" }, { "name": "includeInactiveFlag", @@ -30927,7 +40831,43 @@ } }, "204": { - "description": "EventSetupStylesLOV not found." + "description": "ResvTransactionDiversionCodesLOV 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": [ @@ -30941,21 +40881,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/room/{room}/roomRates": { + "/listOfValues/hotels/{hotelId}/revenueTypeMappingSpace": { "get": { - "summary": "Return list of values for hotel room rates", - "description": "Use this API to return the list of values for room rates for a specific property based on search criteria such as room, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomRatesLOV
", - "operationId": "getRoomRatesLOV", + "summary": "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": "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", @@ -30963,7 +40894,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 RevenueTypeMappingSpace LOV" }, { "name": "includeInactiveFlag", @@ -31037,7 +40968,43 @@ } }, "204": { - "description": "RoomRatesLOV not found." + "description": "RevenueTypeMappingSpaceLOV 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": [ @@ -31051,11 +41018,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomClassCategories": { + "/listOfValues/hotels/{hotelId}/revenueTypeMappingTrxCodes": { "get": { - "summary": "Return list of values for hotel room class categories", - "description": "Use this API to return the list of values for room class categories for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomClassCategoriesLOV
", - "operationId": "getRoomClassCategoriesLOV", + "summary": "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", @@ -31064,7 +41031,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 RevenueTypeMappingTrxCodes LOV" }, { "name": "includeInactiveFlag", @@ -31138,7 +41105,43 @@ } }, "204": { - "description": "RoomClassCategoriesLOV not found." + "description": "RevenueTypeMappingTrxCodesLOV 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": [ @@ -31152,12 +41155,25 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomClasses": { + "/listOfValues/hotels/{hotelId}/roleWithDepartment/{roleWithDepartment}/userRoles": { "get": { - "summary": "Return list of values for hotel room classes", - "description": "Use this API to return the list of values for room classes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomClassesLOV
", - "operationId": "getRoomClassesLOV", + "summary": "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", @@ -31165,7 +41181,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 UserRoles LOV" }, { "name": "includeInactiveFlag", @@ -31239,108 +41255,43 @@ } }, "204": { - "description": "RoomClassesLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/roomFeatures": { - "get": { - "summary": "Return list of values for hotel room features", - "description": "Use this API to return the list of values for room features for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomFeaturesLOV
", - "operationId": "getRoomFeaturesLOV", - "parameters": [ - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch RoomFeatures LOV" + "description": "UserRolesLOV not found." }, - { - "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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "RoomFeaturesLOV not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -31354,12 +41305,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomHoldConditions": { + "/listOfValues/hotels/{hotelId}/room/{room}/assignRooms": { "get": { - "summary": "Return list of values for hotel room hold conditions", - "description": "Use this API to return the list of values for room hold conditions for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomHoldConditionsLOV
", - "operationId": "getRoomHoldConditionsLOV", + "summary": "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", @@ -31367,7 +41327,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 AssignRooms LOV" }, { "name": "includeInactiveFlag", @@ -31441,7 +41401,43 @@ } }, "204": { - "description": "RoomHoldConditionsLOV not found." + "description": "AssignRoomsLOV 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": [ @@ -31455,12 +41451,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomMaintenance": { + "/listOfValues/hotels/{hotelId}/room/{room}/eventSetupStyles": { "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", + "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", @@ -31468,7 +41473,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 EventSetupStyles LOV" }, { "name": "includeInactiveFlag", @@ -31542,7 +41547,43 @@ } }, "204": { - "description": "RoomMaintenanceLOV not found." + "description": "EventSetupStylesLOV 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": [ @@ -31556,20 +41597,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomNumber/{roomNumber}/connectingSuites": { + "/listOfValues/hotels/{hotelId}/room/{room}/roomRates": { "get": { - "summary": "Return list of values for hotel connecting suites", - "description": "Use this API to return the list of values for connecting suites for a specific property based on search criteria such as roomNumber, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getConnectingSuitesLOV
", - "operationId": "getConnectingSuitesLOV", + "summary": "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": "roomNumber", + "name": "room", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'roomNumber' which is required to fetch ConnectingSuites LOV" + "description": "Value of the parameter 'room' which is required to fetch RoomRates LOV" }, { "name": "hotelId", @@ -31578,7 +41619,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 RoomRates LOV" }, { "name": "includeInactiveFlag", @@ -31652,7 +41693,43 @@ } }, "204": { - "description": "ConnectingSuitesLOV not found." + "description": "RoomRatesLOV 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": [ @@ -31666,20 +41743,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomPool/{roomPool}/roomPoolRoomTypes": { + "/listOfValues/hotels/{hotelId}/room/{room}/roomsKeyCreation": { "get": { - "summary": "Return list of values for hotel room pool room types", - "description": "Use this API to return the list of values for room pool room types for a specific property based on search criteria such as roomPool, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomPoolRoomTypesLOV
", - "operationId": "getRoomPoolRoomTypesLOV", + "summary": "Fetch List Of Values for Rooms Key Creation", + "description": "OperationId:getRoomsKeyCreationLOV
", + "operationId": "getRoomsKeyCreationLOV", "parameters": [ { - "name": "roomPool", + "name": "room", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'roomPool' which is required to fetch RoomPoolRoomTypes LOV" + "description": "Value of the parameter 'room' which is required to fetch RoomsKeyCreation LOV" }, { "name": "hotelId", @@ -31688,7 +41765,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 RoomsKeyCreation LOV" }, { "name": "includeInactiveFlag", @@ -31762,7 +41839,43 @@ } }, "204": { - "description": "RoomPoolRoomTypesLOV not found." + "description": "RoomsKeyCreationLOV 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": [ @@ -31776,11 +41889,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomPools": { + "/listOfValues/hotels/{hotelId}/roomClassCategories": { "get": { - "summary": "Return list of values for hotel room pools", - "description": "Use this API to return the list of values for room pools for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomPoolsLOV
", - "operationId": "getRoomPoolsLOV", + "summary": "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", @@ -31789,7 +41902,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 RoomClassCategories LOV" }, { "name": "includeInactiveFlag", @@ -31863,7 +41976,43 @@ } }, "204": { - "description": "RoomPoolsLOV not found." + "description": "RoomClassCategoriesLOV 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": [ @@ -31877,11 +42026,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomRevenueTrxCodes": { + "/listOfValues/hotels/{hotelId}/roomClasses": { "get": { - "summary": "Return list of values for hotel room revenue transaction codes", - "description": "Use this API to return the list of values for room revenue transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomRevenueTrxCodesLOV
", - "operationId": "getRoomRevenueTrxCodesLOV", + "summary": "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", @@ -31890,7 +42039,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 RoomClasses LOV" }, { "name": "includeInactiveFlag", @@ -31964,7 +42113,43 @@ } }, "204": { - "description": "RoomRevenueTrxCodesLOV not found." + "description": "RoomClassesLOV 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": [ @@ -31978,11 +42163,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomRotationGroups": { + "/listOfValues/hotels/{hotelId}/roomFeatures": { "get": { - "summary": "Return list of values for hotel room rotation groups", - "description": "Use this API to return the list of values for room rotation groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomRotationGroupsLOV
", - "operationId": "getRoomRotationGroupsLOV", + "summary": "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", @@ -31991,7 +42176,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 RoomFeatures LOV" }, { "name": "includeInactiveFlag", @@ -32065,7 +42250,43 @@ } }, "204": { - "description": "RoomRotationGroupsLOV not found." + "description": "RoomFeaturesLOV 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": [ @@ -32079,11 +42300,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomRotationUnitGrades": { + "/listOfValues/hotels/{hotelId}/roomHoldConditions": { "get": { - "summary": "Return list of values for hotel room rotation unit grades", - "description": "Use this API to return the list of values for room rotation unit grades for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomRotationUnitGradesLOV
", - "operationId": "getRoomRotationUnitGradesLOV", + "summary": "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": "hotelId", @@ -32092,7 +42313,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 RoomHoldConditions LOV" }, { "name": "includeInactiveFlag", @@ -32166,7 +42387,43 @@ } }, "204": { - "description": "RoomRotationUnitGradesLOV not found." + "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": [ @@ -32180,11 +42437,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomSpecials": { + "/listOfValues/hotels/{hotelId}/roomMaintenance": { "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", + "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", @@ -32193,7 +42450,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 RoomMaintenance LOV" }, { "name": "includeInactiveFlag", @@ -32267,7 +42524,43 @@ } }, "204": { - "description": "RoomSpecialsLOV not found." + "description": "RoomMaintenanceLOV 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": [ @@ -32281,38 +42574,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomType/{roomType}/arrival/{arrival}/departure/{departure}/roomingListHKRooms": { + "/listOfValues/hotels/{hotelId}/roomNumber/{roomNumber}/connectingSuites": { "get": { - "summary": "Return list of values for hotel rooming list housekeeping rooms", - "description": "Use this API to return the list of values for rooming list housekeeping rooms for a specific property based on search criteria such as departure, arrival, roomType, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomingListHKRoomsLOV
", - "operationId": "getRoomingListHKRoomsLOV", + "summary": "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": "departure", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'departure' which is required to fetch RoomingListHKRooms LOV" - }, - { - "name": "arrival", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'arrival' which is required to fetch RoomingListHKRooms LOV" - }, - { - "name": "roomType", + "name": "roomNumber", "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 'roomNumber' which is required to fetch ConnectingSuites LOV" }, { "name": "hotelId", @@ -32321,7 +42596,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 ConnectingSuites LOV" }, { "name": "includeInactiveFlag", @@ -32395,7 +42670,43 @@ } }, "204": { - "description": "RoomingListHKRoomsLOV not found." + "description": "ConnectingSuitesLOV 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": [ @@ -32409,20 +42720,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomType/{roomType}/availableRoomTypeComponents": { + "/listOfValues/hotels/{hotelId}/roomPool/{roomPool}/roomPoolRoomTypes": { "get": { - "summary": "Return list of values for hotel available room type components", - "description": "Use this API to return the list of values for available room type components for a specific property based on search criteria such as roomType, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getAvailableRoomTypeComponentsLOV
", - "operationId": "getAvailableRoomTypeComponentsLOV", + "summary": "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": "roomType", + "name": "roomPool", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'roomType' which is required to fetch AvailableRoomTypeComponents LOV" + "description": "Value of the parameter 'roomPool' which is required to fetch RoomPoolRoomTypes LOV" }, { "name": "hotelId", @@ -32431,7 +42742,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 RoomPoolRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -32505,7 +42816,43 @@ } }, "204": { - "description": "AvailableRoomTypeComponentsLOV not found." + "description": "RoomPoolRoomTypesLOV 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": [ @@ -32519,30 +42866,149 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomType/{roomType}/roomNumber/{roomNumber}/availableRoomComponents": { + "/listOfValues/hotels/{hotelId}/roomPools": { "get": { - "summary": "Return list of values for hotel available room components", - "description": "Use this API to return the list of values for available room components for a specific property based on search criteria such as roomNumber, roomType, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getAvailableRoomComponentsLOV
", - "operationId": "getAvailableRoomComponentsLOV", + "summary": "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": "roomNumber", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'roomNumber' which is required to fetch AvailableRoomComponents LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch RoomPools 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": "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": "RoomPoolsLOV 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}/roomRevenueTrxCodes": { + "get": { + "summary": "Return list of values for hotel room revenue transaction codes", + "description": "Use this API to return the list of values for room revenue transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomRevenueTrxCodesLOV
", + "operationId": "getRoomRevenueTrxCodesLOV", + "parameters": [ { "name": "hotelId", "in": "path", @@ -32550,7 +43016,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 RoomRevenueTrxCodes LOV" }, { "name": "includeInactiveFlag", @@ -32624,7 +43090,43 @@ } }, "204": { - "description": "AvailableRoomComponentsLOV not found." + "description": "RoomRevenueTrxCodesLOV 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": [ @@ -32638,21 +43140,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomTypeLabel/{roomTypeLabel}/facilityTasksRoomType": { + "/listOfValues/hotels/{hotelId}/roomRotationGroups": { "get": { - "summary": "Return list of values for hotel facility tasks room types", - "description": "Use this API to return the list of values for facility tasks room types for a specific property based on search criteria such as roomTypeLabel, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getFacilityTasksRoomTypeLOV
", - "operationId": "getFacilityTasksRoomTypeLOV", + "summary": "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": "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", @@ -32660,7 +43153,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 RoomRotationGroups LOV" }, { "name": "includeInactiveFlag", @@ -32734,7 +43227,43 @@ } }, "204": { - "description": "FacilityTasksRoomTypeLOV not found." + "description": "RoomRotationGroupsLOV 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": [ @@ -32748,11 +43277,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomTypePool": { + "/listOfValues/hotels/{hotelId}/roomRotationUnitGrades": { "get": { - "summary": "Return list of values for hotel room type pools", - "description": "Use this API to return the list of values for room type pools for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomTypePoolLOV
", - "operationId": "getRoomTypePoolLOV", + "summary": "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": "hotelId", @@ -32761,7 +43290,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 RoomRotationUnitGrades LOV" }, { "name": "includeInactiveFlag", @@ -32835,7 +43364,43 @@ } }, "204": { - "description": "RoomTypePoolLOV not found." + "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": [ @@ -32849,11 +43414,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomTypes": { + "/listOfValues/hotels/{hotelId}/roomSpecials": { "get": { - "summary": "Return list of values for hotel room types", - "description": "Use this API to return the list of values for room types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomTypesLOV
", - "operationId": "getRoomTypesLOV", + "summary": "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", @@ -32862,7 +43427,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 RoomSpecials LOV" }, { "name": "includeInactiveFlag", @@ -32936,7 +43501,43 @@ } }, "204": { - "description": "RoomTypesLOV not found." + "description": "RoomSpecialsLOV 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": [ @@ -32950,12 +43551,39 @@ ] } }, - "/listOfValues/hotels/{hotelId}/rooms": { + "/listOfValues/hotels/{hotelId}/roomType/{roomType}/arrival/{arrival}/departure/{departure}/roomingListHKRooms": { "get": { - "summary": "Return list of values for hotel rooms", - "description": "Use this API to return the list of values for rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomsLOV
", - "operationId": "getRoomsLOV", + "summary": "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": "departure", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'departure' which is required to fetch RoomingListHKRooms LOV" + }, + { + "name": "arrival", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'arrival' which is required to fetch RoomingListHKRooms LOV" + }, + { + "name": "roomType", + "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", "in": "path", @@ -32963,7 +43591,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 RoomingListHKRooms LOV" }, { "name": "includeInactiveFlag", @@ -33037,7 +43665,43 @@ } }, "204": { - "description": "RoomsLOV not found." + "description": "RoomingListHKRoomsLOV 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": [ @@ -33051,12 +43715,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/roomsKeyGeneration": { + "/listOfValues/hotels/{hotelId}/roomType/{roomType}/availableRoomTypeComponents": { "get": { - "summary": "Return list of values for hotel rooms key generation", - "description": "Use this API to return the list of values for rooms key generation for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomsKeyGenerationLOV
", - "operationId": "getRoomsKeyGenerationLOV", + "summary": "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": "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", @@ -33064,7 +43737,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 AvailableRoomTypeComponents LOV" }, { "name": "includeInactiveFlag", @@ -33138,7 +43811,43 @@ } }, "204": { - "description": "RoomsKeyGenerationLOV not found." + "description": "AvailableRoomTypeComponentsLOV 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": [ @@ -33152,12 +43861,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/routingInstructions": { + "/listOfValues/hotels/{hotelId}/roomType/{roomType}/roomNumber/{roomNumber}/availableRoomComponents": { "get": { - "summary": "Return list of values for hotel routing instructions", - "description": "Use this API to return the list of values for routing instructions for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoutingInstructionsLOV
", - "operationId": "getRoutingInstructionsLOV", + "summary": "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", @@ -33165,7 +43892,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 AvailableRoomComponents LOV" }, { "name": "includeInactiveFlag", @@ -33239,7 +43966,43 @@ } }, "204": { - "description": "RoutingInstructionsLOV not found." + "description": "AvailableRoomComponentsLOV 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": [ @@ -33253,12 +44016,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/salesManagerGoalPeriod": { + "/listOfValues/hotels/{hotelId}/roomTypeLabel/{roomTypeLabel}/facilityTasksRoomType": { "get": { - "summary": "Return list of values for hotel sales manager goal periods", - "description": "Use this API to return the list of values for sales manager goal periods for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSalesManagerGoalPeriodLOV
", - "operationId": "getSalesManagerGoalPeriodLOV", + "summary": "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", @@ -33266,7 +44038,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 FacilityTasksRoomType LOV" }, { "name": "includeInactiveFlag", @@ -33340,7 +44112,43 @@ } }, "204": { - "description": "SalesManagerGoalPeriodLOV not found." + "description": "FacilityTasksRoomTypeLOV 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": [ @@ -33354,11 +44162,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/scheduledReportsExport": { + "/listOfValues/hotels/{hotelId}/roomTypePool": { "get": { - "summary": "Return list of values for hotel scheduled report exports", - "description": "Use this API to return the list of values for scheduled report exports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getScheduledReportsExportLOV
", - "operationId": "getScheduledReportsExportLOV", + "summary": "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", @@ -33367,7 +44175,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 RoomTypePool LOV" }, { "name": "includeInactiveFlag", @@ -33441,7 +44249,43 @@ } }, "204": { - "description": "ScheduledReportsExportLOV not found." + "description": "RoomTypePoolLOV 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": [ @@ -33455,21 +44299,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/sectionType/{sectionType}/sitePlanSectionTypeLinks": { + "/listOfValues/hotels/{hotelId}/roomTypes": { "get": { - "summary": "Return list of values for hotel site plan section type links", - "description": "Use this API to return the list of values for site plan section type links for a specific property based on search criteria such as sectionType, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSitePlanSectionTypeLinksLOV
", - "operationId": "getSitePlanSectionTypeLinksLOV", + "summary": "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": "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", @@ -33477,7 +44312,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 RoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -33551,130 +44386,43 @@ } }, "204": { - "description": "SitePlanSectionTypeLinksLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/sell/{sell}/exchangeType/{exchangeType}/foreignCurrencies": { - "get": { - "summary": "Return list of values for hotel foreign currencies", - "description": "Use this API to return the list of values for foreign currencies for a specific property based on search criteria such as exchangeType, sell, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getForeignCurrenciesLOV
", - "operationId": "getForeignCurrenciesLOV", - "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" + "description": "RoomTypesLOV not found." }, - { - "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" - ] + "400": { + "$ref": "#/responses/400" }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ForeignCurrencies LOV" + "401": { + "$ref": "#/responses/401" }, - { - "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" + "403": { + "$ref": "#/responses/403" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "405": { + "$ref": "#/responses/405" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/authKey" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-app-key" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-hotelid" + "415": { + "$ref": "#/responses/415" }, - { - "$ref": "#/parameters/x-externalsystem" + "500": { + "$ref": "#/responses/500" }, - { - "$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" - } + "502": { + "$ref": "#/responses/502" }, - "204": { - "description": "ForeignCurrenciesLOV not found." + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -33688,30 +44436,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/inventoryItems": { + "/listOfValues/hotels/{hotelId}/rooms": { "get": { - "summary": "Return list of values for hotel inventory items", - "description": "Use this API to return the list of values for inventory items for a specific property based on search criteria such as sellInEvent, sellInReservation, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getInventoryItemsLOV
", - "operationId": "getInventoryItemsLOV", + "summary": "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": "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", @@ -33719,7 +44449,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 Rooms LOV" }, { "name": "includeInactiveFlag", @@ -33793,7 +44523,43 @@ } }, "204": { - "description": "InventoryItemsLOV not found." + "description": "RoomsLOV 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": [ @@ -33807,30 +44573,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/resortInventoryItems": { + "/listOfValues/hotels/{hotelId}/roomsKeyGeneration": { "get": { - "summary": "Return list of values for hotel resort inventory items", - "description": "Use this API to return the list of values for resort inventory items for a specific property based on search criteria such as sellInEvent, sellInReservation, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResortInventoryItemsLOV
", - "operationId": "getResortInventoryItemsLOV", + "summary": "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": "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", @@ -33838,7 +44586,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 RoomsKeyGeneration LOV" }, { "name": "includeInactiveFlag", @@ -33912,7 +44660,43 @@ } }, "204": { - "description": "ResortInventoryItemsLOV not found." + "description": "RoomsKeyGenerationLOV 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": [ @@ -33926,11 +44710,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/serviceRequestCodes": { + "/listOfValues/hotels/{hotelId}/routingInstructions": { "get": { - "summary": "Return list of values for hotel service request codes", - "description": "Use this API to return the list of values for service request codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getServiceRequestCodesLOV
", - "operationId": "getServiceRequestCodesLOV", + "summary": "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": "hotelId", @@ -33939,7 +44723,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 RoutingInstructions LOV" }, { "name": "includeInactiveFlag", @@ -34013,7 +44797,43 @@ } }, "204": { - "description": "ServiceRequestCodesLOV not found." + "description": "RoutingInstructionsLOV 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": [ @@ -34027,11 +44847,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/setupStyles": { + "/listOfValues/hotels/{hotelId}/salesManagerGoalPeriod": { "get": { - "summary": "Return list of values for hotel setup styles", - "description": "Use this API to return the list of values for setup styles for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSetupStylesLOV
", - "operationId": "getSetupStylesLOV", + "summary": "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", @@ -34040,7 +44860,1033 @@ "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 SalesManagerGoalPeriod 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": "SalesManagerGoalPeriodLOV 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}/scheduledReportsExport": { + "get": { + "summary": "Return list of values for hotel scheduled report exports", + "description": "Use this API to return the list of values for scheduled report exports for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getScheduledReportsExportLOV
", + "operationId": "getScheduledReportsExportLOV", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch ScheduledReportsExport 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": "ScheduledReportsExportLOV 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}/sectionType/{sectionType}/sitePlanSectionTypeLinks": { + "get": { + "summary": "Return list of values for hotel site plan section type links", + "description": "Use this API to return the list of values for site plan section type links for a specific property based on search criteria such as sectionType, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSitePlanSectionTypeLinksLOV
", + "operationId": "getSitePlanSectionTypeLinksLOV", + "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", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch SitePlanSectionTypeLinks 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": "SitePlanSectionTypeLinksLOV 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}/sell/{sell}/exchangeType/{exchangeType}/foreignCurrencies": { + "get": { + "summary": "Return list of values for hotel foreign currencies", + "description": "Use this API to return the list of values for foreign currencies for a specific property based on search criteria such as exchangeType, sell, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getForeignCurrenciesLOV
", + "operationId": "getForeignCurrenciesLOV", + "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", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch ForeignCurrencies 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": "ForeignCurrenciesLOV 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}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/inventoryItems": { + "get": { + "summary": "Return list of values for hotel inventory items", + "description": "Use this API to return the list of values for inventory items for a specific property based on search criteria such as sellInEvent, sellInReservation, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getInventoryItemsLOV
", + "operationId": "getInventoryItemsLOV", + "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", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch InventoryItems 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": "InventoryItemsLOV 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}/sellInReservation/{sellInReservation}/sellInEvent/{sellInEvent}/resortInventoryItems": { + "get": { + "summary": "Return list of values for hotel resort inventory items", + "description": "Use this API to return the list of values for resort inventory items for a specific property based on search criteria such as sellInEvent, sellInReservation, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getResortInventoryItemsLOV
", + "operationId": "getResortInventoryItemsLOV", + "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", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch ResortInventoryItems 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": "ResortInventoryItemsLOV 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}/serviceRequestCodes": { + "get": { + "summary": "Return list of values for hotel service request codes", + "description": "Use this API to return the list of values for service request codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getServiceRequestCodesLOV
", + "operationId": "getServiceRequestCodesLOV", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch ServiceRequestCodes 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": "ServiceRequestCodesLOV 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}/setupStyles": { + "get": { + "summary": "Return list of values for hotel setup styles", + "description": "Use this API to return the list of values for setup styles for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSetupStylesLOV
", + "operationId": "getSetupStylesLOV", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch SetupStyles LOV" }, { "name": "includeInactiveFlag", @@ -34115,6 +45961,42 @@ }, "204": { "description": "SetupStylesLOV 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": [ @@ -34215,7 +46097,472 @@ } }, "204": { - "description": "ShiftReportsLOV not found." + "description": "ShiftReportsLOV 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}/siteType/{siteType}/sitePlans": { + "get": { + "summary": "Return list of values for hotel site plans", + "description": "Use this API to return the list of values for site plans for a specific property based on search criteria such as siteType, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSitePlansLOV
", + "operationId": "getSitePlansLOV", + "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", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch SitePlans 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": "SitePlansLOV 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}/snapshotTypes": { + "get": { + "summary": "Fetch List Of Values for Snapshot Types", + "description": "OperationId:getSnapshotTypesLOV
", + "operationId": "getSnapshotTypesLOV", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch SnapshotTypes 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": "SnapshotTypesLOV 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}/space/{space}/cateringSetupStyles": { + "get": { + "summary": "Return list of values for hotel catering setup styles", + "description": "Use this API to return the list of values for catering setup styles for a specific property based on search criteria such as space, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getCateringSetupStylesLOV
", + "operationId": "getCateringSetupStylesLOV", + "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", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'hotelId' which is required to fetch CateringSetupStyles 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": "CateringSetupStylesLOV 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": [ @@ -34229,20 +46576,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/siteType/{siteType}/sitePlans": { + "/listOfValues/hotels/{hotelId}/space/{space}/eventRateCode": { "get": { - "summary": "Return list of values for hotel site plans", - "description": "Use this API to return the list of values for site plans for a specific property based on search criteria such as siteType, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSitePlansLOV
", - "operationId": "getSitePlansLOV", + "summary": "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": "siteType", + "name": "space", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'siteType' which is required to fetch SitePlans LOV" + "description": "Value of the parameter 'space' which is required to fetch EventRateCode LOV" }, { "name": "hotelId", @@ -34251,7 +46598,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 EventRateCode LOV" }, { "name": "includeInactiveFlag", @@ -34325,7 +46672,43 @@ } }, "204": { - "description": "SitePlansLOV not found." + "description": "EventRateCodeLOV 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": [ @@ -34339,11 +46722,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/snapshotTypes": { + "/listOfValues/hotels/{hotelId}/spaces": { "get": { - "summary": "Fetch List Of Values for Snapshot Types", - "description": "OperationId:getSnapshotTypesLOV
", - "operationId": "getSnapshotTypesLOV", + "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", @@ -34352,7 +46735,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 Spaces LOV" }, { "name": "includeInactiveFlag", @@ -34426,7 +46809,43 @@ } }, "204": { - "description": "SnapshotTypesLOV not found." + "description": "SpacesLOV 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": [ @@ -34440,21 +46859,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/space/{space}/cateringSetupStyles": { + "/listOfValues/hotels/{hotelId}/specialRequests": { "get": { - "summary": "Return list of values for hotel catering setup styles", - "description": "Use this API to return the list of values for catering setup styles for a specific property based on search criteria such as space, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getCateringSetupStylesLOV
", - "operationId": "getCateringSetupStylesLOV", + "summary": "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": "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", @@ -34462,7 +46872,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 SpecialRequests LOV" }, { "name": "includeInactiveFlag", @@ -34536,7 +46946,43 @@ } }, "204": { - "description": "CateringSetupStylesLOV not found." + "description": "SpecialRequestsLOV 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": [ @@ -34550,21 +46996,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/space/{space}/eventRateCode": { + "/listOfValues/hotels/{hotelId}/specials": { "get": { - "summary": "Return list of values for hotel event rate codes", - "description": "Use this API to return the list of values for event rate codes for a specific property based on search criteria such as space, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getEventRateCodeLOV
", - "operationId": "getEventRateCodeLOV", + "summary": "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": "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", @@ -34572,7 +47009,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 Specials LOV" }, { "name": "includeInactiveFlag", @@ -34646,7 +47083,43 @@ } }, "204": { - "description": "EventRateCodeLOV not found." + "description": "SpecialsLOV 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": [ @@ -34660,11 +47133,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/spaces": { + "/listOfValues/hotels/{hotelId}/storedValueRedeemTrx": { "get": { - "summary": "Return list of values for hotel spaces", - "description": "Use this API to return the list of values for spaces for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSpacesLOV
", - "operationId": "getSpacesLOV", + "summary": "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": "hotelId", @@ -34673,7 +47146,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 StoredValueRedeemTrx LOV" }, { "name": "includeInactiveFlag", @@ -34747,7 +47220,43 @@ } }, "204": { - "description": "SpacesLOV not found." + "description": "StoredValueRedeemTrxLOV 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": [ @@ -34761,11 +47270,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/specialRequests": { + "/listOfValues/hotels/{hotelId}/summaryRefreshLog": { "get": { - "summary": "Return list of values for hotel special requests", - "description": "Use this API to return the list of values for special requests for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSpecialRequestsLOV
", - "operationId": "getSpecialRequestsLOV", + "summary": "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": "hotelId", @@ -34774,7 +47283,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 SummaryRefreshLog LOV" }, { "name": "includeInactiveFlag", @@ -34848,7 +47357,43 @@ } }, "204": { - "description": "SpecialRequestsLOV not found." + "description": "SummaryRefreshLogLOV 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": [ @@ -34862,12 +47407,21 @@ ] } }, - "/listOfValues/hotels/{hotelId}/specials": { + "/listOfValues/hotels/{hotelId}/superBlock/{superBlock}/subBlock": { "get": { - "summary": "Return list of values for hotel specials", - "description": "Use this API to return the list of values for specials for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSpecialsLOV
", - "operationId": "getSpecialsLOV", + "summary": "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": "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", @@ -34875,7 +47429,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 SubBlock LOV" }, { "name": "includeInactiveFlag", @@ -34949,7 +47503,43 @@ } }, "204": { - "description": "SpecialsLOV not found." + "description": "SubBlockLOV 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": [ @@ -34963,11 +47553,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/storedValueRedeemTrx": { + "/listOfValues/hotels/{hotelId}/synchronizeRateCodes": { "get": { - "summary": "Return list of values for hotel stored value redeem transactions", - "description": "Use this API to return the list of values for stored value redeem transactions for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getStoredValueRedeemTrxLOV
", - "operationId": "getStoredValueRedeemTrxLOV", + "summary": "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": "hotelId", @@ -34976,7 +47566,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 SynchronizeRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -35050,7 +47640,43 @@ } }, "204": { - "description": "StoredValueRedeemTrxLOV not found." + "description": "SynchronizeRateCodesLOV 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": [ @@ -35064,12 +47690,30 @@ ] } }, - "/listOfValues/hotels/{hotelId}/summaryRefreshLog": { + "/listOfValues/hotels/{hotelId}/taskCode/{taskCode}/taskSheetNo/{taskSheetNo}/taskSheetRooms": { "get": { - "summary": "Return list of values for hotel summary refresh logs", - "description": "Use this API to return the list of values for summary refresh logs for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSummaryRefreshLogLOV
", - "operationId": "getSummaryRefreshLogLOV", + "summary": "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", @@ -35077,7 +47721,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 TaskSheetRooms LOV" }, { "name": "includeInactiveFlag", @@ -35151,7 +47795,43 @@ } }, "204": { - "description": "SummaryRefreshLogLOV not found." + "description": "TaskSheetRoomsLOV 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": [ @@ -35165,20 +47845,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/superBlock/{superBlock}/subBlock": { + "/listOfValues/hotels/{hotelId}/taxCode/{taxCode}/taxTransactionCode": { "get": { - "summary": "Return list of values for hotel sub blocks", - "description": "Use this API to return the list of values for sub blocks for a specific property based on search criteria such as superBlock, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSubBlockLOV
", - "operationId": "getSubBlockLOV", + "summary": "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": "superBlock", + "name": "taxCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'superBlock' which is required to fetch SubBlock LOV" + "description": "Value of the parameter 'taxCode' which is required to fetch TaxTransactionCode LOV" }, { "name": "hotelId", @@ -35187,7 +47867,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 TaxTransactionCode LOV" }, { "name": "includeInactiveFlag", @@ -35261,7 +47941,43 @@ } }, "204": { - "description": "SubBlockLOV not found." + "description": "TaxTransactionCodeLOV 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": [ @@ -35275,11 +47991,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/synchronizeRateCodes": { + "/listOfValues/hotels/{hotelId}/taxTypes": { "get": { - "summary": "Return list of values for hotel synchronize rate codes", - "description": "Use this API to return the list of values for synchronize rate codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getSynchronizeRateCodesLOV
", - "operationId": "getSynchronizeRateCodesLOV", + "summary": "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", @@ -35288,7 +48004,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 TaxTypes LOV" }, { "name": "includeInactiveFlag", @@ -35362,7 +48078,43 @@ } }, "204": { - "description": "SynchronizeRateCodesLOV not found." + "description": "TaxTypesLOV 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": [ @@ -35376,29 +48128,170 @@ ] } }, - "/listOfValues/hotels/{hotelId}/taskCode/{taskCode}/taskSheetNo/{taskSheetNo}/taskSheetRooms": { + "/listOfValues/hotels/{hotelId}/telephoneCategory": { "get": { - "summary": "Return list of values for hotel task sheet rooms", - "description": "Use this API to return the list of values for task sheet rooms for a specific property based on search criteria such as taskSheetNo, taskCode, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTaskSheetRoomsLOV
", - "operationId": "getTaskSheetRoomsLOV", + "summary": "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": "taskSheetNo", + "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'taskSheetNo' which is required to fetch TaskSheetRooms LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch TelephoneCategory LOV" }, { - "name": "taskCode", + "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": "TelephoneCategoryLOV 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}/tiered/{tiered}/currentRateCode/{currentRateCode}/configDynamicBaseRatePlans": { + "get": { + "summary": "Return list of values for hotel configuration dynamic base rate plans", + "description": "Use this API to return the list of values for configuration dynamic base rate plans for a specific property based on search criteria such as currentRateCode, tiered, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getConfigDynamicBaseRatePlansLOV
", + "operationId": "getConfigDynamicBaseRatePlansLOV", + "parameters": [ + { + "name": "currentRateCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'taskCode' which is required to fetch TaskSheetRooms LOV" + "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", @@ -35407,7 +48300,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 ConfigDynamicBaseRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -35481,7 +48374,43 @@ } }, "204": { - "description": "TaskSheetRoomsLOV not found." + "description": "ConfigDynamicBaseRatePlansLOV 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": [ @@ -35495,21 +48424,12 @@ ] } }, - "/listOfValues/hotels/{hotelId}/taxCode/{taxCode}/taxTransactionCode": { + "/listOfValues/hotels/{hotelId}/transactionAdjustmentReasonCodes": { "get": { - "summary": "Return list of values for hotel tax transaction code", - "description": "Use this API to return the list of values for tax transaction code for a specific property based on search criteria such as taxCode, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTaxTransactionCodeLOV
", - "operationId": "getTaxTransactionCodeLOV", + "summary": "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": "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", @@ -35517,7 +48437,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 TransactionAdjustmentReasonCodes LOV" }, { "name": "includeInactiveFlag", @@ -35591,7 +48511,43 @@ } }, "204": { - "description": "TaxTransactionCodeLOV not found." + "description": "TransactionAdjustmentReasonCodesLOV 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": [ @@ -35605,11 +48561,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/taxTypes": { + "/listOfValues/hotels/{hotelId}/transactionCodes": { "get": { - "summary": "Return list of values for hotel tax types", - "description": "Use this API to return the list of values for tax types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTaxTypesLOV
", - "operationId": "getTaxTypesLOV", + "summary": "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": "hotelId", @@ -35618,7 +48574,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 TransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -35692,7 +48648,43 @@ } }, "204": { - "description": "TaxTypesLOV not found." + "description": "TransactionCodesLOV 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": [ @@ -35706,11 +48698,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/telephoneCategory": { + "/listOfValues/hotels/{hotelId}/transactionCodesConsumption": { "get": { - "summary": "Return list of values for hotel telephone categories", - "description": "Use this API to return the list of values for telephone categories for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTelephoneCategoryLOV
", - "operationId": "getTelephoneCategoryLOV", + "summary": "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", @@ -35719,7 +48711,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 TransactionCodesConsumption LOV" }, { "name": "includeInactiveFlag", @@ -35793,130 +48785,43 @@ } }, "204": { - "description": "TelephoneCategoryLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/hotels/{hotelId}/tiered/{tiered}/currentRateCode/{currentRateCode}/configDynamicBaseRatePlans": { - "get": { - "summary": "Return list of values for hotel configuration dynamic base rate plans", - "description": "Use this API to return the list of values for configuration dynamic base rate plans for a specific property based on search criteria such as currentRateCode, tiered, hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getConfigDynamicBaseRatePlansLOV
", - "operationId": "getConfigDynamicBaseRatePlansLOV", - "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" + "description": "TransactionCodesConsumptionLOV not found." }, - { - "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" - ] + "400": { + "$ref": "#/responses/400" }, - { - "name": "hotelId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch ConfigDynamicBaseRatePlans LOV" + "401": { + "$ref": "#/responses/401" }, - { - "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" + "403": { + "$ref": "#/responses/403" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "405": { + "$ref": "#/responses/405" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/authKey" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-app-key" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-hotelid" + "415": { + "$ref": "#/responses/415" }, - { - "$ref": "#/parameters/x-externalsystem" + "500": { + "$ref": "#/responses/500" }, - { - "$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" - } + "502": { + "$ref": "#/responses/502" }, - "204": { - "description": "ConfigDynamicBaseRatePlansLOV not found." + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -35930,11 +48835,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionAdjustmentReasonCodes": { + "/listOfValues/hotels/{hotelId}/transactionCodesPayment": { "get": { - "summary": "Return list of values for hotel transaction adjustment reason codes", - "description": "Use this API to return the list of values for transaction adjustment reason codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTransactionAdjustmentReasonCodesLOV
", - "operationId": "getTransactionAdjustmentReasonCodesLOV", + "summary": "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", @@ -35943,7 +48848,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 TransactionCodesPayment LOV" }, { "name": "includeInactiveFlag", @@ -36017,7 +48922,43 @@ } }, "204": { - "description": "TransactionAdjustmentReasonCodesLOV not found." + "description": "TransactionCodesPaymentLOV 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": [ @@ -36031,11 +48972,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionCodes": { + "/listOfValues/hotels/{hotelId}/transactionDeleteReasonCodes": { "get": { - "summary": "Return list of values for hotel transaction codes", - "description": "Use this API to return the list of values for transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTransactionCodesLOV
", - "operationId": "getTransactionCodesLOV", + "summary": "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", @@ -36044,7 +48985,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 TransactionDeleteReasonCodes LOV" }, { "name": "includeInactiveFlag", @@ -36118,7 +49059,43 @@ } }, "204": { - "description": "TransactionCodesLOV not found." + "description": "TransactionDeleteReasonCodesLOV 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": [ @@ -36132,11 +49109,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionCodesConsumption": { + "/listOfValues/hotels/{hotelId}/transactionDiversionRuleRooms": { "get": { - "summary": "Return list of values for hotel transaction codes consumption", - "description": "Use this API to return the list of values for transaction codes consumption for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTransactionCodesConsumptionLOV
", - "operationId": "getTransactionCodesConsumptionLOV", + "summary": "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", @@ -36145,7 +49122,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 TransactionDiversionRuleRooms LOV" }, { "name": "includeInactiveFlag", @@ -36219,7 +49196,43 @@ } }, "204": { - "description": "TransactionCodesConsumptionLOV not found." + "description": "TransactionDiversionRuleRoomsLOV 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": [ @@ -36233,11 +49246,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionCodesPayment": { + "/listOfValues/hotels/{hotelId}/transactionGroups": { "get": { - "summary": "Return list of values for hotel transaction codes payment", - "description": "Use this API to return the list of values for transaction codes payment for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTransactionCodesPaymentLOV
", - "operationId": "getTransactionCodesPaymentLOV", + "summary": "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", @@ -36246,7 +49259,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 TransactionGroups LOV" }, { "name": "includeInactiveFlag", @@ -36320,7 +49333,43 @@ } }, "204": { - "description": "TransactionCodesPaymentLOV not found." + "description": "TransactionGroupsLOV 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": [ @@ -36334,11 +49383,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionDeleteReasonCodes": { + "/listOfValues/hotels/{hotelId}/transactionSubgroups": { "get": { - "summary": "Return list of values for hotel transaction delete reason codes", - "description": "Use this API to return the list of values for transaction delete reason codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTransactionDeleteReasonCodesLOV
", - "operationId": "getTransactionDeleteReasonCodesLOV", + "summary": "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": "hotelId", @@ -36347,7 +49396,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 TransactionSubgroups LOV" }, { "name": "includeInactiveFlag", @@ -36421,7 +49470,43 @@ } }, "204": { - "description": "TransactionDeleteReasonCodesLOV not found." + "description": "TransactionSubgroupsLOV 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": [ @@ -36435,11 +49520,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionDiversionRuleRooms": { + "/listOfValues/hotels/{hotelId}/transportTypes": { "get": { - "summary": "Return list of values for hotel transaction diversion rule rooms", - "description": "Use this API to return the list of values for transaction diversion rule rooms for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTransactionDiversionRuleRoomsLOV
", - "operationId": "getTransactionDiversionRuleRoomsLOV", + "summary": "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", @@ -36448,7 +49533,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 TransportTypes LOV" }, { "name": "includeInactiveFlag", @@ -36522,7 +49607,43 @@ } }, "204": { - "description": "TransactionDiversionRuleRoomsLOV not found." + "description": "TransportTypesLOV 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": [ @@ -36536,11 +49657,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionGroups": { + "/listOfValues/hotels/{hotelId}/transportTypesHotel": { "get": { - "summary": "Return list of values for hotel transaction groups", - "description": "Use this API to return the list of values for transaction groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTransactionGroupsLOV
", - "operationId": "getTransactionGroupsLOV", + "summary": "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": "hotelId", @@ -36549,7 +49670,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 TransportTypesHotel LOV" }, { "name": "includeInactiveFlag", @@ -36623,7 +49744,43 @@ } }, "204": { - "description": "TransactionGroupsLOV not found." + "description": "TransportTypesHotelLOV not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -36637,11 +49794,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transactionSubgroups": { + "/listOfValues/hotels/{hotelId}/travelAgentSource": { "get": { - "summary": "Return list of values for hotel transaction subgroups", - "description": "Use this API to return the list of values for transaction subgroups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTransactionSubgroupsLOV
", - "operationId": "getTransactionSubgroupsLOV", + "summary": "Return list of values for hotel travel agent source reservations", + "description": "Use this API to return the list of values for travel agent sources for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTravelAgentSourceLOV
", + "operationId": "getTravelAgentSourceLOV", "parameters": [ { "name": "hotelId", @@ -36650,7 +49807,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 TravelAgentSource LOV" }, { "name": "includeInactiveFlag", @@ -36724,7 +49881,43 @@ } }, "204": { - "description": "TransactionSubgroupsLOV not found." + "description": "TravelAgentSourceLOV 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": [ @@ -36738,11 +49931,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transportTypes": { + "/listOfValues/hotels/{hotelId}/travelAgentSourceResv": { "get": { - "summary": "Return list of values for hotel transport types", - "description": "Use this API to return the list of values for transport types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTransportTypesLOV
", - "operationId": "getTransportTypesLOV", + "summary": "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", @@ -36751,7 +49944,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 TravelAgentSourceResv LOV" }, { "name": "includeInactiveFlag", @@ -36825,7 +50018,43 @@ } }, "204": { - "description": "TransportTypesLOV not found." + "description": "TravelAgentSourceResvLOV 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": [ @@ -36839,11 +50068,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/transportTypesHotel": { + "/listOfValues/hotels/{hotelId}/turnawayCodes": { "get": { - "summary": "Return list of values for hotel transport types", - "description": "Use this API to return the list of values for transport types for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTransportTypesLOV
", - "operationId": "getTransportTypesHotelLOV", + "summary": "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", @@ -36852,7 +50081,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 TurnawayCodes LOV" }, { "name": "includeInactiveFlag", @@ -36926,7 +50155,43 @@ } }, "204": { - "description": "TransportTypesHotelLOV not found." + "description": "TurnawayCodesLOV 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": [ @@ -36940,11 +50205,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/travelAgentSource": { + "/listOfValues/hotels/{hotelId}/upsellDefaultTrxCode": { "get": { - "summary": "Return list of values for hotel travel agent source reservations", - "description": "Use this API to return the list of values for travel agent sources for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTravelAgentSourceLOV
", - "operationId": "getTravelAgentSourceLOV", + "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": "hotelId", @@ -36953,7 +50218,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 UpsellDefaultTrxCode LOV" }, { "name": "includeInactiveFlag", @@ -37027,7 +50292,43 @@ } }, "204": { - "description": "TravelAgentSourceLOV not found." + "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": [ @@ -37041,11 +50342,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/travelAgentSourceResv": { + "/listOfValues/hotels/{hotelId}/upsellFromRoomClassEdit": { "get": { - "summary": "Return list of values for hotel travel agent source reservations", - "description": "Use this API to return the list of values for travel agent source reservations for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTravelAgentSourceResvLOV
", - "operationId": "getTravelAgentSourceResvLOV", + "summary": "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", @@ -37054,7 +50355,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TravelAgentSourceResv LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellFromRoomClassEdit LOV" }, { "name": "includeInactiveFlag", @@ -37128,7 +50429,43 @@ } }, "204": { - "description": "TravelAgentSourceResvLOV not found." + "description": "UpsellFromRoomClassEditLOV 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": [ @@ -37142,11 +50479,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/turnawayCodes": { + "/listOfValues/hotels/{hotelId}/upsellFromRoomTypeEdit": { "get": { - "summary": "Return list of values for hotel turnaway codes", - "description": "Use this API to return the list of values for turnaway codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getTurnawayCodesLOV
", - "operationId": "getTurnawayCodesLOV", + "summary": "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", @@ -37155,7 +50492,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch TurnawayCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellFromRoomTypeEdit LOV" }, { "name": "includeInactiveFlag", @@ -37229,7 +50566,43 @@ } }, "204": { - "description": "TurnawayCodesLOV not found." + "description": "UpsellFromRoomTypeEditLOV 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": [ @@ -37243,11 +50616,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellDefaultTrxCode": { + "/listOfValues/hotels/{hotelId}/upsellHierarchyLevels": { "get": { - "summary": "Return list of values for hotel upsell default transaction code", - "description": "Use this API to return the list of values for upsell default transaction code for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUpsellDefaultTrxCodeLOV
", - "operationId": "getUpsellDefaultTrxCodeLOV", + "summary": "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", @@ -37256,7 +50629,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellDefaultTrxCode LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellHierarchyLevels LOV" }, { "name": "includeInactiveFlag", @@ -37330,7 +50703,43 @@ } }, "204": { - "description": "UpsellDefaultTrxCodeLOV not found." + "description": "UpsellHierarchyLevelsLOV 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": [ @@ -37344,11 +50753,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellFromRoomClassEdit": { + "/listOfValues/hotels/{hotelId}/upsellRateCategoriesEdit": { "get": { - "summary": "Return list of values for hotel upsell from room class edit", - "description": "Use this API to return the list of values for upsell from room class edit for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUpsellFromRoomClassEditLOV
", - "operationId": "getUpsellFromRoomClassEditLOV", + "summary": "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", @@ -37357,7 +50766,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellFromRoomClassEdit LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRateCategoriesEdit LOV" }, { "name": "includeInactiveFlag", @@ -37431,7 +50840,43 @@ } }, "204": { - "description": "UpsellFromRoomClassEditLOV not found." + "description": "UpsellRateCategoriesEditLOV 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": [ @@ -37445,11 +50890,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellFromRoomTypeEdit": { + "/listOfValues/hotels/{hotelId}/upsellRateCodes": { "get": { - "summary": "Return list of values for hotel upsell from room type edit", - "description": "Use this API to return the list of values for upsell from room type edit for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUpsellFromRoomTypeEditLOV
", - "operationId": "getUpsellFromRoomTypeEditLOV", + "summary": "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", @@ -37458,7 +50903,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellFromRoomTypeEdit LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRateCodes LOV" }, { "name": "includeInactiveFlag", @@ -37532,7 +50977,43 @@ } }, "204": { - "description": "UpsellFromRoomTypeEditLOV not found." + "description": "UpsellRateCodesLOV 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": [ @@ -37546,11 +51027,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellHierarchyLevels": { + "/listOfValues/hotels/{hotelId}/upsellRoomClassView": { "get": { - "summary": "Return list of values for hotel upsell hierarchy levels", - "description": "Use this API to return the list of values for upsell hierarchy levels for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUpsellHierarchyLevelsLOV
", - "operationId": "getUpsellHierarchyLevelsLOV", + "summary": "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", @@ -37559,7 +51040,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellHierarchyLevels LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRoomClassView LOV" }, { "name": "includeInactiveFlag", @@ -37633,7 +51114,43 @@ } }, "204": { - "description": "UpsellHierarchyLevelsLOV not found." + "description": "UpsellRoomClassViewLOV 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": [ @@ -37647,11 +51164,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRateCategoriesEdit": { + "/listOfValues/hotels/{hotelId}/upsellRoomTypeView": { "get": { - "summary": "Return list of values for hotel upsell rate categories edit", - "description": "Use this API to return the list of values for upsell rate categories edit for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUpsellRateCategoriesEditLOV
", - "operationId": "getUpsellRateCategoriesEditLOV", + "summary": "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", @@ -37660,7 +51177,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRateCategoriesEdit LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRoomTypeView LOV" }, { "name": "includeInactiveFlag", @@ -37734,7 +51251,43 @@ } }, "204": { - "description": "UpsellRateCategoriesEditLOV not found." + "description": "UpsellRoomTypeViewLOV 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": [ @@ -37748,11 +51301,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRateCodes": { + "/listOfValues/hotels/{hotelId}/upsellRule": { "get": { - "summary": "Return list of values for hotel upsell rate codes", - "description": "Use this API to return the list of values for upsell rate codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUpsellRateCodesLOV
", - "operationId": "getUpsellRateCodesLOV", + "summary": "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", @@ -37761,7 +51314,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRateCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRule LOV" }, { "name": "includeInactiveFlag", @@ -37835,7 +51388,43 @@ } }, "204": { - "description": "UpsellRateCodesLOV not found." + "description": "UpsellRuleLOV 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": [ @@ -37849,11 +51438,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRoomClassView": { + "/listOfValues/hotels/{hotelId}/upsellTrxCodes": { "get": { - "summary": "Return list of values for hotel upsell room class view", - "description": "Use this API to return the list of values for upsell room class view for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUpsellRoomClassViewLOV
", - "operationId": "getUpsellRoomClassViewLOV", + "summary": "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", @@ -37862,7 +51451,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRoomClassView LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UpsellTrxCodes LOV" }, { "name": "includeInactiveFlag", @@ -37936,7 +51525,43 @@ } }, "204": { - "description": "UpsellRoomClassViewLOV not found." + "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" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -37950,11 +51575,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRoomTypeView": { + "/listOfValues/hotels/{hotelId}/userLogActivityGroups": { "get": { - "summary": "Return list of values for hotel upsell room type view", - "description": "Use this API to return the list of values for upsell room type view for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUpsellRoomTypeViewLOV
", - "operationId": "getUpsellRoomTypeViewLOV", + "summary": "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", @@ -37963,7 +51588,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRoomTypeView LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch UserLogActivityGroups LOV" }, { "name": "includeInactiveFlag", @@ -38037,7 +51662,43 @@ } }, "204": { - "description": "UpsellRoomTypeViewLOV not found." + "description": "UserLogActivityGroupsLOV 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": [ @@ -38051,11 +51712,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellRule": { + "/listOfValues/hotels/{hotelId}/yearSetup": { "get": { - "summary": "Return list of values for hotel upsell rules", - "description": "Use this API to return the list of values for upsell rules for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUpsellRuleLOV
", - "operationId": "getUpsellRuleLOV", + "summary": "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", @@ -38064,7 +51725,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellRule LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch YearSetup LOV" }, { "name": "includeInactiveFlag", @@ -38138,7 +51799,43 @@ } }, "204": { - "description": "UpsellRuleLOV not found." + "description": "YearSetupLOV 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": [ @@ -38152,11 +51849,11 @@ ] } }, - "/listOfValues/hotels/{hotelId}/upsellTrxCodes": { + "/listOfValues/hotels/{hotelId}/yieldMarkets": { "get": { - "summary": "Return list of values for hotel upsell transaction codes", - "description": "Use this API to return the list of values for upsell transaction codes for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUpsellTrxCodesLOV
", - "operationId": "getUpsellTrxCodesLOV", + "summary": "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", @@ -38165,7 +51862,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch UpsellTrxCodes LOV" + "description": "Value of the parameter 'hotelId' which is required to fetch YieldMarkets LOV" }, { "name": "includeInactiveFlag", @@ -38239,7 +51936,43 @@ } }, "204": { - "description": "UpsellTrxCodesLOV not found." + "description": "YieldMarketsLOV 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": [ @@ -38253,20 +51986,20 @@ ] } }, - "/listOfValues/hotels/{hotelId}/userLogActivityGroups": { + "/listOfValues/includeDayUse/{includeDayUse}/roomReservationStatus": { "get": { - "summary": "Return list of values for hotel user log activity groups", - "description": "Use this API to return the list of values for user log activity groups for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getUserLogActivityGroupsLOV
", - "operationId": "getUserLogActivityGroupsLOV", + "summary": "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 UserLogActivityGroups LOV" + "description": "Value of the parameter 'includeDayUse' which is required to fetch RoomReservationStatus LOV" }, { "name": "includeInactiveFlag", @@ -38340,7 +52073,43 @@ } }, "204": { - "description": "UserLogActivityGroupsLOV not found." + "description": "RoomReservationStatusLOV 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": [ @@ -38354,20 +52123,24 @@ ] } }, - "/listOfValues/hotels/{hotelId}/yearSetup": { + "/listOfValues/includeGlobals/{includeGlobals}/templatePreferences": { "get": { - "summary": "Return list of values for hotel year setup", - "description": "Use this API to return the list of values for user hotel year setup for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getYearSetupLOV
", - "operationId": "getYearSetupLOV", + "summary": "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 YearSetup LOV" + "description": "Value of the parameter 'includeGlobals' which is required to fetch TemplatePreferences LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -38441,7 +52214,43 @@ } }, "204": { - "description": "YearSetupLOV not found." + "description": "TemplatePreferencesLOV 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": [ @@ -38455,20 +52264,24 @@ ] } }, - "/listOfValues/hotels/{hotelId}/yieldMarkets": { + "/listOfValues/includeInactive/{includeInactive}/templateMarketCodes": { "get": { - "summary": "Return list of values for hotel yield markets", - "description": "Use this API to return the list of values for yield markets for a specific property based on search criteria such as hotelId, includeInactiveFlag, parameterName, parameterValue.OperationId:getYieldMarketsLOV
", - "operationId": "getYieldMarketsLOV", + "summary": "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 YieldMarkets LOV" + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateMarketCodes LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -38542,7 +52355,43 @@ } }, "204": { - "description": "YieldMarketsLOV not found." + "description": "TemplateMarketCodesLOV not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -38556,20 +52405,24 @@ ] } }, - "/listOfValues/includeDayUse/{includeDayUse}/roomReservationStatus": { + "/listOfValues/includeInactive/{includeInactive}/templateMarketGroups": { "get": { - "summary": "Return list of values for room reservation status", - "description": "Use this API to return the list of values for room reservation status based on search criteria such as includeDayUse, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomReservationStatusLOV
", - "operationId": "getRoomReservationStatusLOV", + "summary": "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": "includeDayUse", + "name": "includeInactive", "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 'includeInactive' which is required to fetch TemplateMarketGroups LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -38643,7 +52496,43 @@ } }, "204": { - "description": "RoomReservationStatusLOV not found." + "description": "TemplateMarketGroupsLOV 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": [ @@ -38657,20 +52546,20 @@ ] } }, - "/listOfValues/includeGlobals/{includeGlobals}/templatePreferences": { + "/listOfValues/includeInactive/{includeInactive}/templateRoomClasses": { "get": { - "summary": "Return list of values for preference templates", - "description": "Use this API to return the list of values for preference templates based on search criteria such as includeGlobals, includeInactiveFlag, parameterName, parameterValue.OperationId:getTemplatePreferencesLOV
", - "operationId": "getTemplatePreferencesLOV", + "summary": "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": "includeGlobals", + "name": "includeInactive", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'includeGlobals' which is required to fetch TemplatePreferences LOV", + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateRoomClasses LOV", "enum": [ "Y", "N" @@ -38748,7 +52637,43 @@ } }, "204": { - "description": "TemplatePreferencesLOV not found." + "description": "TemplateRoomClassesLOV 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": [ @@ -38762,11 +52687,11 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateMarketCodes": { + "/listOfValues/includeInactive/{includeInactive}/templateSourceCodes": { "get": { - "summary": "Return list of values for market code templates", - "description": "Use this API to return the list of values for market code templates based on search criteria such as includeInactive, includeInactiveFlag, parameterName, parameterValue.OperationId:getTemplateMarketCodesLOV
", - "operationId": "getTemplateMarketCodesLOV", + "summary": "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": "includeInactive", @@ -38775,7 +52700,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateMarketCodes LOV", + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateSourceCodes LOV", "enum": [ "Y", "N" @@ -38853,7 +52778,43 @@ } }, "204": { - "description": "TemplateMarketCodesLOV not found." + "description": "TemplateSourceCodesLOV 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": [ @@ -38867,11 +52828,11 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateMarketGroups": { + "/listOfValues/includeInactive/{includeInactive}/templateSourceGroups": { "get": { - "summary": "Return list of values for market group templates", - "description": "Use this API to return the list of values for market group templates based on search criteria such as includeInactive, includeInactiveFlag, parameterName, parameterValue.OperationId:getTemplateMarketGroupsLOV
", - "operationId": "getTemplateMarketGroupsLOV", + "summary": "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": "includeInactive", @@ -38880,7 +52841,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateMarketGroups LOV", + "description": "Value of the parameter 'includeInactive' which is required to fetch TemplateSourceGroups LOV", "enum": [ "Y", "N" @@ -38958,7 +52919,43 @@ } }, "204": { - "description": "TemplateMarketGroupsLOV not found." + "description": "TemplateSourceGroupsLOV 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": [ @@ -38972,24 +52969,20 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateRoomClasses": { + "/listOfValues/interfaceId/{interfaceId}/allRevenueTypes": { "get": { - "summary": "Return list of values for room class templates", - "description": "Use this API to return the list of values for room class templates based on search criteria such as includeInactive, includeInactiveFlag, parameterName, parameterValue.OperationId:getTemplateRoomClassesLOV
", - "operationId": "getTemplateRoomClassesLOV", + "summary": "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": "includeInactive", + "name": "interfaceId", "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 'interfaceId' which is required to fetch AllRevenueTypes LOV" }, { "name": "includeInactiveFlag", @@ -39063,7 +53056,43 @@ } }, "204": { - "description": "TemplateRoomClassesLOV not found." + "description": "AllRevenueTypesLOV 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": [ @@ -39077,24 +53106,20 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateSourceCodes": { + "/listOfValues/interfaceId/{interfaceId}/oxiResorts": { "get": { - "summary": "Return list of values for source code templates", - "description": "Use this API to return the list of values for source code templates based on search criteria such as includeInactive, includeInactiveFlag, parameterName, parameterValue.OperationId:getTemplateSourceCodesLOV
", - "operationId": "getTemplateSourceCodesLOV", + "summary": "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": "includeInactive", + "name": "interfaceId", "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 'interfaceId' which is required to fetch OXIResorts LOV" }, { "name": "includeInactiveFlag", @@ -39168,7 +53193,43 @@ } }, "204": { - "description": "TemplateSourceCodesLOV not found." + "description": "OXIResortsLOV 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": [ @@ -39182,24 +53243,29 @@ ] } }, - "/listOfValues/includeInactive/{includeInactive}/templateSourceGroups": { + "/listOfValues/interfaceType/{interfaceType}/databaseId/{databaseId}/externalDatabaseAvailableResorts": { "get": { - "summary": "Return list of values for source group templates", - "description": "Use this API to return the list of values for source group templates based on search criteria such as includeInactive, includeInactiveFlag, parameterName, parameterValue.OperationId:getTemplateSourceGroupsLOV
", - "operationId": "getTemplateSourceGroupsLOV", + "summary": "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": "includeInactive", + "name": "databaseId", "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 '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", @@ -39273,7 +53339,43 @@ } }, "204": { - "description": "TemplateSourceGroupsLOV not found." + "description": "ExternalDatabaseAvailableResortsLOV 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": [ @@ -39287,20 +53389,47 @@ ] } }, - "/listOfValues/interfaceId/{interfaceId}/allRevenueTypes": { + "/listOfValues/levelCode/{levelCode}/levelType/{levelType}/settingName/{settingName}/channelCode/{channelCode}/channelParameters": { "get": { - "summary": "Return list of values for all revenue types", - "description": "Use this API to return the list of values for all revenue types based on search criteria such as interfaceId, includeInactiveFlag, parameterName, parameterValue.OperationId:getAllRevenueTypesLOV
", - "operationId": "getAllRevenueTypesLOV", + "summary": "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": "interfaceId", + "name": "channelCode", "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 '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", @@ -39374,7 +53503,43 @@ } }, "204": { - "description": "AllRevenueTypesLOV not found." + "description": "ChannelParametersLOV 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": [ @@ -39388,20 +53553,29 @@ ] } }, - "/listOfValues/interfaceId/{interfaceId}/oxiResorts": { + "/listOfValues/levelCode/{levelCode}/settingName/{settingName}/applicationSettings": { "get": { - "summary": "Return list of values for OXIResorts", - "description": "Use this API to return the list of values for OXIResorts based on search criteria such as interfaceId, includeInactiveFlag, parameterName, parameterValue.OperationId:getOXIResortsLOV
", - "operationId": "getOXIResortsLOV", + "summary": "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": "interfaceId", + "name": "settingName", "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 'settingName' which is required to fetch ApplicationSettings LOV" + }, + { + "name": "levelCode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'levelCode' which is required to fetch ApplicationSettings LOV" }, { "name": "includeInactiveFlag", @@ -39475,7 +53649,43 @@ } }, "204": { - "description": "OXIResortsLOV not found." + "description": "ApplicationSettingsLOV 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": [ @@ -39489,29 +53699,20 @@ ] } }, - "/listOfValues/interfaceType/{interfaceType}/databaseId/{databaseId}/externalDatabaseAvailableResorts": { + "/listOfValues/levelCode/{levelCode}/taskSheetDept": { "get": { - "summary": "Return list of values for external database available resorts", - "description": "Use this API to return the list of values for external database available resorts based on search criteria such as databaseId, interfaceType, includeInactiveFlag, parameterName, parameterValue.OperationId:getExternalDatabaseAvailableResortsLOV
", - "operationId": "getExternalDatabaseAvailableResortsLOV", + "summary": "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": "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": "levelCode", "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 'levelCode' which is required to fetch TaskSheetDept LOV" }, { "name": "includeInactiveFlag", @@ -39585,7 +53786,43 @@ } }, "204": { - "description": "ExternalDatabaseAvailableResortsLOV not found." + "description": "TaskSheetDeptLOV 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": [ @@ -39599,47 +53836,166 @@ ] } }, - "/listOfValues/levelCode/{levelCode}/levelType/{levelType}/settingName/{settingName}/channelCode/{channelCode}/channelParameters": { + "/listOfValues/locationType/{locationType}/location/{location}/distributionTemplates": { "get": { - "summary": "Return list of values for channel parameters", - "description": "Use this API to return the list of values for channel parameters based on search criteria such as channelCode, settingName, levelType, levelCode, includeInactiveFlag, parameterName, parameterValue.OperationId:getChannelParametersLOV
", - "operationId": "getChannelParametersLOV", + "summary": "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": "channelCode", + "name": "location", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'channelCode' which is required to fetch ChannelParameters LOV" + "description": "Value of the parameter 'location' which is required to fetch DistributionTemplates LOV" }, { - "name": "settingName", + "name": "locationType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'settingName' which is required to fetch ChannelParameters LOV" + "description": "Value of the parameter 'locationType' which is required to fetch DistributionTemplates 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": "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": "levelCode", + "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": "DistributionTemplatesLOV 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/membershipId/{membershipId}/membershipStatementBatchList": { + "get": { + "summary": "Return list of values for membership statement batch list", + "description": "Use this API to return the list of values for membership statement batch list based on search criteria such as membershipId, includeInactiveFlag, parameterName, parameterValue.OperationId:getMembershipStatementBatchListLOV
", + "operationId": "getMembershipStatementBatchListLOV", + "parameters": [ + { + "name": "membershipId", "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 'membershipId' which is required to fetch MembershipStatementBatchList LOV" }, { "name": "includeInactiveFlag", @@ -39713,7 +54069,43 @@ } }, "204": { - "description": "ChannelParametersLOV not found." + "description": "MembershipStatementBatchListLOV 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": [ @@ -39727,29 +54119,20 @@ ] } }, - "/listOfValues/levelCode/{levelCode}/settingName/{settingName}/applicationSettings": { + "/listOfValues/membershipId/{membershipId}/membershipTotalPointsAvailable": { "get": { - "summary": "Return list of values for application settings", - "description": "Use this API to return the list of values for application settings based on search criteria such as settingName, levelCode, includeInactiveFlag, parameterName, parameterValue.OperationId:getApplicationSettingsLOV
", - "operationId": "getApplicationSettingsLOV", + "summary": "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": "settingName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'settingName' which is required to fetch ApplicationSettings LOV" - }, - { - "name": "levelCode", + "name": "membershipId", "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 'membershipId' which is required to fetch MembershipTotalPointsAvailable LOV" }, { "name": "includeInactiveFlag", @@ -39823,7 +54206,43 @@ } }, "204": { - "description": "ApplicationSettingsLOV not found." + "description": "MembershipTotalPointsAvailableLOV 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": [ @@ -39837,20 +54256,20 @@ ] } }, - "/listOfValues/levelCode/{levelCode}/taskSheetDept": { + "/listOfValues/membershipLevel/{membershipLevel}/membershipCardFeeAmount": { "get": { - "summary": "Return list of values for task sheet departments", - "description": "Use this API to return the list of values for task sheet departments based on search criteria such as levelCode, includeInactiveFlag, parameterName, parameterValue.OperationId:getTaskSheetDeptLOV
", - "operationId": "getTaskSheetDeptLOV", + "summary": "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": "levelCode", + "name": "membershipLevel", "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 'membershipLevel' which is required to fetch MembershipCardFeeAmount LOV" }, { "name": "includeInactiveFlag", @@ -39924,7 +54343,43 @@ } }, "204": { - "description": "TaskSheetDeptLOV not found." + "description": "MembershipCardFeeAmountLOV 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": [ @@ -39938,29 +54393,29 @@ ] } }, - "/listOfValues/locationType/{locationType}/location/{location}/distributionTemplates": { + "/listOfValues/membershipLevelRank/{membershipLevelRank}/membershipType/{membershipType}/membershipMaxDowngradeLevel": { "get": { - "summary": "Return list of values for distribution templates", - "description": "Use this API to return the list of values for distribution templates based on search criteria such as location, locationType, includeInactiveFlag, parameterName, parameterValue.OperationId:getDistributionTemplatesLOV
", - "operationId": "getDistributionTemplatesLOV", + "summary": "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": "location", + "name": "membershipType", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'location' which is required to fetch DistributionTemplates LOV" + "description": "Value of the parameter 'membershipType' which is required to fetch MembershipMaxDowngradeLevel LOV" }, { - "name": "locationType", + "name": "membershipLevelRank", "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 'membershipLevelRank' which is required to fetch MembershipMaxDowngradeLevel LOV" }, { "name": "includeInactiveFlag", @@ -40034,7 +54489,43 @@ } }, "204": { - "description": "DistributionTemplatesLOV not found." + "description": "MembershipMaxDowngradeLevelLOV 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": [ @@ -40048,20 +54539,20 @@ ] } }, - "/listOfValues/membershipId/{membershipId}/membershipStatementBatchList": { + "/listOfValues/membershipType/{membershipType}/membershipBenefitProgram": { "get": { - "summary": "Return list of values for membership statement batch list", - "description": "Use this API to return the list of values for membership statement batch list based on search criteria such as membershipId, includeInactiveFlag, parameterName, parameterValue.OperationId:getMembershipStatementBatchListLOV
", - "operationId": "getMembershipStatementBatchListLOV", + "summary": "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": "membershipId", + "name": "membershipType", "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 'membershipType' which is required to fetch MembershipBenefitProgram LOV" }, { "name": "includeInactiveFlag", @@ -40135,7 +54626,43 @@ } }, "204": { - "description": "MembershipStatementBatchListLOV not found." + "description": "MembershipBenefitProgramLOV 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": [ @@ -40149,20 +54676,20 @@ ] } }, - "/listOfValues/membershipId/{membershipId}/membershipTotalPointsAvailable": { + "/listOfValues/membershipType/{membershipType}/membershipBenefits": { "get": { - "summary": "Return list of values for membership total points available", - "description": "Use this API to return the list of values for membership total points available based on search criteria such as membershipId, includeInactiveFlag, parameterName, parameterValue.OperationId:getMembershipTotalPointsAvailableLOV
", - "operationId": "getMembershipTotalPointsAvailableLOV", + "summary": "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": "membershipId", + "name": "membershipType", "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 'membershipType' which is required to fetch MembershipBenefits LOV" }, { "name": "includeInactiveFlag", @@ -40236,7 +54763,43 @@ } }, "204": { - "description": "MembershipTotalPointsAvailableLOV not found." + "description": "MembershipBenefitsLOV 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": [ @@ -40250,20 +54813,20 @@ ] } }, - "/listOfValues/membershipLevel/{membershipLevel}/membershipCardFeeAmount": { + "/listOfValues/membershipType/{membershipType}/membershipPointsRuleCodes": { "get": { - "summary": "Return list of values for membership card fee amounts", - "description": "Use this API to return the list of values for membership card fee amounts based on search criteria such as membershipLevel, includeInactiveFlag, parameterName, parameterValue.OperationId:getMembershipCardFeeAmountLOV
", - "operationId": "getMembershipCardFeeAmountLOV", + "summary": "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": "membershipLevel", + "name": "membershipType", "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 'membershipType' which is required to fetch MembershipPointsRuleCodes LOV" }, { "name": "includeInactiveFlag", @@ -40337,7 +54900,43 @@ } }, "204": { - "description": "MembershipCardFeeAmountLOV not found." + "description": "MembershipPointsRuleCodesLOV 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": [ @@ -40351,11 +54950,11 @@ ] } }, - "/listOfValues/membershipLevelRank/{membershipLevelRank}/membershipType/{membershipType}/membershipMaxDowngradeLevel": { + "/listOfValues/membershipType/{membershipType}/upsellMembershipLevelsOnly": { "get": { - "summary": "Return list of values for membership max downgrade level", - "description": "Use this API to return the list of values for membership max downgrade level based on search criteria such as membershipType, membershipLevelRank, includeInactiveFlag, parameterName, parameterValue.OperationId:getMembershipMaxDowngradeLevelLOV
", - "operationId": "getMembershipMaxDowngradeLevelLOV", + "summary": "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": "membershipType", @@ -40364,16 +54963,144 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'membershipType' which is required to fetch MembershipMaxDowngradeLevel LOV" + "description": "Value of the parameter 'membershipType' which is required to fetch UpsellMembershipLevelsOnly LOV" }, { - "name": "membershipLevelRank", + "name": "includeInactiveFlag", + "in": "query", + "required": false, + "description": "Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.", + "type": "boolean" + }, + { + "name": "parameterName", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Name of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "parameterValue", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "description": "Value of the parameter.", + "items": { + "type": "string" + }, + "required": false + }, + { + "name": "excludeCodes", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "maxItems": 4000 + }, + "required": false + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + } + }, + "description": "", + "schema": { + "$ref": "#/definitions/listOfValues" + } + }, + "204": { + "description": "UpsellMembershipLevelsOnlyLOV 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/menuClassId/{menuClassId}/menu": { + "get": { + "summary": "Return list of values for menus", + "description": "Use this API to return the list of values for menus based on search criteria such as menuClassId, includeInactiveFlag, parameterName, parameterValue.OperationId:getMenuLOV
", + "operationId": "getMenuLOV", + "parameters": [ + { + "name": "menuClassId", "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 'menuClassId' which is required to fetch Menu LOV" }, { "name": "includeInactiveFlag", @@ -40447,7 +55174,43 @@ } }, "204": { - "description": "MembershipMaxDowngradeLevelLOV not found." + "description": "MenuLOV 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": [ @@ -40461,20 +55224,20 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/membershipBenefitProgram": { + "/listOfValues/mode/{mode}/folioGroupingTransactionCodes": { "get": { - "summary": "Return list of values for membership benefit programs", - "description": "Use this API to return the list of values for membership benefit programs based on search criteria such as membershipType, includeInactiveFlag, parameterName, parameterValue.OperationId:getMembershipBenefitProgramLOV
", - "operationId": "getMembershipBenefitProgramLOV", + "summary": "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": "membershipType", + "name": "mode", "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 'mode' which is required to fetch FolioGroupingTransactionCodes LOV" }, { "name": "includeInactiveFlag", @@ -40548,7 +55311,43 @@ } }, "204": { - "description": "MembershipBenefitProgramLOV not found." + "description": "FolioGroupingTransactionCodesLOV 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": [ @@ -40562,20 +55361,20 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/membershipBenefits": { + "/listOfValues/module/{module}/actionTypes": { "get": { - "summary": "Return list of values for membership benefits", - "description": "Use this API to return the list of values for membership benefits based on search criteria such as membershipType, includeInactiveFlag, parameterName, parameterValue.OperationId:getMembershipBenefitsLOV
", - "operationId": "getMembershipBenefitsLOV", + "summary": "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": "membershipType", + "name": "module", "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 'module' which is required to fetch ActionTypes LOV" }, { "name": "includeInactiveFlag", @@ -40649,7 +55448,43 @@ } }, "204": { - "description": "MembershipBenefitsLOV not found." + "description": "ActionTypesLOV 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": [ @@ -40663,20 +55498,29 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/membershipPointsRuleCodes": { + "/listOfValues/moduleId/{moduleId}/parameterName/{parameter}/reportsGeneric": { "get": { - "summary": "Return list of values for membership points rule codes", - "description": "Use this API to return the list of values for membership points rule codes based on search criteria such as membershipType, includeInactiveFlag, parameterName, parameterValue.OperationId:getMembershipPointsRuleCodesLOV
", - "operationId": "getMembershipPointsRuleCodesLOV", + "summary": "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": "membershipType", + "name": "parameter", "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 'parameter' which is required to fetch ReportsGeneric LOV" + }, + { + "name": "moduleId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'moduleId' which is required to fetch ReportsGeneric LOV" }, { "name": "includeInactiveFlag", @@ -40750,7 +55594,43 @@ } }, "204": { - "description": "MembershipPointsRuleCodesLOV not found." + "description": "ReportsGenericLOV 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": [ @@ -40764,20 +55644,20 @@ ] } }, - "/listOfValues/membershipType/{membershipType}/upsellMembershipLevelsOnly": { + "/listOfValues/moduleName/{moduleName}/configReports": { "get": { - "summary": "Return list of values for upsell membership levels only", - "description": "Use this API to return the list of values for upsell membership levels only based on search criteria such as membershipType, includeInactiveFlag, parameterName, parameterValue.OperationId:getUpsellMembershipLevelsOnlyLOV
", - "operationId": "getUpsellMembershipLevelsOnlyLOV", + "summary": "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": "membershipType", + "name": "moduleName", "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 'moduleName' which is required to fetch ConfigReports LOV" }, { "name": "includeInactiveFlag", @@ -40851,7 +55731,43 @@ } }, "204": { - "description": "UpsellMembershipLevelsOnlyLOV not found." + "description": "ConfigReportsLOV 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": [ @@ -40865,20 +55781,20 @@ ] } }, - "/listOfValues/menuClassId/{menuClassId}/menu": { + "/listOfValues/moduleName/{moduleName}/udfMappings": { "get": { - "summary": "Return list of values for menus", - "description": "Use this API to return the list of values for menus based on search criteria such as menuClassId, includeInactiveFlag, parameterName, parameterValue.OperationId:getMenuLOV
", - "operationId": "getMenuLOV", + "summary": "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": "menuClassId", + "name": "moduleName", "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 'moduleName' which is required to fetch UDFMappings LOV" }, { "name": "includeInactiveFlag", @@ -40952,7 +55868,43 @@ } }, "204": { - "description": "MenuLOV not found." + "description": "UDFMappingsLOV 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": [ @@ -40966,20 +55918,20 @@ ] } }, - "/listOfValues/mode/{mode}/folioGroupingTransactionCodes": { + "/listOfValues/nameType/{nameType}/profileEnrollmentMatchCriteria": { "get": { - "summary": "Return list of values for folio grouping transaction codes", - "description": "Use this API to return the list of values for folio grouping transaction codes based on search criteria such as mode, includeInactiveFlag, parameterName, parameterValue.OperationId:getFolioGroupingTransactionCodesLOV
", - "operationId": "getFolioGroupingTransactionCodesLOV", + "summary": "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": "mode", + "name": "nameType", "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 'nameType' which is required to fetch ProfileEnrollmentMatchCriteria LOV" }, { "name": "includeInactiveFlag", @@ -41053,7 +56005,43 @@ } }, "204": { - "description": "FolioGroupingTransactionCodesLOV not found." + "description": "ProfileEnrollmentMatchCriteriaLOV 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": [ @@ -41067,20 +56055,20 @@ ] } }, - "/listOfValues/module/{module}/actionTypes": { + "/listOfValues/nameType/{nameType}/profileEnrollmentRuleDoNotMergeCriteria": { "get": { - "summary": "Return list of values for action types", - "description": "Use this API to return the list of values for action types based on search criteria such as module, includeInactiveFlag, parameterName, parameterValue.OperationId:getActionTypesLOV
", - "operationId": "getActionTypesLOV", + "summary": "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": "module", + "name": "nameType", "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 'nameType' which is required to fetch ProfileEnrollmentRuleDoNotMergeCriteria LOV" }, { "name": "includeInactiveFlag", @@ -41154,7 +56142,43 @@ } }, "204": { - "description": "ActionTypesLOV not found." + "description": "ProfileEnrollmentRuleDoNotMergeCriteriaLOV 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": [ @@ -41168,29 +56192,20 @@ ] } }, - "/listOfValues/moduleId/{moduleId}/parameterName/{parameter}/reportsGeneric": { + "/listOfValues/nameType/{nameType}/profileEnrollmentRuleFilterCriteria": { "get": { - "summary": "Return list of values for generic reports", - "description": "Use this API to return the list of values for generic reports based on search criteria such as parameter, moduleId, includeInactiveFlag, parameterName, parameterValue.OperationId:getReportsGenericLOV
", - "operationId": "getReportsGenericLOV", + "summary": "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": "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": "nameType", "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 'nameType' which is required to fetch ProfileEnrollmentRuleFilterCriteria LOV" }, { "name": "includeInactiveFlag", @@ -41264,7 +56279,43 @@ } }, "204": { - "description": "ReportsGenericLOV not found." + "description": "ProfileEnrollmentRuleFilterCriteriaLOV 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": [ @@ -41278,20 +56329,33 @@ ] } }, - "/listOfValues/moduleName/{moduleName}/configReports": { + "/listOfValues/newEvent/{newEvent}/waitList/{waitList}/cateringEventStatus": { "get": { - "summary": "Return list of values for configuration reports", - "description": "Use this API to return the list of values for configuration reports based on search criteria such as moduleName, includeInactiveFlag, parameterName, parameterValue.OperationId:getConfigReportsLOV
", - "operationId": "getConfigReportsLOV", + "summary": "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": "moduleName", + "name": "waitList", "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 'waitList' which is required to fetch CateringEventStatus LOV" + }, + { + "name": "newEvent", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'newEvent' which is required to fetch CateringEventStatus LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -41365,7 +56429,43 @@ } }, "204": { - "description": "ConfigReportsLOV not found." + "description": "CateringEventStatusLOV 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": [ @@ -41379,20 +56479,20 @@ ] } }, - "/listOfValues/moduleName/{moduleName}/udfMappings": { + "/listOfValues/number/{number}/autoNumberGenerator": { "get": { - "summary": "Return list of values for user defined field mappings", - "description": "Use this API to return the list of values for user defined field mappings based on search criteria such as moduleName, includeInactiveFlag, parameterName, parameterValue.OperationId:getUDFMappingsLOV
", - "operationId": "getUDFMappingsLOV", + "summary": "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": "moduleName", + "name": "number", "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 'number' which is required to fetch AutoNumberGenerator LOV" }, { "name": "includeInactiveFlag", @@ -41466,7 +56566,43 @@ } }, "204": { - "description": "UDFMappingsLOV not found." + "description": "AutoNumberGeneratorLOV 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": [ @@ -41480,20 +56616,20 @@ ] } }, - "/listOfValues/nameType/{nameType}/profileEnrollmentMatchCriteria": { + "/listOfValues/operaParam/{operaParam}/profileNameValidationsType": { "get": { - "summary": "Return list of values for profile enrollment match criteria", - "description": "Use this API to return the list of values for profile enrollment match criteria based on search criteria such as nameType, includeInactiveFlag, parameterName, parameterValue.OperationId:getProfileEnrollmentMatchCriteriaLOV
", - "operationId": "getProfileEnrollmentMatchCriteriaLOV", + "summary": "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": "nameType", + "name": "operaParam", "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 'operaParam' which is required to fetch ProfileNameValidationsType LOV" }, { "name": "includeInactiveFlag", @@ -41567,7 +56703,43 @@ } }, "204": { - "description": "ProfileEnrollmentMatchCriteriaLOV not found." + "description": "ProfileNameValidationsTypeLOV 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": [ @@ -41581,20 +56753,29 @@ ] } }, - "/listOfValues/nameType/{nameType}/profileEnrollmentRuleDoNotMergeCriteria": { + "/listOfValues/outboundType/{outboundType}/protocol/{protocol}/outboundServiceNames": { "get": { - "summary": "Return list of values for profile enrollment rule do not merge criteria", - "description": "Use this API to return the list of values for profile enrollment rule do not merge criteria based on search criteria such as nameType, includeInactiveFlag, parameterName, parameterValue.OperationId:getProfileEnrollmentRuleDoNotMergeCriteriaLOV
", - "operationId": "getProfileEnrollmentRuleDoNotMergeCriteriaLOV", + "summary": "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": "nameType", + "name": "protocol", "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 '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", @@ -41668,7 +56849,43 @@ } }, "204": { - "description": "ProfileEnrollmentRuleDoNotMergeCriteriaLOV not found." + "description": "ServiceNameLOV 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": [ @@ -41682,20 +56899,29 @@ ] } }, - "/listOfValues/nameType/{nameType}/profileEnrollmentRuleFilterCriteria": { + "/listOfValues/parameterName/{parameter}/chainCode/{chainCode}/parameterActiveUnderChain": { "get": { - "summary": "Return list of values for profile enrollment rule filter criteria", - "description": "Use this API to return the list of values for profile enrollment rule filter criteria based on search criteria such as nameType, includeInactiveFlag, parameterName, parameterValue.OperationId:getProfileEnrollmentRuleFilterCriteriaLOV
", - "operationId": "getProfileEnrollmentRuleFilterCriteriaLOV", + "summary": "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": "nameType", + "name": "chainCode", "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 '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", @@ -41769,7 +56995,43 @@ } }, "204": { - "description": "ProfileEnrollmentRuleFilterCriteriaLOV not found." + "description": "ParameterActiveUnderChainLOV 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": [ @@ -41783,33 +57045,20 @@ ] } }, - "/listOfValues/newEvent/{newEvent}/waitList/{waitList}/cateringEventStatus": { + "/listOfValues/period/{period}/repCalendarYears": { "get": { - "summary": "Return list of values for catering event status", - "description": "Use this API to return the list of values for catering event status based on search criteria such as waitList, newEvent, includeInactiveFlag, parameterName, parameterValue.OperationId:getCateringEventStatusLOV
", - "operationId": "getCateringEventStatusLOV", + "summary": "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": "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": "period", "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 'period' which is required to fetch RepCalendarYears LOV" }, { "name": "includeInactiveFlag", @@ -41883,7 +57132,43 @@ } }, "204": { - "description": "CateringEventStatusLOV not found." + "description": "RepCalendarYearsLOV 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": [ @@ -41897,20 +57182,20 @@ ] } }, - "/listOfValues/number/{number}/autoNumberGenerator": { + "/listOfValues/pkgId/{pkgId}/cateringPackageRevenueEventType": { "get": { - "summary": "Return list of values for auto number generator", - "description": "Use this API to return the list of values for auto number generator based on search criteria such as number, includeInactiveFlag, parameterName, parameterValue.OperationId:getAutoNumberGeneratorLOV
", - "operationId": "getAutoNumberGeneratorLOV", + "summary": "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": "number", + "name": "pkgId", "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 'pkgId' which is required to fetch CateringPackageRevenueEventType LOV" }, { "name": "includeInactiveFlag", @@ -41984,7 +57269,43 @@ } }, "204": { - "description": "AutoNumberGeneratorLOV not found." + "description": "CateringPackageRevenueEventTypeLOV 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": [ @@ -41998,20 +57319,20 @@ ] } }, - "/listOfValues/operaParam/{operaParam}/profileNameValidationsType": { + "/listOfValues/pkgLinkId/{pkgLinkId}/cateringPackageRevenueConfigEventType": { "get": { - "summary": "Return list of values for profile name validation types", - "description": "Use this API to return the list of values for profile name validation types based on search criteria such as number, includeInactiveFlag, parameterName, parameterValue.OperationId:getProfileNameValidationsTypeLOV
", - "operationId": "getProfileNameValidationsTypeLOV", + "summary": "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": "operaParam", + "name": "pkgLinkId", "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 'pkgLinkId' which is required to fetch CateringPackageRevenueConfigEventType LOV" }, { "name": "includeInactiveFlag", @@ -42085,7 +57406,43 @@ } }, "204": { - "description": "ProfileNameValidationsTypeLOV not found." + "description": "CateringPackageRevenueConfigEventTypeLOV 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": [ @@ -42099,29 +57456,20 @@ ] } }, - "/listOfValues/outboundType/{outboundType}/protocol/{protocol}/outboundServiceNames": { + "/listOfValues/policyType/{policyType}/depositCancelRulesMultiHotel": { "get": { - "summary": "Return list of values for service names", - "description": "Use this API to return the list of values for service names based on search criteria such as protocol, outboundType, includeInactiveFlag, parameterName, parameterValue.OperationId:getServiceNameLOV
", - "operationId": "getServiceNameLOV", + "summary": "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": "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": "policyType", "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 'policyType' which is required to fetch DepositCancelRulesMultiHotel LOV" }, { "name": "includeInactiveFlag", @@ -42195,7 +57543,43 @@ } }, "204": { - "description": "ServiceNameLOV not found." + "description": "DepositCancelRulesMultiHotelLOV 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": [ @@ -42209,29 +57593,20 @@ ] } }, - "/listOfValues/parameterName/{parameter}/chainCode/{chainCode}/parameterActiveUnderChain": { + "/listOfValues/policyType/{policyType}/templatePolicyCodes": { "get": { - "summary": "Return list of values for parameter active under chain", - "description": "Use this API to return the list of values for parameter active under chain based on search criteria such as chainCode, parameter, includeInactiveFlag, parameterName, parameterValue.OperationId:getParameterActiveUnderChainLOV
", - "operationId": "getParameterActiveUnderChainLOV", + "summary": "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": "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": "policyType", "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 'policyType' which is required to fetch TemplatePolicyCodes LOV" }, { "name": "includeInactiveFlag", @@ -42305,7 +57680,43 @@ } }, "204": { - "description": "ParameterActiveUnderChainLOV not found." + "description": "TemplatePolicyCodesLOV 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": [ @@ -42319,20 +57730,20 @@ ] } }, - "/listOfValues/period/{period}/repCalendarYears": { + "/listOfValues/preferenceGroup/{preferenceGroup}/preferencesMultiHotels": { "get": { - "summary": "Return list of values for rep calendar years", - "description": "Use this API to return the list of values for rep calendar years based on search criteria such as period, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepCalendarYearsLOV
", - "operationId": "getRepCalendarYearsLOV", + "summary": "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": "period", + "name": "preferenceGroup", "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 'preferenceGroup' which is required to fetch PreferencesMultiHotels LOV" }, { "name": "includeInactiveFlag", @@ -42406,108 +57817,43 @@ } }, "204": { - "description": "RepCalendarYearsLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/pkgId/{pkgId}/cateringPackageRevenueEventType": { - "get": { - "summary": "Return list of values for catering package revenue event types", - "description": "Use this API to return the list of values for catering package revenue event types based on search criteria such as pkgId, includeInactiveFlag, parameterName, parameterValue.OperationId:getCateringPackageRevenueEventTypeLOV
", - "operationId": "getCateringPackageRevenueEventTypeLOV", - "parameters": [ - { - "name": "pkgId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'pkgId' which is required to fetch CateringPackageRevenueEventType LOV" + "description": "PreferencesMultiHotelsLOV not found." }, - { - "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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "CateringPackageRevenueEventTypeLOV not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -42521,20 +57867,20 @@ ] } }, - "/listOfValues/pkgLinkId/{pkgLinkId}/cateringPackageRevenueConfigEventType": { + "/listOfValues/profiles/{profileId}/claimMembershipDetails": { "get": { - "summary": "Return list of values for catering package revenue config event types", - "description": "Use this API to return the list of values for catering package revenue config event types based on search criteria such as pkgLinkId, includeInactiveFlag, parameterName, parameterValue.OperationId:getCateringPackageRevenueConfigEventTypeLOV
", - "operationId": "getCateringPackageRevenueConfigEventTypeLOV", + "summary": "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": "pkgLinkId", + "name": "profileId", "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 'profileId' which is required to fetch ClaimMembershipDetails LOV" }, { "name": "includeInactiveFlag", @@ -42608,7 +57954,43 @@ } }, "204": { - "description": "CateringPackageRevenueConfigEventTypeLOV not found." + "description": "ClaimMembershipDetailsLOV 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": [ @@ -42622,20 +58004,20 @@ ] } }, - "/listOfValues/policyType/{policyType}/depositCancelRulesMultiHotel": { + "/listOfValues/profiles/{profileId}/hotelsForARProfile": { "get": { - "summary": "Return list of values for deposit cancel rules multi hotel", - "description": "Use this API to return the list of values for deposit cancel rules multi hotel based on search criteria such as policyType, includeInactiveFlag, parameterName, parameterValue.OperationId:getDepositCancelRulesMultiHotelLOV
", - "operationId": "getDepositCancelRulesMultiHotelLOV", + "summary": "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": "policyType", + "name": "profileId", "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 'profileId' which is required to fetch HotelsForARProfile LOV" }, { "name": "includeInactiveFlag", @@ -42709,7 +58091,43 @@ } }, "204": { - "description": "DepositCancelRulesMultiHotelLOV not found." + "description": "HotelsForARProfileLOV 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": [ @@ -42723,20 +58141,20 @@ ] } }, - "/listOfValues/policyType/{policyType}/templatePolicyCodes": { + "/listOfValues/profiles/{profileId}/membershipTransferPoints": { "get": { - "summary": "Return list of values for policy code templates", - "description": "Use this API to return the list of values for policy code templates based on search criteria such as policyType, includeInactiveFlag, parameterName, parameterValue.OperationId:getTemplatePolicyCodesLOV
", - "operationId": "getTemplatePolicyCodesLOV", + "summary": "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": "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 MembershipTransferPoints LOV" }, { "name": "includeInactiveFlag", @@ -42810,7 +58228,43 @@ } }, "204": { - "description": "TemplatePolicyCodesLOV not found." + "description": "MembershipTransferPointsLOV 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": [ @@ -42824,20 +58278,20 @@ ] } }, - "/listOfValues/preferenceGroup/{preferenceGroup}/preferencesMultiHotels": { + "/listOfValues/profiles/{profileId}/negotiatedRateHotels": { "get": { - "summary": "Return list of values for preferences multi hotels", - "description": "Use this API to return the list of values for preferences multi hotels based on search criteria such as preferenceGroup, includeInactiveFlag, parameterName, parameterValue.OperationId:getPreferencesMultiHotelsLOV
", - "operationId": "getPreferencesMultiHotelsLOV", + "summary": "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": "preferenceGroup", + "name": "profileId", "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 'profileId' which is required to fetch NegotiatedRateHotels LOV" }, { "name": "includeInactiveFlag", @@ -42911,7 +58365,43 @@ } }, "204": { - "description": "PreferencesMultiHotelsLOV not found." + "description": "NegotiatedRateHotelsLOV 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": [ @@ -42925,11 +58415,11 @@ ] } }, - "/listOfValues/profiles/{profileId}/claimMembershipDetails": { + "/listOfValues/profiles/{profileId}/profileCommunications": { "get": { - "summary": "Return list of values for claim membership details", - "description": "Use this API to return the list of values for claim membership details based on search criteria such as profileId, includeInactiveFlag, parameterName, parameterValue.OperationId:getClaimMembershipDetailsLOV
", - "operationId": "getClaimMembershipDetailsLOV", + "summary": "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": "profileId", @@ -42938,7 +58428,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'profileId' which is required to fetch ClaimMembershipDetails LOV" + "description": "Value of the parameter 'profileId' which is required to fetch ProfileCommunications LOV" }, { "name": "includeInactiveFlag", @@ -43012,7 +58502,43 @@ } }, "204": { - "description": "ClaimMembershipDetailsLOV not found." + "description": "ProfileCommunicationsLOV 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": [ @@ -43026,12 +58552,21 @@ ] } }, - "/listOfValues/profiles/{profileId}/hotelsForARProfile": { + "/listOfValues/profiles/{profileId}/taxTypeCheck/{taxTypeCheck}/profileHotels": { "get": { - "summary": "Return list of values for hotels for account receivable profiles", - "description": "Use this API to return the list of values for hotels for account receivable profiles based on search criteria such as profileId, includeInactiveFlag, parameterName, parameterValue.OperationId:getHotelsForARProfileLOV
", - "operationId": "getHotelsForARProfileLOV", + "summary": "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": "taxTypeCheck", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Value of the parameter 'taxTypeCheck' which is required to fetch ProfileHotels LOV" + }, { "name": "profileId", "in": "path", @@ -43039,7 +58574,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'profileId' which is required to fetch HotelsForARProfile LOV" + "description": "Value of the parameter 'profileId' which is required to fetch ProfileHotels LOV" }, { "name": "includeInactiveFlag", @@ -43113,7 +58648,43 @@ } }, "204": { - "description": "HotelsForARProfileLOV not found." + "description": "ProfileHotelsLOV 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": [ @@ -43127,20 +58698,20 @@ ] } }, - "/listOfValues/profiles/{profileId}/membershipTransferPoints": { + "/listOfValues/property/{property}/roomHierarchyClassesCopy": { "get": { - "summary": "Return list of values for membership transfer points", - "description": "Use this API to return the list of values for hotels for membership transfer points based on search criteria such as profileId, includeInactiveFlag, parameterName, parameterValue.OperationId:getMembershipTransferPointsLOV
", - "operationId": "getMembershipTransferPointsLOV", + "summary": "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": "profileId", + "name": "property", "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 'property' which is required to fetch RoomHierarchyClassesCopy LOV" }, { "name": "includeInactiveFlag", @@ -43214,7 +58785,43 @@ } }, "204": { - "description": "MembershipTransferPointsLOV not found." + "description": "RoomHierarchyClassesCopyLOV 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": [ @@ -43228,20 +58835,20 @@ ] } }, - "/listOfValues/profiles/{profileId}/negotiatedRateHotels": { + "/listOfValues/property/{property}/roomHierarchyRoomClasses": { "get": { - "summary": "Return list of values for negotiated rate hotels", - "description": "Use this API to return the list of values for negotiated rate hotels based on search criteria such as profileId, includeInactiveFlag, parameterName, parameterValue.OperationId:getNegotiatedRateHotelsLOV
", - "operationId": "getNegotiatedRateHotelsLOV", + "summary": "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": "profileId", + "name": "property", "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 'property' which is required to fetch RoomHierarchyRoomClasses LOV" }, { "name": "includeInactiveFlag", @@ -43315,7 +58922,43 @@ } }, "204": { - "description": "NegotiatedRateHotelsLOV not found." + "description": "RoomHierarchyRoomClassesLOV 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": [ @@ -43329,20 +58972,20 @@ ] } }, - "/listOfValues/profiles/{profileId}/profileCommunications": { + "/listOfValues/property/{property}/roomHierarchyRoomTypes": { "get": { - "summary": "Return list of values for profile communications", - "description": "Use this API to return the list of values for profile communications based on search criteria such as profileId, includeInactiveFlag, parameterName, parameterValue.OperationId:getProfileCommunicationsLOV
", - "operationId": "getProfileCommunicationsLOV", + "summary": "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": "profileId", + "name": "property", "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 'property' which is required to fetch RoomHierarchyRoomTypes LOV" }, { "name": "includeInactiveFlag", @@ -43416,117 +59059,43 @@ } }, "204": { - "description": "ProfileCommunicationsLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/profiles/{profileId}/taxTypeCheck/{taxTypeCheck}/profileHotels": { - "get": { - "summary": "Return list of values for profile hotels", - "description": "Use this API to return the list of values for profile hotels based on search criteria such as taxTypeCheck, profileId, includeInactiveFlag, parameterName, parameterValue.OperationId:getProfileHotelsLOV
", - "operationId": "getProfileHotelsLOV", - "parameters": [ - { - "name": "taxTypeCheck", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'taxTypeCheck' which is required to fetch ProfileHotels LOV" + "description": "RoomHierarchyRoomTypesLOV not found." }, - { - "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" + "400": { + "$ref": "#/responses/400" }, - { - "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" + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/authKey" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-app-key" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-hotelid" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-externalsystem" + "415": { + "$ref": "#/responses/415" }, - { - "$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" - } + "500": { + "$ref": "#/responses/500" }, - "204": { - "description": "ProfileHotelsLOV not found." + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -43540,11 +59109,11 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyClassesCopy": { + "/listOfValues/property/{property}/roomHierarchyTypesCopy": { "get": { - "summary": "Return list of values for hotel room hierarchy classes copy", - "description": "Use this API to return the list of values for room hierarchy classes copy for a specific property based on search criteria such as property, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomHierarchyClassesCopyLOV
", - "operationId": "getRoomHierarchyClassesCopyLOV", + "summary": "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": "property", @@ -43553,7 +59122,7 @@ "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'property' which is required to fetch RoomHierarchyClassesCopy LOV" + "description": "Value of the parameter 'property' which is required to fetch RoomHierarchyTypesCopy LOV" }, { "name": "includeInactiveFlag", @@ -43627,7 +59196,43 @@ } }, "204": { - "description": "RoomHierarchyClassesCopyLOV not found." + "description": "RoomHierarchyTypesCopyLOV 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": [ @@ -43641,20 +59246,20 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyRoomClasses": { + "/listOfValues/propertyList/{propertyList}/repRatePlans": { "get": { - "summary": "Return list of values for hotel room hierarchy room classes", - "description": "Use this API to return the list of values for room hierarchy room classes for a specific property based on search criteria such as property, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomHierarchyRoomClassesLOV
", - "operationId": "getRoomHierarchyRoomClassesLOV", + "summary": "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": "property", + "name": "propertyList", "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 'propertyList' which is required to fetch RepRatePlans LOV" }, { "name": "includeInactiveFlag", @@ -43728,7 +59333,43 @@ } }, "204": { - "description": "RoomHierarchyRoomClassesLOV not found." + "description": "RepRatePlansLOV 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": [ @@ -43742,20 +59383,29 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyRoomTypes": { + "/listOfValues/radioType/{radioType}/hotels/{hotelId}/cateringPackageCodes": { "get": { - "summary": "Return list of values for hotel room hierarchy room types", - "description": "Use this API to return the list of values for room hierarchy room types for a specific property based on search criteria such as property, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomHierarchyRoomTypesLOV
", - "operationId": "getRoomHierarchyRoomTypesLOV", + "summary": "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": "property", + "name": "hotelId", "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 '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", @@ -43829,7 +59479,43 @@ } }, "204": { - "description": "RoomHierarchyRoomTypesLOV not found." + "description": "CateringPackageCodesLOV 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": [ @@ -43843,20 +59529,29 @@ ] } }, - "/listOfValues/property/{property}/roomHierarchyTypesCopy": { + "/listOfValues/rateCode/{rateCode}/profiles/{profileId}/negotiatedRatesHotels": { "get": { - "summary": "Return list of values for hotel room hierarchy types copy", - "description": "Use this API to return the list of values for room hierarchy types copy for a specific property based on search criteria such as property, includeInactiveFlag, parameterName, parameterValue.OperationId:getRoomHierarchyTypesCopyLOV
", - "operationId": "getRoomHierarchyTypesCopyLOV", + "summary": "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": "property", + "name": "profileId", "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 '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", @@ -43930,108 +59625,43 @@ } }, "204": { - "description": "RoomHierarchyTypesCopyLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/propertyList/{propertyList}/repRatePlans": { - "get": { - "summary": "Return list of values for rep rate plans", - "description": "Use this API to return the list of values for rep rate plans based on search criteria such as propertyList, includeInactiveFlag, parameterName, parameterValue.OperationId:getRepRatePlansLOV
", - "operationId": "getRepRatePlansLOV", - "parameters": [ - { - "name": "propertyList", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'propertyList' which is required to fetch RepRatePlans LOV" + "description": "NegotiatedRatesHotelsLOV not found." }, - { - "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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "RepRatePlansLOV not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -44045,29 +59675,29 @@ ] } }, - "/listOfValues/radioType/{radioType}/hotels/{hotelId}/cateringPackageCodes": { + "/listOfValues/roleLevel/{roleLevel}/levelCode/{levelCode}/rolesForLevel": { "get": { - "summary": "Return list of values for hotel catering package codes", - "description": "Use this API to return the list of values for catering package codes for a specific property based on search criteria such as hotelId, radioType, includeInactiveFlag, parameterName, parameterValue.OperationId:getCateringPackageCodesLOV
", - "operationId": "getCateringPackageCodesLOV", + "summary": "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": "hotelId", + "name": "levelCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, - "description": "Value of the parameter 'hotelId' which is required to fetch CateringPackageCodes LOV" + "description": "Value of the parameter 'levelCode' which is required to fetch RolesForLevel LOV" }, { - "name": "radioType", + "name": "roleLevel", "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 'roleLevel' which is required to fetch RolesForLevel LOV" }, { "name": "includeInactiveFlag", @@ -44141,7 +59771,43 @@ } }, "204": { - "description": "CateringPackageCodesLOV not found." + "description": "RolesForLevelLOV 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": [ @@ -44155,29 +59821,38 @@ ] } }, - "/listOfValues/rateCode/{rateCode}/profiles/{profileId}/negotiatedRatesHotels": { + "/listOfValues/roles/{roles}/chainCode/{chainCode}/actionTask/{actionTask}/organizations": { "get": { - "summary": "Return list of values for negotiated rate hotels", - "description": "Use this API to return the list of values for negotiated rate hotels based on search criteria such as profileId, rateCode, includeInactiveFlag, parameterName, parameterValue.OperationId:getNegotiatedRatesHotelsLOV
", - "operationId": "getNegotiatedRatesHotelsLOV", + "summary": "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 NegotiatedRatesHotels LOV" + "description": "Value of the parameter 'actionTask' which is required to fetch Organizations LOV" }, { - "name": "rateCode", + "name": "chainCode", "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 '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", @@ -44251,7 +59926,43 @@ } }, "204": { - "description": "NegotiatedRatesHotelsLOV not found." + "description": "OrganizationsLOV 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": [ @@ -44265,29 +59976,24 @@ ] } }, - "/listOfValues/roleLevel/{roleLevel}/levelCode/{levelCode}/rolesForLevel": { + "/listOfValues/salesFormat/{salesFormat}/addressFormatElements": { "get": { - "summary": "Return list of values for roles for level", - "description": "Use this API to return the list of values for roles for level based on search criteria such as levelCode, roleLevel, includeInactiveFlag, parameterName, parameterValue.OperationId:getRolesForLevelLOV
", - "operationId": "getRolesForLevelLOV", + "summary": "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": "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": "salesFormat", "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 'salesFormat' which is required to fetch AddressFormatElements LOV", + "enum": [ + "Y", + "N" + ] }, { "name": "includeInactiveFlag", @@ -44361,7 +60067,43 @@ } }, "204": { - "description": "RolesForLevelLOV not found." + "description": "AddressFormatElementsLOV 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": [ @@ -44375,38 +60117,20 @@ ] } }, - "/listOfValues/roles/{roles}/chainCode/{chainCode}/actionTask/{actionTask}/organizations": { + "/listOfValues/shiftGroupId/{shiftGroupId}/shiftReportsNoParam": { "get": { - "summary": "Return list of values for organizations", - "description": "Use this API to return the list of values for organizations based on search criteria such as actionTask, chainCode, roles, includeInactiveFlag, parameterName, parameterValue.OperationId:getOrganizationsLOV
", - "operationId": "getOrganizationsLOV", + "summary": "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": "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": "shiftGroupId", "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 'shiftGroupId' which is required to fetch ShiftReportsNoParam LOV" }, { "name": "includeInactiveFlag", @@ -44480,7 +60204,43 @@ } }, "204": { - "description": "OrganizationsLOV not found." + "description": "ShiftReportsNoParamLOV 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": [ @@ -44494,24 +60254,20 @@ ] } }, - "/listOfValues/salesFormat/{salesFormat}/addressFormatElements": { + "/listOfValues/siteType/{siteType}/sitePlanSectionTypes": { "get": { - "summary": "Return list of values for address format elements", - "description": "Use this API to return the list of values for address format elements based on search criteria such as salesFormat, includeInactiveFlag, parameterName, parameterValue.OperationId:getAddressFormatElementsLOV
", - "operationId": "getAddressFormatElementsLOV", + "summary": "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": "salesFormat", + "name": "siteType", "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 'siteType' which is required to fetch SitePlanSectionTypes LOV" }, { "name": "includeInactiveFlag", @@ -44585,108 +60341,43 @@ } }, "204": { - "description": "AddressFormatElementsLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/shiftGroupId/{shiftGroupId}/shiftReportsNoParam": { - "get": { - "summary": "Return list of values for shift reports no parameter", - "description": "Use this API to return the list of values for shift reports no parameter based on search criteria such as shiftGroupId, includeInactiveFlag, parameterName, parameterValue.OperationId:getShiftReportsNoParamLOV
", - "operationId": "getShiftReportsNoParamLOV", - "parameters": [ - { - "name": "shiftGroupId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'shiftGroupId' which is required to fetch ShiftReportsNoParam LOV" + "description": "SitePlanSectionTypesLOV not found." }, - { - "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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "ShiftReportsNoParamLOV not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -44700,20 +60391,20 @@ ] } }, - "/listOfValues/siteType/{siteType}/sitePlanSectionTypes": { + "/listOfValues/sourceId/{sourceId}/globalAlertFieldQuery": { "get": { - "summary": "Return list of values for site plan section types", - "description": "Use this API to return the list of values for site plan section types based on search criteria such as siteType, includeInactiveFlag, parameterName, parameterValue.OperationId:getSitePlanSectionTypesLOV
", - "operationId": "getSitePlanSectionTypesLOV", + "summary": "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": "siteType", + "name": "sourceId", "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 'sourceId' which is required to fetch GlobalAlertFieldQuery LOV" }, { "name": "includeInactiveFlag", @@ -44787,108 +60478,43 @@ } }, "204": { - "description": "SitePlanSectionTypesLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/sourceId/{sourceId}/globalAlertFieldQuery": { - "get": { - "summary": "Return list of values for global alert field queries", - "description": "Use this API to return the list of values for global alert field queries based on search criteria such as sourceId, includeInactiveFlag, parameterName, parameterValue.OperationId:getGlobalAlertFieldQueryLOV
", - "operationId": "getGlobalAlertFieldQueryLOV", - "parameters": [ - { - "name": "sourceId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 2000, - "description": "Value of the parameter 'sourceId' which is required to fetch GlobalAlertFieldQuery LOV" + "description": "GlobalAlertFieldQueryLOV not found." }, - { - "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" + "400": { + "$ref": "#/responses/400" }, - { - "name": "parameterName", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Name of the parameter.", - "items": { - "type": "string" - }, - "required": false + "401": { + "$ref": "#/responses/401" }, - { - "name": "parameterValue", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "description": "Value of the parameter.", - "items": { - "type": "string" - }, - "required": false + "403": { + "$ref": "#/responses/403" }, - { - "name": "excludeCodes", - "in": "query", - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string", - "maxItems": 4000 - }, - "required": false + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/authKey" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-app-key" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-hotelid" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-externalsystem" + "414": { + "$ref": "#/responses/414" }, - { - "$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" - } + "415": { + "$ref": "#/responses/415" }, - "204": { - "description": "GlobalAlertFieldQueryLOV not found." + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -45017,6 +60643,42 @@ }, "204": { "description": "GlobalAlertOperatorLOV 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": [ @@ -45118,6 +60780,42 @@ }, "204": { "description": "MailGenericLOV 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": [ @@ -45219,6 +60917,42 @@ }, "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": [ @@ -45320,6 +61054,42 @@ }, "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": [ @@ -45430,6 +61200,42 @@ }, "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": [ @@ -45531,6 +61337,42 @@ }, "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": [ @@ -45632,6 +61474,42 @@ }, "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": [ @@ -45733,6 +61611,42 @@ }, "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": [ @@ -45834,6 +61748,42 @@ }, "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": [ @@ -45935,6 +61885,42 @@ }, "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": [ @@ -46036,6 +62022,42 @@ }, "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": [ @@ -46141,178 +62163,286 @@ }, "description": "", "schema": { - "$ref": "#/definitions/listOfValues" + "$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": "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": "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": "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": "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" } }, - "204": { - "description": "UdfAttributesLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/listOfValues/userId/{userId}/croUsers": { - "get": { - "summary": "Return list of values for cro users", - "description": "Use this API to return the list of values for cro users based on search criteria such as userId, includeInactiveFlag, parameterName, parameterValue.OperationId:getCroUsersLOV
", - "operationId": "getCroUsersLOV", - "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 + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/authKey" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-app-key" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-hotelid" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-externalsystem" + "405": { + "$ref": "#/responses/405" }, - { - "$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" - } + "406": { + "$ref": "#/responses/406" }, - "204": { - "description": "CroUsersLOV not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "LOV" - ] - } - }, - "/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": "validateListOfValues", - "in": "body", - "required": true, - "schema": { - "allOf": [ - { - "$ref": "#/definitions/validateListOfValues" - } - ] - } + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/authKey" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-app-key" + "415": { + "$ref": "#/responses/415" }, - { - "$ref": "#/parameters/x-hotelid" + "500": { + "$ref": "#/responses/500" }, - { - "$ref": "#/parameters/x-externalsystem" + "502": { + "$ref": "#/responses/502" }, - { - "$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" - } + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -46414,6 +62544,42 @@ }, "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": [ @@ -46515,6 +62681,42 @@ }, "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": [ @@ -46616,6 +62818,42 @@ }, "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": [ @@ -46717,6 +62955,42 @@ }, "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": [ @@ -46818,6 +63092,42 @@ }, "204": { "description": "StatisticsYearsLOV 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": [ @@ -47575,7 +63885,8 @@ "YieldableCodes", "QrCodeName", "ChannelNegotiatedRateCode", - "FiscalTerminals" + "FiscalTerminals", + "ChainJobProcedures" ] }, { @@ -47651,6 +63962,42 @@ }, "204": { "description": "ListOfValues 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": [ @@ -47704,6 +64051,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -47756,6 +64139,42 @@ }, "204": { "description": "pingLOVService 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": [ @@ -48357,4 +64776,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/medcfg.json b/rest-api-specs/property/medcfg.json index 53b8ead..6010cef 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -23,7 +23,7 @@ "paths": { "/customizedLetter/{letterId}": { "get": { - "summary": "Get customized letter", + "summary": "Return customized letter", "description": "Use this API to return a customized letter based on search criteria such as letterId, letterIdContext, letterIdtype.OperationId:getCustomizedLetter
", "operationId": "getCustomizedLetter", "parameters": [ @@ -38,6 +38,7 @@ }, { "name": "letterIdContext", + "maxLength": 80, "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", @@ -47,6 +48,7 @@ "name": "letterIdtype", "in": "query", "required": false, + "maxLength": 80, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, @@ -83,6 +85,42 @@ }, "204": { "description": "CustomizedLetter 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": [ @@ -98,8 +136,8 @@ }, "/emailFile/{emailId}": { "get": { - "summary": "Get Email Blob File", - "description": "Use this API to retrieve email Blob File Stored in File Storage Schema.Its used in Profiles to fetch Email and Open in an end user's mail client.OperationId:getEmailFile
", + "summary": "Return email blob file", + "description": "Use this API to return email blob file stored in file storage schema based on the search criteria emailId. It's used in profiles to return email and open in an end user's mail client.OperationId:getEmailFile
", "operationId": "getEmailFile", "parameters": [ { @@ -144,6 +182,42 @@ }, "204": { "description": "EmailFile 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": [ @@ -159,12 +233,13 @@ }, "/fileAttachments": { "get": { - "summary": "Get file attachment", + "summary": "Return file attachment", "description": "Use this API to return file attachments based on search criteria such as id, idContext, idType.OperationId:getFileAttachment
", "operationId": "getFileAttachment", "parameters": [ { "name": "id", + "maxLength": 80, "in": "query", "required": false, "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", @@ -172,6 +247,7 @@ }, { "name": "idContext", + "maxLength": 80, "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", @@ -179,6 +255,7 @@ }, { "name": "idType", + "maxLength": 80, "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", @@ -217,6 +294,42 @@ }, "204": { "description": "FileAttachment 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": [ @@ -231,7 +344,7 @@ }, "post": { "summary": "Upload a file attachment", - "description": "Use this API to create a file attachment.OperationId:uploadFileAttachment
", + "description": "Use this API to upload a file attachment.OperationId:uploadFileAttachment
", "operationId": "uploadFileAttachment", "parameters": [ { @@ -281,6 +394,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -296,7 +445,7 @@ }, "/folioReports/email": { "post": { - "summary": "Email folio report", + "summary": "Create email folio report", "description": "Use this APU to email folio report.OperationId:emailFolioReport
", "operationId": "emailFolioReport", "parameters": [ @@ -347,6 +496,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -362,8 +547,8 @@ }, "/hotels/{hotelId}/reservations/{reservationId}/customizedLetter": { "put": { - "summary": "Set customized letter", - "description": "Use this API to set a customized letter for a specific reservation based on the hotelId, reservationId, customizedLetter.OperationId:setCustomizedLetter
", + "summary": "Update customized letter", + "description": "Use this API to update a customized letter for a reservation for a specific property based on the hotelId, reservationId, customizedLetter.OperationId:setCustomizedLetter
", "operationId": "setCustomizedLetter", "parameters": [ { @@ -431,6 +616,42 @@ "schema": { "$ref": "#/definitions/customizedLetterStatus" } + }, + "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": [ @@ -446,7 +667,7 @@ }, "/hotels/{hotelId}/reservations/{reservationId}/folioReports": { "get": { - "summary": "Get folio report", + "summary": "Return folio report", "description": "This API will get a folio report for a reservation.OperationId:getFolioReport
", "operationId": "getFolioReport", "parameters": [ @@ -470,6 +691,7 @@ }, { "name": "reservationIdContext", + "maxLength": 80, "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", @@ -477,6 +699,7 @@ }, { "name": "reservationIdType", + "maxLength": 80, "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", @@ -498,6 +721,7 @@ }, { "name": "folioType", + "maxLength": 80, "in": "query", "required": false, "description": "Optional folio type.", @@ -513,6 +737,7 @@ }, { "name": "referenceCurrency", + "maxLength": 20, "in": "query", "required": false, "description": "Folio currency code.", @@ -551,6 +776,42 @@ }, "204": { "description": "FolioReport 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": [ @@ -566,7 +827,7 @@ }, "/hotels/{hotelId}/reservations/{reservationId}/registrationCard": { "get": { - "summary": "Get registration card", + "summary": "Return registration card", "description": "Use this API to return a registration card for a reservation based on search criteria such as reservationId, hotelId, reservationIdContext, reservationIdType, regenerate, signedOnly, language, template.OperationId:getRegistrationCard
", "operationId": "getRegistrationCard", "parameters": [ @@ -590,6 +851,7 @@ }, { "name": "reservationIdContext", + "maxLength": 80, "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", @@ -597,6 +859,7 @@ }, { "name": "reservationIdType", + "maxLength": 80, "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", @@ -618,6 +881,7 @@ }, { "name": "language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "in": "query", "required": false, "description": "Optional language code to use for registration card generation. Default guest language will be applied if not specified.", @@ -625,6 +889,7 @@ }, { "name": "template", + "maxLength": 80, "in": "query", "required": false, "description": "Optional registration card template code to use for registration card generation. Default template will be applied if not specified.", @@ -663,6 +928,42 @@ }, "204": { "description": "RegistrationCard 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": [ @@ -678,8 +979,8 @@ }, "/images": { "post": { - "summary": "Use this API to Upload an image", - "description": "You can use this API to upload an image.OperationId:uploadImage
", + "summary": "Upload image", + "description": "You can use this API to upload an image for imageCodeType RoomMaintIssue.OperationId:uploadImage
", "operationId": "uploadImage", "parameters": [ { @@ -729,6 +1030,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -742,14 +1079,15 @@ ] }, "delete": { - "summary": "Use this API to Delete image", - "description": "This API will delete an image.OperationId:removeImage
", + "summary": "Delete image", + "description": "Use this API to delete an image based on parameters such as imageCode, imageSet, imageId, imageIdContext, imageIdType.OperationId:removeImage
", "operationId": "removeImage", "parameters": [ { "name": "imageCode", "in": "query", "required": false, + "description": "An enumeration of image codes such as Logo, RoomType, InvItem", "type": "string", "uniqueItems": true, "enum": [ @@ -792,6 +1130,7 @@ }, { "name": "imageSet", + "maxLength": 800, "in": "query", "required": false, "type": "string", @@ -799,6 +1138,7 @@ }, { "name": "imageId", + "maxLength": 2000, "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.", @@ -806,6 +1146,7 @@ }, { "name": "imageIdContext", + "maxLength": 80, "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", @@ -813,6 +1154,7 @@ }, { "name": "imageIdType", + "maxLength": 80, "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", @@ -852,6 +1194,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -865,12 +1243,13 @@ ] }, "get": { - "summary": "Get image", + "summary": "Return image", "description": "Use this API to return an image based on search criteria such as linkId, linkIdContext, linkIdType, imageCode, imageParameterCode, imageParameterValue, languageCode, imageStyle, imageId, imageIdContext, imageIdType, base64.OperationId:getImage
", "operationId": "getImage", "parameters": [ { "name": "linkId", + "maxLength": 2000, "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.", @@ -878,6 +1257,7 @@ }, { "name": "linkIdContext", + "maxLength": 80, "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", @@ -885,6 +1265,7 @@ }, { "name": "linkIdType", + "maxLength": 80, "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", @@ -892,6 +1273,7 @@ }, { "name": "imageCode", + "description": "An enumeration of image codes such as Logo, RoomType, InvItem", "in": "query", "required": false, "type": "string", @@ -936,6 +1318,7 @@ }, { "name": "imageParameterCode", + "description": "An enumeration of image parameter codes such as Logo, RoomType, InvItem", "in": "query", "type": "array", "collectionFormat": "multi", @@ -995,6 +1378,8 @@ }, { "name": "languageCode", + "maxLength": 20, + "description": "Unique Code of language.", "in": "query", "required": false, "type": "string" @@ -1019,6 +1404,7 @@ }, { "name": "imageId", + "maxLength": 2000, "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.", @@ -1026,6 +1412,7 @@ }, { "name": "imageIdContext", + "maxLength": 80, "in": "query", "required": false, "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", @@ -1033,6 +1420,7 @@ }, { "name": "imageIdType", + "maxLength": 80, "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", @@ -1078,6 +1466,42 @@ }, "204": { "description": "Image 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": [ @@ -1110,6 +1534,7 @@ }, "x-hotelid": { "name": "x-hotelid", + "maxLength": 2000, "type": "string", "description": "Mandatory parameter to identify the hotel code where the end user is logged in", "in": "header", @@ -2026,4 +2451,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/ops.json b/rest-api-specs/property/ops.json index ce4dec4..b73dea9 100644 --- a/rest-api-specs/property/ops.json +++ b/rest-api-specs/property/ops.json @@ -1,15 +1,9 @@ { - "produces": [ - "application/json" - ], - "schemes": [ - "https" - ], "swagger": "2.0", "info": { - "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.
", "title": "OPERA Provisioning Service API", - "version": "23.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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -19,205 +13,227 @@ "url": "https://opensource.org/licenses/upl" } }, + "schemes": [ + "https" + ], "basePath": "/ops/v1", + "produces": [ + "application/json" + ], "paths": { "/listofvalues/currencies": { "get": { - "description": "Operation to fetch all currencies that are valid in the Environment.OperationId:getShells
", - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Provisioning" - ], "summary": "Operation to fetch all currencies that are valid in the Environment.", + "description": "Operation to fetch all currencies that are valid in the Environment.OperationId:getShells
", "operationId": "getCurrencies", "parameters": [ { - "type": "string", - "description": "Bearer token that needs to be passed which is generated post user authentication", - "name": "authorization", - "in": "header", - "required": true + "$ref": "#/parameters/authKey" }, { - "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", - "type": "string", - "description": "Client or Partner's Application Key", - "name": "x-app-key", - "in": "header", - "required": true + "$ref": "#/parameters/x-app-key" }, { - "type": "string", - "description": "Mandatory parameter to identify the hotel code where the end user is logged in", - "name": "x-hotelid", - "in": "header", - "required": true + "$ref": "#/parameters/x-hotelid" }, { - "maxLength": 80, - "type": "string", - "x-example": "EXTERNALSYSTEMCODE", - "description": "External system code.", - "name": "x-externalsystem", - "in": "header" + "$ref": "#/parameters/x-externalsystem" }, { - "type": "string", - "description": "Language code", - "name": "Accept-Language", - "in": "header" + "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { - "description": "Response object which will contain all the List of valid currencies in the environment.", - "schema": { - "$ref": "#/definitions/currencies" - }, "headers": { "Content-Language": { - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "type": "string", - "description": "Audience language" + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" } + }, + "description": "Response object which will contain all the List of valid currencies in the environment.", + "schema": { + "$ref": "#/definitions/currencies" } }, "204": { "description": "No valid currrency found." }, "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/400" }, "401": { - "description": "Unauthorized" + "$ref": "#/responses/401" }, "403": { - "description": "Forbidden" + "$ref": "#/responses/403" }, "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/404" }, "405": { - "description": "Method not allowed" + "$ref": "#/responses/405" }, "406": { - "description": "Not acceptable." + "$ref": "#/responses/406" }, "413": { - "description": "Request Entity Too Large" + "$ref": "#/responses/413" }, "414": { - "description": "Request URI Too Large" + "$ref": "#/responses/414" }, "415": { - "description": "Unsupported Media Type" + "$ref": "#/responses/415" }, "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } + "$ref": "#/responses/500" }, "502": { - "description": "Bad Gateway" + "$ref": "#/responses/502" }, "503": { - "description": "Service Unavailable" + "$ref": "#/responses/503" } - } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "Provisioning" + ] } } }, - "definitions": { - "currencies": { - "description": "Response object which will contain all the List of valid currencies in the environment.", - "type": "object", - "properties": { - "currencyList": { - "description": "List of currencies available in the environment.", - "type": "array", - "items": { - "type": "string" - } - }, - "warnings": { - "$ref": "#/definitions/warningsType" - } + "parameters": { + "authKey": { + "name": "authorization", + "description": "Bearer token that needs to be passed which is generated post user authentication", + "type": "string", + "in": "header", + "required": true + }, + "x-app-key": { + "name": "x-app-key", + "description": "Client or Partner's Application Key", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", + "in": "header", + "required": true + }, + "x-hotelid": { + "name": "x-hotelid", + "type": "string", + "description": "Mandatory parameter to identify the hotel code where the end user is logged in", + "in": "header", + "required": true + }, + "x-externalsystem": { + "name": "x-externalsystem", + "type": "string", + "maxLength": 80, + "description": "External system code.", + "in": "header", + "x-example": "EXTERNALSYSTEMCODE" + }, + "Accept-Language": { + "name": "Accept-Language", + "type": "string", + "description": "Language code", + "in": "header" + }, + "x-hubid": { + "name": "x-hubid", + "type": "string", + "description": "x-hubid is a logical grouping of multiple properties that allows api consumers to manage data from a group of properties. This x-hubid is a valid list of hub codes configured in OPERA to which the user has access. Rest APIs without hotelId in the operation path can support hub level integration using x-hubid", + "in": "header" + } + }, + "responses": { + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/exceptionDetailType" } }, - "errorInstance": { - "description": "Complex type that contains error instance details for a REST call.", - "type": "object", - "title": "Error Instance Details", - "required": [ - "type", - "title" - ], - "properties": { - "detail": { - "description": "Human-readable description specific to this occurrence of the problem.", - "type": "string" - }, - "instance": { - "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced.", - "type": "string" - }, - "o:errorCode": { - "description": "Application error code, which is different from HTTP error code.", - "type": "string" - }, - "o:errorPath": { - "description": "Path to the problem at the resource or property level.", - "type": "string" - }, - "status": { - "description": "HTTP status code for this occurrence of the problem, set by the origin server.", - "type": "integer" - }, - "title": { - "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.", - "type": "string" - }, - "type": { - "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML).", - "type": "string" - } + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Resource not found", + "schema": { + "$ref": "#/definitions/exceptionDetailType" + } + }, + "405": { + "description": "Method not allowed" + }, + "406": { + "description": "Not acceptable." + }, + "413": { + "description": "Request Entity Too Large" + }, + "414": { + "description": "Request URI Too Large" + }, + "415": { + "description": "Unsupported Media Type" + }, + "500": { + "description": "System Error", + "schema": { + "$ref": "#/definitions/exceptionDetailType" } }, + "502": { + "description": "Bad Gateway" + }, + "503": { + "description": "Service Unavailable" + } + }, + "definitions": { "exceptionDetailType": { + "title": "Error Detail", "description": "Complex type that contains error details for a REST call.", "type": "object", - "title": "Error Detail", - "required": [ - "type", - "title" - ], "properties": { + "type": { + "type": "string", + "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." + }, + "title": { + "type": "string", + "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." + }, + "status": { + "type": "integer", + "description": "HTTP status code for this occurrence of the problem, set by the origin server." + }, "detail": { - "description": "Human-readable description specific to this occurrence of the problem.", - "type": "string" + "type": "string", + "description": "Human-readable description specific to this occurrence of the problem." }, "instance": { - "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced.", - "type": "string" - }, - "links": { - "$ref": "#/definitions/links" + "type": "string", + "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." }, "o:errorCode": { - "description": "Application error code, which is different from HTTP error code.", - "type": "string" + "type": "string", + "description": "Application error code, which is different from HTTP error code." + }, + "o:errorPath": { + "type": "string", + "description": "Path to the problem at the resource or property level." }, "o:errorDetails": { "description": "Details of the error message, consisting of a hierarchical tree structure.", @@ -226,38 +242,71 @@ "$ref": "#/definitions/errorInstance" } }, - "o:errorPath": { - "description": "Path to the problem at the resource or property level.", - "type": "string" + "links": { + "$ref": "#/definitions/links" + } + }, + "required": [ + "type", + "title" + ] + }, + "errorInstance": { + "title": "Error Instance Details", + "description": "Complex type that contains error instance details for a REST call.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." + }, + "title": { + "type": "string", + "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." }, "status": { - "description": "HTTP status code for this occurrence of the problem, set by the origin server.", - "type": "integer" + "type": "integer", + "description": "HTTP status code for this occurrence of the problem, set by the origin server." }, - "title": { - "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.", - "type": "string" + "detail": { + "type": "string", + "description": "Human-readable description specific to this occurrence of the problem." }, - "type": { - "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML).", - "type": "string" + "instance": { + "type": "string", + "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." + }, + "o:errorCode": { + "type": "string", + "description": "Application error code, which is different from HTTP error code." + }, + "o:errorPath": { + "type": "string", + "description": "Path to the problem at the resource or property level." } - } + }, + "required": [ + "type", + "title" + ] }, "instanceLink": { - "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", "type": "object", - "required": [ - "href", - "rel", - "method", - "operationId" - ], + "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", "properties": { "href": { "description": "URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.", "type": "string" }, + "rel": { + "description": "Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.", + "type": "string" + }, + "templated": { + "description": "Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.", + "type": "boolean", + "default": false + }, "method": { "description": "HTTP method for requesting the target of the link.", "type": "string", @@ -271,22 +320,13 @@ "HEAD" ] }, - "operationId": { - "description": "The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.", - "type": "string" - }, - "rel": { - "description": "Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.", - "type": "string" - }, "targetSchema": { "description": "Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..", "type": "string" }, - "templated": { - "description": "Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.", - "type": "boolean", - "default": false + "operationId": { + "description": "The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.", + "type": "string" }, "title": { "description": "Exact copy of the \"summary\" field on the linked operation.", @@ -300,39 +340,35 @@ "$ref": "#/definitions/instanceLink" } }, + "warningsType": { + "type": "array", + "description": "Used in conjunction with the Success element to define a business error.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/warningType" + } + }, "warningType": { - "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.", "type": "object", + "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.", "properties": { - "code": { - "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "docURL": { - "description": "If present, this URL refers to an online description of the error that occurred.", - "type": "string", - "maxLength": 2000 - }, - "language": { - "description": "Language identification.", + "value": { "type": "string", - "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + "description": "Property Value" }, - "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.", + "shortText": { + "description": "An abbreviated version of the error in textual format.", "type": "string", "maxLength": 2000 }, - "rph": { - "description": "Reference Place Holder used as an index for this warning.", + "code": { + "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", "type": "string", - "maxLength": 8, - "minLength": 1 + "minLength": 0, + "maxLength": 20 }, - "shortText": { - "description": "An abbreviated version of the error in textual format.", + "docURL": { + "description": "If present, this URL refers to an online description of the error that occurred.", "type": "string", "maxLength": 2000 }, @@ -346,31 +382,51 @@ "type": "string", "maxLength": 2000 }, + "recordId": { + "description": "If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.", + "type": "string", + "maxLength": 2000 + }, "type": { "description": "The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".", "type": "string", - "maxLength": 20, - "minLength": 0 + "minLength": 0, + "maxLength": 20 }, - "value": { - "description": "Property Value", - "type": "string" + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "rph": { + "description": "Reference Place Holder used as an index for this warning.", + "type": "string", + "minLength": 1, + "maxLength": 8 } } }, - "warningsType": { - "description": "Used in conjunction with the Success element to define a business error.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/warningType" + "currencies": { + "type": "object", + "description": "Response object which will contain all the List of valid currencies in the environment.", + "properties": { + "currencyList": { + "type": "array", + "description": "List of currencies available in the environment.", + "items": { + "type": "string" + } + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } } } }, "tags": [ { - "description": "The ProvisioningService Web Service offers capability of provisioning and deprovisioning properties and chains in Opera.", - "name": "Provisioning" + "name": "Provisioning", + "description": "The ProvisioningService Web Service offers capability of provisioning and deprovisioning properties and chains in Opera." } ], "externalDocs": { diff --git a/rest-api-specs/property/outbound/crmoutbound.json b/rest-api-specs/property/outbound/crmoutbound.json index ab911ee..188848d 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -43,6 +43,42 @@ }, "204": { "description": "ExternalProfiles 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" } }, "parameters": [ @@ -306,6 +342,42 @@ }, "204": { "description": "downloadExternalProfile 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": [ @@ -387,6 +459,42 @@ "schema": { "$ref": "#/definitions/enrollment" } + }, + "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": [ @@ -908,6 +1016,42 @@ }, "204": { "description": "PlayerStatistics 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": [ @@ -1415,6 +1559,42 @@ }, "204": { "description": "GamingOffers 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": [ @@ -1482,6 +1662,42 @@ }, "204": { "description": "checkIataNumber not found." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ diff --git a/rest-api-specs/property/outbound/cshoutbound.json b/rest-api-specs/property/outbound/cshoutbound.json index d66e5cb..3a970d8 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -72,6 +72,42 @@ }, "204": { "description": "CompRedemptions 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": [ @@ -150,6 +186,42 @@ "schema": { "$ref": "#/definitions/authorizeCompRedemptionsRS" } + }, + "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": [ @@ -315,6 +387,75 @@ ] } }, + "/hotels/{hotelId}/asyncCompPostingsApproval": { + "put": { + "summary": "Operation to request for submitting bulk comp postings for vendor approval.", + "description": "The API will only submit the request to the vendor and does not wait for the response and it is an asynchronous API. Also, the caller of the API will get an HTTP 200 response code.OperationId:asyncApproveCompPostings
", + "operationId": "asyncApproveCompPostings", + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 20, + "description": "Unique ID of the hotel" + }, + { + "name": "postings", + "in": "body", + "required": true, + "description": "Request object to submit comp transactions request in bulk to gaming system.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/bulkCompTransactionsCriteriaType" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$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 bulk submit comp transactions request.", + "schema": { + "$ref": "#/definitions/sendBulkCompTransactionsStatus" + } + } + }, + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "Cashiering" + ] + } + }, "/hotels/{hotelId}/compPostingsApproval": { "put": { "summary": "Operation to request for comp postings approval.", @@ -464,7 +605,7 @@ }, "x-app-key": { "name": "x-app-key", - "description": "Client or Partner??????s Application Key", + "description": "Client or Partner 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", @@ -541,6 +682,17 @@ } } }, + "sendBulkCompTransactionsStatus": { + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, "sendCompTransactionsStatus": { "type": "object", "properties": { @@ -1160,6 +1312,170 @@ } } }, + "bulkCompTransactionsCriteriaType": { + "type": "object", + "description": "Contains all transactions to be submitted to the vendor", + "properties": { + "compPostings": { + "description": "List of transactions to be submitted to the vendor.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/bulkCompTransactionType" + } + } + } + }, + "bulkCompTransactionType": { + "type": "object", + "description": "Contains the transaction to be submitted to the vendor", + "properties": { + "amount": { + "description": "Transaction amount.", + "$ref": "#/definitions/currencyAmountType" + }, + "name": { + "description": "Family name, last name or Company Name.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "firstName": { + "description": "Given name, first name or names.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "membershipId": { + "description": "Membership number.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "membershipType": { + "description": "Membership number.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "authorizerId": { + "description": "Authorizer Id.", + "$ref": "#/definitions/uniqueID_Type" + }, + "guestNameId": { + "description": "Guest unique identifier.", + "$ref": "#/definitions/uniqueID_Type" + }, + "resvNameId": { + "description": "Reservation id.", + "$ref": "#/definitions/uniqueID_Type" + }, + "confirmationNo": { + "description": "Confirmation number associated with the transaction.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "roomId": { + "description": "Room number associated with the transaction.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "compId": { + "description": "Comp number associated with the transaction.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "folioNo": { + "description": "Window number where the transaction is posted.", + "type": "number" + }, + "subGroup": { + "description": "Subgroup for the transaction.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "transactionId": { + "description": "Transaction Number for which request is being submitted.", + "type": "number" + }, + "transactionCode": { + "description": "Transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "transactionDescription": { + "description": "Transaction description.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "transactionDate": { + "description": "Transaction date of the posting.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "userName": { + "description": "User name.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "externalUserId": { + "description": "External user id.", + "$ref": "#/definitions/uniqueID_Type" + }, + "cashierId": { + "description": "Numeric ID of the cashier.", + "type": "number" + }, + "generateCompTransactions": { + "type": "array", + "description": "List of comp transactions.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/generateCompTransactionType" + } + } + } + }, + "generateCompTransactionType": { + "type": "object", + "description": "Contains the transaction generate to be submitted to the vendor", + "properties": { + "amount": { + "description": "Transaction amount.", + "$ref": "#/definitions/currencyAmountType" + }, + "transactionId": { + "description": "Transaction Number for which request is being submitted.", + "type": "number" + }, + "transactionCode": { + "description": "Transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "transactionDescription": { + "description": "Transaction description.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "transactionDate": { + "description": "Transaction date of the posting.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, "compTransactionType": { "type": "object", "description": "Contains the transaction to be submitted to the vendor", @@ -1321,4 +1637,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/par.json b/rest-api-specs/property/par.json index 4615727..c520b2f 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -533,6 +533,42 @@ }, "204": { "description": "HotelAvailabilityCRO 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": [ @@ -4013,6 +4049,42 @@ }, "204": { "description": "Hotels 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": [ @@ -4211,6 +4283,42 @@ }, "204": { "description": "analyzeRateAvailability 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": [ @@ -11374,6 +11482,42 @@ }, "204": { "description": "HotelAvailability 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": [ @@ -11624,6 +11768,42 @@ }, "204": { "description": "AlternateAvailability 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": [ @@ -11841,6 +12021,42 @@ }, "204": { "description": "AvailableUpsells 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": [ @@ -11943,6 +12159,42 @@ }, "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": [ @@ -12201,6 +12453,42 @@ }, "204": { "description": "ReservationGuarantees 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": [ @@ -12308,6 +12596,42 @@ }, "204": { "description": "HurdleRates 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": [ @@ -12381,6 +12705,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12454,6 +12814,42 @@ "schema": { "$ref": "#/definitions/changeHurdleRatesDetails" } + }, + "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": [ @@ -12581,6 +12977,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12654,6 +13086,42 @@ }, "204": { "description": "AvailabilityRatePlanInfoByMultipleRatePlans 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": [ @@ -12736,6 +13204,42 @@ }, "204": { "description": "AvailabilityRatePlanInfo 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": [ @@ -12908,6 +13412,42 @@ }, "204": { "description": "RestrictionsByDateRange 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": [ @@ -12981,6 +13521,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13054,6 +13630,42 @@ "schema": { "$ref": "#/definitions/clearAllRestrictions" } + }, + "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": [ @@ -13176,6 +13788,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13313,6 +13961,42 @@ }, "204": { "description": "RestrictionsHistory 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": [ @@ -13388,6 +14072,42 @@ "schema": { "$ref": "#/definitions/reservationGuaranteesPolicies" } + }, + "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": [ @@ -13458,6 +14178,42 @@ }, "204": { "description": "Yield Market Type value of Membership Id 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": [ @@ -24088,6 +24844,11 @@ "numberOfEvents": { "description": "Represents the total number of events in a calendar for a hotel.", "type": "integer" + }, + "websiteAddress": { + "description": "Website address for a resort or property", + "type": "string", + "maxLength": 200 } } }, diff --git a/rest-api-specs/property/parasync.json b/rest-api-specs/property/parasync.json index 25c041b..3a4453d 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -47,6 +47,42 @@ "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" } }, "parameters": [ @@ -152,6 +188,42 @@ } }, "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "parameters": [ @@ -223,6 +295,42 @@ "schema": { "$ref": "#/definitions/restrictionsStatus" } + }, + "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" } }, "parameters": [ @@ -797,4 +905,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/repcfg.json b/rest-api-specs/property/repcfg.json index e8cbf7a..ad07b4f 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -74,6 +74,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ diff --git a/rest-api-specs/property/rmcfg.json b/rest-api-specs/property/rmcfg.json index 6f0e50f..1d85292 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -93,6 +93,42 @@ }, "204": { "description": "BedTypeRequests 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": [ @@ -157,6 +193,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -232,6 +304,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -303,6 +411,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -388,6 +532,42 @@ }, "204": { "description": "BedTypes 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": [ @@ -452,6 +632,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -527,6 +743,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -598,6 +850,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -668,6 +956,42 @@ }, "204": { "description": "BuildingFloorMappings 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": [ @@ -732,6 +1056,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -817,6 +1177,42 @@ }, "204": { "description": "BuildingGroups 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": [ @@ -881,6 +1277,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -954,6 +1386,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1018,6 +1486,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1122,6 +1626,42 @@ }, "204": { "description": "Buildings 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": [ @@ -1195,6 +1735,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1259,6 +1835,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1323,6 +1935,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1408,6 +2056,42 @@ }, "204": { "description": "FloorTypes 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": [ @@ -1472,6 +2156,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1547,6 +2267,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1618,10 +2374,46 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -1692,6 +2484,42 @@ }, "204": { "description": "Floors 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": [ @@ -1756,6 +2584,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1831,6 +2695,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1902,6 +2802,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1977,6 +2913,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2021,13 +2993,14 @@ "in": "query", "required": false, "type": "string", - "description": "A Traveling Rule will add extra credit to a task assignment sheet when rooms from multiple Buildings, Section Groups, Sections and/or Floors are assigned.", + "description": "A Facility Rule will add extra credit to a task assignment sheet when certain task conditions exist. Multiple Facility Task Rules will be applied on top of each other if the conditions are met. A Miscellaneous Rule will add extra credit to a task assignment sheet when the attendants are occupied with anything other than cleaning a room, for example a team meeting. A Special Rule will add extra credit to a task assignment sheet when the defined Specials are attached to a reservation. A Traveling Rule will add extra credit to a task assignment sheet when rooms from multiple Buildings, Section Groups, Sections and/or Floors are assigned. An Inventory Item Rule will add extra credit to a task assignment sheet when the defined Items are attached to a reservation.", "uniqueItems": true, "enum": [ "FacilityTask", "Miscellaneous", "Special", - "Travelling" + "Travelling", + "ItemInventory" ] }, { @@ -2070,6 +3043,42 @@ }, "204": { "description": "HousekeepingCreditRules 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": [ @@ -2143,6 +3152,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2227,6 +3272,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2296,6 +3377,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2390,6 +3507,42 @@ }, "204": { "description": "HousekeepingAttendants 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": [ @@ -2463,6 +3616,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2547,6 +3736,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2735,6 +3960,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2818,6 +4079,42 @@ }, "204": { "description": "HousekeepingRoomSchedules 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": [ @@ -2891,6 +4188,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2975,6 +4308,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3059,6 +4428,42 @@ }, "204": { "description": "HousekeepingSectionGroups 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": [ @@ -3132,6 +4537,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3214,6 +4655,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3296,6 +4773,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3394,6 +4907,42 @@ }, "204": { "description": "HousekeepingSections 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": [ @@ -3467,6 +5016,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3538,6 +5123,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3620,6 +5241,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3700,6 +5357,42 @@ }, "204": { "description": "HouseKeepingSupplyCodes 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": [ @@ -3773,6 +5466,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3858,6 +5587,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3940,6 +5705,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4050,6 +5851,42 @@ }, "204": { "description": "HousekeepingTaskSheetRooms 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": [ @@ -4123,6 +5960,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4210,6 +6083,42 @@ }, "204": { "description": "HousekeepingTasks 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": [ @@ -4283,6 +6192,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4361,6 +6306,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4443,6 +6424,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4549,6 +6566,42 @@ }, "204": { "description": "OutOfOrderServiceReasons 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": [ @@ -4622,6 +6675,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4706,6 +6795,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4775,6 +6900,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4869,6 +7030,42 @@ }, "204": { "description": "RoomGroups 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": [ @@ -4942,6 +7139,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5026,6 +7259,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5106,10 +7375,46 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -5190,6 +7495,42 @@ }, "204": { "description": "RoomClasses 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": [ @@ -5263,6 +7604,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5347,6 +7724,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5423,6 +7836,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5521,6 +7970,42 @@ }, "204": { "description": "ResortRoomConditions 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": [ @@ -5594,6 +8079,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5678,6 +8199,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5747,6 +8304,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5839,6 +8432,42 @@ }, "204": { "description": "RoomFeatures 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": [ @@ -5912,6 +8541,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5985,6 +8650,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6067,6 +8768,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6181,6 +8918,42 @@ }, "204": { "description": "HotelRoomMaintenanceReasons 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": [ @@ -6254,6 +9027,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6338,6 +9147,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6407,6 +9252,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6477,6 +9358,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6547,6 +9464,42 @@ }, "204": { "description": "RoomTypeInfo 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": [ @@ -6627,6 +9580,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6772,6 +9761,42 @@ }, "204": { "description": "RoomTypes 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": [ @@ -6845,6 +9870,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6929,6 +9990,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7005,6 +10102,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7124,6 +10257,42 @@ }, "204": { "description": "Rooms 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": [ @@ -7197,6 +10366,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7281,6 +10486,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7357,6 +10598,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7441,6 +10718,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7544,6 +10857,42 @@ }, "204": { "description": " Device Configuration List 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": [ @@ -7617,6 +10966,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7699,6 +11084,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7766,6 +11187,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7841,6 +11298,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7916,6 +11409,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7991,6 +11520,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8066,6 +11631,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8141,6 +11742,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8211,6 +11848,42 @@ }, "204": { "description": "TemplateOutOfOrderServiceReasons 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": [ @@ -8275,6 +11948,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8350,6 +12059,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8410,6 +12155,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8476,10 +12257,46 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -8539,6 +12356,42 @@ }, "204": { "description": "RoomClassTemplates 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": [ @@ -8614,6 +12467,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8681,6 +12570,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8758,6 +12683,42 @@ }, "204": { "description": "RoomConditionTemplates 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": [ @@ -8822,6 +12783,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8897,6 +12894,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8964,6 +12997,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9035,6 +13104,42 @@ }, "204": { "description": "TemplateRoomFeatures 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": [ @@ -9099,6 +13204,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9172,6 +13313,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9236,6 +13413,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9325,6 +13538,42 @@ }, "204": { "description": "RoomHierarchies 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": [ @@ -9389,6 +13638,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9478,6 +13763,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9542,6 +13863,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9608,6 +13965,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9674,6 +14067,42 @@ "schema": { "$ref": "#/definitions/roomHierarchiesDetails" } + }, + "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": [ @@ -9752,6 +14181,42 @@ }, "204": { "description": "TemplateRoomMaintenanceReasons 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": [ @@ -9816,6 +14281,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9891,6 +14392,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9951,6 +14488,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10036,6 +14609,42 @@ }, "204": { "description": "RoomMoveReasons 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": [ @@ -10100,6 +14709,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10175,6 +14820,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10246,6 +14927,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10331,6 +15048,42 @@ }, "204": { "description": "RoomPotentials 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": [ @@ -10395,6 +15148,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10470,6 +15259,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10541,6 +15366,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10626,6 +15487,42 @@ }, "204": { "description": "RoomPreferencePriorities 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": [ @@ -10690,6 +15587,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10765,6 +15698,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10836,6 +15805,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10908,8 +15913,44 @@ "$ref": "#/definitions/templateHousekeepingRoomSchedulesDetails" } }, - "204": { - "description": "Template HousekeepingRoomSchedules not found." + "204": { + "description": "Template HousekeepingRoomSchedules 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": [ @@ -10974,6 +16015,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11048,6 +16125,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11107,6 +16220,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11210,6 +16359,42 @@ }, "204": { "description": "RoomTypeTemplates 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": [ @@ -11274,6 +16459,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11349,6 +16570,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11416,6 +16673,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11563,6 +16856,42 @@ }, "204": { "description": "RoomsSummary 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": [ @@ -11648,6 +16977,42 @@ }, "204": { "description": "SmokingTypes 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": [ @@ -11712,6 +17077,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11787,6 +17188,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11858,6 +17295,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11921,6 +17394,42 @@ }, "204": { "description": "TemplateFloors 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": [ @@ -11985,6 +17494,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12060,6 +17605,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12120,6 +17701,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12191,6 +17808,42 @@ }, "204": { "description": "HousekeepingTasks 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": [ @@ -12255,6 +17908,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12324,6 +18013,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12397,6 +18122,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13500,17 +19261,24 @@ "inactive": { "description": "Indicates if the Housekeeping Credit Rule is inactive.", "type": "boolean" + }, + "itemInventory": { + "description": "When RuleType is set to Item Inventory, specifies which item inventory makes this credit rule applicable. For example, the credit value will be added to the task assignment sheet when the assigned room has this specific item inventory applied to the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, "housekeepingCreditRuleTypeType": { "type": "string", - "description": "A Traveling Rule will add extra credit to a task assignment sheet when rooms from multiple Buildings, Section Groups, Sections and/or Floors are assigned.", + "description": "A Facility Rule will add extra credit to a task assignment sheet when certain task conditions exist. Multiple Facility Task Rules will be applied on top of each other if the conditions are met. A Miscellaneous Rule will add extra credit to a task assignment sheet when the attendants are occupied with anything other than cleaning a room, for example a team meeting. A Special Rule will add extra credit to a task assignment sheet when the defined Specials are attached to a reservation. A Traveling Rule will add extra credit to a task assignment sheet when rooms from multiple Buildings, Section Groups, Sections and/or Floors are assigned. An Inventory Item Rule will add extra credit to a task assignment sheet when the defined Items are attached to a reservation.", "enum": [ "FacilityTask", "Miscellaneous", "Special", - "Travelling" + "Travelling", + "ItemInventory" ] }, "housekeepingCreditRuleTravelTypeType": { @@ -14724,6 +20492,14 @@ "description": "Indicator that tells whether the out of order/service reason in the hotel is active or not.", "type": "boolean" }, + "includeInStatisticsYn": { + "description": "Indicator for RNA to use to decide whether to include this room status in statistics, with no functional impact.", + "type": "boolean" + }, + "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" + }, "hotelId": { "description": "Hotel code the out of order/service reason belongs to.", "type": "string", @@ -16752,6 +22528,14 @@ "inactive": { "description": "Indicator that tells whether the out of order/service reason in the hotel is active or not.", "type": "boolean" + }, + "includeInStatisticsYn": { + "description": "Indicator for RNA to use to decide whether to include this room status in statistics, with no functional impact.", + "type": "boolean" + }, + "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" } } }, @@ -18480,4 +24264,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/rmr.json b/rest-api-specs/property/rmr.json index 8df3a6f..f33ab46 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -142,6 +142,42 @@ }, "204": { "description": "Reservation Rotation Points 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": [ @@ -224,10 +260,49 @@ "description": "Response object for fetching Reservation Rotation Points Details. Rotation points details with adjustment log are returned for the requested hotel, reservation Id and room number.", "schema": { "$ref": "#/definitions/getReservationRotationPointsDetails" + }, + "examples": { + "application/json": {} } }, "204": { "description": "Reservation Rotation Points 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": [ @@ -314,7 +389,46 @@ "description": "Response Body.", "schema": { "$ref": "#/definitions/status" + }, + "examples": { + "application/json": {} } + }, + "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": [ @@ -442,6 +556,42 @@ }, "204": { "description": "Room Rotation Points 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": [ @@ -510,7 +660,46 @@ "description": "Response Body.", "schema": { "$ref": "#/definitions/status" + }, + "examples": { + "application/json": {} } + }, + "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": [ @@ -618,6 +807,42 @@ }, "204": { "description": "Associated Room Ownership 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": [ @@ -810,6 +1035,42 @@ }, "204": { "description": "Room Owners 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": [ @@ -1800,4 +2061,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/rmrcfg.json b/rest-api-specs/property/rmrcfg.json index 8dbeffc..7c393a5 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -100,6 +100,42 @@ }, "204": { "description": "AdjustmentReasons 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": [ @@ -164,6 +200,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -239,6 +311,42 @@ "schema": { "$ref": "#/definitions/AdjustmentReasonsDetailsUpdated" } + }, + "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": [ @@ -313,6 +421,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -381,6 +525,42 @@ }, "204": { "description": "RevenueTransactionCodes 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": [ @@ -454,6 +634,42 @@ "schema": { "$ref": "#/definitions/ChangeRevenueTransactionCodesDetails" } + }, + "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": [ @@ -515,6 +731,42 @@ }, "204": { "description": "RotationPeriod 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": [ @@ -588,6 +840,42 @@ "schema": { "$ref": "#/definitions/ChangeRotationPeriodDetails" } + }, + "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": [ @@ -663,6 +951,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -762,6 +1086,42 @@ }, "204": { "description": "RotationRules 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": [ @@ -836,6 +1196,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -908,6 +1304,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -991,6 +1423,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1106,6 +1574,42 @@ }, "204": { "description": "UnitGrades 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": [ @@ -1179,6 +1683,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1263,6 +1803,42 @@ "schema": { "$ref": "#/definitions/UnitGradesDetailsUpdated" } + }, + "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": [ @@ -1346,6 +1922,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1438,6 +2050,42 @@ }, "204": { "description": "OverrideReasons 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": [ @@ -1502,6 +2150,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1577,6 +2261,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1651,6 +2371,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1720,6 +2476,42 @@ }, "204": { "description": "getRoomOwnerReferrals 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": [ @@ -1793,6 +2585,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1877,6 +2705,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1946,6 +2810,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2015,6 +2915,42 @@ }, "204": { "description": "getProfileRoomOwners 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": [ @@ -2081,6 +3017,42 @@ "schema": { "$ref": "#/definitions/roomOwnershipDetails" } + }, + "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": [ @@ -2145,6 +3117,42 @@ "schema": { "$ref": "#/definitions/roomOwnershipDetails" } + }, + "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": [ @@ -2215,6 +3223,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3982,4 +5026,4 @@ "description": "Find out more about Oracle Hospitality", "url": "https://docs.oracle.com/en/industries/hospitality/integration_platforms.html" } -} +} \ No newline at end of file diff --git a/rest-api-specs/property/rsv.json b/rest-api-specs/property/rsv.json index e757287..0ed7110 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -87,6 +87,42 @@ }, "204": { "description": "BlockReservationStatisticsByDateAndRoomPool 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": [ @@ -153,6 +189,42 @@ "schema": { "$ref": "#/definitions/registerCall" } + }, + "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": [ @@ -238,6 +310,42 @@ }, "204": { "description": "CallStatistics 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": [ @@ -1292,6 +1400,42 @@ }, "204": { "description": "ExternalSystemReservations 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": [ @@ -1440,6 +1584,42 @@ }, "204": { "description": "AwardUpgrades 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": [ @@ -1508,6 +1688,42 @@ }, "204": { "description": "Awards 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": [ @@ -1745,6 +1961,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1820,6 +2072,42 @@ "schema": { "$ref": "#/definitions/reservationCancellationPolicyCriteria" } + }, + "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": [ @@ -2060,6 +2348,42 @@ }, "204": { "description": "ConfirmationLetters 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": [ @@ -2133,6 +2457,42 @@ "schema": { "$ref": "#/definitions/confirmationLettersDetails" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2208,6 +2568,42 @@ "schema": { "$ref": "#/definitions/changeDepositPolicyDetails" } + }, + "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": [ @@ -2301,6 +2697,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2379,6 +2811,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2538,97 +3006,42 @@ }, "204": { "description": "ReservationByExtId not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Reservation" - ] - }, - "put": { - "summary": "Update Reservation by ID", - "description": "Use this to update an existing reservation for a hotel, such as adding comments, changing the number of guests. There are many fields in putReservation defined by ListOfValues; ensure you have reviewed ListOfValues APIs in order successfully to use putReservation.OperationId:putReservationByExtId
", - "operationId": "putReservationByExtId", - "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." + "400": { + "$ref": "#/responses/400" }, - { - "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." + "401": { + "$ref": "#/responses/401" }, - { - "name": "changeReservation", - "in": "body", - "required": true, - "description": "Request method to change a reservations information.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/changeReservation" - } - ] - } + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/authKey" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-app-key" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-hotelid" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-externalsystem" + "413": { + "$ref": "#/responses/413" }, - { - "$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/changeReservationDetails" - } + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2640,13 +3053,11 @@ "tags": [ "Reservation" ] - } - }, - "/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", + "summary": "Update Reservation by ID", + "description": "Use this to update an existing reservation for a hotel, such as adding comments, changing the number of guests. There are many fields in putReservation defined by ListOfValues; ensure you have reviewed ListOfValues APIs in order successfully to use putReservation.OperationId:putReservationByExtId
", + "operationId": "putReservationByExtId", "parameters": [ { "name": "reservationExternalId", @@ -2676,14 +3087,143 @@ "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, { - "name": "reinstateReservation", + "name": "changeReservation", "in": "body", "required": true, - "description": "Overriding the validation check will log the supposed errors in the warnings log if they would fail.", + "description": "Request method to change a reservations information.", "schema": { "allOf": [ { - "$ref": "#/definitions/reinstateReservation" + "$ref": "#/definitions/changeReservation" + } + ] + } + }, + { + "$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/changeReservationDetails" + } + }, + "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}/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", + "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": "reinstateReservation", + "in": "body", + "required": true, + "description": "Overriding the validation check will log the supposed errors in the warnings log if they would fail.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/reinstateReservation" } ] } @@ -2722,6 +3262,42 @@ "schema": { "$ref": "#/definitions/reinstateReservationDetails" } + }, + "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": [ @@ -2813,6 +3389,42 @@ "schema": { "$ref": "#/definitions/cancelReservationDetails" } + }, + "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": [ @@ -2906,6 +3518,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2997,6 +3645,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3076,6 +3760,42 @@ }, "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": [ @@ -3167,6 +3887,42 @@ "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": [ @@ -3273,6 +4029,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3348,6 +4140,42 @@ }, "204": { "description": "ExternalSystemDeliveryHistory 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": [ @@ -3555,6 +4383,42 @@ }, "204": { "description": "GuestMessages 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": [ @@ -3626,6 +4490,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3708,6 +4608,42 @@ "schema": { "$ref": "#/definitions/extendReservationLockDetails" } + }, + "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": [ @@ -3799,6 +4735,42 @@ }, "204": { "description": "PreArrivalMemberReservations 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": [ @@ -4022,6 +4994,42 @@ }, "204": { "description": "PreConfiguredRoutingInstructions 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": [ @@ -4225,6 +5233,42 @@ }, "204": { "description": "ReservationsToShareByProfileId 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": [ @@ -4300,6 +5344,42 @@ "schema": { "$ref": "#/definitions/rateInfo" } + }, + "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": [ @@ -4695,7 +5775,7 @@ "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.", + "description": "Unique Identifier for a guest profile associated with the reservation(s)", "type": "string" }, { @@ -5676,6 +6756,21 @@ "minLength": 0, "maxLength": 50 }, + { + "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": "backToBackDateOn", + "in": "query", + "required": false, + "description": "Fetches all Back to Back reservations that are scheduled to stay over the selected Back to Back date and any additional reservations that are marked as Back to Back for fetched Back to Back reservations.", + "type": "string", + "format": "date" + }, { "$ref": "#/parameters/authKey" }, @@ -5709,6 +6804,42 @@ }, "204": { "description": "HotelReservations 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": [ @@ -5975,6 +7106,42 @@ "schema": { "$ref": "#/definitions/createReservationType" } + }, + "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": [ @@ -6130,6 +7297,42 @@ }, "204": { "description": "ReservationActivityLog 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": [ @@ -6205,6 +7408,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6280,6 +7519,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6382,6 +7657,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6451,6 +7762,156 @@ "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" + ] + }, + "put": { + "summary": "Update Linked Reservations Common Details.", + "description": "This Operation allows to update attributes common to all reservations that are linked to an existing reservation.OperationId:putReservationLinks
", + "operationId": "putReservationLinks", + "parameters": [ + { + "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": "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": "changeLinkedReservationsCommonDetails", + "in": "body", + "required": true, + "description": "Request object with attributes to be updated on all linked reservations.", + "schema": { + "$ref": "#/definitions/changeLinkedReservationsCommonDetails" + } + }, + { + "$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 with new values for the attributes that were updated on all linked reservations.", + "schema": { + "$ref": "#/definitions/linkedReservationsCommonDetails" + } + }, + "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": [ @@ -6688,6 +8149,42 @@ }, "204": { "description": "RateInfo 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": [ @@ -6763,6 +8260,42 @@ "schema": { "$ref": "#/definitions/cancelReservationDetails" } + }, + "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": [ @@ -6982,6 +8515,42 @@ }, "204": { "description": "ReservationsSummary 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": [ @@ -7142,6 +8711,42 @@ "schema": { "$ref": "#/definitions/validateReservationChangesDetails" } + }, + "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": [ @@ -7345,6 +8950,42 @@ }, "204": { "description": "ReservationsToShareByReservationId 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": [ @@ -7614,6 +9255,42 @@ }, "204": { "description": "Reservation 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": [ @@ -7862,6 +9539,42 @@ "schema": { "$ref": "#/definitions/changeReservationDetails" } + }, + "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": [ @@ -7929,6 +9642,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8020,6 +9769,42 @@ }, "204": { "description": "AlertNotices 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": [ @@ -8115,6 +9900,42 @@ }, "204": { "description": "ReservationAttachments 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": [ @@ -8195,6 +10016,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8279,6 +10136,42 @@ "schema": { "$ref": "#/definitions/breakShareValidationsDetails" } + }, + "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": [ @@ -8349,6 +10242,42 @@ }, "204": { "description": "CallHistory 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": [ @@ -8573,6 +10502,42 @@ }, "204": { "description": "CancellationHistory 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": [ @@ -8657,6 +10622,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8739,6 +10740,42 @@ "schema": { "$ref": "#/definitions/computeCancellationPoliciesDetails" } + }, + "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": [ @@ -8815,6 +10852,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8899,6 +10972,42 @@ "schema": { "$ref": "#/definitions/reinstateReservationDetails" } + }, + "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": [ @@ -9009,6 +11118,42 @@ "schema": { "$ref": "#/definitions/cancelReservationDetails" } + }, + "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": [ @@ -9093,75 +11238,42 @@ "schema": { "$ref": "#/definitions/status" } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Reservation" - ] - }, - "delete": { - "summary": "Detach Certificate", - "description": "Remove a certification from a reservation.OperationId:deleteReservationCertificate
", - "operationId": "deleteReservationCertificate", - "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." + "400": { + "$ref": "#/responses/400" }, - { - "$ref": "#/parameters/authKey" + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/x-app-key" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-hotelid" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-externalsystem" + "405": { + "$ref": "#/responses/405" }, - { - "$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" - } + "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": [ @@ -9173,13 +11285,11 @@ "tags": [ "Reservation" ] - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/combineshares/action/validate": { - "put": { - "summary": "Combine Share Validations", - "description": "Validate before combining Reservations for shares.OperationId:putCombineShareValidations
", - "operationId": "putCombineShareValidations", + }, + "delete": { + "summary": "Detach Certificate", + "description": "Remove a certification from a reservation.OperationId:deleteReservationCertificate
", + "operationId": "deleteReservationCertificate", "parameters": [ { "name": "reservationId", @@ -9199,19 +11309,126 @@ "maxLength": 2000, "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, - { - "name": "combineShareValidations", - "in": "body", - "required": true, - "description": "Request to validate a combine share operation. This would be done prior to the actual Combine Share operation. Based on the validations returned from this request, the appropriate values can be returned to the Combine Share operation request.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/combineShareValidations" - } - ] - } - }, + { + "$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}/combineshares/action/validate": { + "put": { + "summary": "Combine Share Validations", + "description": "Validate before combining Reservations for shares.OperationId:putCombineShareValidations
", + "operationId": "putCombineShareValidations", + "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": "combineShareValidations", + "in": "body", + "required": true, + "description": "Request to validate a combine share operation. This would be done prior to the actual Combine Share operation. Based on the validations returned from this request, the appropriate values can be returned to the Combine Share operation request.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/combineShareValidations" + } + ] + } + }, { "$ref": "#/parameters/authKey" }, @@ -9246,6 +11463,42 @@ "schema": { "$ref": "#/definitions/combineShareValidationsDetails" } + }, + "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": [ @@ -9330,6 +11583,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9414,6 +11703,42 @@ "schema": { "$ref": "#/definitions/reservationDailyRateDetailDetails" } + }, + "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": [ @@ -9498,6 +11823,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9580,6 +11941,42 @@ "schema": { "$ref": "#/definitions/computeDepositPoliciesDetails" } + }, + "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": [ @@ -9656,6 +12053,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9741,88 +12174,42 @@ }, "204": { "description": "ECoupons not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Reservation" - ] - }, - "post": { - "summary": "Create Reservation ECoupon", - "description": "Create the Reservation Ecoupons.OperationId:postECoupons
", - "operationId": "postECoupons", - "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." + "400": { + "$ref": "#/responses/400" }, - { - "name": "eCouponsInfo", - "in": "body", - "required": true, - "description": "Request object for creating new eCoupons.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/eCouponsInfo" - } - ] - } + "401": { + "$ref": "#/responses/401" }, - { - "$ref": "#/parameters/authKey" + "403": { + "$ref": "#/responses/403" }, - { - "$ref": "#/parameters/x-app-key" + "404": { + "$ref": "#/responses/404" }, - { - "$ref": "#/parameters/x-hotelid" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/x-externalsystem" + "406": { + "$ref": "#/responses/406" }, - { - "$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" - } + "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": [ @@ -9835,10 +12222,10 @@ "Reservation" ] }, - "put": { - "summary": "Change Reservation Ecoupon", - "description": "Change the Reservation Ecoupons.OperationId:putECoupons
", - "operationId": "putECoupons", + "post": { + "summary": "Create Reservation ECoupon", + "description": "Create the Reservation Ecoupons.OperationId:postECoupons
", + "operationId": "postECoupons", "parameters": [ { "name": "reservationId", @@ -9862,7 +12249,125 @@ "name": "eCouponsInfo", "in": "body", "required": true, - "description": "Request object for changing the existing eCoupons attached to Reservation.", + "description": "Request object for creating new eCoupons.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/eCouponsInfo" + } + ] + } + }, + { + "$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": [ + "Reservation" + ] + }, + "put": { + "summary": "Change Reservation Ecoupon", + "description": "Change the Reservation Ecoupons.OperationId:putECoupons
", + "operationId": "putECoupons", + "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": "eCouponsInfo", + "in": "body", + "required": true, + "description": "Request object for changing the existing eCoupons attached to Reservation.", "schema": { "allOf": [ { @@ -9905,6 +12410,42 @@ "schema": { "$ref": "#/definitions/eCoupons" } + }, + "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": [ @@ -9981,6 +12522,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10065,6 +12642,42 @@ }, "204": { "description": "ReservationExcludedPreferences 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": [ @@ -10135,6 +12748,42 @@ }, "204": { "description": "ReservationLocators 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": [ @@ -10217,6 +12866,42 @@ "schema": { "$ref": "#/definitions/reservationLocatorsDetails" } + }, + "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": [ @@ -10310,6 +12995,42 @@ "schema": { "$ref": "#/definitions/reservationLocatorsStatus" } + }, + "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": [ @@ -10388,6 +13109,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10472,6 +13229,42 @@ "schema": { "$ref": "#/definitions/guestMessagesDetails" } + }, + "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": [ @@ -10554,6 +13347,42 @@ "schema": { "$ref": "#/definitions/changeResvGuestMessages" } + }, + "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": [ @@ -10647,6 +13476,42 @@ "schema": { "$ref": "#/definitions/changeGuestMessages" } + }, + "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": [ @@ -10725,6 +13590,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10809,6 +13710,42 @@ "schema": { "$ref": "#/definitions/reservationDailyRateDetailDetails" } + }, + "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": [ @@ -10879,6 +13816,42 @@ }, "204": { "description": "ReservedInventoryItems 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": [ @@ -10961,6 +13934,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11043,6 +14052,42 @@ "schema": { "$ref": "#/definitions/reservedInventoryItemsInfo" } + }, + "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": [ @@ -11112,6 +14157,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11259,6 +14340,160 @@ }, "204": { "description": "LinkedReservations 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" + ] + }, + "put": { + "summary": "Update Linked Reservation by ID", + "description": "Use this API to update an existing linked reservation for given reservation name id and hotel code.OperationId:putLinkedReservation
", + "operationId": "putLinkedReservation", + "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": "changeLinkedReservation", + "in": "body", + "required": true, + "description": "Request object to change a linked reservation information.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/changeLinkedReservationType" + } + ] + } + }, + { + "$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": [ @@ -11351,6 +14586,42 @@ }, "204": { "description": "LinkedReservationsSummary 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": [ @@ -11435,6 +14706,42 @@ "schema": { "$ref": "#/definitions/reservationLockDetails" } + }, + "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": [ @@ -11519,6 +14826,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11603,6 +14946,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11685,6 +15064,42 @@ "schema": { "$ref": "#/definitions/masterAccountSummary" } + }, + "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": [ @@ -11754,6 +15169,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11838,6 +15289,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11907,6 +15394,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11991,6 +15514,42 @@ "schema": { "$ref": "#/definitions/mergeReservationsStatus" } + }, + "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": [ @@ -12075,6 +15634,42 @@ "schema": { "$ref": "#/definitions/moveReservationHotelDetails" } + }, + "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": [ @@ -12236,6 +15831,42 @@ }, "204": { "description": "Package 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": [ @@ -12318,6 +15949,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12400,6 +16067,42 @@ "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": [ @@ -12469,6 +16172,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12553,6 +16292,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12628,6 +16403,42 @@ }, "204": { "description": "PaymentMethods 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": [ @@ -12697,6 +16508,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12779,6 +16626,42 @@ "schema": { "$ref": "#/definitions/reservationPaymentMethods" } + }, + "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": [ @@ -12863,6 +16746,42 @@ }, "204": { "description": "ReservationPolicies 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": [ @@ -12957,6 +16876,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13471,6 +17426,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13552,6 +17543,42 @@ }, "204": { "description": "ReservationPreference 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": [ @@ -13634,6 +17661,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13727,6 +17790,42 @@ "schema": { "$ref": "#/definitions/reservationPreferenceDetails" } + }, + "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": [ @@ -13805,6 +17904,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13898,6 +18033,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14004,6 +18175,42 @@ }, "204": { "description": "RoutingInstructions 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": [ @@ -14086,6 +18293,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14156,6 +18399,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14238,6 +18517,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14322,6 +18637,42 @@ "schema": { "$ref": "#/definitions/shareReservations" } + }, + "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": [ @@ -14406,6 +18757,42 @@ "schema": { "$ref": "#/definitions/changeSharingGuests" } + }, + "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": [ @@ -14476,6 +18863,42 @@ }, "204": { "description": "ShareReservations 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": [ @@ -14541,7 +18964,260 @@ } ], "responses": { - "201": { + "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:deleteShareReservation
", + "operationId": "deleteShareReservation", + "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": "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" + }, + { + "$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}/stay/action/validate": { + "put": { + "summary": "Check overlapping stay", + "description": "Validate overlapping stay for a reservationOperationId:putValidateOverlappingStay
", + "operationId": "putValidateOverlappingStay", + "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": "overlappingStay", + "in": "body", + "required": true, + "description": "Request to check for overlapping stays of reservations.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/overlappingStay" + } + ] + } + }, + { + "$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", @@ -14554,191 +19230,46 @@ "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 for checking overlapping stays of reservations.", "schema": { - "$ref": "#/definitions/combineShareReservationsDetails" + "$ref": "#/definitions/overlappingStayDetails" } - } - }, - "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:deleteShareReservation
", - "operationId": "deleteShareReservation", - "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." + "400": { + "$ref": "#/responses/400" }, - { - "name": "overrideInventoryCheck", - "in": "query", - "required": false, - "description": "Indicate to Override the Room Inventory Check if applicable.", - "type": "boolean" + "401": { + "$ref": "#/responses/401" }, - { - "name": "overrideMaxOccupancyCheck", - "in": "query", - "required": false, - "description": "Indicate to Override the check on Maximum Room Occupancy if applicable.", - "type": "boolean" + "403": { + "$ref": "#/responses/403" }, - { - "name": "overrideRateAvailabilityCheck", - "in": "query", - "required": false, - "description": "Indicate to Override the check on Maximum Room Occupancy if applicable.", - "type": "boolean" + "404": { + "$ref": "#/responses/404" }, - { - "name": "returnShareReservations", - "in": "query", - "required": false, - "description": "After the break share operation, return the new list of Sharer Reservations.", - "type": "boolean" + "405": { + "$ref": "#/responses/405" }, - { - "$ref": "#/parameters/authKey" + "406": { + "$ref": "#/responses/406" }, - { - "$ref": "#/parameters/x-app-key" + "413": { + "$ref": "#/responses/413" }, - { - "$ref": "#/parameters/x-hotelid" + "414": { + "$ref": "#/responses/414" }, - { - "$ref": "#/parameters/x-externalsystem" + "415": { + "$ref": "#/responses/415" }, - { - "$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" - } - } - }, - "consumes": [ - "application/json;charset=UTF-8" - ], - "produces": [ - "application/json;charset=UTF-8" - ], - "tags": [ - "Reservation" - ] - } - }, - "/hotels/{hotelId}/reservations/{reservationId}/stay/action/validate": { - "put": { - "summary": "Check overlapping stay", - "description": "Validate overlapping stay for a reservationOperationId:putValidateOverlappingStay
", - "operationId": "putValidateOverlappingStay", - "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." + "500": { + "$ref": "#/responses/500" }, - { - "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." + "502": { + "$ref": "#/responses/502" }, - { - "name": "overlappingStay", - "in": "body", - "required": true, - "description": "Request to check for overlapping stays of reservations.", - "schema": { - "allOf": [ - { - "$ref": "#/definitions/overlappingStay" - } - ] - } - }, - { - "$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 for checking overlapping stays of reservations.", - "schema": { - "$ref": "#/definitions/overlappingStayDetails" - } + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14830,6 +19361,42 @@ }, "204": { "description": "Tickets 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": [ @@ -14912,6 +19479,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14994,6 +19597,42 @@ "schema": { "$ref": "#/definitions/tickets" } + }, + "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": [ @@ -15063,6 +19702,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15232,6 +19907,42 @@ }, "204": { "description": "TicketsInquiry 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": [ @@ -15316,6 +20027,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15387,6 +20134,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15556,6 +20339,42 @@ }, "204": { "description": "ReprintTickets 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": [ @@ -15626,6 +20445,42 @@ }, "204": { "description": "TracesByReservation 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": [ @@ -15714,6 +20569,42 @@ }, "204": { "description": "TransactionDiversions 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": [ @@ -15796,6 +20687,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15878,6 +20805,42 @@ "schema": { "$ref": "#/definitions/transactionDiversionsDetails" } + }, + "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": [ @@ -15947,6 +20910,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16031,6 +21030,42 @@ "schema": { "$ref": "#/definitions/reservationsUpgradeEligibilityDetails" } + }, + "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": [ @@ -16162,6 +21197,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16230,6 +21301,42 @@ }, "204": { "description": "ReservationUpsellInfo 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": [ @@ -16265,6 +21372,14 @@ "maxLength": 2000, "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, + { + "name": "overrideInventory", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "Indicates whether to Override the Room Inventory Check" + }, { "$ref": "#/parameters/authKey" }, @@ -16299,6 +21414,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16597,6 +21748,42 @@ }, "204": { "description": "RoomCalendar 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": [ @@ -16667,6 +21854,42 @@ }, "204": { "description": "TracesByRoom 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": [ @@ -16764,6 +21987,42 @@ }, "204": { "description": "Script 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": [ @@ -16922,6 +22181,42 @@ }, "204": { "description": "SellMessageConfig 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": [ @@ -16995,6 +22290,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17068,6 +22399,42 @@ "schema": { "$ref": "#/definitions/sellMessageConfig" } + }, + "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": [ @@ -17128,6 +22495,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17203,6 +22606,42 @@ "schema": { "$ref": "#/definitions/overlappingStayDetails" } + }, + "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": [ @@ -17278,6 +22717,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -17369,6 +22844,42 @@ }, "204": { "description": "UpgradeEligibilityReservations 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": [ @@ -17430,6 +22941,42 @@ }, "204": { "description": "FutureReservationsOrBlocks 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": [ @@ -17482,6 +23029,42 @@ }, "204": { "description": "RecentlyAccessedReservations 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": [ @@ -17815,15 +23398,11 @@ "required": false }, { - "name": "profileIds", + "name": "profileId", "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 + "required": false, + "description": "Unique Identifier for a guest profile associated with the reservation(s)", + "type": "string" }, { "name": "membershipCardNumber", @@ -18668,6 +24247,21 @@ "minLength": 0, "maxLength": 50 }, + { + "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": "backToBackDateOn", + "in": "query", + "required": false, + "description": "Fetches all Back to Back reservations that are scheduled to stay over the selected Back to Back date and any additional reservations that are marked as Back to Back for fetched Back to Back reservations.", + "type": "string", + "format": "date" + }, { "$ref": "#/parameters/authKey" }, @@ -19184,6 +24778,42 @@ }, "204": { "description": "Reservations 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": [ @@ -19277,6 +24907,42 @@ }, "204": { "description": "ReservationIndicators 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": [ @@ -19352,6 +25018,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19412,6 +25114,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19493,6 +25231,42 @@ }, "204": { "description": "ReservationPace 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": [ @@ -19673,6 +25447,42 @@ }, "204": { "description": "ReservationStatistics 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": [ @@ -19736,6 +25546,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -19811,6 +25657,42 @@ "schema": { "$ref": "#/definitions/splitMultiRoomReservationDetails" } + }, + "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": [ @@ -19977,6 +25859,42 @@ }, "204": { "description": "SellMessages 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": [ @@ -20145,6 +26063,42 @@ }, "204": { "description": "SellMessageConfigByChain 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": [ @@ -20209,6 +26163,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -20273,6 +26263,42 @@ "schema": { "$ref": "#/definitions/sellMessageConfig" } + }, + "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": [ @@ -20335,6 +26361,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -21335,6 +27397,12 @@ "fiscalInfo": { "description": "Fiscal related informatin for a reservation.", "$ref": "#/definitions/fiscalInfoType" + }, + "parentReservationHotelId": { + "description": "Property associated with the Linked Reservation that serves as parent to this reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 } } }, @@ -21535,6 +27603,14 @@ "roomAvailableNights": { "description": "Number of nights this room is avaiable if room is assigned to reservation", "type": "integer" + }, + "backToBack": { + "description": "This attribute indicates if the linked reservation is marked as Back to Back or not.", + "type": "boolean" + }, + "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" } } }, @@ -22777,6 +28853,10 @@ "type": "object", "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", "properties": { + "excludeFromAutoAuthorization": { + "description": "Indicates if the reseravtion will be excluded from auto athorization of Credit Cards.", + "type": "boolean" + }, "postingRestriction": { "description": "Flag used by interface program during check in.", "type": "boolean" @@ -23784,6 +29864,11 @@ "description": "Channel specific information to be received in case the reservation is being created through a channel.", "$ref": "#/definitions/channelResvRQInfoType" }, + "reservationNotification": { + "description": "Boolean flag that forces reservation to updates in OPERA. By default, this value is false.", + "type": "boolean", + "default": false + }, "links": { "$ref": "#/definitions/links" }, @@ -24311,6 +30396,18 @@ "overrideRoomFeatures": { "description": "This flag indicates true/false. When this is true, it will allow to override the room feature preference validation while assigning rooms. The Reservation Room Features OPERA Control will determine which room feature preferences will be validated. When Reservation Room Features is on, the validation will be against the Room Feature preferences attached to the reservation. If the parameter is off, the validation will be against the room feature preferences attached to the profile. This is applicable when the Room Feature Validation OPERA Control is on.", "type": "boolean" + }, + "backToBack": { + "description": "This attribute indicates if the linked reservation is marked as Back to Back or not.", + "type": "boolean" + }, + "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" + }, + "payeeSharer": { + "description": "This attribute indicates if the Shared reservation is marked as the Payee Sharer or not.", + "type": "boolean" } } }, @@ -25396,6 +31493,11 @@ "showInactiveRoomOwners": { "description": "Flag to show inactive Room Owners.", "type": "boolean" + }, + "guestAge": { + "description": "Age of a guest in years.", + "type": "integer", + "minimum": 0 } } }, @@ -30982,6 +37084,14 @@ "childCount": { "description": "Number of children of the reservation.", "type": "integer" + }, + "backToBack": { + "description": "This attribute indicates if the linked reservation is marked as Back to Back or not.", + "type": "boolean" + }, + "profileId": { + "description": "Unique guest profile identifier for the linked reservation.", + "$ref": "#/definitions/profileId" } } }, @@ -33320,6 +39430,11 @@ "description": "Channel specific information to be received in case the reservation is being created through a channel.", "$ref": "#/definitions/channelResvRQInfoType" }, + "reservationNotification": { + "description": "Boolean flag that forces reservation to updates in OPERA. By default, this value is false.", + "type": "boolean", + "default": false + }, "links": { "$ref": "#/definitions/links" }, @@ -34080,6 +40195,11 @@ "description": "Channel specific information to be received in case the reservation is being created through a channel.", "$ref": "#/definitions/channelResvRQInfoType" }, + "reservationNotification": { + "description": "Boolean flag that forces reservation to updates in OPERA. By default, this value is false.", + "type": "boolean", + "default": false + }, "verificationOnly": { "description": "Indicator if the request is a verification on whether the reservation can be canceled.", "type": "boolean" @@ -41648,6 +47768,68 @@ "Exclusive", "Regular" ] + }, + "linkedReservationsCommonDetailsType": { + "type": "object", + "description": "Details common to all linked reservations.", + "properties": { + "linkedName": { + "type": "string", + "description": "Name associated with a group of linked reservations.", + "minLength": 0, + "maxLength": 50 + } + } + }, + "changeLinkedReservationsCommonDetails": { + "type": "object", + "description": "Request object for updating linked reservations details.", + "properties": { + "linkedReservationsCommonDetails": { + "description": "Updated values of details common to all linked reservations.", + "$ref": "#/definitions/linkedReservationsCommonDetailsType" + } + } + }, + "linkedReservationsCommonDetails": { + "type": "object", + "description": "Response object for updating linked reservations details.", + "properties": { + "linkedReservationsCommonDetails": { + "description": "Updated values of details common to all linked reservations.", + "$ref": "#/definitions/linkedReservationsCommonDetailsType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "changeLinkedReservationType": { + "type": "object", + "description": "Request object to change a linked reservation information.", + "properties": { + "linkedReservationInfo": { + "description": "Linked reservation information that needs to be changed.", + "$ref": "#/definitions/linkedReservationInfoType" + } + } + }, + "backToBackResSequenceType": { + "type": "object", + "description": "Type object represents Back To Back Sequence Position and Total Count of Linked Back To Back Reservations ordered by consecutive Stay Dates.", + "properties": { + "position": { + "description": "Indicates the Sequence position of Back to Back Reservation.", + "type": "integer" + }, + "totalCount": { + "description": "Indicates the total count of Back To Back Reservations in the group of Linked Reservations.", + "type": "integer" + } + } } }, "tags": [ diff --git a/rest-api-specs/property/rsvasync.json b/rest-api-specs/property/rsvasync.json index 58bdd41..8155f15 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -44,6 +44,42 @@ } }, "description": "Location of process status resource" + }, + "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" } }, "parameters": [ @@ -147,6 +183,42 @@ } }, "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "parameters": [ @@ -215,6 +287,42 @@ "schema": { "$ref": "#/definitions/reservationsDailySummaryDetails" } + }, + "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" } }, "parameters": [ @@ -265,691 +373,13429 @@ "ReservationAsync" ] } - } - }, - "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 - }, - "Accept-Language": { - "name": "Accept-Language", - "type": "string", - "description": "Language code", - "in": "header" - } - }, - "responses": { - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } - }, - "401": { - "description": "Unauthorized" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Resource not found", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } - }, - "405": { - "description": "Method not allowed" - }, - "406": { - "description": "Not acceptable." - }, - "413": { - "description": "Request Entity Too Large" - }, - "414": { - "description": "Request URI Too Large" - }, - "415": { - "description": "Unsupported Media Type" - }, - "500": { - "description": "System Error", - "schema": { - "$ref": "#/definitions/exceptionDetailType" - } - }, - "502": { - "description": "Bad Gateway" }, - "503": { - "description": "Service Unavailable" - } - }, - "definitions": { - "exceptionDetailType": { - "title": "Error Detail", - "description": "Complex type that contains error details for a REST call.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." - }, - "title": { - "type": "string", - "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." - }, - "status": { - "type": "integer", - "description": "HTTP status code for this occurrence of the problem, set by the origin server." - }, - "detail": { - "type": "string", - "description": "Human-readable description specific to this occurrence of the problem." - }, - "instance": { - "type": "string", - "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." - }, - "o:errorCode": { - "type": "string", - "description": "Application error code, which is different from HTTP error code." - }, - "o:errorPath": { - "type": "string", - "description": "Path to the problem at the resource or property level." - }, - "o:errorDetails": { - "description": "Details of the error message, consisting of a hierarchical tree structure.", - "type": "array", - "items": { - "$ref": "#/definitions/errorInstance" + "/hotels/{hotelId}/reservationDetailsMassUpdate": { + "post": { + "summary": "Updates reservation details of a given list of reservations.", + "description": "This API allows you to update reservation details of a given list of reservations. A user is allowed to submit only one mass update request per hotel at a time.OperationId:startReservationDetailsMassUpdateProcess
", + "operationId": "startReservationDetailsMassUpdateProcess", + "x-interaction": [ + "async-polling" + ], + "responses": { + "202": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of process status resource" + } + }, + "description": "Location of process status resource" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, - "links": { - "$ref": "#/definitions/links" - } + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "criteria", + "in": "body", + "required": true, + "description": "Request object for submitting mass update of reservation details.", + "schema": { + "$ref": "#/definitions/reservationDetailsMassUpdateCriteria" + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ReservationAsync" + ] } }, - "errorInstance": { - "title": "Error Instance Details", - "description": "Complex type that contains error instance details for a REST call.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." - }, - "title": { - "type": "string", - "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." - }, - "status": { - "type": "integer", - "description": "HTTP status code for this occurrence of the problem, set by the origin server." - }, - "detail": { - "type": "string", - "description": "Human-readable description specific to this occurrence of the problem." - }, - "instance": { - "type": "string", - "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." - }, - "o:errorCode": { - "type": "string", - "description": "Application error code, which is different from HTTP error code." - }, - "o:errorPath": { + "/hotels/{hotelId}/tracesMassUpdate": { + "post": { + "summary": "Updates reservation traces of a given list of reservations.", + "description": "This API allows you to update reservation traces of a given list of reservations. A user is allowed to submit only one mass update request per hotel at a time.OperationId:startTracesMassUpdateProcess
", + "operationId": "startTracesMassUpdateProcess", + "x-interaction": [ + "async-polling" + ], + "responses": { + "202": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of process status resource" + } + }, + "description": "Location of process status resource" + }, + "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" + } + }, + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "criteria", + "in": "body", + "required": true, + "description": "Request object for submitting mass update of reservation traces.", + "schema": { + "$ref": "#/definitions/tracesMassUpdateCriteria" + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ReservationAsync" + ] + } + }, + "/hotels/{hotelId}/preferencesMassUpdate": { + "post": { + "summary": "Updates reservation preferences of a given list of reservations.", + "description": "This API allows you to create reservation preferences of a given list of reservations. A user is allowed to submit only one mass update request per hotel at a time.OperationId:startPreferencesMassUpdateProcess
", + "operationId": "startPreferencesMassUpdateProcess", + "x-interaction": [ + "async-polling" + ], + "responses": { + "202": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of process status resource" + } + }, + "description": "Location of process status resource" + }, + "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" + } + }, + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "criteria", + "in": "body", + "required": true, + "description": "Request object for submitting mass update of reservation preferences.", + "schema": { + "$ref": "#/definitions/preferencesMassUpdateCriteria" + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ReservationAsync" + ] + } + }, + "/hotels/{hotelId}/routingInstructionsMassUpdate": { + "post": { + "summary": "Updates reservation routing instructions of a given list of reservations.", + "description": "This API allows you to update reservation routing instructions of a given list of reservations. A user is allowed to submit only one mass update request per hotel at a time.OperationId:startRoutingInstructionsMassUpdateProcess
", + "operationId": "startRoutingInstructionsMassUpdateProcess", + "x-interaction": [ + "async-polling" + ], + "responses": { + "202": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of process status resource" + } + }, + "description": "Location of process status resource" + }, + "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" + } + }, + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "criteria", + "in": "body", + "required": true, + "description": "Request object for submitting mass update of reservation routing instructions.", + "schema": { + "$ref": "#/definitions/routingInstructionsMassUpdateCriteria" + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ReservationAsync" + ] + } + }, + "/hotels/{hotelId}/housekeepingMassUpdate": { + "post": { + "summary": "Updates reservation housekeeping options and/or schedules of a given list of reservations.", + "description": "This API allows you to update reservation housekeeping options and/or schedules of a given list of reservations. A user is allowed to submit only one mass update reservations request per hotel at a time.OperationId:startHousekeepingMassUpdateProcess
", + "operationId": "startHousekeepingMassUpdateProcess", + "x-interaction": [ + "async-polling" + ], + "responses": { + "202": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of process status resource" + } + }, + "description": "Location of process status resource" + }, + "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" + } + }, + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "criteria", + "in": "body", + "required": true, + "description": "Request object for submitting mass update of housekeeping options and schedule.", + "schema": { + "$ref": "#/definitions/housekeepingMassUpdateCriteria" + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ReservationAsync" + ] + } + }, + "/hotels/{hotelId}/massUpdate/{massUpdateId}": { + "head": { + "summary": "Check status of Mass Update process.", + "description": "Use this to check whether the mass update process has been completed. You can get the value of massUpdateId from the process API response (under header location).OperationId:headMassUpdateProcessStatus
", + "operationId": "headMassUpdateProcessStatus", + "responses": { + "200": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Status": { + "type": "string", + "description": "Status of the requested process.", + "enum": [ + "Processing", + "Invalid" + ] + }, + "Cache-Control": { + "type": "string", + "description": "number of seconds to wait before polling again.", + "x-example": "max-age=10" + } + }, + "description": "Response for status of scheduled asynchronous process." + }, + "201": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Status": { + "type": "string", + "description": "Status of the requested process.", + "enum": [ + "Completed" + ] + }, + "Location": { + "type": "string", + "description": "Location of newly created resource once the status of process run is Complete." + } + }, + "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "parameters": [ + { + "name": "massUpdateId", + "in": "path", + "required": true, + "description": "Unique ID of mass update process", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ReservationAsync" + ] + }, + "get": { + "summary": "Get results of a Mass Update process", + "description": "This API returns a summary of the reservations included in the mass update process. You can get the value of massUpdateId from the process API response (under header location).OperationId:getMassUpdateProcessSummary
", + "operationId": "getMassUpdateProcessSummary", + "parameters": [ + { + "name": "massUpdateId", + "in": "path", + "required": true, + "description": "Unique ID of mass update process", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "$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 mass update process summary", + "schema": { + "$ref": "#/definitions/massUpdateSummaryType" + }, + "examples": { + "application/json": {} + } + }, + "204": { + "description": "Mass Update Process Summary 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": [ + "ReservationAsync" + ] + } + }, + "/hotels/{hotelId}/notesMassUpdate": { + "post": { + "summary": "Updates reservation notes of a given list of reservations.", + "description": "This API allows you to update reservation notes of a given list of reservations. A user is allowed to submit only one mass update request per hotel at a time.OperationId:startNotesMassUpdateProcess
", + "operationId": "startNotesMassUpdateProcess", + "x-interaction": [ + "async-polling" + ], + "responses": { + "202": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of process status resource" + } + }, + "description": "Location of process status resource" + }, + "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" + } + }, + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "criteria", + "in": "body", + "required": true, + "description": "Request object for submitting mass update of reservation notes.", + "schema": { + "$ref": "#/definitions/notesMassUpdateCriteria" + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ReservationAsync" + ] + } + }, + "/hotels/{hotelId}/transportationsMassUpdate": { + "post": { + "summary": "Updates reservation transportations of a given list of reservations.", + "description": "This API allows you to create reservation transportations of a given list of reservations. A user is allowed to submit only one mass update request per hotel at a time.OperationId:startTransportationsMassUpdateProcess
", + "operationId": "startTransportationsMassUpdateProcess", + "x-interaction": [ + "async-polling" + ], + "responses": { + "202": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of process status resource" + } + }, + "description": "Location of process status resource" + }, + "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" + } + }, + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "criteria", + "in": "body", + "required": true, + "description": "Request object for submitting mass update of reservation transportations.", + "schema": { + "$ref": "#/definitions/transportationsMassUpdateCriteria" + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ReservationAsync" + ] + } + }, + "/hotels/{hotelId}/blocks/{blockId}/roominglistvalidation": { + "post": { + "summary": "Validate Rooming List Reservations", + "description": "Use this API to validate Reservations Rooming List.OperationId:startRoomingListValidationProcess
", + "operationId": "startRoomingListValidationProcess", + "x-interaction": [ + "async-polling" + ], + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Block Id" + }, + { + "name": "roomingList", + "in": "body", + "required": true, + "description": "Request object for validate rooming list reservations.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/roomingList" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "202": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of process status resource" + } + }, + "description": "Location of process status resource" + }, + "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": [ + "ReservationAsync" + ] + } + }, + "/hotels/{hotelId}/roominglistvalidation/{requestId}": { + "head": { + "summary": "Check status of Rooming List validation process.", + "description": "Use this to check whether the validate rooming list process status is Processing, Invalid, Failed or Success. You can get the value of requestId from the process API response under header location.OperationId: getRoomingListValidationProcessStatus
", + "operationId": "getRoomingListValidationProcessStatus", + "responses": { + "200": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Status": { + "type": "string", + "description": "Status of the requested process.", + "enum": [ + "Processing", + "Invalid" + ] + }, + "Cache-Control": { + "type": "string", + "description": "number of seconds to wait before polling again.", + "x-example": "max-age=10" + } + }, + "description": "Response for status of scheduled asynchronous process." + }, + "201": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Status": { + "type": "string", + "description": "Status of the requested process.", + "enum": [ + "Completed" + ] + }, + "Location": { + "type": "string", + "description": "Location of validated rooming list reservations once the status of process run is Complete." + } + }, + "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "parameters": [ + { + "name": "requestId", + "in": "path", + "required": true, + "description": "Unique ID for rooming list validation process", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ReservationAsync" + ] + }, + "get": { + "summary": "Get results of Rooming List validation process", + "description": "This API returns a summary of the status from rooming list validation process. You can get the value of requestId from the process API response (under header location).OperationId:getRoomingListValidationProcessResults
", + "operationId": "getRoomingListValidationProcessResults", + "parameters": [ + { + "name": "requestId", + "in": "path", + "required": true, + "description": "Unique ID for rooming list validation process", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "$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 validation of block rooming list. This object contains the details with unique identifiers for the validate block reservations. Also Success,Warnings and Errors related to this operation.", + "schema": { + "$ref": "#/definitions/validateRoomingListType" + }, + "examples": { + "application/json": {} + } + }, + "204": { + "description": "Rooming List Process Summary 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": [ + "ReservationAsync" + ] + } + }, + "/hotels/{hotelId}/paymentInstructionsMassUpdate": { + "post": { + "summary": "Updates reservation payment instructions of a given list of reservations.", + "description": "This API allows you to update reservation payment instructions of a given list of reservations. A user is allowed to submit only one mass update request per hotel at a time.OperationId:startPaymentInsructionsMassUpdateProcess
", + "operationId": "startPaymentInstructionsMassUpdateProcess", + "x-interaction": [ + "async-polling" + ], + "responses": { + "202": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of process status resource" + } + }, + "description": "Location of process status resource" + }, + "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" + } + }, + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + { + "name": "criteria", + "in": "body", + "required": true, + "description": "Request object for submitting mass update of reservation payment instructions.", + "schema": { + "$ref": "#/definitions/paymentInstructionsMassUpdateCriteria" + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ReservationAsync" + ] + } + }, + "/hotels/{hotelId}/blocks/{blockId}/roominglistcreation": { + "post": { + "summary": "Create Rooming List Reservations", + "description": "Use this API to create Reservations Rooming List.OperationId:startRoomingListCreationProcess
", + "operationId": "startRoomingListCreationProcess", + "x-interaction": [ + "async-polling" + ], + "parameters": [ + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "blockId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 2000, + "description": "Block Id" + }, + { + "name": "roomingList", + "in": "body", + "required": true, + "description": "Request object for create rooming list reservations.", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/roomingList" + } + ] + } + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "202": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Location": { + "type": "string", + "description": "Location of process status resource" + } + }, + "description": "Location of process status resource" + }, + "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": [ + "ReservationAsync" + ] + } + }, + "/hotels/{hotelId}/roominglistcreation/{requestId}": { + "head": { + "summary": "Check status of Rooming List creation process.", + "description": "Use this to check whether the create rooming list process status is Processing, Invalid, Failed or Success. You can get the value of requestId from the process API response under header location.OperationId: getRoomingListCreationProcessStatus
", + "operationId": "getRoomingListCreationProcessStatus", + "responses": { + "200": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Status": { + "type": "string", + "description": "Status of the requested process.", + "enum": [ + "Processing", + "Invalid" + ] + }, + "Cache-Control": { + "type": "string", + "description": "number of seconds to wait before polling again.", + "x-example": "max-age=10" + } + }, + "description": "Response for status of scheduled asynchronous process." + }, + "201": { + "headers": { + "Content-Language": { + "type": "string", + "description": "Audience language", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", + "x-example": "en-GB" + }, + "Status": { + "type": "string", + "description": "Status of the requested process.", + "enum": [ + "Completed" + ] + }, + "Location": { + "type": "string", + "description": "Location of created rooming list reservations once the status of process run is Complete." + } + }, + "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" + } + }, + "parameters": [ + { + "name": "requestId", + "in": "path", + "required": true, + "description": "Unique ID for rooming list creation process", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "$ref": "#/parameters/authKey" + }, + { + "$ref": "#/parameters/x-app-key" + }, + { + "$ref": "#/parameters/x-externalsystem" + }, + { + "$ref": "#/parameters/x-hotelid" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "consumes": [ + "application/json;charset=UTF-8" + ], + "produces": [ + "application/json;charset=UTF-8" + ], + "tags": [ + "ReservationAsync" + ] + }, + "get": { + "summary": "Get results of Rooming List Creation process", + "description": "This API returns a summary of the status from rooming list creation process. You can get the value of requestId from the process API response (under header location).OperationId:getRoomingListCreationProcessResults
", + "operationId": "getRoomingListCreationProcessResults", + "parameters": [ + { + "name": "requestId", + "in": "path", + "required": true, + "description": "Unique ID for rooming list creation process", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "name": "hotelId", + "in": "path", + "required": true, + "description": "Unique ID of a Hotel", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + { + "$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 creation of block rooming list reservations. This object contains the details with unique identifiers for the create block reservations. Also Success,Warnings and Errors related to this operation.", + "schema": { + "$ref": "#/definitions/createRoomingListType" + }, + "examples": { + "application/json": {} + } + }, + "204": { + "description": "No content returned for Rooming List Creation Process Summary." + }, + "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": [ + "ReservationAsync" + ] + } + } + }, + "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" + } + }, + "responses": { + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/exceptionDetailType" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Resource not found", + "schema": { + "$ref": "#/definitions/exceptionDetailType" + } + }, + "405": { + "description": "Method not allowed" + }, + "406": { + "description": "Not acceptable." + }, + "413": { + "description": "Request Entity Too Large" + }, + "414": { + "description": "Request URI Too Large" + }, + "415": { + "description": "Unsupported Media Type" + }, + "500": { + "description": "System Error", + "schema": { + "$ref": "#/definitions/exceptionDetailType" + } + }, + "502": { + "description": "Bad Gateway" + }, + "503": { + "description": "Service Unavailable" + } + }, + "definitions": { + "exceptionDetailType": { + "title": "Error Detail", + "description": "Complex type that contains error details for a REST call.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." + }, + "title": { + "type": "string", + "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." + }, + "status": { + "type": "integer", + "description": "HTTP status code for this occurrence of the problem, set by the origin server." + }, + "detail": { + "type": "string", + "description": "Human-readable description specific to this occurrence of the problem." + }, + "instance": { + "type": "string", + "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." + }, + "o:errorCode": { + "type": "string", + "description": "Application error code, which is different from HTTP error code." + }, + "o:errorPath": { + "type": "string", + "description": "Path to the problem at the resource or property level." + }, + "o:errorDetails": { + "description": "Details of the error message, consisting of a hierarchical tree structure.", + "type": "array", + "items": { + "$ref": "#/definitions/errorInstance" + } + }, + "links": { + "$ref": "#/definitions/links" + } + } + }, + "errorInstance": { + "title": "Error Instance Details", + "description": "Complex type that contains error instance details for a REST call.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." + }, + "title": { + "type": "string", + "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." + }, + "status": { + "type": "integer", + "description": "HTTP status code for this occurrence of the problem, set by the origin server." + }, + "detail": { + "type": "string", + "description": "Human-readable description specific to this occurrence of the problem." + }, + "instance": { + "type": "string", + "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." + }, + "o:errorCode": { + "type": "string", + "description": "Application error code, which is different from HTTP error code." + }, + "o:errorPath": { + "type": "string", + "description": "Path to the problem at the resource or property level." + } + } + }, + "instanceLink": { + "type": "object", + "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", + "properties": { + "href": { + "description": "URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.", + "type": "string" + }, + "rel": { + "description": "Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.", + "type": "string" + }, + "templated": { + "description": "Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.", + "type": "boolean", + "default": false + }, + "method": { + "description": "HTTP method for requesting the target of the link.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE", + "PATCH", + "OPTIONS", + "HEAD" + ] + }, + "targetSchema": { + "description": "Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..", + "type": "string" + }, + "operationId": { + "description": "The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.", + "type": "string" + }, + "title": { + "description": "Exact copy of the \"summary\" field on the linked operation.", + "type": "string" + } + } + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/instanceLink" + } + }, + "reservationsDailySummarySearchType": { + "type": "object", + "properties": { + "hotelId": { + "description": "The Hotel Code for which the reservation search will be performed.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "timeSpan": { + "description": "The start date and time span for the search to be performed.", + "$ref": "#/definitions/timeSpanType" + }, + "lastModifiedDate": { + "description": "Start and End Modified Dates of Reservations after which the results are to be fetched", + "$ref": "#/definitions/lastModifiedDateType" + } + } + }, + "timeSpanType": { + "type": "object", + "description": "Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, whild Duration provides a measure of time to add to the StartDate to yield end date.", + "properties": { + "startDate": { + "type": "string", + "format": "date" + }, + "endDate": { + "type": "string", + "format": "date" + }, + "duration": { + "type": "string" + } + } + }, + "massUpdateTimeSpanType": { + "type": "object", + "description": "Allows for a choice in description of the amount of time spanned by this type.", + "properties": { + "startDate": { + "type": "string", + "format": "date" + }, + "endDate": { + "type": "string", + "format": "date" + } + } + }, + "lastModifiedDateType": { + "type": "object", + "description": "Start and End Modified Dates of Reservations after which the results are to be fetched", + "properties": { + "startLastModifiedDate": { + "type": "string", + "format": "date-time" + }, + "endLastModifiedDate": { + "type": "string", + "format": "date-time" + } + } + }, + "reservationDailySummaryType": { + "type": "object", + "description": "Daily summary information related to a reservation.", + "properties": { + "reservationIdList": { + "description": "Collection of reservation identifiers like Reservation Name ID, Confirmation Number, etc.", + "$ref": "#/definitions/reservationIdList" + }, + "externalReferences": { + "description": "External Reference information for Reservation.", + "$ref": "#/definitions/externalReferencesType" + }, + "resvStatus": { + "description": "Indicates the status of the reservation.", + "$ref": "#/definitions/database_ResStatusType" + }, + "sharedYn": { + "description": "Indicates whether the reservation has any sharers. Y indicates true and N indicates false.", + "type": "string" + }, + "sharersList": { + "description": "Collection of Confirmation Numbers of Sharers.", + "type": "string" + }, + "sharersResvIdList": { + "description": "The unique identifier reservationId List of the shared reservations.", + "type": "string" + }, + "arrival": { + "type": "string", + "format": "date-time" + }, + "departure": { + "type": "string", + "format": "date-time" + }, + "checkedOutDate": { + "description": "The date the reservation was checked out.", + "type": "string", + "format": "date-time" + }, + "cancellationDate": { + "description": "The date the reservation was canceled.", + "type": "string", + "format": "date-time" + }, + "bookingDate": { + "type": "string", + "format": "date-time" + }, + "nationality": { + "description": "Affiliation or ethnicity to a particular country.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "resvType": { + "description": "Type of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "noOfRooms": { + "description": "Number of rooms of the reservation.", + "type": "integer" + }, + "blockCode": { + "description": "Block code of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "guestCountry": { + "description": "Country code for guest's primary address.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "travelAgentId": { + "description": "ID of the travel agent for the reservation.", + "$ref": "#/definitions/uniqueID_Type" + }, + "travelAgentName": { + "description": "Name of the travel agent for the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "iataCode": { + "description": "IATA Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "companyId": { + "description": "ID of the company for the reservation.", + "$ref": "#/definitions/uniqueID_Type" + }, + "companyName": { + "description": "Name of the company for the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "groupId": { + "description": "ID of the group for the reservation.", + "$ref": "#/definitions/uniqueID_Type" + }, + "groupName": { + "description": "Name of the group for the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "sourceId": { + "description": "ID of the source for the reservation.", + "$ref": "#/definitions/uniqueID_Type" + }, + "sourceName": { + "description": "Name of the source for the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "resvContactId": { + "description": "ID of the contact for the reservation.", + "$ref": "#/definitions/uniqueID_Type" + }, + "resvContactName": { + "description": "Name of the contact for the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "createDateTime": { + "description": "Business Date when the reservation was created.", + "type": "string", + "format": "date-time" + }, + "lastModifiedDateTime": { + "description": "Business Date when the reservation was modified.Either lastModifiedDateTime or lastModifiedDate will be returned.", + "type": "string", + "format": "date-time" + }, + "lastModifiedDate": { + "description": "Business Date when the reservation was modified.Either lastModifiedDateTime or lastModifiedDate will be returned.", + "type": "string", + "format": "date-time" + }, + "membershipId": { + "description": "Card Number of the membership.Either membershipId or membershipNumber will be returned.", + "type": "string" + }, + "membershipNumber": { + "description": "Card Number of the membership.Either membershipId or membershipNumber will be returned.", + "type": "string" + }, + "membershipType": { + "description": "Type of membership.", + "type": "string" + }, + "membershipLevel": { + "description": "Indicates the membership level.", + "type": "string" + }, + "adults": { + "description": "Number of adults.", + "type": "integer" + }, + "children1": { + "description": "Number of children classified under the first Age Qualifying Group.", + "type": "integer" + }, + "children2": { + "description": "Number of children classified under the second Age Qualifying Group.", + "type": "integer" + }, + "children3": { + "description": "Number of children classified under the third Age Qualifying Group.", + "type": "integer" + }, + "cancellationReasonCode": { + "type": "string" + }, + "bookingMedium": { + "description": "Classifies the medium(Channel field on reservation screen) through which the reservation is made. Either bookingMedium or origin_of_booking will be present in the response.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "origin_of_booking": { + "description": "Classifies the medium(Channel field on reservation screen) through which the reservation is made.Either bookingMedium or origin_of_booking will be present in the response.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "dailySummary": { + "description": "Collection of daily summary for the reservation.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/dailySummaryType" + } + }, + "createdHotelDateTime": { + "description": "Business Date in property timezone when the reservation was created.", + "type": "string", + "format": "date-time" + }, + "modifiedHotelDateTime": { + "description": "Business Date in property timezone when the reservation was modified.Either lastModifiedDateTime or lastModifiedDate will be returned.", + "type": "string", + "format": "date-time" + } + } + }, + "uniqueIDListType": { + "type": "array", + "description": "Unique Id that references an object uniquely in the system.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "uniqueID_Type": { + "type": "object", + "description": "An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).", + "properties": { + "id": { + "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "preferencesTypeType": { + "type": "object", + "description": "Preference details for the profile.", + "properties": { + "preference": { + "description": "Collection of Preferences for the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/preferencesType" + } + }, + "preferenceType": { + "description": "Preference group code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "preferenceTypeDescription": { + "description": "Preference group description.", + "type": "string" + } + } + }, + "preferencesType": { + "type": "object", + "description": "Guest Preference details for the profile.", + "properties": { + "preferenceValue": { + "description": "Preference value for display purposes.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "reservationIdList": { + "type": "array", + "description": "Unique Id that references an object uniquely in the system.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "dailySummaryType": { + "type": "object", + "description": "Statistic information related to a specific reservation stay date.", + "properties": { + "rateCode": { + "description": "The rate plan code of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "rateAmount": { + "description": "A monetary amount.", + "type": "number" + }, + "rateAmountCurrency": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "marketCode": { + "description": "Holds the code that relates to the market being sold (e.g., the corporate market, packages).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomType": { + "description": "Room type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "bookedRoomType": { + "description": "Booked room type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "room": { + "description": "Room number.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "netRateAmount": { + "description": "Net Amount generated by the reservation.", + "type": "number" + }, + "netRateAmountCurrency": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "roomRevenue": { + "description": "Room Revenue generated by the reservation.", + "type": "number" + }, + "roomRevenueCurrency": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "fbRevenue": { + "description": "Food and Beverage Revenue generated by the reservation.", + "type": "number" + }, + "fbRevenueCurrency": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "otherRevenue": { + "description": "Other Revenue generated by the reservation.", + "type": "number" + }, + "otherRevenueCurrency": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "totalRevenue": { + "description": "Total Revenue generated by the reservation.", + "type": "number" + }, + "totalRevenueCurrency": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "packageRevenue": { + "description": "Package Revenue generated by the reservation.", + "type": "number" + }, + "packageRevenueCurrency": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "tax": { + "description": "Tax Revenue generated by the reservation.", + "type": "number" + }, + "taxCurrency": { + "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", + "type": "string", + "minLength": 3, + "maxLength": 3 + }, + "roomTypeCharged": { + "description": "Room type charged for the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "trxDate": { + "description": "Reservation stay date for which the daily statistics are projected.", + "type": "string", + "format": "date-time" + }, + "sourceCode": { + "description": "The entity/channel who made the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "channel": { + "description": "Classifies the Channel field on reservation screen through which the reservation is made.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "adults": { + "description": "Number of adults of the reservation.", + "type": "integer" + }, + "children": { + "description": "Number of children of the reservation.", + "type": "integer" + } + } + }, + "database_ResStatusType": { + "type": "string", + "description": "This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.", + "enum": [ + "RESERVED", + "REQUESTED", + "NO SHOW", + "CANCELLED", + "IN HOUSE", + "CHECKED IN", + "CHECKED OUT", + "WAITLIST", + "DUE IN", + "DUE OUT", + "WALKIN", + "PENDING CHECKOUT", + "PROSPECT" + ] + }, + "criteria": { + "type": "object", + "description": "Request object for fetching future reservations asynchronously.", + "properties": { + "criteria": { + "$ref": "#/definitions/reservationsDailySummarySearchType" + } + } + }, + "reservationsDailySummaryDetails": { + "type": "object", + "description": "Reservation Daily Summary Details.", + "properties": { + "reservations": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationDailySummaryType" + } + } + } + }, + "reservationDetailsMassUpdateCriteria": { + "type": "object", + "description": "Reservation Details Mass Update criteria.", + "properties": { + "reservationIds": { + "description": "Unique ID of reservations to be updated.", + "type": "array", + "maxItems": 100, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "expectedTimes": { + "description": "The Expected Arrival and Departure Times.", + "$ref": "#/definitions/resExpectedTimesType" + }, + "marketCode": { + "description": "Market code of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "sourceCode": { + "description": "Source code of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "bookingMedium": { + "description": "Classifies the medium(Channel field on reservation screen) through which the reservation is made.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "advanceCheckIn": { + "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", + "$ref": "#/definitions/advanceCheckInType" + }, + "userDefinedFields": { + "description": "A common type used to hold user defined fields(UDFs). ", + "$ref": "#/definitions/userDefinedFieldsType" + } + } + }, + "tracesMassUpdateCriteria": { + "type": "object", + "description": "Reservation Traces Mass Update criteria.", + "properties": { + "reservationIds": { + "description": "Unique ID of reservations to be updated.", + "type": "array", + "maxItems": 100, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "timeInfo": { + "description": "Date of the trace.", + "$ref": "#/definitions/traceTimeType" + }, + "departmentIds": { + "description": "Indicates the Department code.", + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "minLength": 1, + "maxLength": 20 + } + }, + "traceText": { + "description": "The information this trace contains.", + "type": "string", + "minLength": 1, + "maxLength": 2000 + }, + "frequency": { + "description": "Time information of the trace.", + "$ref": "#/definitions/massUpdateTracesFrequencyType" + } + } + }, + "preferencesMassUpdateCriteria": { + "type": "object", + "description": "Reservation Preferences Mass Update criteria.", + "properties": { + "reservationIds": { + "description": "Unique ID of reservations to be updated.", + "type": "array", + "maxItems": 100, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "preferenceCollection": { + "description": "Collection of reservation preferences.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/preferencesTypeType" + } + }, + "copyToProfile": { + "description": "Specifies whether to copy the reservation preference to the profile or not.", + "type": "boolean" + } + } + }, + "routingInstructionsMassUpdateCriteria": { + "type": "object", + "description": "A routing info object can either be of type Folio OR of type Room with its corresponding object.", + "properties": { + "reservationIds": { + "description": "Unique ID of reservations to be updated.", + "type": "array", + "maxItems": 100, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "folio": { + "description": "Folio routing type.", + "type": "object", + "properties": { + "payeeInfo": { + "$ref": "#/definitions/massUpdatePayeeInfoType" + }, + "instructions": { + "description": "Set of routing instructions associated to this routing type.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/massUpdateRoutingInstructionType" + } + }, + "folioWindowNo": { + "type": "integer" + } + } + }, + "room": { + "description": "Room routing type.", + "type": "object", + "properties": { + "reservationNameId": { + "description": "Reservation name id to which the instruction will be routed.", + "$ref": "#/definitions/uniqueID_Type" + }, + "instructions": { + "description": "Set of routing instructions associated to this routing type.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/massUpdateRoutingInstructionType" + } + } + } + }, + "refreshFolio": { + "description": "On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions.", + "type": "boolean" + } + } + }, + "transportationsMassUpdateCriteria": { + "type": "object", + "description": "Reservation Transportations Mass Update criteria.", + "properties": { + "reservationIds": { + "description": "Unique ID of reservations to be updated.", + "type": "array", + "maxItems": 100, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "arrivalTransport": { + "$ref": "#/definitions/massTransportInfoType" + }, + "departureTransport": { + "$ref": "#/definitions/massTransportInfoType" + } + } + }, + "traceTimeType": { + "type": "object", + "properties": { + "dateTimeSpan": { + "description": "Time span for the trace.", + "$ref": "#/definitions/dateTimeSpanType" + }, + "traceTime": { + "description": "Time of the trace in 24 hour time.", + "type": "string", + "minLength": 0, + "maxLength": 8, + "pattern": "([0-1]?[0-9]|2[0-3]):[0-5][0-9]" + } + } + }, + "dateTimeSpanType": { + "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.Maximum duration allowed is 30 days.", + "properties": { + "startDateTime": { + "type": "string", + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "format": "date-time" + } + } + }, + "massUpdateTracesFrequencyType": { + "type": "string", + "description": "Simple type to mention the trace date range when mass updating the reservation traces.", + "enum": [ + "DateRange", + "ArrivalDayOnly", + "DepartureDayOnly", + "StayDates" + ] + }, + "resExpectedTimesType": { + "type": "object", + "description": "Holds the Arrival and Departure Time Information", + "properties": { + "reservationExpectedArrivalTime": { + "description": "Arrival Time", + "type": "string", + "format": "date-time" + }, + "reservationExpectedDepartureTime": { + "description": "Departure Time", + "type": "string", + "format": "date-time" + } + } + }, + "advanceCheckInType": { + "type": "object", + "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", + "properties": { + "expectedReturnTime": { + "description": "Expected Return Time", + "type": "string", + "format": "date-time" + }, + "eTRComments": { + "description": "ETR Comments", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } + }, + "massUpdateHousekeepingInstructions": { + "type": "object", + "description": "Mass update housekeeping instructions criteria.", + "properties": { + "expectedServiceTime": { + "description": "Expected start time for housekeeping task(s) in 24 hour format.", + "type": "string", + "minLength": 0, + "maxLength": 8, + "pattern": "([0-1]?[0-9]|2[0-3]):[0-5][0-9]" + }, + "clearCurrentExpectedServiceTime": { + "description": "Indicates if the current expected service time is to be removed for selected reservations.", + "type": "boolean", + "default": false + }, + "cleaningPriority": { + "description": "Indicates whether cleaning priority is to be given to the reservation room.", + "type": "boolean" + }, + "turndownRequested": { + "description": "Indicates whether guest wants turndown facility or not.", + "type": "boolean" + }, + "instructions": { + "description": "Housekeeping instructions for the room.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } + }, + "massUpdateHousekeepingTaskStayPeriod": { + "type": "string", + "description": "Date period type the housekeeping task is to be performed.", + "enum": [ + "EntireStay", + "SpecificDates" + ] + }, + "massUpdateFacilityCodes": { + "type": "array", + "description": "List of the facility codes.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/massUpdateFacilityCode" + } + }, + "massUpdateFacilityCode": { + "type": "object", + "description": "Housekeeping facility code, and its quantity.", + "properties": { + "quantity": { + "description": "Signifies the quantity.", + "type": "integer" + }, + "code": { + "description": "Housekeeping facility code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "massUpdateFacilityHousekeepingTask": { + "type": "object", + "description": "Information about housekeeping facility task.", + "properties": { + "facilityTask": { + "description": "Code of facility task.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "taskStartDate": { + "description": "Date on which the task needs to start being performed.", + "type": "string", + "format": "date" + }, + "taskEndDate": { + "description": "Date on which task will stop being performed.", + "type": "string", + "format": "date" + }, + "stayPeriod": { + "description": "Specifies whether task is performed for the entire stay or for specific dates.", + "$ref": "#/definitions/massUpdateHousekeepingTaskStayPeriod" + }, + "frequency": { + "description": "Signifies frequency(i.e. every 2 days) with which task is to be performed.", + "type": "integer" + }, + "cycleStartDay": { + "description": "Signifies offset(in days) i.e. start on 3rd day from arrival.", + "type": "integer" + }, + "replaceExistingTasks": { + "description": "Remove existing task(s) scheduled for the selected date(s) for the selected reservations before adding new one.", + "type": "boolean", + "default": false + }, + "facilityCodes": { + "description": "Housekeeping facility codes", + "$ref": "#/definitions/massUpdateFacilityCodes" + } + } + }, + "massUpdateHousekeepingSchedule": { + "type": "object", + "description": "Mass update housekeeping schedule criteria.", + "properties": { + "facilityHousekeepingTask": { + "description": "Facility tasks to be performed for the reservation.", + "$ref": "#/definitions/massUpdateFacilityHousekeepingTask" + } + } + }, + "housekeepingMassUpdateCriteria": { + "type": "object", + "description": "Mass update housekeeping criteria.", + "properties": { + "reservationIds": { + "description": "Unique ID of reservations to be updated.", + "type": "array", + "maxItems": 100, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "housekeepingInstructions": { + "description": "Housekeeping instructions criteria", + "$ref": "#/definitions/massUpdateHousekeepingInstructions" + }, + "housekeepingSchedule": { + "description": "Housekeeping schedule criteria", + "$ref": "#/definitions/massUpdateHousekeepingSchedule" + } + } + }, + "notesMassUpdateCriteria": { + "type": "object", + "description": "Notes Mass Update criteria.", + "properties": { + "reservationIds": { + "description": "Unique ID of reservations to be updated.", + "type": "array", + "maxItems": 100, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "reservationComment": { + "description": "Comment details for the reservation comment.", + "$ref": "#/definitions/reservationCommentType" + } + } + }, + "reservationCommentType": { + "type": "object", + "description": "Reservation Comment Type.", + "properties": { + "text": { + "description": "Specifies Comment's Text", + "type": "string", + "minLength": 1, + "maxLength": 4000 + }, + "commentTitle": { + "description": "Specifies Comment's Title.", + "type": "string", + "minLength": 1, + "maxLength": 200 + }, + "notificationLocation": { + "description": "Notification Location associated with the Note.", + "type": "string", + "enum": [ + "CASHIER", + "GENERAL", + "IN HOUSE", + "RESERVATION" + ] + }, + "type": { + "description": "Specifies type of the comment.", + "type": "string", + "minLength": 1, + "maxLength": 20 + }, + "internal": { + "description": "When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.", + "type": "boolean", + "default": false + } + } + }, + "userDefinedFieldsType": { + "type": "object", + "description": "A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.", + "properties": { + "characterUDFs": { + "description": "Collection of user defined fields of Character/String Type.", + "$ref": "#/definitions/characterUDFsType" + }, + "numericUDFs": { + "description": "Collection of user defined fields of Numeric Type.", + "$ref": "#/definitions/numericUDFsType" + }, + "dateUDFs": { + "description": "Collection of user defined fields of Date Type.", + "$ref": "#/definitions/dateUDFsType" + } + } + }, + "dateUDFsType": { + "type": "array", + "description": "Used to hold collection of user defined fields of Date Type.", + "maxItems": 20, + "items": { + "$ref": "#/definitions/dateUDFType" + } + }, + "dateUDFType": { + "type": "object", + "description": "Used to hold user defined field of Date Type.", + "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 + }, + "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": 2000 + } + } + }, + "characterUDFsType": { + "type": "array", + "description": "Used to hold collection of user defined fields of Character/String Type.", + "maxItems": 40, + "items": { + "$ref": "#/definitions/characterUDFType" + } + }, + "characterUDFType": { + "type": "object", + "description": "Used to hold user defined field of Character/String Type.", + "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 + }, + "value": { + "description": "Value of user defined field.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "alternateName": { + "description": "Label of user defined field used by vendors or customers.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } + }, + "numericUDFsType": { + "type": "array", + "description": "Used to hold collection of user defined fields of Numeric Type.", + "maxItems": 40, + "items": { + "$ref": "#/definitions/numericUDFType" + } + }, + "numericUDFType": { + "type": "object", + "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.", + "properties": { + "name": { + "description": "Name of user defined field.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "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": 2000 + } + } + }, + "massUpdateSummaryType": { + "type": "object", + "description": "Response object for mass update process summary.", + "properties": { + "massUpdateOutcomes": { + "$ref": "#/definitions/massUpdateOutcomesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "massUpdateOutcomesType": { + "type": "array", + "description": "Collection of outcome of mass update to reservations.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/massUpdateOutcomeType" + } + }, + "massUpdateOutcomeType": { + "type": "object", + "description": "Response object for outcome of mass update to reservations.", + "properties": { + "reservationId": { + "description": "Unique Reservation Id", + "type": "number", + "minLength": 0, + "maxLength": 40 + }, + "guestFullName": { + "description": "Guest's Full display name.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "confirmationNo": { + "description": "Confirmation number of the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "arrivalDate": { + "description": "Display the arrival date of the guest.", + "type": "string", + "format": "date-time" + }, + "departureDate": { + "description": "Display the departure date of the guest.", + "type": "string", + "format": "date-time" + }, + "roomId": { + "description": "Display room number if it has been assigned.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "updateStatus": { + "type": "string", + "description": "Update Status.", + "enum": [ + "Success", + "Fail" + ] + }, + "outcomeMessages": { + "description": "Status of the update", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/outcomeMessageType" + } + } + } + }, + "outcomeMessageType": { + "type": "object", + "description": "Object for update messages.", + "properties": { + "messageCode": { + "type": "string", + "description": "Update Message Code.", + "minLength": 0, + "maxLength": 2000 + }, + "messageText": { + "description": "Update Message Text", + "type": "string", + "minLength": 0, + "maxLength": 4000 + } + } + }, + "warningsType": { + "type": "array", + "description": "Used in conjunction with the Success element to define a business error.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/warningType" + } + }, + "warningType": { + "type": "object", + "description": "Used when a message has been successfully processed to report any warnings or business errors that occurred.", + "properties": { + "value": { + "type": "string", + "description": "Property Value" + }, + "shortText": { + "description": "An abbreviated version of the error in textual format.", + "type": "string", + "maxLength": 2000 + }, + "code": { + "description": "If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "docURL": { + "description": "If present, this URL refers to an online description of the error that occurred.", + "type": "string", + "maxLength": 2000 + }, + "status": { + "description": "If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.", + "type": "string", + "maxLength": 2000 + }, + "tag": { + "description": "If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].", + "type": "string", + "maxLength": 2000 + }, + "recordId": { + "description": "If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.", + "type": "string", + "maxLength": 2000 + }, + "type": { + "description": "The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "rph": { + "description": "Reference Place Holder used as an index for this warning.", + "type": "string", + "minLength": 1, + "maxLength": 8 + } + } + }, + "roomingListBlockInfoType": { + "type": "object", + "description": "Block Information for create rooming list operation.", + "properties": { + "hotelId": { + "description": "Hotel code for the block", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "blockIdList": { + "description": "Collection of unique block identifiers", + "$ref": "#/definitions/blockIdList" + } + } + }, + "blockIdList": { + "type": "array", + "description": "Unique Id that references an object uniquely in the system.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "externalReferencesType": { + "type": "array", + "description": "This type contains unique information of external reference.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/externalReferenceType" + } + }, + "externalReferenceType": { + "type": "object", + "description": "This type contains unique information of external reference.", + "properties": { + "id": { + "description": "Unique ID of external reference.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "idExtension": { + "description": "ID extension for external reference.", + "type": "integer" + }, + "idContext": { + "description": "ID context for external reference.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "associatedResType": { + "type": "object", + "description": "Information regarding associated reservations to the reservation.", + "properties": { + "parentReservation": { + "description": "Stores Unique ID of the parent reservation.", + "$ref": "#/definitions/uniqueID_Type" + }, + "originalMultiRoomRes": { + "description": "Stores Unique ID of the original multi room reservation from which this reservation is split off.", + "$ref": "#/definitions/uniqueID_Type" + } + } + }, + "sourceOfSaleType": { + "type": "object", + "description": "Point of Sale of reservation. Identifies the entity/channel who made the reservation.", + "properties": { + "sourceType": { + "description": "Type of entity/channel who made the reservation..", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "sourceCode": { + "description": "The entity/channel who made the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "codeListType": { + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "ownerType": { + "type": "object", + "description": "Generic type for information about an owner.", + "properties": { + "hotel": { + "description": "Hotel to which the owner belongs to.", + "$ref": "#/definitions/codeDescriptionType" + }, + "userId": { + "description": "Unique application user ID.", + "$ref": "#/definitions/uniqueID_Type" + }, + "userName": { + "description": "Unique application user name of the owner.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "ownerCode": { + "description": "Unique Code to identify the owner.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "profileId": { + "description": "Unique owner profile information.", + "$ref": "#/definitions/profileId" + }, + "name": { + "description": "Provides name information of the owner.", + "$ref": "#/definitions/personNameType" + }, + "department": { + "description": "Department to which the owner belongs to.", + "$ref": "#/definitions/codeDescriptionType" + }, + "email": { + "description": "Email information of the owner.", + "$ref": "#/definitions/emailInfoType" + }, + "phone": { + "description": "Information on the telephone number of the owner.", + "$ref": "#/definitions/telephoneInfoType" + }, + "relationship": { + "description": "Relationship of the owner within the profile or block.", + "$ref": "#/definitions/codeDescriptionType" + }, + "primary": { + "description": "When true, this is a primary owner.", + "type": "boolean" + } + } + }, + "masterAccountInfoType": { + "type": "object", + "properties": { + "masterAccountId": { + "description": "Unique ID of the Master account.", + "$ref": "#/definitions/uniqueID_Type" + }, + "masterAccountName": { + "description": "Name of the Master account.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "currentRoomInfoType": { + "type": "object", + "description": "Room information of the reservation for the current day.", + "properties": { + "roomType": { + "description": "Current room type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomId": { + "description": "Current room number.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "suggestedRoomNumbers": { + "description": "Suggested room numbers.", + "$ref": "#/definitions/codeListType" + }, + "roomDescription": { + "description": "Current room description.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "roomViewCode": { + "description": "Represents the room view code like City view, River view, Ocean view etc.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "assignedByAI": { + "description": "Represents the room was assigned by AI Room Assignment.", + "type": "boolean" + }, + "upgradedByAI": { + "description": "Represents the room was upgraded by AI Room Assignment.", + "type": "boolean" + } + } + }, + "taxType": { + "type": "object", + "description": "Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways.", + "properties": { + "description": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "type": { + "description": "Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).", + "$ref": "#/definitions/amountDeterminationType" + }, + "code": { + "description": "Code identifying the fee (e.g.,agency fee, municipality fee).", + "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 + } + } + }, + "amountDeterminationType": { + "type": "string", + "description": "Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.", + "enum": [ + "Inclusive", + "Exclusive" + ] + }, + "taxesType": { + "type": "object", + "description": "A collection of taxes.", + "properties": { + "tax": { + "description": "An individual tax.", + "type": "array", + "maxItems": 99, + "items": { + "$ref": "#/definitions/taxType" + } + }, + "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 + } + } + }, + "feesType": { + "type": "object", + "description": "A collection of fees or service charges.", + "properties": { + "fee": { + "description": "An individual fee or service charge.", + "type": "array", + "maxItems": 99, + "items": { + "$ref": "#/definitions/feeType" + } + }, + "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 + } + } + }, + "feeType": { + "type": "object", + "description": "Applicable service charges or fees.", + "properties": { + "description": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "type": { + "description": "Used to indicate if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).", + "$ref": "#/definitions/amountDeterminationType" + }, + "code": { + "description": "Code identifying the fee (e.g.,agency fee, municipality fee).", + "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 + } + } + }, + "totalType": { + "type": "object", + "description": "The total amount charged for the service including additional amounts and fees.", + "properties": { + "taxes": { + "description": "A collection of taxes.", + "$ref": "#/definitions/taxesType" + }, + "fees": { + "description": "A collection of fees or service charges.", + "$ref": "#/definitions/feesType" + }, + "description": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "amountBeforeTax": { + "description": "The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax).", + "type": "number" + }, + "amountAfterTax": { + "description": "The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax).", + "type": "number" + }, + "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" + }, + "code": { + "description": "Type of charge.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "rateOverride": { + "description": "When true indicates that the rate amount has been overridden.", + "type": "boolean" + } + } + }, + "pointsType": { + "type": "object", + "description": "The Redeem Points contains the number of points required to book a room type.", + "properties": { + "awardsType": { + "description": "Awards type for the award type rate code.", + "type": "string" + }, + "points": { + "description": "No of points required to book this Room Stay.", + "type": "integer" + } + } + }, + "additionalGuestAmountType": { + "type": "object", + "properties": { + "amount": { + "$ref": "#/definitions/totalType" + }, + "ageQualifyingCode": { + "type": "string", + "enum": [ + "ADULT", + "CHILD", + "OTHER", + "CHILDBUCKET1", + "CHILDBUCKET2", + "CHILDBUCKET3", + "CHILDBUCKET4", + "CHILDBUCKET5" + ] + } + } + }, + "discountType": { + "type": "object", + "description": "Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not specified since logically.", + "properties": { + "discountReason": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "percent": { + "description": "Percentage discount.", + "type": "number" + }, + "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 + }, + "discountCode": { + "description": "Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent).", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "shareDistributionInstructionType": { + "type": "string", + "description": "The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL -> Full Rate for each Sharer. SPLIT-> Split the Rate amount between Sharer Reservations. ENTIRE -> This Sharer will get the total amount of the rate code for all the Sharer Reservations.", + "enum": [ + "Full", + "Entire", + "Split", + "CustomSplit" + ] + }, + "amountType": { + "type": "object", + "description": "Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description.", + "properties": { + "base": { + "description": "The base amount charged for the accommodation or service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True, then taxes are included in the base amount. Note that any additional charges should itemized in the other elements.", + "$ref": "#/definitions/totalType" + }, + "additionalGuestAmounts": { + "description": "Collection of incremental charges per age qualifying code for additional guests. Amount charged for additional occupant is with respect to age group of the base guests.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/additionalGuestAmountType" + } + }, + "discount": { + "description": "Discount percentage and/or Amount, code and textual reason for discount", + "$ref": "#/definitions/discountType" + }, + "shareRatePercentage": { + "description": "Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "shareDistributionInstruction": { + "description": "Last rate share distribution instruction applied on share reservation daily rate segment.", + "$ref": "#/definitions/shareDistributionInstructionType" + }, + "total": { + "description": "The total amount charged for this rate including additional occupant amounts and fees.", + "$ref": "#/definitions/totalType" + }, + "requiredPoints": { + "description": "The Points contains the number of points required to book a particular room type.", + "$ref": "#/definitions/pointsType" + }, + "effectiveRate": { + "description": "The reservation effective amount charged for the accommodation or service (i.e. base amount + amount for Add to Rate Combine Line packages) per unit of time", + "$ref": "#/definitions/totalType" + }, + "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 + } + } + }, + "rateRangeType": { + "type": "object", + "description": "Rate Range details like maximum rate amount and minimum rate amount in each available rate category.", + "properties": { + "base": { + "description": "The base amount charged for the accommodation or service.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/totalType" + } + }, + "rateChange": { + "description": "Rate Change Indicator.", + "type": "boolean" + } + } + }, + "ratesType": { + "type": "object", + "description": "Individual rate amount.", + "properties": { + "rate": { + "description": "The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/amountType" + } + }, + "rateRange": { + "description": "Rate Range details like maximum rate amount and minimum rate amount in each available rate category.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/rateRangeType" + } + } + } + }, + "currencyAmountType": { + "type": "object", + "description": "A monetary value expressed with a currency code.", + "properties": { + "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 + } + } + }, + "packageElementType": { + "type": "object", + "properties": { + "amount": { + "$ref": "#/definitions/currencyAmountType" + }, + "allowance": { + "$ref": "#/definitions/currencyAmountType" + }, + "description": { + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + }, + "startDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "endDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "packageCode": { + "type": "string" + }, + "calculationRule": { + "type": "string" + }, + "postingRhythm": { + "type": "string" + }, + "quantity": { + "type": "integer" + }, + "includedInRate": { + "type": "boolean" + }, + "addRateSeprateLine": { + "type": "boolean" + }, + "addRateCombinedLine": { + "type": "boolean" + }, + "startTime": { + "type": "string" + }, + "endTime": { + "type": "string" + }, + "sellSeparate": { + "type": "boolean" + } + } + }, + "profileIdList": { + "type": "array", + "description": "Unique Id that references an object uniquely in the system.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "resProfileTypeType": { + "type": "string", + "enum": [ + "Guest", + "Company", + "Group", + "TravelAgent", + "Source", + "ReservationContact", + "BillingContact", + "Addressee" + ] + }, + "personNameTypeType": { + "type": "string", + "description": "Person's name in an external system.", + "enum": [ + "Primary", + "Alternate", + "Incognito", + "External", + "Phonetic" + ] + }, + "personNameType": { + "type": "object", + "description": "This provides name information for a person.", + "properties": { + "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 + }, + "surname": { + "description": "Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full 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 + }, + "nameTitleSuffix": { + "description": "Title Suffix. Must be populated if ADVANCED_TITLE is on.", + "type": "integer" + }, + "envelopeGreeting": { + "description": "Envelope Greeting of the profile", + "type": "string" + }, + "salutation": { + "description": "Salutation of the profile", + "type": "string" + }, + "nameType": { + "description": "Type of name of the individual, such as former, nickname, alternate or alias name.", + "$ref": "#/definitions/personNameTypeType" + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "externalSystem": { + "description": "When name type is external, indicates the external system the name belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "anonymizationType": { + "type": "object", + "description": "Provides information about guest's anonymization status.", + "properties": { + "anonymizationStatus": { + "description": "Status of anonymization such as Requested or Anonymized.", + "$ref": "#/definitions/anonymizationStatusType" + }, + "anonymizationDate": { + "description": "Date and Time when the guest was anonymized.", + "type": "string", + "format": "date-time" + } + } + }, + "anonymizationStatusType": { + "type": "string", + "description": "Guest has been anonymized.", + "enum": [ + "Requested", + "Anonymized" + ] + }, + "identificationInfoType": { + "type": "object", + "description": "Information on the identification of the customer.", + "properties": { + "identification": { + "description": "Detailed information on the identification of the customer.", + "$ref": "#/definitions/identificationType" + }, + "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": 20 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "identificationType": { + "type": "object", + "description": "Identification information of the customer.", + "properties": { + "idType": { + "description": "Identification Type. Eg Passport, Driving License etc.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "idNumber": { + "description": "Identification Number.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "idNumberMasked": { + "description": "Masked Identification Number.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "issuedCountry": { + "description": "The country where Identification was issued.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "issuedDate": { + "description": "Issued date of Identification.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "issuedPlace": { + "description": "The place where Identification was issued.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "expirationDate": { + "description": "Expiration date of Identification.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "registeredProperty": { + "description": "Property where the identification belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" + } + } + }, + "companyInfoType": { + "type": "object", + "description": "Company Information of the Profile.", + "properties": { + "legalCompany": { + "description": "Legal Company.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "department": { + "description": "Department of the Profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "position": { + "description": "Business Title or Position of the profile.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "countryNameType": { + "type": "object", + "description": "Code for a country or a nationality.", + "properties": { + "value": { + "type": "string", + "description": "Used for Character Strings, length 0 to 200.", + "minLength": 0, + "maxLength": 200 + }, + "code": { + "description": "Code for a country or a nationality.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "profileMembershipType": { + "type": "object", + "description": "Detailed information of the memberships.", + "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" + }, + "membershipLevelDescription": { + "description": "Indicates the membership level description.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "membershipClass": { + "description": "Indicates the membership class.", + "type": "string" + }, + "earningPreference": { + "description": "Earning preference to the membership.", + "$ref": "#/definitions/membershipEarningPreferenceType" + }, + "inactive": { + "description": "Indicates whether membership is active or inactive.", + "type": "boolean" + }, + "benefits": { + "description": "benefits for the membership.", + "$ref": "#/definitions/benefitsType" + }, + "tierAdministration": { + "description": "Defines the degree of participation for this membership in the tier management portion of the program.", + "$ref": "#/definitions/tierAdministrationType" + }, + "downgrade": { + "description": "Defines how downgrading will be handled for this membership.", + "$ref": "#/definitions/downgradeType" + }, + "reIssueNewCard": { + "description": "The status of issuing new membership card to the member.", + "$ref": "#/definitions/cardReIssueType" + }, + "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": 32000 + }, + "downgradeDescription": { + "description": "Indicates information regarding the member's possible downgrades.", + "type": "string", + "minLength": 0, + "maxLength": 32000 + }, + "rating": { + "description": "Value Rating Type Description for this membership.", + "type": "string" + }, + "membershipEnrollmentCode": { + "description": "Indicates how the guest enrolled in the program.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "memberStatus": { + "description": "Indicates where the guest is in the membership enrollment process.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "currentPoints": { + "description": "Profile MemberShip Points.", + "type": "number" + }, + "pointsLabel": { + "description": "Label used to refer to points for this membership type", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "enrollmentSource": { + "description": "Source from where the enrollment is done.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "enrollmentResort": { + "description": "Resort/CRO where enrollment is done.", + "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.", + "type": "string", + "minLength": 0, + "maxLength": 1 + }, + "primaryMembership": { + "description": "Boolean indicator set to True implies membership is a Primary Membership.", + "type": "boolean" + }, + "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.", + "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.", + "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" + }, + "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 + }, + "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 + } + } + }, + "customerType": { + "type": "object", + "description": "Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.", + "properties": { + "personName": { + "description": "Detailed name information for the customer.", + "type": "array", + "maxItems": 5, + "items": { + "$ref": "#/definitions/personNameType" + } + }, + "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" + } + } + }, + "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" + }, + "language": { + "description": "Indicates the language code selected from Languages List of Values.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "nationality": { + "description": "Indicates the nationality code selected from Nationalities List of Values", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "vipStatus": { + "description": "Code of the VIP level associated with the guest.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "companyType": { + "type": "object", + "properties": { + "companyName": { + "description": "Name of the company.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "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": 40 + }, + "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 + }, + "commissionCode": { + "description": "Commission code of the company.", + "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 + } + } + }, + "addressInfoType": { + "type": "object", + "description": "Provides address information.", + "properties": { + "address": { + "description": "Address details for the profile.", + "$ref": "#/definitions/addressType" + }, + "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": 20 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "massUpdateAddressInfoType": { + "type": "object", + "description": "Provides address information.", + "properties": { + "id": { + "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "addressType": { + "type": "object", + "description": "Provides address information.", + "properties": { + "isValidated": { + "description": "Indicator to define if the Address is validated by the Address Validation System.", + "type": "boolean" + }, + "addressLine": { + "description": "When the address is unformatted (FormattedInd=\"false\") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.", + "type": "array", + "maxItems": 4, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 80 + } + }, + "cityName": { + "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "postalCode": { + "description": "Post Office Code number.", + "type": "string", + "minLength": 0, + "maxLength": 15 + }, + "cityExtension": { + "description": "Post Office City Extension Code number. City Extension mainly used for UK addresses.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "county": { + "description": "County or District Name (e.g., Fairfax). This is read only.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "state": { + "description": "State or Province name (e.g., Texas).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "country": { + "description": "Country name (e.g., Ireland).", + "$ref": "#/definitions/countryNameType" + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "type": { + "description": "Defines the type of address (e.g. home, business, other).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "typeDescription": { + "description": "Describes the type code", + "type": "string" + }, + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "updateReservations": { + "description": "Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.", + "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" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 + } + } + }, + "telephoneInfoType": { + "type": "object", + "description": "Information on a telephone number for the customer.", + "properties": { + "telephone": { + "description": "Phone details for the profile.", + "$ref": "#/definitions/telephoneType" + }, + "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": 20 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "telephoneType": { + "type": "object", + "description": "Information on a telephone number for the customer.", + "properties": { + "phoneTechType": { + "description": "Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "phoneUseType": { + "description": "Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "phoneUseTypeDescription": { + "description": "Description of the PhoneUseType code", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "phoneNumber": { + "description": "Telephone number assigned to a single location.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "extension": { + "description": "Extension to reach a specific party at the phone number.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" + }, + "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 + } + } + }, + "status": { + "type": "object", + "description": "Response Body.", + "properties": { + "warnings": { + "$ref": "#/definitions/warningsType" + }, + "links": { + "$ref": "#/definitions/links" + } + } + }, + "emailInfoType": { + "type": "object", + "description": "Information on an email for the customer.", + "properties": { + "email": { + "description": "eMail deatils for the profile.", + "$ref": "#/definitions/emailType" + }, + "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": 20 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "emailType": { + "type": "object", + "description": "Information on an email for the customer.", + "properties": { + "emailAddress": { + "description": "Defines the e-mail address.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "type": { + "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "typeDescription": { + "description": "Describes the Type code", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "emailFormat": { + "description": "Supported Email format.", + "type": "string", + "enum": [ + "Html", + "Text" + ] + }, + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" + }, + "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 + } + } + }, + "uRLInfoType": { + "type": "object", + "description": "Web site address.", + "properties": { + "url": { + "description": "Provides URL information.", + "$ref": "#/definitions/uRLType" + }, + "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": 20 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "uRLType": { + "type": "object", + "description": "Web site address, in IETF(The Internet Engineering Task Force) specified format.", + "properties": { + "value": { + "type": "string", + "description": "Property Value" + }, + "type": { + "description": "Defines the purpose of the URL address, such as personal, business, public, etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "typeDescription": { + "description": "Describes the Type code", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "primaryInd": { + "description": "When true, indicates a primary information.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" + } + } + }, + "commentInfoType": { + "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" + }, + "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 + }, + "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": 20 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "commentType": { + "type": "object", + "description": "An indication of a new paragraph for a sub-section of a formatted text message.", + "properties": { + "text": { + "description": "Formatted text content.", + "$ref": "#/definitions/formattedTextTextType" + }, + "image": { + "description": "An image for this paragraph.", + "type": "string" + }, + "url": { + "description": "A URL for this paragraph.", + "type": "string" + }, + "commentTitle": { + "description": "Specifies Comment's Title.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "notificationLocation": { + "description": "Notification Location associated with the Note.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "type": { + "description": "Specifies type of the comment.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "typeDescription": { + "description": "Comment type Description.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "internal": { + "description": "When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.", + "type": "boolean" + }, + "confidential": { + "description": "When true, the comment may be confidential.", + "type": "boolean" + }, + "overrideInternal": { + "description": "When true, the note internal could be modified.", + "type": "boolean" + }, + "protectDescription": { + "description": "When true, the note title will be populated from the note type description and couldn't be modified.", + "type": "boolean" + }, + "hotelId": { + "description": "If specified comment belongs to the Hotel, otherwise it is a global comment.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "actionType": { + "description": "Specifies type of action described in the comments.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "actionDate": { + "description": "Indicates at which date an action described in the comment must be taken.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "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 + } + } + }, + "formattedTextTextType": { + "type": "object", + "description": "Provides text and indicates whether it is formatted or not.", + "properties": { + "value": { + "type": "string", + "description": "Property Value" + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + } + } + }, + "preferenceTypeType": { + "type": "object", + "description": "Preference details for the profile.", + "properties": { + "preference": { + "description": "Collection of Preferences for the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/preferenceType" + } + }, + "preferenceType": { + "description": "Preference group code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "preferenceTypeDescription": { + "description": "Preference group description.", + "type": "string" + }, + "sequence": { + "description": "Preference Sequence.", + "type": "string" + }, + "maxQuantity": { + "description": "Maximum quantity of preferences allowed per preference group.", + "type": "integer" + }, + "availableQuantity": { + "description": "Available quantity of preferences (maximum quantity - Existing preferences)per preference group.", + "type": "integer" + }, + "maxResortUsedQuantity": { + "description": "Maximum quantity of preferences used by any resort per preference group.", + "type": "integer" + }, + "reservationPreference": { + "description": "Whether this preference is reservation preference or not.", + "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" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "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 + } + } + }, + "preferenceType": { + "type": "object", + "description": "Guest Preference details for the profile.", + "properties": { + "preferenceValue": { + "description": "Preference value for display purposes.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "description": { + "description": "Preference Description for display purposes.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "global": { + "description": "Whether this preference is property specific or not.", + "type": "boolean" + }, + "source": { + "description": "Source of the preference.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "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 + } + }, + "preferenceCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "excludedPreferencesCount": { + "description": "Specifies the count of preferences excluded for the attached reservation preference.", + "type": "integer" + }, + "copyToProfile": { + "description": "Specifies whether to copy the reservation preference to the profile or not.", + "type": "boolean" + } + } + }, + "profileType": { + "type": "object", + "description": "Type provides the detailed information about the profile and its children.", + "properties": { + "customer": { + "description": "Detailed customer information for this profile.", + "$ref": "#/definitions/customerType" + }, + "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" + } + } + } + }, + "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" + } + } + } + }, + "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" + } + } + } + }, + "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" + } + } + } + } + } + }, + "profileCommissionType": { + "type": "object", + "description": "This is the preconfigured routing instruction type.", + "properties": { + "hotelId": { + "description": "Hotel Code for the commission being used for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "commissionCode": { + "description": "commission Code for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "bankAccount": { + "description": "Bank account used for the commission for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "paymentMethod": { + "description": "Type of payment associated with the bank account.", + "$ref": "#/definitions/commissionPaymentMethods" + }, + "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" + } + } + }, + "commissionPaymentMethods": { + "type": "string", + "description": "Check", + "enum": [ + "Cent", + "Eft", + "Chk" + ] + }, + "profileCashieringType": { + "type": "object", + "description": "Contains cashiering related details for the profile", + "properties": { + "directBillingList": { + "description": "Contains the direct billing related information for the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/directBillingType" + } + }, + "autoFolioSettlementType": { + "description": "Contains the auto folio settlement type for the profile.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "paymentDueDays": { + "description": "Ability to define on the account, the number of days after which the invoice should be paid.", + "type": "integer" + }, + "taxPercent1": { + "description": "Tax1 Percentage for Collecting Agent.", + "type": "integer" + }, + "taxPercent2": { + "description": "Tax2 Percentage for Collecting Agent.", + "type": "integer" + }, + "taxPercent3": { + "description": "Tax3 Percentage for Collecting Agent.", + "type": "integer" + }, + "taxPercent4": { + "description": "Tax4 Percentage for Collecting Agent.", + "type": "integer" + }, + "taxPercent5": { + "description": "Tax5 Percentage for Collecting Agent.", + "type": "integer" + }, + "arNoCentral": { + "description": "Account Receivables Central Number.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "referenceCurrency": { + "description": "Reference Currency.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "vATOffsetYN": { + "description": "VAT Offset Flag.", + "type": "string", + "minLength": 0, + "maxLength": 1 + }, + "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" + } + } + }, + "directBillingType": { + "type": "object", + "description": "This is the preconfigured routing instruction type.", + "properties": { + "hotelId": { + "description": "Hotel Code for which the details of direct billing is provided for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "aRNumber": { + "description": "Hotel Code for which the details of direct billing is provided for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "eCertificatesType": { + "type": "array", + "description": "List of e-certificates for the profile.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/eCertificateType" + } + }, + "eCertificateType": { + "type": "object", + "description": "E-Certificates details.", + "properties": { + "certificateId": { + "description": "System generated unique certificate id.", + "type": "integer" + }, + "voucherNo": { + "description": "System generated unique voucher number.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "certificateNo": { + "description": "Printed certificate no. This has to be unique.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "eCertificateInfo": { + "$ref": "#/definitions/eCertificateInfoType" + }, + "expiryDate": { + "description": "Date of expiry.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "newExpiryDate": { + "description": "New Date of expiry to extend e-certificate.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "profileId": { + "description": "NameId.", + "$ref": "#/definitions/profileId" + }, + "consumptionDetail": { + "$ref": "#/definitions/eCertificateConsumptionType" + }, + "status": { + "description": "Status of the certificate.", + "$ref": "#/definitions/eCertificateStatusType" + }, + "printed": { + "description": "Print status of the certificate.", + "type": "boolean" + }, + "inactiveDate": { + "description": "Date the record was marked as inactive.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "awardId": { + "description": "AwardID.", + "$ref": "#/definitions/awardId" + }, + "databaseId": { + "description": "External reference from which the record is created.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "source": { + "description": "Source of e-certificate.", + "$ref": "#/definitions/eCertificateIssueSourceType" + }, + "issueType": { + "description": "Process action issued the certificate. valid values are assigned (a),opt in (o) and purchased (p).", + "$ref": "#/definitions/eCertificateIssueType" + }, + "issueDate": { + "description": "Date when certificate was issued.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "awardPoints": { + "description": "Award points if any in case of certificate use membership award.", + "type": "integer" + }, + "generationDetail": { + "$ref": "#/definitions/eCertificateGenerationType" + }, + "originalVoucherNo": { + "description": "In case of in lieu of certificate this will contain the original voucher no.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "originalCertificateNo": { + "description": "In case of in lieu of certificate this will contain the original certificate no.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "inLieuSequence": { + "description": "Seq of the in lieu of certificate. 1..n. original certificate will be treated as null = 0.", + "type": "integer" + }, + "cancelRequestDate": { + "description": "Date on which the cancellation was requested.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "extensionCount": { + "description": "Number of times e-certificate is already extended.", + "type": "integer" + } + } + }, + "awardId": { + "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" + } + } + }, + "eCertificateStatusType": { + "type": "string", + "description": "Indicates that OPERA E-Certificate is reserved.", + "enum": [ + "Cancelled", + "Consumed", + "Deleted", + "Expired", + "Issued", + "Reserved" + ] + }, + "eCertificateIssueType": { + "type": "string", + "description": "Indicates that guest purchased OPERA E-Certificate.", + "enum": [ + "Assigned", + "OptedIn", + "Purchased" + ] + }, + "eCertificateConsumptionType": { + "type": "object", + "description": "E-Certificates details.", + "properties": { + "hotelId": { + "description": "Property where certificate was consumed for.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "source": { + "description": "Source of consumption.", + "$ref": "#/definitions/eCertificateConsumeSourceType" + }, + "surname": { + "description": "Last name of the person who consumed the certificate..", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "firstName": { + "description": "First name of the person who consumed the certificate.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "middleName": { + "description": "Middle name of the person who consumed the certificate.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "email": { + "description": "Email of the person who consumed the certificate.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "date": { + "description": "Date the certificate was consumed.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "userName": { + "description": "Application user who created the consumption.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "userNotes": { + "description": "Any notes on the certificate entered at time of consumption.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "referenceId": { + "description": "Any reference like reservation no etc against which the certificate was consumed.", + "$ref": "#/definitions/uniqueID_Type" + }, + "locationType": { + "description": "Consumption location type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "authorizationCode": { + "description": "Authorization code for consumption.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "serviceDate": { + "description": "Date on which the service is due (arrival date in case of reservation).", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "eCertificateConsumeSourceType": { + "type": "string", + "description": "Indicates that OPERA E-Certificate is consumed by hotelPMS.", + "enum": [ + "Central", + "Web", + "Hotel" + ] + }, + "eCertificateIssueSourceType": { + "type": "string", + "description": "Indicates that OPERA E-Certificate is issued by external system.", + "enum": [ + "Opera", + "Web", + "Interface" + ] + }, + "eCertificateInfoType": { + "type": "object", + "description": "E-Certificates details.", + "properties": { + "certificateType": { + "description": "User defined certificate code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "membershipType": { + "description": "Membership type to which the certificate is linked to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "awardCode": { + "description": "Award type to which the certificate is linked to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "promotionCode": { + "description": "Promotion code to which certificate is attached to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "voucherBenefitCode": { + "description": "Voucher benefit code attached to the certificate.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "hotels": { + "description": "Hotel to which certificate is attached to.", + "type": "object", + "properties": { + "code": { + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + }, + "scope": { + "description": "Scope of e-cert: global,single property or multi property.", + "$ref": "#/definitions/eCertificateScopeType" + } + } + }, + "description": { + "description": "Description about the certificate.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "longDescription": { + "description": "Detail description about the certificate.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "label": { + "description": "Label for the certificate.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "maxExtensionAllowed": { + "description": "Number of times e-certificate can be extended.", + "type": "integer" + }, + "usageCriteria": { + "$ref": "#/definitions/eCertificateUsageCriteriaType" + }, + "value": { + "description": "Value of the certificate for the guest.", + "$ref": "#/definitions/currencyAmountType" + }, + "cost": { + "description": "Cost of certificate.", + "$ref": "#/definitions/currencyAmountType" + }, + "benefitSummary": { + "description": "Summary of Benefits attached to this ECertificate.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + } + } + }, + "eCertificateScopeType": { + "type": "string", + "description": "Indicates that OPERA E-Certificate is available for a specific list of hotels.", + "enum": [ + "Global", + "Hotel", + "MultiHotel" + ] + }, + "eCertificateUsageCriteriaType": { + "type": "object", + "description": "E-Certificates details.", + "properties": { + "reservation": { + "description": "Indicates if certificate is to be used against reservation or not.", + "type": "boolean" + }, + "web": { + "description": "Indicates if web certificate can be consumed in OWS.", + "type": "boolean" + }, + "webAllowed": { + "description": "Indicates if certificate consumption allowable on the web.", + "type": "boolean" + }, + "benefit": { + "description": "Indicates to attach a rate code to the e-certificate as a benefit.", + "type": "boolean" + }, + "hotel": { + "description": "Indicates if web certificate can be consumed in hotel.", + "type": "boolean" + }, + "verifyCertificateNo": { + "description": "Specify if the certificate number verification is required at time of consumption or not.", + "type": "boolean" + }, + "cancelAllowed": { + "description": "Identify if cancel is allowed or not.", + "type": "boolean" + }, + "generateInLieuCertificate": { + "description": "Identify if in lieu of certificate can be generated or not.", + "type": "boolean" + } + } + }, + "eCertificateGenerationType": { + "type": "object", + "description": "E-Certificates details.", + "properties": { + "ruleId": { + "description": "Key to identify the generation rule id.", + "$ref": "#/definitions/uniqueID_Type" + }, + "generationDetail": { + "description": "Reason for which e-certificate was generated.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "referenceValue": { + "description": "Type of value that is in the certificate.valid values are membership_level.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "privacyInfoType": { + "type": "object", + "description": "Defines Privacy related information for the profile.", + "properties": { + "marketResearchParticipation": { + "description": "Indicates if the profile participates in market research.", + "type": "boolean" + }, + "lastPrivacyPromptDate": { + "description": "Indicate the last privacy prompt date of the guest.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "infoFromThirdParty": { + "description": "Indicates if the profile is ok getting info from third parties.", + "type": "boolean" + }, + "autoEnrollLoyaltyProgram": { + "description": "Indicates if the profile wishes to be automatically enrolled in the property's loyalty program.", + "type": "boolean" + }, + "allowPhone": { + "description": "Indicates if the profile wishes to allow phone calls.", + "type": "boolean" + }, + "allowSMS": { + "description": "Indicates if the profile wishes to allow SMS.", + "type": "boolean" + }, + "allowEmail": { + "description": "Indicates if the profile wishes to allow Email.", + "type": "boolean" + }, + "optInMailingList": { + "description": "Indicates if the profile wishes to opt in for Mailing List.", + "type": "boolean" + }, + "optInMarketResearch": { + "description": "Indicates if the profile wishes to opt in for Market Research.", + "type": "boolean" + }, + "optInThirdParty": { + "description": "Indicates if the profile wishes to opt in for Third Party.", + "type": "boolean" + }, + "optInAutoEnrollmentMember": { + "description": "Indicates if the profile wishes to opt in for Auto Enrolment Member.", + "type": "boolean" + }, + "optInPhone": { + "description": "Indicates if the profile wishes to opt in for Phone.", + "type": "boolean" + }, + "optInSms": { + "description": "Indicates if the profile wishes to opt in for SMS.", + "type": "boolean" + }, + "optInEmail": { + "description": "Indicates if the profile wishes to opt in for Email.", + "type": "boolean" + } + } + }, + "profileTaxInfoType": { + "type": "object", + "description": "Profile information related to tax.", + "properties": { + "tax1No": { + "description": "The tax id of this profile. Usually issued by a government agency. Used by 1099 printing.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "tax2No": { + "description": "Tax 2 id of this profile.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "taxCategory": { + "description": "Tax Category to be changed.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "taxOffice": { + "description": "Tax Office to be changed.", + "type": "string", + "minLength": 0, + "maxLength": 30 + }, + "taxType": { + "description": "Tax type to be changed.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "businessId": { + "description": "Business ID. The maximum length of this element should not exceed 120 characters.", + "type": "string", + "minLength": 0, + "maxLength": 128 + }, + "businessRegistration": { + "description": "Business Registration Code. The maximum length of this element should not exceed 120 characters.", + "type": "string", + "minLength": 0, + "maxLength": 128 + } + } + }, + "profileRestrictions": { + "type": "object", + "properties": { + "reason": { + "description": "Restriction reason associated with the current profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "reasonDescription": { + "description": "Description of restriction reason.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "restricted": { + "description": "True indicates there are restrictions associated with the current profile.", + "type": "boolean" + } + } + }, + "lastStayInfoType": { + "type": "object", + "description": "Contains last stay related details for the profile", + "properties": { + "lastVisit": { + "description": "Used to hold last stay information for the profile.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "lastRoom": { + "description": "Used to hold last room information for the profile.", + "type": "string" + }, + "lastRate": { + "description": "Used to hold last rate information for the profile.", + "$ref": "#/definitions/currencyAmountType" + }, + "totalStay": { + "description": "The total number of previous stay of the profile.", + "type": "integer" + } + } + }, + "reservationStayHistoryFutureInfoType": { + "type": "object", + "description": "Information of History and Future Reservation details attached to Profiles.", + "properties": { + "historyList": { + "description": "Refer to History list type document.", + "$ref": "#/definitions/stayHistoryListType" + }, + "futureList": { + "description": "Refer to Future list type document.", + "$ref": "#/definitions/stayFutureListType" + } + } + }, + "stayHistoryListType": { + "type": "object", + "description": "A collection of reservation history details attached to Profiles.", + "properties": { + "reservationInfo": { + "description": "Additional reservation information attached to the profile . Eg : History reservation details", + "type": "array", + "maxItems": 4000, + "items": { + "$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" + }, + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "stayReservationInfoType": { + "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" + }, + "roomStay": { + "description": "Collection of room stays.", + "$ref": "#/definitions/stayInfoType" + }, + "attachedProfiles": { + "description": "List of attached profiles", + "$ref": "#/definitions/resAttachedProfileListType" + }, + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "reservationStatus": { + "description": "Indicates the status of the reservation.", + "$ref": "#/definitions/pMS_ResStatusType" + }, + "computedReservationStatus": { + "description": "Indicates the status of the reservation.", + "$ref": "#/definitions/pMS_ResStatusType" + } + } + }, + "stayFutureListType": { + "type": "object", + "description": "A collection of reservation history details attached to Profiles.", + "properties": { + "reservationInfo": { + "description": "Additional reservation information attached to the profile . Eg : Future reservation details", + "type": "array", + "maxItems": 4000, + "items": { + "$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" + }, + "totalResults": { + "description": "Total number of rows queried", + "type": "integer" + }, + "count": { + "description": "Total number of rows returned", + "type": "integer" + } + } + }, + "reservationProfileType": { + "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" + }, + "reservationProfileType": { + "$ref": "#/definitions/resProfileTypeType" + } + } + }, + "childAgesType": { + "type": "array", + "description": "Age of a child in years.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/childAgeType" + } + }, + "childAgeType": { + "type": "object", + "description": "Defines Child's Age.", + "properties": { + "age": { + "description": "Age of a child in years.", + "type": "integer" + } + } + }, + "childBucketsType": { + "type": "object", + "description": "Defines children counts with Age Qualifying Group(Child Bucket) classification.", + "properties": { + "bucket1Count": { + "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1).", + "type": "integer" + }, + "bucket2Count": { + "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2).", + "type": "integer" + }, + "bucket3Count": { + "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3).", + "type": "integer" + }, + "bucket4Count": { + "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).", + "type": "integer" + }, + "bucket5Count": { + "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).", + "type": "integer" + } + } + }, + "guestCountsType": { + "type": "object", + "description": "A collection of GuestCount by age group.", + "properties": { + "childAges": { + "description": "Defines Children's Ages. Number of children ages mentioned may mot match with children counts.", + "$ref": "#/definitions/childAgesType" + }, + "childBuckets": { + "description": "Defines children counts with Age Qualifying Group(Child Bucket#1) classification.", + "$ref": "#/definitions/childBucketsType" + }, + "adults": { + "description": "Defines the number of Adults.", + "type": "integer" + }, + "children": { + "description": "Defines the number of Children.", + "type": "integer" + } + } + }, + "resAwardsType": { + "type": "object", + "description": "Membership Awards code applied on the reservation.", + "properties": { + "membershipNo": { + "description": "Membership program under which the award is applied.", + "$ref": "#/definitions/uniqueID_Type" + }, + "awardVouchers": { + "$ref": "#/definitions/awardVouchersType" + }, + "originalRoomType": { + "description": "Room Type before the Upgrade Award.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "upgradeRoomType": { + "description": "Room Type after the Upgrade Award.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "awardVouchersType": { + "type": "array", + "description": "This stores the Membership Awards code applied on the reservation.", + "maxItems": 5, + "items": { + "type": "object", + "properties": { + "awardCode": { + "description": "Membership Award code applied on the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "voucherNo": { + "description": "Membership Award number.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + } + }, + "foreignExchangeType": { + "type": "object", + "description": "Foreign Exchange info.", + "properties": { + "type": { + "description": "Exchange Type for the postings.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "effectiveDate": { + "description": "Effective Exchange date for the foreign currency posting.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "reservationBlockType": { + "type": "object", + "description": "Key information about the block for a reservation.", + "properties": { + "blockIdList": { + "description": "Collection of unique block identifiers for the reservation.", + "$ref": "#/definitions/blockIdList" + }, + "blockName": { + "description": "The Name of the block that is attached to the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "hotelId": { + "description": "This is the HotelCode of the Block.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "mealPlansType": { + "type": "array", + "description": "Meal plan codes associated with the rate codes.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/mealPlanCodeType" + } + }, + "mealPlanCodeType": { + "type": "object", + "description": "Meal plan codes associated with the rate codes.", + "properties": { + "code": { + "description": "Meal plan code.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "included": { + "description": "Represents if the meal plan code is included in rate code or not.", + "type": "boolean" + }, + "breakfastIncluded": { + "description": "Represents if the meal plan code is available for breakfast or not.", + "type": "boolean" + }, + "lunchIncluded": { + "description": "Represents if the meal plan code is available for lunch or not.", + "type": "boolean" + }, + "dinnerIncluded": { + "description": "Represents if the meal plan code is available for dinner or not.", + "type": "boolean" + } + } + }, + "roomRateAvailReasonType": { + "type": "string", + "description": "Indicates the Room Rate is not available due to unavailability of enough items for the rate code.", + "enum": [ + "Available", + "Restricted", + "RestrictedDueToInventory", + "RestrictedDueToOccupancy", + "RestrictedDueToItemInventory" + ] + }, + "roomRateType": { + "type": "object", + "properties": { + "total": { + "$ref": "#/definitions/totalType" + }, + "totalPoints": { + "$ref": "#/definitions/pointsType" + }, + "rates": { + "$ref": "#/definitions/ratesType" + }, + "packages": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/packageElementType" + } + }, + "stayProfiles": { + "description": "Profile associated with the room Stay.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationProfileType" + } + }, + "guestCounts": { + "description": "A collection of Guest Counts associated with the room rate.", + "$ref": "#/definitions/guestCountsType" + }, + "taxFreeGuestCounts": { + "description": "A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts.", + "$ref": "#/definitions/guestCountsType" + }, + "awards": { + "description": "Membership Awards code applied on the reservation.", + "$ref": "#/definitions/resAwardsType" + }, + "foreignExchange": { + "description": "Exchange Type information for the postings.", + "$ref": "#/definitions/foreignExchangeType" + }, + "reservationBlock": { + "description": "Key information about the block for this reservation.", + "$ref": "#/definitions/reservationBlockType" + }, + "roomRateInfo": { + "description": "Information about the Room Rate Combination.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "mealPlans": { + "description": "Meal plan codes for rate plan code.", + "$ref": "#/definitions/mealPlansType" + }, + "roomType": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "ratePlanCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "promotionCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "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 + }, + "availability": { + "description": "Used to specify an availability status for the room rate. When available value could be either not specified or \"Available\".", + "$ref": "#/definitions/roomRateAvailReasonType" + }, + "suppressRate": { + "type": "boolean" + }, + "marketCode": { + "description": "The code that relates to the market being sold to (e.g., the corporate market, packages).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "marketCodeDescription": { + "description": "Description of the market code.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "sourceCode": { + "description": "To specify where the business came from e.g. radio, newspaper ad, etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "sourceCodeDescription": { + "description": "Description of the source of business.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "numberOfUnits": { + "description": "The number of rooms.", + "type": "integer" + }, + "roomId": { + "description": "A string value representing the unique identification of a room.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "pseudoRoom": { + "description": "True indicates as pseudo room type. This is usually used for a posting master reservation.", + "type": "boolean" + }, + "roomTypeCharged": { + "description": "Room Type used for the Rate calculation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "commissionCode": { + "description": "Commission Code applicable for commission calculation for Travel Agent/Company.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "commissionable": { + "description": "Indicates Commission is applicable for commission calculation for Travel Agent/Company.", + "type": "boolean" + }, + "houseUseOnly": { + "description": "Indicates this reservation is for House use.", + "type": "boolean" + }, + "complimentary": { + "description": "Indicates this reservation rate is complimentary.", + "type": "boolean" + }, + "inventoryLender": { + "description": "Indicates whether the room type inventory was taken from the allotment or House availability.", + "type": "string" + }, + "fixedRate": { + "description": "Fixed Rate Indicator.", + "type": "boolean" + }, + "barRanking": { + "description": "Best Available rates ranking.", + "type": "integer" + }, + "rateGroup": { + "description": "For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "discountAllowed": { + "description": "Indicates if the Rate Code is discountable i.e discounts are allowed on the rate code.", + "type": "boolean" + }, + "bogoDiscount": { + "description": "Indicates if the Rate Code has BOGO(Bye one Get one) indicator.", + "type": "boolean" + }, + "rateLevel": { + "description": "Rate plan type like Corporate,Regular,Military,Weekend etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "commissionPercentage": { + "description": "Indicates commission percentage used by the rate plan.", + "type": "integer" + }, + "commissionAmount": { + "description": "Indicates commission amount used by the rate plan.", + "type": "integer" + }, + "credentialsRequired": { + "description": "If true, indicates that credentials is required to sell the rate code.", + "type": "boolean" + }, + "taxIncluded": { + "description": "If true, indicates if tax is included in the rate code.", + "type": "boolean" + }, + "rateDescription": { + "description": "Rate code description.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + } + } + }, + "resGuaranteeType": { + "type": "object", + "description": "Validations type record returned after Validations are done.", + "properties": { + "guaranteeCode": { + "description": "Guarantee Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "shortDescription": { + "description": "Guarantee Code.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "onHold": { + "description": "Guarantee Code.", + "type": "boolean" + } + } + }, + "promotionType": { + "type": "object", + "description": "Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.", + "properties": { + "promotionCode": { + "description": "Promotion code associated with the rate plan.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "promotionName": { + "description": "Promotion code Name associated with the rate plan.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "couponCode": { + "description": "Promotion Coupon Code when promotion is setup to have a valid coupon code.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "roomStayType": { + "type": "object", + "properties": { + "registrationNumber": { + "description": "Registration Number of the reservation for the current day.", + "$ref": "#/definitions/uniqueID_Type" + }, + "currentRoomInfo": { + "description": "Room information of the reservation for the current day.", + "$ref": "#/definitions/currentRoomInfoType" + }, + "roomRates": { + "description": "A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/roomRateType" + } + }, + "guestCounts": { + "$ref": "#/definitions/guestCountsType" + }, + "arrivalDate": { + "type": "string", + "format": "date" + }, + "departureDate": { + "type": "string", + "format": "date" + }, + "expectedTimes": { + "description": "The Expected Arrival and Departure Times.", + "$ref": "#/definitions/resExpectedTimesType" + }, + "originalTimeSpan": { + "description": "The Original Time Span(Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same.", + "$ref": "#/definitions/timeSpanType" + }, + "guarantee": { + "description": "The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.", + "$ref": "#/definitions/resGuaranteeType" + }, + "promotion": { + "description": "Promotions applied to the reservation to get the promotional rate.", + "$ref": "#/definitions/promotionType" + }, + "suiteWith": { + "description": "Connecting Rooms.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "total": { + "description": "The total amount charged for the Room Stay.", + "$ref": "#/definitions/totalType" + }, + "totalPoints": { + "description": "The total number of Points charged for the Room Stay.", + "$ref": "#/definitions/pointsType" + }, + "multiValueAttrs": { + "description": "Informative indicators indicating different values of an attribute exists over the stay.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "maxLength": 2000 + } + }, + "upsellInfo": { + "description": "Indicates Upsell Information to be applied on Reservation.", + "$ref": "#/definitions/upsellInfoType" + }, + "mobileNotifications": { + "description": "Denotes the status of Room Ready and Key Ready messages.", + "$ref": "#/definitions/resMobileNotificationsType" + }, + "roomNumberLocked": { + "description": "When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.", + "type": "boolean" + }, + "printRate": { + "description": "This control whether rate info will be printed in confirmation letter.", + "type": "boolean" + }, + "ownerReservationType": { + "description": "Indicates whether reservation is for Unit/Room Owner or Authorized User. If this attribute is not define it is a regular/rental reservation.", + "$ref": "#/definitions/ownerResTypeType" + }, + "primaryShareType": { + "description": "This is populated in case of primary share scenario. This indicates whether this reservation is primary or non primary. Changes or postings to the 'non-primary' share reservation is not allowed.", + "$ref": "#/definitions/primaryShareTypeType" + }, + "remoteCheckInAllowed": { + "description": "Indicates whether the reservation is pre-registered for internet check-in 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 + }, + "bookingMediumDescription": { + "description": "Description of the booking medium.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "availableUpsellOfferCount": { + "description": "Number of Upsell Offers Available for this stay. This will only be populated if the Upsell Instruction is included in the Allowed Instruction request", + "type": "integer" + } + } + }, + "primaryShareTypeType": { + "type": "string", + "enum": [ + "Primary", + "NonPrimary" + ] + }, + "ownerResTypeType": { + "type": "string", + "enum": [ + "Owner", + "AuthorizedUser" + ] + }, + "resMobileNotificationsType": { + "type": "object", + "description": "Contains the status of Room Ready and Key Ready messages.", + "properties": { + "roomReady": { + "description": "Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED", + "$ref": "#/definitions/communicationStatusType" + }, + "keyReady": { + "description": "Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED", + "$ref": "#/definitions/communicationStatusType" + }, + "checkoutMessageReceived": { + "description": "Indicates if the Mobile checkout message is received.", + "type": "boolean" + }, + "requiresAction": { + "description": "Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout", + "type": "boolean" + }, + "errorMessage": { + "description": "Error message when Mobile Notification has failed.", + "type": "string" + } + } + }, + "communicationStatusType": { + "type": "string", + "description": "Enum to denote the Status of Readiness messages sent to Guest Devices.", + "enum": [ + "Pending", + "Completed", + "Failed", + "Sent", + "Received", + "Cancelled", + "PendingAvailability" + ] + }, + "upsellInfoType": { + "type": "object", + "description": "Information regarding upsell for a reservation.", + "properties": { + "originalInfo": { + "description": "Original Values of the reservation prior to upgrade.", + "type": "object", + "properties": { + "rateCode": { + "description": "The Rate Code of the Reservation before it was upgraded", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "totalAmount": { + "description": "Total Amount of the reservation before it was upgraded.", + "$ref": "#/definitions/currencyAmountType" + }, + "roomType": { + "description": "Original Reservation Room Type before being upgraded.", + "$ref": "#/definitions/codeDescriptionType" + }, + "nights": { + "description": "The number of nights of the reservation before being upgraded.", + "type": "integer" + } + } + }, + "upsellInfo": { + "description": "Information of a reservation during the process of upgrade.", + "type": "object", + "properties": { + "totalUpsellCharge": { + "description": "Amount that was charged for the upsell.", + "$ref": "#/definitions/currencyAmountType" + }, + "totalUpsellMoneyAmount": { + "description": "Total Amount that was charged including upsell.", + "$ref": "#/definitions/currencyAmountType" + }, + "firstNightUpsellAmount": { + "description": "First Night Total Amount including Upsell.", + "$ref": "#/definitions/currencyAmountType" + }, + "firstNightUpsellCharge": { + "description": "First Night Upsell Charges.", + "$ref": "#/definitions/currencyAmountType" + }, + "totalUpsellPoints": { + "description": "Total Upsell Points.", + "type": "integer" + }, + "totalActualRateAmount": { + "description": "Actual Total Room Rate for the Target Upsell Room Type.", + "$ref": "#/definitions/currencyAmountType" + }, + "roomType": { + "description": "Reservation Room Type for Upsell.", + "$ref": "#/definitions/codeDescriptionType" + }, + "roomLongDescription": { + "description": "Detail description of the Room Type.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "ruleId": { + "description": "Upsell Rule Id.", + "type": "integer" + }, + "ruleCode": { + "description": "Upsell rule code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "ruleDescription": { + "description": "Upsell rule description", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "percentageSavings": { + "description": "Percentage savings resulting from accepting upsell offer. This will be calculated as the ratio of the amount saved by accepting the upsell offer to the actual room rate (i.e. room rate when upsell is not offered)", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "upsellDate": { + "description": "The date on which reservation is upgraded.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "upsellUser": { + "description": "User who upgraded the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + } + } + }, + "codeDescriptionType": { + "type": "object", + "description": "This contains a generic code and description information.", + "properties": { + "code": { + "description": "Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "description.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } + }, + "reservationHistoryFutureInfoType": { + "type": "object", + "description": "Information of History and Future Reservation details attached to Profiles.", + "properties": { + "historyList": { + "description": "Refer to History list type document.", + "$ref": "#/definitions/historyListType" + }, + "futureList": { + "description": "Refer to Future list type document.", + "$ref": "#/definitions/futureListType" + } + } + }, + "historyListType": { + "type": "object", + "description": "A collection of reservation history details attached to Profiles.", + "properties": { + "reservationInfo": { + "description": "Additional reservation information attached to the profile . Eg : History reservation details", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationInfoType" + } + }, + "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" + } + } + }, + "futureListType": { + "type": "object", + "description": "A collection of reservation history details attached to Profiles.", + "properties": { + "reservationInfo": { + "description": "Additional reservation information attached to the profile . Eg : Future reservation details", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationInfoType" + } + }, + "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" + } + } + }, + "reservationTurndownInfoType": { + "type": "object", + "description": "Turndown information for a reservation", + "properties": { + "allowed": { + "description": "Indicates if turndown is allowed or not", + "type": "boolean" + }, + "status": { + "description": "Indicates turndown status, values could be required, not required, completed", + "$ref": "#/definitions/turndownStatusType" + } + } + }, + "turndownStatusType": { + "type": "string", + "description": "Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed.", + "enum": [ + "Required", + "NotRequired", + "Compeleted" + ] + }, + "guestHousekeepingServiceRequestType": { + "type": "string", + "description": "Possible values for the Guest Service Status.", + "enum": [ + "DoNotDisturb", + "MakeUpRoom", + "NoStatusSelected" + ] + }, + "stayInfoType": { + "type": "object", + "description": "Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties.", + "properties": { + "arrivalDate": { + "type": "string", + "format": "date" + }, + "departureDate": { + "type": "string", + "format": "date" + }, + "originalTimeSpan": { + "description": "The Original Time Span covers the Room Stay dates of the original reservation.", + "$ref": "#/definitions/timeSpanType" + }, + "expectedTimes": { + "description": "The expected arrival, return and departure times of the guest.", + "$ref": "#/definitions/resExpectedTimesType" + }, + "adultCount": { + "description": "A collection of Guest Counts associated with Room Stay.", + "type": "integer" + }, + "childCount": { + "description": "A collection of Child Counts associated with Room Stay.", + "type": "integer" + }, + "roomClass": { + "description": "Room class code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomType": { + "description": "Room type code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "componentRoomType": { + "description": "True indicates room type is a component type.", + "type": "boolean" + }, + "numberOfRooms": { + "description": "Room Id", + "type": "integer" + }, + "roomId": { + "description": "Room Id", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "ratePlanCode": { + "description": "Rate plan code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "rateAmount": { + "description": "Rate amount", + "$ref": "#/definitions/currencyAmountType" + }, + "points": { + "description": "The Points contains the number of points used to book a particular room type.", + "$ref": "#/definitions/pointsType" + }, + "rateSuppressed": { + "description": "Whether this rate should be suppressed from view", + "type": "boolean" + }, + "reservationBlock": { + "description": "Key information about the block for this reservation.", + "$ref": "#/definitions/reservationBlockType" + }, + "bookingChannelCode": { + "description": "Booking channel code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "linkCode": { + "description": "Party code", + "type": "string", + "maxLength": 2000 + }, + "fixedRate": { + "description": "True if the rate is a fixed rate, otherwise false", + "type": "boolean" + }, + "totalAmount": { + "description": "The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.", + "$ref": "#/definitions/currencyAmountType" + }, + "guarantee": { + "description": "The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context.", + "$ref": "#/definitions/resGuaranteeType" + }, + "promotion": { + "description": "Promotion Codes", + "$ref": "#/definitions/promotionType" + }, + "marketCode": { + "description": "Market code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "marketDescription": { + "description": "Description of Market code", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "sourceCode": { + "description": "Source of business", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "sourceCodeDescription": { + "description": "Description of the source of business.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "balance": { + "description": "Balance amount", + "$ref": "#/definitions/currencyAmountType" + }, + "compBalance": { + "description": "Comp Balance amount", + "$ref": "#/definitions/currencyAmountType" + }, + "roomTypeCharged": { + "description": "Room type code that was charged", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "depositPayments": { + "description": "A collection of deposit and/or payments for the Room Stay.", + "$ref": "#/definitions/currencyAmountType" + }, + "guestServiceStatus": { + "description": "Service Status of In House guest like DND or MUP", + "$ref": "#/definitions/guestHousekeepingServiceRequestType" + }, + "scheduledCheckoutTime": { + "description": "Indicates that this reservation is scheduled for automated check out.", + "type": "string", + "format": "date" + }, + "roomNumberLocked": { + "description": "When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.", + "type": "boolean" + }, + "pseudoRoom": { + "description": "True indicates as pseudo room type. This is usually used for a posting master reservation.", + "type": "boolean" + }, + "assignedByAI": { + "description": "Represents the room was assigned by AI Room Assignment.", + "type": "boolean" + }, + "upgradedByAI": { + "description": "Represents the room was assigned by AI Room Assignment.", + "type": "boolean" + } + } + }, + "aRAccountShortInfoType": { + "type": "object", + "description": "Accounts Receivabales Account details type charged for batched posting.", + "properties": { + "accountName": { + "description": "Name of the AR Account.", + "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.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "status": { + "description": "The status of the account.", + "$ref": "#/definitions/aRAccountStatusType" + } + } + }, + "aRAccountStatusType": { + "type": "object", + "description": "Type for the Account Status. Status can be restricted and a message/description added to the Account.", + "properties": { + "restriction": { + "description": "The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "User defined status message on the Account.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "restricted": { + "description": "Flag to indicate if the Account is restricted.", + "type": "boolean" + } + } + }, + "resAttachedProfileListType": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/resAttachedProfileType" + } + }, + "resAttachedProfileType": { + "type": "object", + "properties": { + "name": { + "description": "Attached profile name", + "type": "string" + }, + "profileIdList": { + "description": "Collection of unique profile identifiers", + "$ref": "#/definitions/profileIdList" + }, + "reservationProfileType": { + "$ref": "#/definitions/resProfileTypeType" + } + } + }, + "payeeInfoType": { + "type": "object", + "description": "Payee information.", + "properties": { + "payeeId": { + "description": "Opera name id of the payee.", + "$ref": "#/definitions/uniqueID_Type" + }, + "payeeName": { + "description": "Name of the payee.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "payeeAddress": { + "description": "Address of the payee.", + "$ref": "#/definitions/addressInfoType" + }, + "payeeAddressCount": { + "description": "Payee multiple address count.", + "type": "integer" + }, + "payeeReferenceCurrency": { + "description": "Reference currency of the payee.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "payeeAccountInfo": { + "description": "AR account short info of the payee.", + "$ref": "#/definitions/aRAccountShortInfoType" + }, + "payeeTaxNumber": { + "description": "The tax number of the payee.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "massUpdatePayeeInfoType": { + "type": "object", + "description": "Payee information.", + "properties": { + "payeeId": { + "description": "Opera name id of the payee.", + "$ref": "#/definitions/uniqueID_Type" + }, + "payeeAddress": { + "description": "Address of the payee.", + "$ref": "#/definitions/massUpdateAddressInfoType" + } + } + }, + "reservationFolioWindowsType": { + "type": "array", + "description": "Collection of reservation folio windows.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationFolioWindowType" + } + }, + "reservationFolioWindowType": { + "type": "object", + "description": "Folio window view which holds the set of folios for a reservation.", + "properties": { + "payeeInfo": { + "description": "The window's configured payee information.", + "$ref": "#/definitions/payeeInfoType" + }, + "balance": { + "description": "Running balance of the window.", + "$ref": "#/definitions/currencyAmountType" + }, + "paymentMethod": { + "description": "Payment Method Type", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "folioWindowNo": { + "type": "integer" + } + } + }, + "searchMatchesType": { + "type": "array", + "description": "List of Generic Name-Value-Pair Parameters used for super search matches.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/searchMatchType" + } + }, + "searchMatchType": { + "type": "object", + "description": "Search match indicating attribute and the matching value.", + "properties": { + "attribute": { + "description": "Search match attribute.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "value": { + "description": "Search match value.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + } + }, + "taxTypeType": { + "type": "object", + "description": "Provides information about the Tax Type.", + "properties": { + "hotelId": { + "description": "Code of the Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "code": { + "description": "Code of the Tax Type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "Description of the Tax Type.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "collectingAgentTax": { + "description": "A boolean flag for Collecting Agent Tax", + "type": "boolean" + }, + "printAutoAdjust": { + "description": "Print auto adjust information for this tax type on the tax exempt report.", + "type": "boolean" + }, + "reportExemptDays": { + "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.", + "type": "integer" + }, + "reportTaxPercentage": { + "description": "Tax percentage. Only used for tax exempt report.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "minimumLengthOfStay": { + "description": "Minimun Length of Stay.", + "type": "integer" + } + } + }, + "reservationDepositType": { + "type": "object", + "description": "Reservation Deposit Type.", + "properties": { + "amountRequired": { + "description": "Deposit Amount Required.", + "type": "number" + }, + "amountPaid": { + "description": "Deposit Amount Paid.", + "type": "number" + }, + "amountOwed": { + "description": "Deposit Amount Owed.", + "type": "number" + }, + "dueDate": { + "description": "Deposit Due Date.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "postingDate": { + "description": "Deposit Posting Date.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "hasPaid": { + "description": "Resolves whether reservation has paid deposit.", + "type": "boolean" + }, + "hasOutstanding": { + "description": "Resolves whether reservation has outstanding deposit.", + "type": "boolean" + } + } + }, + "reservationInterfaceStatusType": { + "type": "object", + "description": "Hotel Interface Type for a reservation and status of the various services", + "properties": { + "roomExtension": { + "description": "Identifier for the room extension", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelInterface": { + "description": "Hotel interface information for the reservation", + "$ref": "#/definitions/hotelInterfaceType" + }, + "interfaceRights": { + "description": "Contains a list of status/rights for the various services under this interface", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/interfaceRightsStatusType" + } + } + } + }, + "interfaceRightsStatusType": { + "type": "object", + "properties": { + "right": { + "description": "Internal code for each allowed right of a Hotel Interface record.", + "type": "integer" + }, + "statusCode": { + "description": "User defined code for an Interface Right.", + "type": "string", + "minLength": 0, + "maxLength": 5 + }, + "description": { + "description": "User defined description for an Interface Right.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "category": { + "description": "Category code of this interface right.", + "type": "string", + "minLength": 0, + "maxLength": 1 + } + } + }, + "hotelInterfaceType": { + "type": "object", + "properties": { + "interfaceId": { + "description": "Unique DB internal number of a Hotel Interface record.", + "$ref": "#/definitions/uniqueID_Type" + }, + "hotelId": { + "description": "Hotel Code", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "interfaceName": { + "description": "Name of the Hotel Interface", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "interfaceType": { + "description": "Three letter code for each interface that identifies the interface.", + "$ref": "#/definitions/hotelInterfaceTypeType" + }, + "logo": { + "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "machineName": { + "description": "Unique machine name of the running IFC.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "status": { + "description": "The current status of the IFC.", + "$ref": "#/definitions/hotelInterfaceStatusType" + }, + "activeFlag": { + "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING.", + "type": "boolean" + } + } + }, + "hotelInterfaceTypeType": { + "type": "string", + "enum": [ + "Bms", + "Cas", + "Ccw", + "Dls", + "Eft", + "Exp", + "Mak", + "Mbs", + "Msc", + "Pbx", + "Pos", + "Svs", + "Tik", + "Vid", + "Vms", + "Www", + "Xml" + ], + "description": "XML Posting Interface" + }, + "hotelInterfaceStatusType": { + "type": "string", + "description": "Status of the Hotel Interface either STOPPED or RUNNING.", + "enum": [ + "Stopped", + "Running", + "Waiting", + "StopInitiated", + "StartInitiated", + "RebootInitiated", + "Other" + ] + }, + "reservationInfoType": { + "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" + }, + "externalReferences": { + "description": "External Reference information for Reservation.", + "$ref": "#/definitions/externalReferencesType" + }, + "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" + }, + "attachedProfiles": { + "description": "List of attached profiles", + "$ref": "#/definitions/resAttachedProfileListType" + }, + "reservationPaymentMethod": { + "description": "Payment method used for this reservation", + "$ref": "#/definitions/reservationPaymentMethodType" + }, + "reservationFolioWindows": { + "description": "Collection of reservation folio windows.", + "$ref": "#/definitions/reservationFolioWindowsType" + }, + "specials": { + "description": "Set of reservation preferences which belongs to the Specials group.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "lastPrivacyPromptDate": { + "description": "Last Privacy Prompt Date", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "displayColor": { + "description": "Color setting of the reservation.", + "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" + }, + "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" + } + }, + "guestPreferredCurrency": { + "description": "Currency code preferred by guest.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "turndownInfo": { + "description": "Currency code preferred by guest.", + "$ref": "#/definitions/reservationTurndownInfoType" + }, + "mobileNotifications": { + "description": "Denotes the status of Room Ready, Key Ready messages.", + "$ref": "#/definitions/resMobileNotificationsType" + }, + "reservationCommunication": { + "description": "Collection of reservation communication details.", + "$ref": "#/definitions/resCommunicationType" + }, + "advanceCheckIn": { + "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", + "$ref": "#/definitions/advanceCheckInType" + }, + "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 + } + } + }, + "keyCount": { + "description": "Number of keys created for the reservation.", + "type": "integer" + }, + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelName": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "expectedServiceTime": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomStayReservation": { + "description": "Boolean True if this reservation is reserving rooms. False if it is only reserving services.", + "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" + }, + "lastModifierId": { + "description": "Identifies the last software system or person to modify a record.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "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 + }, + "reservationStatus": { + "description": "Indicates the status of the reservation.", + "$ref": "#/definitions/pMS_ResStatusType" + }, + "computedReservationStatus": { + "description": "Indicates the status of the reservation.", + "$ref": "#/definitions/pMS_ResStatusType" + }, + "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" + }, + "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" + }, + "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 + }, + "preRegistered": { + "description": "Defines if the reservation is pre-registered or not.", + "type": "boolean" + }, + "openFolio": { + "description": "Returns true when reservation has an open folio.", + "type": "boolean" + }, + "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" + }, + "allowMobileViewFolio": { + "description": "Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.", + "type": "boolean" + }, + "optedForCommunication": { + "description": "Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation.", + "type": "boolean" + } + } + }, + "queueTextInfoType": { + "type": "object", + "description": "Information regarding the message sent to guest.", + "properties": { + "sentTime": { + "description": "Time the text was last sent to the user.", + "type": "string", + "format": "date-time" + }, + "sentBy": { + "description": "User name of the user who sent message.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "reservationQueueInformationType": { + "type": "object", + "description": "Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.", + "properties": { + "timeSpan": { + "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.", + "type": "object", + "properties": { + "startDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "endDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "duration": { + "type": "string" + }, + "durationInSeconds": { + "description": "The total duration, in seconds, the reservation is on Queue.", + "type": "integer" + } + } + }, + "guestTextInfo": { + "description": "Information for the message sent to the user", + "$ref": "#/definitions/queueTextInfoType" + }, + "priority": { + "description": "The Queue Priority given to this reservation.", + "type": "integer" + }, + "averageQueueTimeToCheckIn": { + "description": "The average time, in seconds, a reservation was on queue prior to Check-In.", + "type": "integer" + }, + "averageQueueTimeCurrentReservations": { + "description": "The average time, in seconds, of the reservations currently in queue.", + "type": "integer" + }, + "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 + } + } + }, + "compAuthorizerInfoType": { + "type": "object", + "description": "Authorizer Information", + "properties": { + "authorizerId": { + "$ref": "#/definitions/uniqueID_Type" + }, + "authorizerUserName": { + "description": "Application user name of the authorizer", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "authorizerName": { + "description": "Full name of the authorizer.", + "type": "string", + "minLength": 0, + "maxLength": 100 + } + } + }, + "trxCodesInfoType": { + "type": "array", + "description": "List of Transaction codes info.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/trxInfoType" + } + }, + "articlePostItType": { + "type": "object", + "description": "Post it information of an article.", + "properties": { + "availableForPostIt": { + "description": "Indicates whether the article is available for post it.", + "type": "boolean" + }, + "color": { + "description": "Color indicator which is only configurable if article is available for post it.", + "$ref": "#/definitions/colorType" + } + } + }, + "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" + ] + }, + "articleInfoType": { + "type": "object", + "description": "Information regarding an article.", + "properties": { + "description": { + "description": "Description of the article.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "transactionCode": { + "description": "Transaction code to which the article belongs.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "price": { + "description": "Default price of the article.", + "$ref": "#/definitions/currencyAmountType" + }, + "postIt": { + "description": "Post it information of the article.", + "$ref": "#/definitions/articlePostItType" + }, + "universalProductCode": { + "description": "Unique Universal product code of the article.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelId": { + "description": "Hotel code to which the article belongs.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "articleCode": { + "description": "Unique code of the article.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "inactive": { + "description": "Indicates whether the article is inactive or not.", + "type": "boolean" + }, + "orderSequence": { + "description": "Display Order sequence.", + "type": "number" + } + } + }, + "trxInfoType": { + "type": "object", + "description": "Transaction codes info.", + "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.", + "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 + }, + "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" + } + } + }, + "massUpdateTrxInfoType": { + "type": "object", + "description": "Transaction codes info.", + "properties": { + "transactionCode": { + "description": "Unique identifier for the Transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "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 + }, + "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" + }, + "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 + } + } + }, + "massUpdateBillingInstructionType": { + "type": "object", + "description": "Configured Billing Instruction which represents a set of Transaction Codes.", + "properties": { + "billingCode": { + "description": "Unique identifier for the Billing Instruction.", + "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" + }, + "billingInstructions": { + "description": "Set of preconfigured Billing Instruction results.", + "$ref": "#/definitions/billingInstructionsType" + }, + "autoPopulateRouting": { + "description": "A flag which determines whether the instructions has to be automatically populated for this profile or not.", + "type": "boolean" + } + } + }, + "profileCashieringDetailType": { + "type": "object", + "description": "The type contains routing instructions for the profile.", + "properties": { + "paymentMethod": { + "description": "Payment Method Details.", + "$ref": "#/definitions/codeDescriptionType" + }, + "eCommerceId": { + "description": "E-Commerce ID of the Profile", + "$ref": "#/definitions/uniqueID_Type" + }, + "routingInstructions": { + "description": "Set of preconfigured transaction codes.", + "$ref": "#/definitions/profileRoutingInstructionsType" + }, + "taxType": { + "description": "Tax type code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "fiscalGuestType": { + "description": "Guest type code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelId": { + "description": "Hotel Code for which the routing instructions are provided for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "transportInfoType": { + "type": "object", + "properties": { + "comments": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "type": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "transportCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "carrierCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "stationCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "dateTime": { + "type": "string", + "format": "date-time" + }, + "transportationReqd": { + "type": "boolean" + } + } + }, + "massTransportInfoType": { + "type": "object", + "properties": { + "comments": { + "description": "Comments about the transport info", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "type": { + "description": "Identifier for transport type transport info of a reservation", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "transportCode": { + "description": "Identifier for transport transport code transport info of a reservation", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "carrierCode": { + "description": "Identifier for carrier code in transport info of a reservation", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "stationCode": { + "description": "Identifier for station code in transport info of a reservation", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "dateTime": { + "description": "Date time for arrival and departure transportation", + "type": "string", + "format": "date-time" + }, + "transportationReqd": { + "description": "Identifier to check if transport is required", + "type": "boolean" + } + } + }, + "visaInfoType": { + "type": "object", + "properties": { + "visaIssueDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "visaExpiryDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "visaNumber": { + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "resGuestType": { + "type": "object", + "description": "A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection.", + "properties": { + "profileInfo": { + "description": "A collection of Profiles or Unique IDs of Profiles.", + "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" + }, + "profileCashieringDetail": { + "description": "Cashiering details for the profile.", + "$ref": "#/definitions/profileCashieringDetailType" + }, + "registrationCardNo": { + "description": "Unique identifier of the police registration card number.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "arrivalTransport": { + "$ref": "#/definitions/transportInfoType" + }, + "departureTransport": { + "$ref": "#/definitions/transportInfoType" + }, + "visaInfo": { + "$ref": "#/definitions/visaInfoType" + }, + "reservationGuestRPH": { + "description": "This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service.", + "type": "string", + "minLength": 1, + "maxLength": 8 + }, + "primary": { + "description": "When true indicates this is the primary guest.", + "type": "boolean" + } + } + }, + "profileId": { + "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" + } + } + }, + "resSharedGuestListType": { + "type": "array", + "description": "Collection of shared guest reservations.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/resSharedGuestInfoType" + } + }, + "resSharedGuestInfoType": { + "type": "object", + "description": "Contains information regarding the share reservation.", + "properties": { + "profileId": { + "$ref": "#/definitions/profileId" + }, + "firstName": { + "description": "Given name, first name or names", + "type": "string" + }, + "lastName": { + "description": "Family name, last name.", + "type": "string" + }, + "fullName": { + "description": "String representation of the full name", + "type": "string" + } + } + }, + "guestLastStayInfoType": { + "type": "object", + "description": "Contains last stay related details of the guest.", + "properties": { + "lastStayDate": { + "description": "Guest's last stay date.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "lastStayRoom": { + "description": "Room Number where the guest stayed.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "lastStayRate": { + "description": "The Rate amount of the guest's last stay.", + "$ref": "#/definitions/currencyAmountType" + }, + "totalStay": { + "description": "The total number of previous stay of the guest.", + "type": "integer" + } + } + }, + "resGuestAdditionalInfoType": { + "type": "object", + "properties": { + "portOfEntry": { + "description": "Entry point into the country. (Croatian Requirements).", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "dateOfEntry": { + "description": "Entry Date into the country. (Croatian Requirements).", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "nextDestination": { + "description": "Entry Date into the country. (Croatian Requirements).", + "type": "string" + }, + "preferredRoomType": { + "description": "Preferred Room Type of the guest.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "lastStay": { + "description": "Last Stay information of the guest.", + "$ref": "#/definitions/guestLastStayInfoType" + }, + "purposeOfStay": { + "description": "Purpose of stay.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "guestClassification": { + "description": "Guest Classification for the data export.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "guestStatus": { + "description": "Guest Status for the data export.", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "commissionPayoutToType": { + "type": "string", + "enum": [ + "TravelAgent", + "Source", + "TravelAgentSource", + "None" + ] + }, + "resCommunicationType": { + "type": "object", + "description": "Communication details for a reservation.", + "properties": { + "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" + } + }, + "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" + } + } + }, + "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" + } + }, + "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" + } + } + } + } + }, + "awardKindType": { + "type": "string", + "description": "Indicates that this is electronic certificate.", + "enum": [ + "Paper", + "ECertificate" + ] + }, + "awardStatusType": { + "type": "string", + "description": "Indicates that certificate is in use.", + "enum": [ + "Available", + "NotAvailable", + "InUse" + ] + }, + "reservationCertificateType": { + "type": "string", + "description": "Certificate is incentive.", + "enum": [ + "Reward", + "Incentive" + ] + }, + "rewardCertificateType": { + "type": "string", + "description": "Point Saver reward.", + "enum": [ + "Regular", + "StayAnytime", + "PointSaver" + ] + }, + "awardsType": { + "type": "array", + "description": "List of awards.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/awardType" + } + }, + "fBAInfoType": { + "type": "object", + "description": "FBA ( Flexible Benefits Awards ) related fields.", + "properties": { + "status": { + "description": "Possible FBA statuses.", + "$ref": "#/definitions/fBAStatusType" + }, + "monetaryValue": { + "description": "Award's FBA monetary values.", + "type": "number" + }, + "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", + "format": "date", + "maxLength": 8 + }, + "postingBusinessDate": { + "description": "Business date of the FBA posting.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "settlementDateTime": { + "description": "Date and time of the FBA settlement.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "settlementBusinessDate": { + "description": "Business date of the FBA settlement.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "reimbursementDateTime": { + "description": "Date and time of the FBA reimbursement.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "reimbursementBusinessDate": { + "description": "Business date of the FBA reimbursement.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "fbaBillGenDate": { + "description": "Business date of the FBA bill generation.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "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" + }, + "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" + } + } + }, + "fBAStatusType": { + "type": "string", + "description": "Flexible benefit award has been reimbursed.", + "enum": [ + "Ordered", + "Attached", + "Posted", + "Settled", + "Reimbursed" + ] + }, + "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" + } + } + }, + "awardType": { + "type": "object", + "description": "Detailed information of the awards.", + "properties": { + "awardCode": { + "description": "Award category.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "awardType": { + "description": "Can be P (Paper) or E (E-Certificate).", + "$ref": "#/definitions/awardKindType" + }, + "description": { + "description": "Description of the award/certificate.", + "type": "string" + }, + "certificateNo": { + "description": "Certificate No.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "masterCertificiateNo": { + "description": "Master Certificate No.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "membershipNo": { + "description": "Membership No.", + "type": "string" + }, + "hotelId": { + "description": "Hotel Code for which the routing instructions are provided for a profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelCategory": { + "description": "Indicates the lowest hotel category for which the certificate is valid.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "externalHotelCode": { + "description": "Hotel Code of the CRS application that this certificate belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "externalConfirmationNo": { + "description": "Confirmation Number given by a CRS application for this reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "categoryValid": { + "description": "Indicates whether the category of certificate is valid or not for this resort.", + "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" + }, + "status": { + "description": "Status of the award aka available.", + "$ref": "#/definitions/awardStatusType" + }, + "expirationDate": { + "description": "Expiration Date.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "gift": { + "description": "Signifies whether award is gift or not.", + "type": "boolean" + }, + "upgrade": { + "description": "Signifies whether upgrade award or not.", + "type": "boolean" + }, + "package": { + "description": "Signifies whether upgrade is package or not.", + "type": "boolean" + }, + "instantlyRedeemable": { + "description": "Indicates if the award is an Instant Redemption award.", + "type": "boolean" + }, + "paidUpgrade": { + "description": "Indicates if this certificate was ordered using the \"Paid Upgrade\" option in the E-Certs screen.", + "type": "boolean" + }, + "detailedCertificate": { + "description": "Indicates if this certificate is detailed or not.", + "type": "boolean" + }, + "nights": { + "description": "Award Nights.", + "type": "integer" + }, + "sourceType": { + "description": "MRW : From MRW MAN:Entered manually.", + "type": "string" + }, + "points": { + "description": "No. of points used to order this award.", + "type": "number" + }, + "fBAInfo": { + "description": "FBA related fields.", + "$ref": "#/definitions/fBAInfoType" + }, + "reservationId": { + "description": "Reservation IDs will be empty if award is not attached.", + "$ref": "#/definitions/reservationId" + }, + "profileId": { + "description": "Unique profile identifier requested to be fetched.", + "$ref": "#/definitions/profileId" + }, + "quantity": { + "description": "Quantity of such awards needed to be ordered.", + "type": "integer" + }, + "displaySequence": { + "description": "Indicates the order in which the certificates received from MRW.", + "type": "number" + }, + "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 + }, + "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 + } + } + }, + "employeeInfoType": { + "type": "object", + "properties": { + "personName": { + "$ref": "#/definitions/personNameType" + }, + "profileId": { + "$ref": "#/definitions/uniqueID_Type" + }, + "addressInfo": { + "$ref": "#/definitions/addressInfoType" + }, + "emailInfo": { + "$ref": "#/definitions/emailInfoType" + }, + "phoneInfo": { + "$ref": "#/definitions/telephoneInfoType" + }, + "department": { + "$ref": "#/definitions/codeDescriptionType" + }, + "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" + } + } + }, + "userSessionDefaultsType": { + "type": "object", + "properties": { + "dbDateFormat": { + "type": "string" + }, + "oracleDateFormat": { + "type": "string" + }, + "oracleTimeFormat": { + "type": "string" + }, + "javaDateFormat": { + "type": "string" + }, + "javaTimeFormat": { + "type": "string" + }, + "currencyCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "currencyFormat": { + "type": "string" + }, + "defaultLanguage": { + "type": "string" + }, + "baseLanguage": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "parametersType": { + "type": "array", + "description": "Collection of generic Name-Value-Pair parameters.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/parameterType" + } + }, + "parameterType": { + "type": "object", + "description": "Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined.", + "properties": { + "parameterName": { + "description": "Name of the parameter.", + "type": "string" + }, + "parameterValue": { + "description": "Value of the parameter.", + "type": "string" + } + } + }, + "userSessionInfoType": { + "type": "object", + "properties": { + "businessDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "systemDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "terminal": { + "type": "string" + }, + "runningApp": { + "type": "string" + }, + "shareProfiles": { + "type": "boolean" + }, + "hotel": { + "$ref": "#/definitions/codeDescriptionType" + }, + "cro": { + "$ref": "#/definitions/codeDescriptionType" + }, + "chain": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "cROCountryCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "sessionDefaults": { + "$ref": "#/definitions/userSessionDefaultsType" + }, + "parameters": { + "$ref": "#/definitions/parametersType" + } + } + }, + "attendantType": { + "type": "object", + "properties": { + "attendantId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "applicationUserType": { + "type": "object", + "properties": { + "hotel": { + "description": "Hotel where user belongs.", + "$ref": "#/definitions/codeDescriptionType" + }, + "appUser": { + "type": "string", + "minLength": 0, + "maxLength": 60 + }, + "lDAPUser": { + "type": "string", + "minLength": 0, + "maxLength": 60 + }, + "actAs": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "actAt": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "userDefaultLanguage": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "appUserId": { + "$ref": "#/definitions/uniqueID_Type" + }, + "cashierId": { + "type": "integer" + }, + "cashierTitle": { + "description": "Cashier title.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "department": { + "type": "string", + "minLength": 0, + "maxLength": 60 + }, + "departmentLocation": { + "type": "string", + "minLength": 0, + "maxLength": 60 + }, + "salesRepCode": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "expiryDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "disabledUntil": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "passwordChangeDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "userInfo": { + "$ref": "#/definitions/employeeInfoType" + }, + "userSessionInfo": { + "description": "This is only used during log-in.", + "$ref": "#/definitions/userSessionInfoType" + }, + "attendantInfo": { + "$ref": "#/definitions/attendantType" + } + } + }, + "trackItId": { + "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" + } + } + }, + "trackItGroup": { + "type": "string", + "description": "Group to which the Track It items belong.", + "enum": [ + "Parcel", + "Valet", + "Baggage", + "Lost" + ] + }, + "resGuestInfoType": { + "type": "object", + "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.", + "properties": { + "membership": { + "description": "The Membership object identifying the frequent customer reward program.", + "$ref": "#/definitions/membershipInfoType" + }, + "namePrefix": { + "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)", + "$ref": "#/definitions/namePrefixType" + }, + "givenName": { + "description": "Given name, first name or names", + "$ref": "#/definitions/givenNameType" + }, + "alternateGivenName": { + "description": "Alternate 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 + }, + "surnamePrefix": { + "description": "e.g \"van der\", \"von\", \"de\"", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "surname": { + "description": "Family name, last name.", + "$ref": "#/definitions/surnameType" + }, + "alternateSurname": { + "description": "Alternate family name, last 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": 20 + }, + "nameTitle": { + "description": "Degree or honors (e.g., Ph.D., M.D.)", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "fullName": { + "description": "Full display name", + "type": "string" + }, + "alternateFullName": { + "description": "Altername full display name", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number", + "$ref": "#/definitions/phoneNumberType" + }, + "email": { + "description": "Email address", + "$ref": "#/definitions/basicEmailType" + }, + "birthDate": { + "description": "Date of birth", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "language": { + "description": "Language identification.", + "type": "string", + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" + }, + "nationality": { + "description": "Affiliation or ethnicity to a particular country.", + "$ref": "#/definitions/countryNameType" + }, + "vip": { + "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).", + "$ref": "#/definitions/vIPType" + }, + "address": { + "description": "Address information that is attached to the reservation guest", + "$ref": "#/definitions/addressSearchType" + }, + "anonymization": { + "description": "Provides information about the guest's anonymization status", + "$ref": "#/definitions/anonymizationType" + }, + "accompanyGuests": { + "description": "List of guest names that are accompanying the reservation guest", + "$ref": "#/definitions/resAccompanyGuestListType" + }, + "externalInfo": { + "description": "External information about the guest associated with the reservation.", + "$ref": "#/definitions/resGuestExternalInfoType" + }, + "guestLastStayInfo": { + "description": "Contains information regarding the last stay of this guest.", + "$ref": "#/definitions/guestLastStayInfoType" + }, + "guestRestrictedCode": { + "description": "Guest profile restricted reason code", + "type": "string" + }, + "guestRestrictedReasonDesc": { + "description": "Guest profile restricted reason description", + "type": "string" + }, + "guestRestricted": { + "description": "True indicates there are restrictions associated with the current profile.", + "type": "boolean" + }, + "registrationCardNo": { + "description": "Unique identifier of the police registration card number.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "nameType": { + "$ref": "#/definitions/nameTypeType" + }, + "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": 20 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "resGuestExternalInfoType": { + "type": "object", + "description": "Specifies Company or Travel Agent profile using IATA or Corp. No.", + "properties": { + "givenName": { + "description": "Given name, first name or names", + "$ref": "#/definitions/givenNameType" + }, + "surname": { + "description": "Family name, last name.", + "$ref": "#/definitions/surnameType" + } + } + }, + "resAccompanyGuestListType": { + "type": "array", + "description": "Collection of accompany guests", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/resAccompanyGuestInfoType" + } + }, + "resAccompanyGuestInfoType": { + "type": "object", + "properties": { + "firstName": { + "description": "Given name, first name or names", + "type": "string" + }, + "lastName": { + "description": "Family name, last name.", + "type": "string" + }, + "fullName": { + "description": "String representation of the full name", + "type": "string" + }, + "registrationCardNo": { + "description": "Unique identifier of the police registration card number.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "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" + } + } + }, + "givenNameType": { + "type": "string", + "description": "Given name, first name or names", + "minLength": 0, + "maxLength": 40 + }, + "namePrefixType": { + "type": "string", + "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)", + "minLength": 0, + "maxLength": 40 + }, + "nameTypeType": { + "type": "string", + "enum": [ + "Guest", + "Company", + "Agent", + "Contact", + "Source", + "Group", + "Employee", + "Hotel", + "Purge" + ] + }, + "surnameType": { + "type": "string", + "description": "Family name, last name.", + "minLength": 0, + "maxLength": 40 + }, + "languageType": { + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "membershipInfoType": { + "type": "object", + "description": "The Membership object identifies the frequent customer reward program.", + "properties": { + "membershipId": { + "description": "Membership ID (Unique ID from the memberships table).", + "type": "number" + }, + "programCode": { + "description": "The code or name of the membership program ('Hertz', 'AAdvantage', etc.).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "bonusCode": { + "description": "The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "membershipTypeDesc": { + "description": "The description of the ProgramCode.(Delta Previlige for code DP)", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "membershipLevelDesc": { + "description": "The description of the Bonus Code.(Platinum for code P)", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "accountId": { + "description": "The account identification number for this particular member in this particular program.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "membershipLevel": { + "description": "The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "playerRanking": { + "description": "Ranking assigned to the Player Profile by the Gaming system.", + "type": "integer" + } + } + }, + "addressSearchType": { + "type": "object", + "description": "Address Details such as city, state, country, postal code etc.", + "properties": { + "cityName": { + "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "postalCode": { + "description": "Post Office Code number.", + "type": "string", + "minLength": 0, + "maxLength": 15 + }, + "state": { + "description": "State or Province name (e.g., Texas).", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "country": { + "description": "Country name (e.g., Ireland).", + "$ref": "#/definitions/countryNameType" + }, + "streetAddress": { + "description": "First Line of Street Address. For profile search it matches the first Address line.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "excludeNoCity": { + "description": "When true indicates that only profiles with city will be fetched.", + "type": "boolean" + } + } + }, + "phoneNumberType": { + "type": "string", + "description": "Phone number", + "minLength": 0, + "maxLength": 40 + }, + "basicEmailType": { + "type": "string", + "description": "Email address", + "minLength": 0, + "maxLength": 2000 + }, + "vIPType": { + "type": "object", + "description": "The supplier's ranking of the customer.", + "properties": { + "vipCode": { + "description": "VIP Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "vipDescription": { + "description": "VIP Description.", + "type": "string", + "minLength": 0, + "maxLength": 80 + } + } + }, + "trackItReservationInfoType": { + "type": "object", + "description": "Reservation info associated with a Track It item.", + "properties": { + "reservationIdList": { + "$ref": "#/definitions/reservationIdList" + }, + "timeSpan": { + "$ref": "#/definitions/timeSpanType" + }, + "guestInfo": { + "$ref": "#/definitions/resGuestInfoType" + }, + "roomType": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "roomStatus": { + "$ref": "#/definitions/housekeepingRoomStatusType" + }, + "guarantee": { + "$ref": "#/definitions/resGuaranteeType" + }, + "reservationStatus": { + "$ref": "#/definitions/pMS_ResStatusType" + }, + "computedReservationStatus": { + "$ref": "#/definitions/pMS_ResStatusType" + } + } + }, + "pMS_ResStatusType": { + "type": "string", + "description": "This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.", + "enum": [ + "Reserved", + "Requested", + "NoShow", + "Cancelled", + "InHouse", + "CheckedOut", + "Waitlisted", + "DueIn", + "DueOut", + "Walkin", + "PendingCheckout" + ] + }, + "trackItLogListType": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/trackItLogType" + } + }, + "trackItLogType": { + "type": "object", + "description": "Individual activity log related to the Track It ticket.", + "properties": { + "hotelId": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "trackItLogId": { + "$ref": "#/definitions/uniqueID_Type" + }, + "trackItId": { + "$ref": "#/definitions/trackItId" + }, + "type": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "businessDate": { + "type": "string", + "format": "date", + "maxLength": 8 + }, + "logUserId": { + "type": "integer" + }, + "logUserName": { + "type": "string" + }, + "logDate": { + "type": "string", + "format": "date-time" + } + } + }, + "trackItActionType": { + "type": "object", + "description": "Identifies the response expected from staff or other parties relative to a Track It ticket.", + "properties": { + "trackItAction": { + "$ref": "#/definitions/codeDescriptionType" + }, + "status": { + "$ref": "#/definitions/actionStatusType" + } + } + }, + "actionStatusType": { + "type": "string", + "description": "Action status of the Track It item(Open, Closed).", + "enum": [ + "Open", + "Closed" + ] + }, + "trackItType": { + "type": "object", + "description": "Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.", + "properties": { + "type": { + "$ref": "#/definitions/codeDescriptionType" + }, + "url": { + "$ref": "#/definitions/uRLType" + } + } + }, + "hotelReservationsType": { + "type": "object", + "description": "A collection of Reservation objects and Unique IDs of Reservation.", + "properties": { + "reservation": { + "description": "A collection of Reservations.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/hotelReservationType" + } + }, + "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" + } + } + }, + "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 + } + } + }, + "activityList": { + "type": "array", + "description": "A collection of Activity objects.", + "maxItems": 4000, + "items": { + "type": "object", + "properties": { + "activityIds": { + "description": "A collection of reference ID values that identify this uniquely scheduled activity instance. May contain one ID per external system plus an internal identifier.", + "$ref": "#/definitions/uniqueIDListType" + }, + "type": { + "description": "The Type of the activity. Eg: SPA, Golf etc.", + "type": "string" + }, + "location": { + "description": "The Location where the activity takes place. Eg: Salon", + "type": "string" + }, + "name": { + "description": "Name of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 200 + } + }, + "numberOfPersons": { + "description": "The total number of the people for whom the activity is scheduled. Can be more than one but should be equal to the number of persons", + "type": "integer" + }, + "timeSpan": { + "description": "The time with-in which an activity falls (Starts/Ends/Spans)", + "$ref": "#/definitions/dateTimeSpanType" + }, + "duration": { + "description": "The time span of the activity falls", + "$ref": "#/definitions/dateTimeSpanType" + }, + "description": { + "description": "Description of the activity", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + }, + "note": { + "description": "Any additional notes or comments regarding the scheduled activity.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + } + }, + "groupCode": { + "description": "Any Block code associated with the activity if its a Group booking.", + "type": "string" + }, + "amount": { + "description": "The amount charged for the activity.", + "$ref": "#/definitions/currencyAmountType" + }, + "deposit": { + "description": "A monetary value expressed with a currency code.", + "type": "object", + "properties": { + "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 + }, + "collectedBy": { + "type": "string", + "enum": [ + "Vendor", + "Agent", + "Other" + ] + } + } + }, + "inactiveDate": { + "description": "The Date by which the activity is deemed Cancelled/Deleted.", + "type": "string", + "format": "date-time" + }, + "participants": { + "description": "The names of the participants.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/personNameType" + } + }, + "uRLLink": { + "description": "The URL link to launch the Activity Reservation System to view or edit full details of this activity.", + "type": "string" + }, + "extensions": { + "description": "Vendor extensions to the activity record.", + "type": "array", + "maxItems": 4000, + "items": { + "type": "string" + } + }, + "status": { + "description": "Activity reservation status. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.", + "type": "string" + }, + "statusDescription": { + "description": "Activity reservation status description. Typical examples are RESERVED, BOOKED, CANCELLED, and TENTATIVE.", + "type": "string" + }, + "link": { + "description": "When true indicates that activity link only needs to be inserted or deleted for this record.", + "type": "boolean" + } + }, + "description": "Represents a single instance of a scheduled activity." + } + }, + "packageCodeHeaderType": { + "type": "object", + "properties": { + "primaryDetails": { + "description": "Package code header primary details.", + "$ref": "#/definitions/configPackagePrimaryDetailsType" + }, + "transactionDetails": { + "description": "Package code header transaction information.", + "$ref": "#/definitions/configPackageTransactionType" + }, + "postingAttributes": { + "description": "Package code posting attributes.", + "$ref": "#/definitions/configPostingAttributesType" + }, + "usageDetails": { + "description": "Package code usage information.", + "$ref": "#/definitions/configPackageUsageDetailType" + } + } + }, + "configPostingAttributesType": { + "type": "object", + "description": "A config Package posting attributes type.", + "properties": { + "addToRate": { + "description": "The package price is added to the room rate.", + "type": "boolean" + }, + "printSeparateLine": { + "description": "The package price is printed on separate line of the folio.", + "type": "boolean" + }, + "sellSeparate": { + "description": "Can the package be sold separate from rate plan code?", + "type": "boolean" + }, + "postNextDay": { + "description": "package charges will be posted next business day.", + "type": "boolean" + }, + "forecastNextDay": { + "description": "Package will be forecasted for consumption the next business day.", + "type": "boolean" + }, + "deliveryTimeRequired": { + "description": "Indicates whether a delivery time is required for the package.", + "type": "boolean" + }, + "webBookable": { + "description": "Can package be sold via Web channel.", + "type": "boolean" + }, + "formula": { + "description": "The custom formula used for this package, if any.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "formulaFunctionName": { + "description": "The custom formula function name used for this package, if any.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "formulaFunctionArguments": { + "description": "The function argument name-value combination accepted by the custom formula used for this package.", + "$ref": "#/definitions/functionArgumentsType" + }, + "startTime": { + "description": "Start time the package is valid.", + "type": "string" + }, + "endTime": { + "description": "End time the package is valid.", + "type": "string" + }, + "catering": { + "description": "Is package used for catering?", + "type": "boolean" + }, + "postingRhythm": { + "description": "The posting rhythm for this package.", + "$ref": "#/definitions/packagePostingRhythmType" + }, + "priceCalculationRule": { + "description": "The price calculation rule for this package.", + "$ref": "#/definitions/packageCalculationRuleType" + }, + "ticket": { + "description": "Indicates whether a package is configured as a ticket or not.", + "type": "boolean" + }, + "inventoryItems": { + "description": "Package Code Inventory Items type.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/pkgInventoryItemType" + } + }, + "calculatedPrice": { + "description": "Calculated Package Price based from Number of Adults, Children and Calculation Rule.", + "type": "number" + } + } + }, + "functionArgumentsType": { + "type": "array", + "description": "Collection of function arguments and their corresponding values.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/functionArgumentType" + } + }, + "functionArgumentType": { + "type": "object", + "description": "This type provided details of a function argument and the value it holds.", + "properties": { + "name": { + "description": "Specifies the name of the function argument.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "value": { + "description": "Specifies the value held by the function argument.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "position": { + "description": "Specifies the position of the function argument in the argument list.", + "type": "integer" + }, + "dataType": { + "description": "Specifies the datatype of the function argument.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "required": { + "description": "Argument of the function mandatory or not.", + "type": "boolean" + } + } + }, + "packagePostingRhythmType": { + "type": "object", + "description": "Package Posting rhythm type.", + "properties": { + "everyXNightsStartingNightY": { + "description": "Post the package every X nights Staring from Night Y.", + "type": "object", + "properties": { + "startOnNightY": { + "description": "Starting night for consumption and posting prices.", + "type": "integer" + }, + "postEveryXNights": { + "description": "Occurance of nights when the package needs to be posted and consumed.", + "type": "integer" + } + } + }, + "certainNightsOfTheWeek": { + "description": "Post the package on certain nights of the week.", + "type": "object", + "properties": { + "sunday": { + "type": "boolean" + }, + "monday": { + "type": "boolean" + }, + "tuesday": { + "type": "boolean" + }, + "wednesday": { + "type": "boolean" + }, + "thursday": { + "type": "boolean" + }, + "friday": { + "type": "boolean" + }, + "saturday": { + "type": "boolean" + } + } + }, + "customStaySchedule": { + "description": "This user defined schedule lets you enter a posting rhythm over a 14-day period, starting with the arrival date, by assigning the day (number) within a guest stay for posting this package price.", + "type": "object", + "properties": { + "night1": { + "description": "Night 1 indicator.", + "type": "boolean" + }, + "night2": { + "description": "Night 2 indicator.", + "type": "boolean" + }, + "night3": { + "description": "Night 3 indicator.", + "type": "boolean" + }, + "night4": { + "description": "Night 4 indicator.", + "type": "boolean" + }, + "night5": { + "description": "Night 5 indicator.", + "type": "boolean" + }, + "night6": { + "description": "Night 6 indicator.", + "type": "boolean" + }, + "night7": { + "description": "Night 7 indicator.", + "type": "boolean" + }, + "night8": { + "description": "Night 8 indicator.", + "type": "boolean" + }, + "night9": { + "description": "Night 9 indicator.", + "type": "boolean" + }, + "night10": { + "description": "Night 10 indicator.", + "type": "boolean" + }, + "night11": { + "description": "Night 11 indicator.", + "type": "boolean" + }, + "night12": { + "description": "Night 12 indicator.", + "type": "boolean" + }, + "night13": { + "description": "Night 13 indicator.", + "type": "boolean" + }, + "night14": { + "description": "Night 14 indicator.", + "type": "boolean" + } + } + }, + "customNightSchedule": { + "description": "The start and end of the posting period is determined as follows: If the package is attached to a rate code: The period starts with the date when the rate code to which the package is attached becomes effective for the stay. The period ends with the date of the last night for that rate code (or the last night of the stay if the rate code remains in effect until the departure date). If the package is attached separately to the reservation: The Begin Date specified on the reservation when the package was attached is the start date for the period. The End Date specified on the reservation when the package was attached is the end date for the period. If no Begin Date and/or End Date are specified when the package is attached to the reservation, the Begin Date is assumed to be the arrival date and the End Date is assumed to be the departure date of the reservation, irrespective of when the package is attached to the reservation.", + "type": "object", + "properties": { + "night1": { + "description": "Night 1 indicator.", + "type": "boolean" + }, + "night2": { + "description": "Night 2 indicator.", + "type": "boolean" + }, + "night3": { + "description": "Night 3 indicator.", + "type": "boolean" + }, + "night4": { + "description": "Night 4 indicator.", + "type": "boolean" + }, + "night5": { + "description": "Night 5 indicator.", + "type": "boolean" + }, + "night6": { + "description": "Night 6 indicator.", + "type": "boolean" + }, + "night7": { + "description": "Night 7 indicator.", + "type": "boolean" + }, + "night8": { + "description": "Night 8 indicator.", + "type": "boolean" + }, + "night9": { + "description": "Night 9 indicator.", + "type": "boolean" + }, + "night10": { + "description": "Night 10 indicator.", + "type": "boolean" + }, + "night11": { + "description": "Night 11 indicator.", + "type": "boolean" + }, + "night12": { + "description": "Night 12 indicator.", + "type": "boolean" + }, + "night13": { + "description": "Night 13 indicator.", + "type": "boolean" + }, + "night14": { + "description": "Night 14 indicator.", + "type": "boolean" + } + } + }, + "type": { + "description": "Posting Rhythm for the package.", + "$ref": "#/definitions/postingRhythmType" + } + } + }, + "postingRhythmType": { + "type": "string", + "description": "Simple type for posting Rhythm types.", + "enum": [ + "EveryNight", + "ArrivalNight", + "EveryXNightsStartingNightY", + "CertainNightsOfTheWeek", + "LastNight", + "EveryNightExceptArrivalNight", + "EveryNightExceptLast", + "EveryNightExceptFirstAndLast", + "CustomStaySchedule", + "CustomNightSchedule", + "FloatingAllowancePerStay", + "TicketPosting" + ] + }, + "packageCalculationRuleType": { + "type": "string", + "description": "Simple type for package caluculation rules.", + "enum": [ + "FlatRate", + "PerPerson", + "PerAdult", + "PerChild", + "PerRoom" + ] + }, + "pkgInventoryItemType": { + "type": "object", + "properties": { + "articleNumber": { + "description": "Article Number of the inventory item.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "Description of the inventory item.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "quantity": { + "description": "Quantity of the inventory item allocated to the package.", + "type": "integer" + }, + "itemId": { + "description": "Identifier for the inventory item.", + "type": "integer" + } + } + }, + "configPackageUsageDetailType": { + "type": "object", + "description": "A Config Package Usage Detail type.", + "properties": { + "source": { + "description": "Indicates if the source of the product is Rate header, Rate Detail or Reservation.", + "$ref": "#/definitions/productSourceType" + }, + "usedInReservations": { + "description": "Indicates if the package is used in, reserved or prospect reservations.", + "type": "boolean" + }, + "usedInRates": { + "description": "Indicates if the package is used in any rate code.", + "type": "boolean" + }, + "usedInHouseReservations": { + "description": "Indicates if any checked in reservations are using this product.", + "type": "boolean" + } + } + }, + "productSourceType": { + "type": "string", + "description": "Sources of Products", + "enum": [ + "Reservation", + "RateHeader", + "RateDetail" + ] + }, + "configPackageTransactionType": { + "type": "object", + "description": "A HotelPackageTransaction type.", + "properties": { + "allowance": { + "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" + }, + "currency": { + "description": "The currency code for this package.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "postingType": { + "description": "The posting frequency for this package, e.g., daily, arrival, departure, etc.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "calculationRule": { + "description": "The price calculation rule for this package.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "packagePostingRules": { + "description": "The package posting rule details.", + "$ref": "#/definitions/packagePostingRulesType" + } + } + }, + "packagePostingRulesType": { + "type": "object", + "properties": { + "transactionCode": { + "description": "The Transaction code used to post the package price.", + "$ref": "#/definitions/packageTransactionCodeType" + }, + "overageCode": { + "description": "The overage code to record over consumed allowance.", + "$ref": "#/definitions/packageTransactionCodeType" + }, + "profitCode": { + "description": "The transaction code to record package profit, if any, from un-consumed allowance.", + "$ref": "#/definitions/packageTransactionCodeType" + }, + "lossCode": { + "description": "The transaction code to record package Loss, if any, from un-consumed allowance.", + "$ref": "#/definitions/packageTransactionCodeType" + }, + "alternateCodesList": { + "description": "The alternate transaction code that can be consumed by the guest in place of the transaction code.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/packageTransactionCodeType" + } + } + } + }, + "packageTransactionCodeType": { + "type": "object", + "properties": { + "description": { + "description": "The description of the code.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "code": { + "description": "Posting / transaction code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "type": { + "description": "Code is inclusive or exclusive of other chanrges such as taxes.", + "$ref": "#/definitions/amountDeterminationType" + } + } + }, + "configPackagePrimaryDetailsType": { + "type": "object", + "description": "A Config Package Info type.", + "properties": { + "description": { + "description": "The description of the package.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "shortDescription": { + "description": "The short description of the package.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "forecastGroup": { + "description": "The Forecast group package belongs to.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "arrangementCode": { + "description": "Arrangement Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "beginSellDate": { + "description": "Indicates the begin sell date of the package.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "endSellDate": { + "description": "Indicates the end sell date of the package.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "packageConsumptionType": { + "type": "object", + "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.", + "type": "integer" + }, + "excludedQuantity": { + "description": "The quantity which has been excluded in the package.", + "type": "integer" + }, + "totalQuantity": { + "description": "The total quantity of the package, calculated based on the calculation rule as defined in the PackageHeaderType.", + "type": "integer" + }, + "allowanceConsumed": { + "description": "Indicates if Allowance(for POS packages) has been consumed/posted for today.", + "type": "boolean" + } + } + }, + "reservationPackageType": { + "type": "object", + "description": "A ReservationPackageType class.", + "properties": { + "packageHeaderType": { + "description": "Package information from configuration.", + "$ref": "#/definitions/packageCodeHeaderType" + }, + "scheduleList": { + "description": "A HotelPackageSchedule type.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationPackageScheduleType" + } + }, + "newTimeSpan": { + "description": "The changed dates(Start and End dates) for this product.", + "$ref": "#/definitions/timeSpanType" + }, + "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" + }, + "ratePlanCode": { + "description": "The rate code which contains this package. If the package is not part of a rate code, this will be empty. Required element and part of the key to fetch the correct package record on the reservation.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "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 + }, + "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 + }, + "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 .", + "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" + } + } + }, + "reservationPackageScheduleType": { + "type": "object", + "description": "A HotelPackageSchedule type.", + "properties": { + "consumptionDate": { + "description": "The date the package was used or can be used.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "unitPrice": { + "description": "The price per unit of the package.", + "type": "number" + }, + "totalQuantity": { + "description": "The total quantity of the package for this date, calculated based on the calculation rule as defined in the PackageHeaderType", + "type": "integer" + }, + "computedResvPrice": { + "description": "Computed Reservation Price of the package. Calculation Will Be Performed Based On Other Parameters.", + "type": "number" + }, + "unitAllowance": { + "description": "The allowance per unit of the package.", + "type": "number" + }, + "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 + }, + "originalUnitPrice": { + "description": "The original price per unit of the package if it has been changed.", + "type": "number" + }, + "originalUnitAllowance": { + "description": "The original allowance per unit of the package if it has been changed.", + "type": "number" + } + } + }, + "itemInfoType": { + "type": "object", + "description": "Basic information regarding an Item.", + "properties": { + "description": { + "description": "Detail description of an item.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "availabilityPeriod": { + "description": "Defines a Time period when the item is available.", + "$ref": "#/definitions/timeWindowType" + }, + "timeSpan": { + "description": "Date Range to get the inventories of the items.", + "$ref": "#/definitions/timeSpanType" + }, + "quantity": { + "description": "Quantity of hold Item", + "type": "integer" + }, + "itemHoldId": { + "description": "ID reference for the hold Item", + "type": "number" + }, + "code": { + "description": "Item Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "name": { + "description": "Name of an item.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "itemPool": { + "description": "Indicates if it is an item pool. Not applicable for Item within the Item Pool.", + "type": "boolean" + }, + "sellSeparate": { + "description": "If true indicates that item is allowed to sell separately.", + "type": "boolean" + }, + "sellInReservation": { + "description": "If true indicates that item can be sold in reservation.", + "type": "boolean" + }, + "sellInEvent": { + "description": "If true indicates that item can be sold in event.", + "type": "boolean" + }, + "requiredForBooking": { + "description": "If true indicates that item is required for the reservation.", + "type": "boolean" + }, + "fixedCharge": { + "description": "If true indicates that item has fixed charge when it is attached to a reservation.", + "type": "boolean" + }, + "outsideStay": { + "description": "If true indicates that item could be held outside of the reservation stay days.", + "type": "boolean" + }, + "defaultDuration": { + "description": "Define the default duration in days when booking the item.", + "type": "integer" + } + } + }, + "timeWindowType": { + "type": "object", + "description": "Defines a Time period with start time and an end time.", + "properties": { + "startTime": { + "description": "Start Time of the Time window.", + "type": "string" + }, + "endTime": { + "description": "End Time of the Time window.", + "type": "string" + } + } + }, + "blockId": { + "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" + } + } + }, + "paragraphType": { + "type": "object", + "description": "An indication of a new paragraph for a sub-section of a formatted text message.", + "properties": { + "text": { + "description": "Formatted text content.", + "$ref": "#/definitions/formattedTextTextType" + }, + "image": { + "description": "An image for this paragraph.", + "type": "string" + }, + "url": { + "description": "A URL for this paragraph.", + "type": "string" + } + } + }, + "membershipEarningPreferenceType": { + "type": "string", + "description": "The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.", + "enum": [ + "Points", + "Miles" + ] + }, + "benefits": { + "description": "benefits for the membership.", + "$ref": "#/definitions/benefitsType" + }, + "benefitsType": { + "type": "array", + "description": "Basic information about membership benefit.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/benefitType" + } + }, + "benefitType": { + "type": "object", + "description": "Basic information about membership benefit.", + "properties": { + "code": { + "description": "Benefit code associated with a membership.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "message": { + "description": "Processing message for membership benefit.", + "type": "string", + "minLength": 0, + "maxLength": 4000 + }, + "inactive": { + "description": "Indicates whether membership benefit is active or inactive.", + "type": "boolean" + } + } + }, + "tierAdministrationType": { + "type": "string", + "description": "Do not upgrade membership. The membership may be downgraded.", + "enum": [ + "Disabled", + "NoUpgrade" + ] + }, + "downgradeType": { + "type": "string", + "description": "Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.", + "enum": [ + "Grace", + "Never", + "Period" + ] + }, + "cardReIssueType": { + "type": "string", + "description": "Request to re issue a new card.", + "enum": [ + "Pending", + "NotApplicable", + "Requested" + ] + }, + "membershipType": { + "type": "object", + "description": "Detailed information of the memberships.", + "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" + }, + "membershipLevelDescription": { + "description": "Indicates the membership level description.", + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "membershipClass": { + "description": "Indicates the membership class.", + "type": "string" + }, + "earningPreference": { + "description": "Earning preference to the membership.", + "$ref": "#/definitions/membershipEarningPreferenceType" + }, + "inactive": { + "description": "Indicates whether membership is active or inactive.", + "type": "boolean" + }, + "benefits": { + "description": "benefits for the membership.", + "$ref": "#/definitions/benefitsType" + }, + "tierAdministration": { + "description": "Defines the degree of participation for this membership in the tier management portion of the program.", + "$ref": "#/definitions/tierAdministrationType" + }, + "downgrade": { + "description": "Defines how downgrading will be handled for this membership.", + "$ref": "#/definitions/downgradeType" + }, + "reIssueNewCard": { + "description": "The status of issuing new membership card to the member.", + "$ref": "#/definitions/cardReIssueType" + }, + "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": 32000 + }, + "downgradeDescription": { + "description": "Indicates information regarding the member's possible downgrades.", + "type": "string", + "minLength": 0, + "maxLength": 32000 + }, + "rating": { + "description": "Value Rating Type Description for this membership.", + "type": "string" + }, + "membershipEnrollmentCode": { + "description": "Indicates how the guest enrolled in the program.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "memberStatus": { + "description": "Indicates where the guest is in the membership enrollment process.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "currentPoints": { + "description": "Profile MemberShip Points.", + "type": "number" + }, + "pointsLabel": { + "description": "Label used to refer to points for this membership type", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "enrollmentSource": { + "description": "Source from where the enrollment is done.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "enrollmentResort": { + "description": "Resort/CRO where enrollment is done.", + "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.", + "type": "string", + "minLength": 0, + "maxLength": 1 + }, + "primaryMembership": { + "description": "Boolean indicator set to True implies membership is a Primary Membership.", + "type": "boolean" + }, + "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.", + "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.", + "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" + }, + "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 + }, + "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 + } + } + }, + "resPaymentCardType": { + "type": "object", + "description": "Information on a credit card for the customer.", + "properties": { + "cardId": { + "description": "credit card id", + "$ref": "#/definitions/uniqueID_Type" + }, + "currentAuthorizedAmount": { + "$ref": "#/definitions/currencyAmountType" + }, + "approvalAmountNeeded": { + "$ref": "#/definitions/currencyAmountType" + }, + "approvalCode": { + "description": "Approval code sent by the credit card company on a successful authorization.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "cardType": { + "description": "Indicates the type of credit card from a defined list", + "$ref": "#/definitions/cardTypeType" + }, + "userDefinedCardType": { + "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided", + "type": "string", + "minLength": 0, + "maxLength": 2 + }, + "cardNumber": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "cardNumberMasked": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "cardNumberLast4Digits": { + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "expirationDate": { + "description": "Expiration date of the credit card", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "expirationDateMasked": { + "description": "Masked Expiration date of the credit card", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "expirationDateExpired": { + "type": "boolean" + }, + "cardHolderName": { + "type": "string", + "minLength": 0, + "maxLength": 200 + }, + "attachCreditCardToProfile": { + "description": "Attach the credit card to profile.", + "type": "boolean" + }, + "processing": { + "description": "This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type.", + "$ref": "#/definitions/cardProcessingType" + }, + "swiped": { + "type": "boolean" + }, + "cardPresent": { + "description": "Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active.", + "type": "boolean" + }, + "cardOrToken": { + "description": "This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type.", + "$ref": "#/definitions/cardNumberTypeType" + }, + "citId": { + "description": "Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.", + "type": "string", + "minLength": 0, + "maxLength": 30 + } + } + }, + "cardNumberTypeType": { + "type": "string", + "description": "Simple type for indicating if credit card number is tokenized.", + "enum": [ + "CardNumber", + "Token" + ] + }, + "cardProcessingType": { + "type": "string", + "enum": [ + "Eft", + "Manual" + ] + }, + "cardTypeType": { + "type": "string", + "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.", + "enum": [ + "Ab", + "Am", + "Ax", + "Cb", + "Dc", + "Ds", + "Dt", + "Ec", + "Er", + "Jc", + "Jl", + "Mc", + "Nb", + "So", + "St", + "Sw", + "Va", + "Xy", + "Zz", + "Cp", + "Cu" + ] + }, + "authorizationRuleType": { + "type": "object", + "description": "Configured rule for computing the amount to authorize.", + "properties": { + "code": { + "description": "The authorization rule code.", + "type": "integer", + "pattern": "[0-9]{1,9}" + }, + "amount": { + "description": "The amount applicable to the authorization rule.", + "$ref": "#/definitions/currencyAmountType" + }, + "percent": { + "description": "A percentage value if the authorization rule is percentage based.", + "type": "number" + } + } + }, + "reservationPaymentMethodType": { + "type": "object", + "properties": { + "paymentCard": { + "$ref": "#/definitions/resPaymentCardType" + }, + "balance": { + "$ref": "#/definitions/currencyAmountType" + }, + "authorizationRule": { + "$ref": "#/definitions/authorizationRuleType" + }, + "emailFolioInfo": { + "description": "Information on an email for the customer.", + "type": "object", + "properties": { + "email": { + "description": "eMail deatils for the profile.", + "$ref": "#/definitions/emailType" + }, + "emailFolio": { + "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": 20 + }, + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "paymentMethod": { + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "folioView": { + "type": "integer" + } + } + }, + "reservationPaymentMethodsType": { + "type": "array", + "description": "Defines reservation payment methods.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationPaymentMethodType" + } + }, + "routingInfoListType": { + "type": "array", + "description": "A routing info object can either be of type Folio OR of type Room with its corresponding instructions.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/routingInfoType" + } + }, + "routingInfoType": { + "type": "object", + "description": "A routing info object can either be of type Folio OR of type Room with its corresponding object.", + "properties": { + "folio": { + "description": "Folio routing type.", + "type": "object", + "properties": { + "guestInfo": { + "description": "Guest details", + "type": "object", + "properties": { + "profileIdList": { + "description": "Unique identifiers for the Profile for both internal and external systems.", + "$ref": "#/definitions/profileIdList" + } + } + }, + "payeeInfo": { + "$ref": "#/definitions/payeeInfoType" + }, + "aRNumber": { + "description": "Accounts Receivable.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "instructions": { + "description": "Set of routing instructions associated to this routing type.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/routingInstructionType" + } + }, + "folioWindowNo": { + "type": "integer" + }, + "paymentMethod": { + "type": "string", + "maxLength": 2000 + } + } + }, + "room": { + "description": "Room routing type.", + "type": "object", + "properties": { + "roomId": { + "description": "Room number to route the instructions.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "guestNameId": { + "description": "Guest unique identifier to which the instruction will be routed.", + "$ref": "#/definitions/uniqueID_Type" + }, + "guestDisplayName": { + "description": "Display Name for the guest.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "reservationNameId": { + "description": "Reservation name id to which the instruction will be routed.", + "$ref": "#/definitions/uniqueID_Type" + }, + "instructions": { + "description": "Set of routing instructions associated to this routing type.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/routingInstructionType" + } + } + } + }, + "comp": { + "description": "Comp Accounting Routing Info", + "type": "object", + "properties": { + "compRequestInfo": { + "$ref": "#/definitions/compRoutingRequestType" + }, + "payeeInfo": { + "$ref": "#/definitions/payeeInfoType" + }, + "instructions": { + "description": "Set of routing instructions associated to this routing type.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/routingInstructionType" + } + }, + "folioWindowNo": { + "type": "integer" + } + } + }, + "request": { + "description": "Comp Accounting Request routing", + "type": "object", + "properties": { + "compRequestInfo": { + "$ref": "#/definitions/compRoutingRequestType" + }, + "instructions": { + "description": "Set of routing instructions associated to this routing type.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/routingInstructionType" + } + } + } + }, + "refreshFolio": { + "description": "On a successful update, the transactions that are already posted in the guest's folio will be re-organized based on the configured instructions.", + "type": "boolean" + } + } + }, + "routingInstructionType": { + "type": "object", + "description": "Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit", + "properties": { + "duration": { + "description": "Duration of this instruction.", + "type": "object", + "properties": { + "timeSpan": { + "$ref": "#/definitions/timeSpanType" + }, + "sunday": { + "type": "boolean" + }, + "monday": { + "type": "boolean" + }, + "tuesday": { + "type": "boolean" + }, + "wednesday": { + "type": "boolean" + }, + "thursday": { + "type": "boolean" + }, + "friday": { + "type": "boolean" + }, + "saturday": { + "type": "boolean" + }, + "daily": { + "description": "Flag to indicate if the routing instruction is a daily instruction.", + "type": "boolean" + } + } + }, + "transactionCodes": { + "description": "Set of Transaction Codes configured in this time span.", + "$ref": "#/definitions/trxCodesInfoType" + }, + "billingInstructions": { + "description": "Set of Billing Instructions configured in this time span.", + "$ref": "#/definitions/billingInstructionsType" + }, + "creditLimit": { + "description": "Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero.", + "type": "number" + }, + "percentageLimit": { + "description": "The routing limit percentage allowed for this routing instruction.", + "type": "number" + }, + "covers": { + "description": "Number of covers for this routing instruction.", + "type": "number" + }, + "limitUsed": { + "description": "Amount of Credit used for this routing instruction.", + "type": "number" + }, + "routingLinkId": { + "description": "Internal Routing Link Id identifier to which limit group the instruction belongs.", + "$ref": "#/definitions/uniqueID_Type" + } + } + }, + "massUpdateRoutingInstructionType": { + "type": "object", + "description": "Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit", + "properties": { + "duration": { + "description": "Duration of this instruction.", + "type": "object", + "properties": { + "timeSpan": { + "$ref": "#/definitions/massUpdateTimeSpanType" + }, + "sunday": { + "type": "boolean" + }, + "monday": { + "type": "boolean" + }, + "tuesday": { + "type": "boolean" + }, + "wednesday": { + "type": "boolean" + }, + "thursday": { + "type": "boolean" + }, + "friday": { + "type": "boolean" + }, + "saturday": { + "type": "boolean" + }, + "daily": { + "description": "Flag to indicate if the routing instruction is a daily instruction.", + "type": "boolean" + } + } + }, + "transactionCodes": { + "type": "array", + "description": "Set of Transaction Codes configured in this time span.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/massUpdateTrxInfoType" + } + }, + "billingInstructions": { + "description": "Set of Billing Instructions configured in this time span.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/massUpdateBillingInstructionType" + } + }, + "creditLimit": { + "description": "Allowable credit amount for this routing instruction. Null value means no limit, 0 equals zero.", + "type": "number" + }, + "percentageLimit": { + "description": "The routing limit percentage allowed for this routing instruction.", + "type": "number" + }, + "covers": { + "description": "Number of covers for this routing instruction.", + "type": "number" + }, + "limitUsed": { + "description": "Amount of Credit used for this routing instruction.", + "type": "number" + } + } + }, + "compRoutingRequestType": { + "type": "object", + "description": "Type for the details of a Comp Routing Request", + "properties": { + "requestedBy": { + "description": "User who requested the Comp Routing", + "$ref": "#/definitions/userInfoType" + }, + "comments": { + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "declinedBy": { + "description": "User information of user who declined comp routing request", + "$ref": "#/definitions/userInfoType" + }, + "status": { + "description": "Comp routing status", + "$ref": "#/definitions/compRoutingStatusType" + } + } + }, + "compRoutingStatusType": { + "type": "string", + "description": "Status which indicates that the Request of Comp Routing was declined", + "enum": [ + "Request", + "Comp", + "Declined" + ] + }, + "userInfoType": { + "type": "object", + "description": "Opera User Information", + "properties": { + "userId": { + "description": "User Id of the Opera User", + "type": "integer" + }, + "userName": { + "description": "Name of the Opera User", + "type": "string", + "minLength": 0, + "maxLength": 40 + } + } + }, + "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" + }, + "nights": { + "description": "The number of nights of the hotel stay that are used to calculate the fee amount.", + "type": "integer" + }, + "percent": { + "description": "The percentage used to calculate the amount.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "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 + } + } + }, + "policyBasisTypeType": { + "type": "string", + "description": "Full Amount.", + "enum": [ + "FlatAmount", + "Percentage", + "Nights", + "NightPercentage", + "FullAmount" + ] + }, + "depositCancelRevenueType": { + "type": "string", + "description": "The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.", + "enum": [ + "Rooms", + "Catering", + "All" + ] + }, + "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" + }, + "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", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "manual": { + "description": "Flag to indicate if the deposit policy is manual.", + "type": "boolean" + }, + "effective": { + "description": "Indicator if deposit policy is currently applicable or not.", + "type": "boolean" + }, + "estimatedAmount": { + "description": "Estimated Amount for the deposit policy.", + "type": "number" + } + } + }, + "resDepositPoliciesType": { + "type": "array", + "description": "A list of deposit policies attached with the reservation.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/resDepositPolicyType" + } + }, + "resDepositPolicyType": { + "type": "object", + "description": "A deposit policy attached with the reservation.", + "properties": { + "revenueType": { + "description": "Type of reservation.", + "$ref": "#/definitions/depositCancelRevenueType" + }, + "policy": { + "description": "Reservation deposit policy details.", + "$ref": "#/definitions/depositPolicyType" + }, + "comments": { + "description": "Comments attached with a deposit.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "amountPaid": { + "description": "Total amount paid against the reservation deposit.", + "$ref": "#/definitions/currencyAmountType" + }, + "amountDue": { + "description": "Total amount due against the reservation deposit.", + "$ref": "#/definitions/currencyAmountType" + }, + "policyId": { + "description": "Unique ID of the Reservation Policy.", + "$ref": "#/definitions/uniqueID_Type" + } + } + }, + "reservationPoliciesType": { + "type": "object", + "description": "A collection of reservation deposit and cancellation policies.", + "properties": { + "cancellationPolicies": { + "description": "A collection of reservation cancellation policies..", + "$ref": "#/definitions/resCancellationPoliciesType" + }, + "depositPolicies": { + "description": "A collection of reservation deposit policies.", + "$ref": "#/definitions/resDepositPoliciesType" + }, + "reservationIdList": { + "description": "A list of Ids for reservation.", + "$ref": "#/definitions/uniqueIDListType" + }, + "name": { + "description": "Name identifier for the reservation.", + "type": "string" + } + } + }, + "resCancellationPoliciesType": { + "type": "array", + "description": "A list of reservation cancellation policies.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/resCancellationPolicyType" + } + }, + "resCancellationPolicyType": { + "type": "object", + "description": "A cancellation policy attached with the reservation.", + "properties": { + "revenueType": { + "description": "Type of reservation.", + "$ref": "#/definitions/depositCancelRevenueType" + }, + "policy": { + "description": "Cancellation policy details.", + "$ref": "#/definitions/resCancelPenaltyType" + }, + "percentageDue": { + "description": "The percentage amount due for reservation cancellation.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "comments": { + "description": "Comments attached with the reservation cancellation.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "policyId": { + "description": "Unique ID of the Reservation Policy.", + "$ref": "#/definitions/uniqueID_Type" + } + } + }, + "resCancelPenaltyType": { + "type": "object", + "description": "The CancelPenalty class defines the cancellation policy of the hotel facility.", + "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" + }, + "penaltyDescription": { + "description": "Text description of the Penalty in a given language.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "offsetUnit": { + "$ref": "#/definitions/offsetUnitType" + }, + "formattedRule": { + "description": "Formatted Text Rule of the Cancellation Penalty.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "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" + }, + "effective": { + "description": "Indicator if Cancellation Penalty is currently applicable or not.", + "type": "boolean" + } + } + }, + "offsetUnitType": { + "type": "string", + "description": "Indicates deadline offset unit type.", + "enum": [ + "Year", + "Month", + "Day", + "Hour" + ] + }, + "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.", + "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.", + "type": "integer" + } + } + }, + "resRevenueBalanceType": { + "type": "object", + "description": "Revenue and Balance Amount summary for the reservation.", + "properties": { + "totalFixedCharge": { + "description": "Total Fixed Charges on the reservation.", + "$ref": "#/definitions/currencyAmountType" + }, + "totalPayment": { + "description": "Total payment received for the reservation.", + "$ref": "#/definitions/currencyAmountType" + }, + "roomRevenue": { + "description": "Room Revenue generated by the reservation.", + "$ref": "#/definitions/currencyAmountType" + }, + "foodAndBevRevenue": { + "description": "Food and Beverage Revenue generated by the reservation.", + "$ref": "#/definitions/currencyAmountType" + }, + "otherRevenue": { + "description": "Other Revenue generated by the reservation.", + "$ref": "#/definitions/currencyAmountType" + }, + "nonRevenue": { + "description": "Total Non Revenue posted on the reservation.", + "$ref": "#/definitions/currencyAmountType" + }, + "totalRevenue": { + "description": "Total Revenue generated by the reservation.", + "$ref": "#/definitions/currencyAmountType" + }, + "balance": { + "description": "Balance amount on the reservation.", + "$ref": "#/definitions/currencyAmountType" + }, + "compBalance": { + "description": "Comp Balance amount", + "$ref": "#/definitions/currencyAmountType" + } + } + }, + "resPeriodicFolioType": { + "type": "object", + "description": "Information regarding periodic folios set on the reservation.", + "properties": { + "lastSettlementDate": { + "description": "Latest date when a direct bill settlement was automatically done using the \"Direct Bill Batch Folios\" option.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "lastFolioDate": { + "description": "Latest date when a folio was printed using the \"Periodic Batch Folios\" option", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "frequency": { + "description": "Frequency in number of days when folios should be printed for this reservation.", + "type": "integer" + } + } + }, + "resCompAccountingType": { + "type": "object", + "description": "Information regarding comp accounting on the reservation.", + "properties": { + "compType": { + "description": "Code used to identify the casino comp type and ranking of a guest.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "authorizer": { + "description": "ID of the employee who will act as the host for this guest.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "compPostings": { + "description": "Indicates if the Comp Billing/posting Exist", + "type": "string", + "minLength": 0, + "maxLength": 5 + } + } + }, + "billingPrivilegesType": { + "type": "object", + "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", + "properties": { + "postingRestriction": { + "description": "Flag used by interface program during check in.", + "type": "boolean" + }, + "preStayCharging": { + "description": "Indicates if the reservation has charging privileges before arrival.", + "type": "boolean" + }, + "postStayCharging": { + "description": "Indicates if the reservation has charging privileges after checkout.", + "type": "boolean" + }, + "folioCloseDate": { + "description": "Date when folio was closed. This works with PostStayCharging flag.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "scheduledCheckout": { + "description": "Indicates if the guest is scheduled for automatic check out.", + "type": "boolean" + }, + "scheduledCheckoutTime": { + "description": "Time of automatic check out if guest is schedule for automatic check out.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "directBillAuthorized": { + "description": "If Direct bill is authorized this will hold User ID who authorized it.", + "type": "boolean" + }, + "videoCheckout": { + "description": "Indicates if the guest can do video checkout", + "type": "boolean" + }, + "allowAutoCheckin": { + "description": "Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.", + "type": "boolean" + }, + "autoSettlement": { + "description": "Indicates if the is a candidate for auto folio settlement.", + "type": "boolean" + }, + "autoSettlementType": { + "description": "The folio settlement type for auto folio settlement.", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "autoSettlementFreq": { + "description": "The interval of days between each auto folio settlement.", + "type": "integer" + }, + "creditLimitAutoPay": { + "description": "Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results.", + "type": "boolean" + } + } + }, + "reservationTaxTypeInfo": { + "type": "object", + "description": "Provides information about the Tax Type.", + "properties": { + "hotelId": { + "description": "Code of the Hotel.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "code": { + "description": "Code of the Tax Type.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "description": { + "description": "Description of the Tax Type.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "collectingAgentTax": { + "description": "A boolean flag for Collecting Agent Tax", + "type": "boolean" + }, + "printAutoAdjust": { + "description": "Print auto adjust information for this tax type on the tax exempt report.", + "type": "boolean" + }, + "reportExemptDays": { + "description": "Number of days after which the guest will be tax exempt. Only used for tax exempt report.", + "type": "integer" + }, + "reportTaxPercentage": { + "description": "Tax percentage. Only used for tax exempt report.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "minimumLengthOfStay": { + "description": "Minimun Length of Stay.", + "type": "integer" + }, + "taxExemptNo": { + "description": "Tax exempt number on the profile.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "bedTaxReportingType": { + "type": "object", + "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", + "properties": { + "taxRegistrationNo": { + "description": "Tax Registration Number for Maldives Bed Tax Reporting.", + "type": "number" + }, + "visaNumber": { + "description": "Visa number used for Maldives Bed Tax Reporting", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "visaIssueDate": { + "description": "Visa Issue Date used for Maldives Bed Tax Reporting.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "visaExpiryDate": { + "description": "Visa Expiration Date used for Maldives Bed Tax Reporting", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "taxableDays": { + "description": "Number of days for which the Maldives tax is applicable.", + "type": "integer" + } + } + }, + "folioTextsType": { + "type": "array", + "description": "This stores the description for the type of tax calculation especially with tax exemption, etc.", + "maxItems": 2, + "items": { + "type": "object", + "properties": { + "text": { + "description": "Additional text field to display on the folio.", + "type": "string", + "minLength": 0, + "maxLength": 50 + }, + "row": { + "description": "Row number of the additional text.", + "type": "integer" + } + } + } + }, + "resPreConfiguredRoutingInstrType": { + "type": "object", + "description": "Instruction to attach Pre-Configured Routing Instructions to a Reservation.", + "properties": { + "authorizerInfo": { + "description": "The authorizer information for Promotion Code with attached Complimentary Routing", + "$ref": "#/definitions/authorizerInfoType" + }, + "ratePlanCode": { + "description": "Rate Code with attached Routing Instruction.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "profileType": { + "description": "Profile Type with attached Routing Instruction.", + "$ref": "#/definitions/resProfileTypeType" + }, + "promotionCode": { + "description": "Promotion Code with attached Complimentary Routing.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "authorizerInfoType": { + "type": "object", + "description": "Authorizer Information", + "properties": { + "authorizerId": { + "$ref": "#/definitions/uniqueID_Type" + }, + "authorizerUserName": { + "description": "Application user name of the authorizer", + "type": "string", + "minLength": 0, + "maxLength": 40 + }, + "authorizerName": { + "description": "Full name of the authorizer.", + "type": "string", + "minLength": 0, + "maxLength": 100 + }, + "authorizerRateCode": { + "description": "Rate code of the authorizer.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "inheritAuthorizerRateCode": { + "description": "Indicates whether user has the choice to have reservation inherit rate code from the authorizer.", + "type": "boolean" + } + } + }, + "resCashieringType": { + "type": "object", + "description": "Cashiering Information for the reservation.", + "properties": { + "revenuesAndBalances": { + "description": "Revenues and Balances Amount summary for the reservation.", + "$ref": "#/definitions/resRevenueBalanceType" + }, + "billingPrivileges": { + "description": "Billing privileges set on the reservation.", + "$ref": "#/definitions/billingPrivilegesType" + }, + "taxType": { + "description": "This stores the code for the type of tax calculation especially with tax exemption, etc.", + "$ref": "#/definitions/reservationTaxTypeInfo" + }, + "bedTaxReporting": { + "description": "This stores the information for Bed Tax Reporting. Mainly used in Maldives.", + "$ref": "#/definitions/bedTaxReportingType" + }, + "folioTexts": { + "description": "Additional text fields to display on the folio.", + "$ref": "#/definitions/folioTextsType" + }, + "periodicFolio": { + "description": "Information regarding periodic folios set on the reservation.", + "$ref": "#/definitions/resPeriodicFolioType" + }, + "compAccounting": { + "description": "Information regarding comp accounting on the reservation.", + "$ref": "#/definitions/resCompAccountingType" + }, + "reservationPreConfiguredRoutingInstruction": { + "description": "Information regarding the selected preconfigured routing instruction on the reservation.", + "$ref": "#/definitions/resPreConfiguredRoutingInstrType" + }, + "financiallyResponsible": { + "description": "The guest from whom payment has to be recovered (direct guest).", + "type": "boolean" + }, + "proratedBilling": { + "description": "In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate.", + "type": "boolean" + }, + "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 + }, + "reverseCheckInAllowed": { + "description": "This attribute is to verify if reverse check-in is allowed for the reservation.", + "type": "boolean" + }, + "reverseAdvanceCheckInAllowed": { + "description": "This attribute is to verify if reverse advance check-in is allowed for the reservation.", + "type": "boolean" + }, + "transactionsPosted": { + "description": "Specifies whether reservation has a financial transaction associated with it.", + "type": "boolean" + } + } + }, + "housekeepingRoomStatusType": { + "type": "string", + "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.", + "enum": [ + "Clean", + "Dirty", + "Pickup", + "Inspected", + "OutOfOrder", + "OutOfService" + ] + }, + "resHousekeepingType": { + "type": "object", + "description": "Holds housekeeping turndown service information for the room.", + "properties": { + "instructions": { + "description": "Turndown instructions for the room.", + "type": "string" + }, + "facilityTaskInfo": { + "description": "The facility task applicable for the current day. This will be information only and not used for any updates.", + "$ref": "#/definitions/facilityTaskType" + }, + "linenChange": { + "description": "Indicates if a linen change is necessary.", + "type": "boolean" + }, + "turndownRequested": { + "description": "Indicates whether guest wants turndown facility or not.", + "type": "boolean" + }, + "serviceTime": { + "description": "This is the Turndown room service time.", + "type": "string", + "format": "date", + "maxLength": 8 + }, + "expectedServiceTime": { + "description": "Expected Start Time for housekeeping task(s).", + "type": "string" + }, + "roomStatus": { + "description": "Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house.", + "$ref": "#/definitions/housekeepingRoomStatusType" + } + } + }, + "facilityTaskType": { + "type": "object", + "description": "Information regarding facility task on a reservation.", + "properties": { + "task": { + "description": "The Task Code.", + "$ref": "#/definitions/housekeepingTaskCodeType" + }, + "supplies": { + "description": "Supplies associated with the task.", + "$ref": "#/definitions/facilityCodesType" + }, + "date": { + "description": "The Date on which the task is applicable.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "facilityCodesType": { + "type": "array", + "description": "List of the facility codes.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/facilityCodeType" + } + }, + "facilityCodeType": { + "type": "object", + "description": "Facility Housekeeping Code, its description and quantity.", + "properties": { + "description": { + "description": "Facility Code.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "quantity": { + "description": "Signifies the quantity.", + "type": "integer" + }, + "code": { + "description": "Facility code value.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "housekeepingTaskCodeType": { + "type": "object", + "description": "Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.", + "properties": { + "description": { + "description": "Description of the Task Code.", "type": "string", - "description": "Path to the problem at the resource or property level." + "minLength": 0, + "maxLength": 80 + }, + "instructions": { + "description": "Instructions for this Task Code.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "facilityDepartureTask": { + "description": "Indicates if this task code is the default departure task for Facility Tasks. This requires", + "type": "boolean" + }, + "linenChange": { + "description": "Indicates if a linen change is necessary.", + "type": "boolean" + }, + "hotelId": { + "description": "Property where this task code is configured.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "code": { + "description": "The Code for the task.", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "sequence": { + "description": "Ordering sequence for display.", + "type": "integer" } } }, - "instanceLink": { + "reservationAllowedActionsType": { + "type": "array", + "description": "Allowed action.", + "maxItems": 11, + "items": { + "$ref": "#/definitions/reservationAllowedActionType" + } + }, + "reservationAllowedActionType": { + "type": "string", + "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.", + "enum": [ + "Cancel", + "Move", + "PreCharge", + "PostCharge", + "FacilitySchedule", + "Upsell", + "PreCheckIn", + "PostToNoShowCancel", + "NoShow", + "NameChange", + "Discount", + "EnrollToPrimaryMembership", + "EnrollInProgress" + ] + }, + "cateringResInfoType": { "type": "object", - "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", + "description": "Information regarding catering event and catering revenue type associated to the reservation.", "properties": { - "href": { - "description": "URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.", - "type": "string" + "eventId": { + "description": "Unique ID on a catering event associated to the reservation.", + "$ref": "#/definitions/eventId" }, - "rel": { - "description": "Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.", + "revenueType": { + "description": "Catering revenue type associated to the reservation.", + "type": "string" + } + } + }, + "eventId": { + "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" }, - "templated": { - "description": "Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.", - "type": "boolean", - "default": false + "type": { + "description": "A reference to the type of object defined by the UniqueID element.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "method": { - "description": "HTTP method for requesting the target of the link.", + "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", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE", - "PATCH", - "OPTIONS", - "HEAD" - ] + "minLength": 0, + "maxLength": 80 }, - "targetSchema": { - "description": "Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..", - "type": "string" + "idContext": { + "description": "Used to identify the source of the identifier (e.g., IATA, ABTA).", + "type": "string", + "minLength": 0, + "maxLength": 80 }, - "operationId": { - "description": "The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.", - "type": "string" + "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 }, - "title": { - "description": "Exact copy of the \"summary\" field on the linked operation.", - "type": "string" + "idExtension": { + "description": "Additional identifying value assigned by the creating system.", + "type": "integer" } } }, - "links": { + "indicatorsType": { "type": "array", + "description": "Collection of lamp indicators.", + "maxItems": 4000, "items": { - "$ref": "#/definitions/instanceLink" + "$ref": "#/definitions/indicatorType" } }, - "reservationsDailySummarySearchType": { + "indicatorType": { "type": "object", + "description": "Lamp indicator Type.", "properties": { - "hotelId": { - "description": "The Hotel Code for which the reservation search will be performed.", + "indicatorName": { + "description": "Name of the indicator.", + "type": "string", + "minLength": 0, + "maxLength": 80 + }, + "count": { + "description": "Indicates number of occurrences of the indicator.", + "type": "integer" + } + } + }, + "waitlistResType": { + "type": "object", + "description": "Information regarding why reservation is being /has been waitlisted.", + "properties": { + "reasonDescription": { + "description": "Waitlist Reason Description.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "priorityDescription": { + "description": "Waitlist priority Description.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "description": { + "description": "Description why the reservation is being /has been waitlisted.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "reasonCode": { + "description": "Waitlist Reason Code.", "type": "string", "minLength": 0, "maxLength": 20 }, - "timeSpan": { - "description": "The start date and time span for the search to be performed.", - "$ref": "#/definitions/timeSpanType" + "priorityCode": { + "description": "Waitlist Priority Code.", + "type": "string", + "minLength": 0, + "maxLength": 20 }, - "lastModifiedDate": { - "description": "Start and End Modified Dates of Reservations after which the results are to be fetched", - "$ref": "#/definitions/lastModifiedDateType" + "telephone": { + "description": "Guest telephone number.", + "type": "string", + "minLength": 0, + "maxLength": 40 } } }, - "timeSpanType": { + "reservationPaymentMethods": { + "description": "A collection of Payment Method objects.", + "$ref": "#/definitions/reservationPaymentMethodsType" + }, + "routingInstructions": { + "description": "Set of Routing Instructions.", + "$ref": "#/definitions/routingInfoListType" + }, + "reservationPolicies": { + "description": "A collection of Cancellation Penalties objects.", + "$ref": "#/definitions/reservationPoliciesType" + }, + "cashiering": { + "description": "Holds cashiering related information for the reservation.", + "$ref": "#/definitions/resCashieringType" + }, + "housekeeping": { + "description": "Holds rooms housekeeping information.", + "$ref": "#/definitions/resHousekeepingType" + }, + "extSystemSync": { + "type": "boolean" + }, + "userDefinedFields": { + "description": "Collections of user defined fields.", + "$ref": "#/definitions/userDefinedFieldsType" + }, + "reservationIndicators": { + "description": "Indicators of additional information attached to the reservation", + "$ref": "#/definitions/indicatorsType" + }, + "waitlist": { + "description": "Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is no more in Waitlist status.", + "$ref": "#/definitions/waitlistResType" + }, + "cancellation": { + "description": "Information regarding why reservation has been/was cancelled. This could hold information as history even if reservation is no more in in Cancelled status.", "type": "object", - "description": "Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, whild Duration provides a measure of time to add to the StartDate to yield end date.", "properties": { - "startDate": { + "description": { "type": "string", - "format": "date" + "minLength": 0, + "maxLength": 2000 }, - "endDate": { + "code": { "type": "string", - "format": "date" + "minLength": 0, + "maxLength": 20 }, - "duration": { + "cancellationNo": { + "description": "Cancellation Number given when reservation was last cancelled.", + "$ref": "#/definitions/uniqueID_Type" + }, + "date": { + "description": "Date when reservation was last cancelled.", + "type": "string", + "format": "date", + "maxLength": 8 + } + } + }, + "catering": { + "description": "Catering event information if reservation is associated with the catering event.", + "$ref": "#/definitions/cateringResInfoType" + }, + "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 + }, + "code": { + "description": "VIP status of the customer.", + "type": "string", + "minLength": 0, + "maxLength": 20 + } + } + }, + "profileTypeType": { + "type": "string", + "description": "The types of Profile handled by the web service.", + "enum": [ + "Guest", + "Agent", + "Company", + "Group", + "Source", + "Employee", + "Hotel", + "Vendor", + "Contact", + "Purge", + "BusinessHeader", + "BillingAccount", + "Activity", + "Potential", + "Account" + ] + }, + "profileNameType": { + "type": "object", + "description": "This provides name information for a person.", + "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" + } + } + }, + "fixedChargesType": { + "type": "array", + "description": "Holds fixed charge detail.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/fixedChargeType" + } + }, + "fixedChargeType": { + "type": "object", + "description": "Holds fixed charge information.", + "properties": { + "schedule": { + "description": "Holds schedule of fixed charge.", + "$ref": "#/definitions/fixedChargeScheduleType" + }, + "charge": { + "description": "Holds specific details of fixed charge.", + "$ref": "#/definitions/fixedChargeDetailType" + }, + "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" } } }, - "lastModifiedDateType": { + "fixedChargeScheduleType": { "type": "object", - "description": "Start and End Modified Dates of Reservations after which the results are to be fetched", + "description": "Holds schedule of fixed charge.", "properties": { - "startLastModifiedDate": { + "start": { + "description": "The starting value of the date range.", "type": "string", - "format": "date-time" + "format": "date", + "maxLength": 8 }, - "endLastModifiedDate": { + "end": { + "description": "The ending value of the date range.", "type": "string", - "format": "date-time" + "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.", + "type": "string", + "minLength": 0, + "maxLength": 3 + }, + "dateToExecute": { + "description": "Date of when to execute yearly fixed charge. Applicable when frequency is Yearly.", + "type": "string", + "format": "date", + "maxLength": 8 } } }, - "reservationDailySummaryType": { + "fixedChargeFrequencyType": { + "type": "string", + "description": "Yearly.", + "enum": [ + "O", + "D", + "W", + "M", + "Q", + "Y" + ] + }, + "fixedChargeDetailType": { "type": "object", - "description": "Daily summary information related to a reservation.", + "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" + }, + "chargeAmount": { + "description": "Price of the product.", + "$ref": "#/definitions/currencyAmountType" + }, + "percent": { + "description": "Percentage of the rate amount.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "supplement": { + "description": "Additional information regarding the fixed charge.", + "type": "string", + "minLength": 0, + "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" + } + } + }, + "hotelReservationType": { + "type": "object", + "description": "The Reservation class contains the current reservation being validated.", "properties": { "reservationIdList": { - "description": "Collection of reservation identifiers like Reservation Name ID, Confirmation Number, etc.", + "description": "Used to provide PMS and/or CRS identifiers.", "$ref": "#/definitions/reservationIdList" }, - "resvStatus": { - "description": "Indicates the status of the reservation.", - "$ref": "#/definitions/pMS_ResStatusType" + "externalReferences": { + "description": "External Reference information for Reservation.", + "$ref": "#/definitions/externalReferencesType" }, - "sharedYn": { - "description": "Indicates whether the reservation has any sharers. Y indicates true and N indicates false.", - "type": "string" + "shares": { + "description": "Collection of share reservation available for that reservation", + "$ref": "#/definitions/hotelReservationsType" }, - "sharersList": { - "description": "Collection of Confirmation Numbers of Sharers.", - "type": "string" + "comments": { + "description": "List of Notes for the Guest related to the reservation.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/commentInfoType" + } }, - "sharersResvIdList": { - "description": "The unique identifier reservationId List of the shared reservations.", - "type": "string" + "guestComments": { + "description": "List of Notes for the Guest related to the profile.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/commentInfoType" + } }, - "arrival": { - "type": "string", - "format": "date-time" + "sharedGuests": { + "description": "Collection of guests who share this reservation.", + "$ref": "#/definitions/resSharedGuestListType" }, - "departure": { - "type": "string", - "format": "date-time" + "roomStay": { + "description": "Room stays information.", + "$ref": "#/definitions/roomStayType" }, - "checkedOutDate": { - "description": "The date the reservation was checked out.", - "type": "string", - "format": "date-time" + "reservationGuests": { + "description": "Collection of guests associated with the reservation.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/resGuestType" + } }, - "cancellationDate": { - "description": "The date the reservation was canceled.", - "type": "string", - "format": "date-time" + "reservationPackages": { + "description": "A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationPackageType" + } }, - "bookingDate": { - "type": "string", - "format": "date-time" + "preferenceCollection": { + "description": "Collection of reservation preferences.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/preferenceTypeType" + } }, - "nationality": { - "description": "Affiliation or ethnicity to a particular country.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "reservationProfiles": { + "description": "Collection of guests associated with the reservation.", + "type": "object", + "properties": { + "reservationProfile": { + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/reservationProfileType" + } + }, + "commissionPayoutTo": { + "description": "If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.", + "$ref": "#/definitions/commissionPayoutToType" + } + } }, - "resvType": { - "description": "Type of the reservation.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "reservationPaymentMethods": { + "description": "A collection of Payment Method objects.", + "$ref": "#/definitions/reservationPaymentMethodsType" }, - "noOfRooms": { - "description": "Number of rooms of the reservation.", - "type": "integer" + "cashiering": { + "description": "Holds cashiering related information for the reservation.", + "$ref": "#/definitions/resCashieringType" }, - "blockCode": { - "description": "Block code of the reservation.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "extSystemSync": { + "type": "boolean" }, - "guestCountry": { - "description": "Country code for guest's primary address.", + "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 }, - "travelAgentId": { - "description": "ID of the travel agent for the reservation.", - "$ref": "#/definitions/uniqueID_Type" + "reservationStatus": { + "description": "Indicates the Actual status of the reservation.", + "$ref": "#/definitions/pMS_ResStatusType" }, - "travelAgentName": { - "description": "Name of the travel agent for the reservation.", - "type": "string", - "minLength": 0, - "maxLength": 200 + "overrideBlockRestriction": { + "type": "boolean" }, - "iataCode": { - "description": "IATA Code.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "additionalGuestInfo": { + "description": "Entry Date into the country. (Croatian Requirements).", + "$ref": "#/definitions/resGuestAdditionalInfoType" }, - "companyId": { - "description": "ID of the company for the reservation.", - "$ref": "#/definitions/uniqueID_Type" + "overrideExternalChecks": { + "description": "Forcefully override the create/update action on the Reservation. For real-time CRS interfaces, this element is used as force selling indicator in case of Create or Update Reservation", + "type": "boolean" }, - "companyName": { - "description": "Name of the company for the reservation.", - "type": "string", - "minLength": 0, - "maxLength": 200 + "userDefinedFields": { + "description": "Collections of user defined fields.", + "$ref": "#/definitions/userDefinedFieldsType" }, - "groupId": { - "description": "ID of the group for the reservation.", - "$ref": "#/definitions/uniqueID_Type" + "fixedCharges": { + "description": "List of reservation fixed charges.", + "$ref": "#/definitions/fixedChargesType" + } + } + }, + "resAccessRestrictionType": { + "type": "string", + "description": "Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.", + "enum": [ + "Change", + "Cancel", + "ChangeOrCancel" + ] + }, + "roomingListReservationType": { + "type": "object", + "description": "Reservation details for a block reservation.", + "properties": { + "hotelReservation": { + "description": "Contains detailed information about the snapshot reservation", + "$ref": "#/definitions/hotelReservationType" }, - "groupName": { - "description": "Name of the group for the reservation.", + "routingInstructions": { + "description": "Contains the routing instructions of the reservation.", + "$ref": "#/definitions/routingInfoListType" + }, + "roomingListSequence": { + "description": "Unique identifier that identifies the sequence of an individual rooming list reservation. The sequence will be maintained across every request and response.", + "type": "integer" + } + } + }, + "errorsType": { + "type": "array", + "description": "An error that occurred during the processing of a message.", + "maxItems": 99, + "items": { + "$ref": "#/definitions/errorType" + } + }, + "errorType": { + "type": "object", + "description": "Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.", + "properties": { + "value": { "type": "string", - "minLength": 0, - "maxLength": 200 + "description": "Property Value" }, - "sourceId": { - "description": "ID of the source for the reservation.", - "$ref": "#/definitions/uniqueID_Type" + "shortText": { + "description": "An abbreviated version of the error in textual format.", + "type": "string" }, - "sourceName": { - "description": "Name of the source for the reservation.", + "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": 200 + "maxLength": 20 }, - "resvContactId": { - "description": "ID of the contact for the reservation.", - "$ref": "#/definitions/uniqueID_Type" + "docURL": { + "description": "If present, this URL refers to an online description of the error that occurred.", + "type": "string" }, - "resvContactName": { - "description": "Name of the contact for the reservation.", - "type": "string", - "minLength": 0, - "maxLength": 200 + "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" }, - "createDateTime": { - "description": "Business Date when the reservation was created.", - "type": "string", - "format": "date-time" + "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" }, - "lastModifiedDateTime": { - "description": "Business Date when the reservation was modified.Either lastModifiedDateTime or lastModifiedDate will be returned.", + "recordId": { + "description": "If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.", + "type": "string" + }, + "type": { + "description": "The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type =\"Unknown\".", "type": "string", - "format": "date-time" + "minLength": 0, + "maxLength": 20 }, - "lastModifiedDate": { - "description": "Business Date when the reservation was modified.Either lastModifiedDateTime or lastModifiedDate will be returned.", + "language": { + "description": "Language identification.", "type": "string", - "format": "date-time" + "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, - "membershipId": { - "description": "Card Number of the membership.Either membershipId or membershipNumber will be returned.", + "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" + } + } + }, + "roomingListReservationsType": { + "type": "object", + "description": "A collection of Block Rooming List Reservations.", + "properties": { + "reservation": { + "description": "A collection of Block Rooming List Reservations.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/roomingListReservationType" + } + } + } + }, + "roomingList": { + "type": "object", + "description": "Request object for creating rooming list reservations. The standard optional Opera Context element is also included.", + "properties": { + "blockInfo": { + "description": "Information of the block for which rooming list reservations are being created.", + "$ref": "#/definitions/roomingListBlockInfoType" }, - "membershipNumber": { - "description": "Card Number of the membership.Either membershipId or membershipNumber will be returned.", - "type": "string" + "reservations": { + "description": "The collection of one or more block reservations to be created.", + "$ref": "#/definitions/roomingListReservationsType" }, - "membershipType": { - "description": "Type of membership.", - "type": "string" + "shares": { + "description": "Contains a collection of groups of a reservations that are shared with each other. This contains the list of reservations that are to be created as part of this request.", + "$ref": "#/definitions/roomingListSharesType" }, - "membershipLevel": { - "description": "Indicates the membership level.", - "type": "string" + "links": { + "$ref": "#/definitions/links" }, - "children1": { - "description": "Number of children classified under the first Age Qualifying Group.", - "type": "integer" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "validateRoomingListType": { + "type": "object", + "description": "Response object to validate block rooming list. This object contains the datils of validated rooming list records.", + "properties": { + "reservations": { + "description": "Collection of block reservations that were validate successfully with unique identifiers.", + "$ref": "#/definitions/validateRoomingListOutcomesType" }, - "children2": { - "description": "Number of children classified under the second Age Qualifying Group.", - "type": "integer" + "links": { + "$ref": "#/definitions/links" }, - "children3": { - "description": "Number of children classified under the third Age Qualifying Group.", - "type": "integer" + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "validateRoomingListOutcomesType": { + "type": "array", + "description": "Collection of outcome of validations of rooming list.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/validateRoomingListOutcomeType" + } + }, + "validateRoomingListOutcomeType": { + "type": "object", + "description": "Response object for outcome of validate rooming list reservations with Success or Fail status and Errors related to this operation.", + "properties": { + "reservationId": { + "description": "Unique Reservation Id", + "type": "number", + "minLength": 0, + "maxLength": 40 }, - "cancellationReasonCode": { - "type": "string" + "reservationSeqNo": { + "description": "Sequencial number of an individual reservation in rooming list.", + "type": "integer" }, - "bookingMedium": { - "description": "Classifies the medium(Channel field on reservation screen) through which the reservation is made. Either bookingMedium or origin_of_booking will be present in the response.", + "guestFullName": { + "description": "Guest's Full display name.", "type": "string", "minLength": 0, - "maxLength": 20 + "maxLength": 2000 }, - "origin_of_booking": { - "description": "Classifies the medium(Channel field on reservation screen) through which the reservation is made.Either bookingMedium or origin_of_booking will be present in the response.", + "roomType": { + "description": "", "type": "string", "minLength": 0, "maxLength": 20 }, - "dailySummary": { - "description": "Collection of daily summary for the reservation.", - "type": "array", - "maxItems": 4000, - "items": { - "$ref": "#/definitions/dailySummaryType" - } + "arrivalDate": { + "description": "Display the arrival date of the guest.", + "type": "string", + "format": "date" }, - "createdHotelDateTime": { - "description": "Business Date in property timezone when the reservation was created.", + "departureDate": { + "description": "Display the departure date of the guest.", "type": "string", - "format": "date-time" + "format": "date" }, - "modifiedHotelDateTime": { - "description": "Business Date in property timezone when the reservation was modified.Either lastModifiedDateTime or lastModifiedDate will be returned.", + "validateStatus": { "type": "string", - "format": "date-time" + "description": "Validate Status.", + "enum": [ + "Success", + "Fail" + ] + }, + "outcomeMessages": { + "description": "Status messages of validate rooming list", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/outcomeMessageType" + } } } }, - "uniqueIDListType": { + "roomingListSharesType": { "type": "array", - "description": "Unique Id that references an object uniquely in the system.", + "description": "Contains a set of rooming list reservations that need to be shared.", "maxItems": 4000, "items": { - "$ref": "#/definitions/uniqueID_Type" + "$ref": "#/definitions/roomingListShareType" + } + }, + "roomingListShareType": { + "type": "object", + "description": "Specifies a group of two or more rooming list reservations that need to be created as shared reservations.", + "properties": { + "reservation": { + "description": "Contains information about the rooming list reservation that is to be shared and specifies the type of share that is to be created.", + "type": "array", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/roomingListShareReservationType" + } + }, + "effectiveRates": { + "description": "Instruction to apply new effective rates to the reservations.", + "$ref": "#/definitions/effectiveRatesType" + }, + "timeSpan": { + "description": "The Time Span(Arrival, Departure) for the reservation share set.", + "$ref": "#/definitions/timeSpanType" + } } }, - "uniqueID_Type": { + "roomingListShareReservationType": { "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": "Contains the rooming list reservation that is to be shared and the information about the share type of this reservation.", "properties": { - "id": { - "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", - "type": "string", - "minLength": 0, - "maxLength": 80 + "reservationId": { + "description": "Indicates the unique Reservation Id.", + "$ref": "#/definitions/uniqueID_Type" }, - "type": { - "description": "A reference to the type of object defined by the UniqueID element.", - "type": "string", - "minLength": 0, - "maxLength": 20 + "typeOfRateAmount": { + "description": "Type of rate division for the sharer reservation. Valid types are Full, Entire and Split.", + "$ref": "#/definitions/shareDistributionInstructionType" + }, + "primaryShare": { + "description": "Indicates if this reservation is a primary sharer.", + "type": "boolean" + }, + "timeSpan": { + "description": "The Time Span(Arrival, Departure) for the reservation", + "$ref": "#/definitions/timeSpanType" } } }, - "reservationIdList": { + "effectiveRatesType": { "type": "array", - "description": "Unique Id that references an object uniquely in the system.", + "description": "Collection of effective rate amount per guest on specific dates.", "maxItems": 4000, "items": { - "$ref": "#/definitions/uniqueID_Type" + "$ref": "#/definitions/effectiveRateType" } }, - "dailySummaryType": { + "effectiveRateType": { "type": "object", - "description": "Statistic information related to a specific reservation stay date.", + "description": "Effective rate amount per guest on specific dates.", "properties": { - "rateCode": { - "description": "The rate plan code of the reservation.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "rateAmount": { - "description": "A monetary amount.", + "onePersonRate": { + "description": "Rate amount for one person.", "type": "number" }, - "rateAmountCurrency": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", - "type": "string", - "minLength": 3, - "maxLength": 3 - }, - "marketCode": { - "description": "Holds the code that relates to the market being sold (e.g., the corporate market, packages).", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "roomType": { - "description": "Room type.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "bookedRoomType": { - "description": "Booked room type.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "room": { - "description": "Room number.", - "type": "string", - "minLength": 0, - "maxLength": 20 - }, - "netRateAmount": { - "description": "Net Amount generated by the reservation.", + "twoPersonRate": { + "description": "Rate amount for two persons.", "type": "number" }, - "netRateAmountCurrency": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", - "type": "string", - "minLength": 3, - "maxLength": 3 - }, - "roomRevenue": { - "description": "Room Revenue generated by the reservation.", + "threePersonRate": { + "description": "Rate amount for three persons.", "type": "number" }, - "roomRevenueCurrency": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", - "type": "string", - "minLength": 3, - "maxLength": 3 + "fourPersonRate": { + "description": "Rate amount for four persons.", + "type": "number" }, - "fbRevenue": { - "description": "Food and Beverage Revenue generated by the reservation.", + "fivePersonRate": { + "description": "Rate amount for five persons.", "type": "number" }, - "fbRevenueCurrency": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", - "type": "string", - "minLength": 3, - "maxLength": 3 + "extraPersonRate": { + "description": "Rate amount for each extra person.", + "type": "number" }, - "otherRevenue": { - "description": "Other Revenue generated by the reservation.", + "extraChildRate": { + "description": "Rate amount for each extra Child.", "type": "number" }, - "otherRevenueCurrency": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", - "type": "string", - "minLength": 3, - "maxLength": 3 + "oneChildRate": { + "description": "Rate amount for one Child.", + "type": "number" }, - "totalRevenue": { - "description": "Total Revenue generated by the reservation.", + "twoChildrenRate": { + "description": "Rate amount for two Children.", "type": "number" }, - "totalRevenueCurrency": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", - "type": "string", - "minLength": 3, - "maxLength": 3 + "threeChildrenRate": { + "description": "Rate amount for three Children.", + "type": "number" }, - "packageRevenue": { - "description": "Package Revenue generated by the reservation.", + "fourChildrenRate": { + "description": "Rate amount for four Children.", "type": "number" }, - "packageRevenueCurrency": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", - "type": "string", - "minLength": 3, - "maxLength": 3 + "rateByAgeBuckets": { + "description": "Collection of rate amount by age bracket.", + "$ref": "#/definitions/rateByAgeBucketsType" }, - "tax": { - "description": "Tax Revenue generated by the reservation.", + "minimumChildrenForFreeStay": { + "description": "Minimum number of children needed to get free stay.", + "type": "integer" + }, + "pointsRequired": { + "description": "The number of award points required for applying this rate plan schedule.", "type": "number" }, - "taxCurrency": { - "description": "Provides a currency code to reflect the currency in which an amount may be expressed.", - "type": "string", - "minLength": 3, - "maxLength": 3 + "overrideFloorAmount": { + "description": "true if floor amount needs to be override", + "type": "boolean" }, - "roomTypeCharged": { - "description": "Room type charged for the reservation.", + "hotelId": { + "description": "", "type": "string", "minLength": 0, "maxLength": 20 }, - "trxDate": { - "description": "Reservation stay date for which the daily statistics are projected.", - "type": "string", - "format": "date-time" - }, - "sourceCode": { - "description": "The entity/channel who made the reservation.", + "ratePlanCode": { + "description": "", "type": "string", "minLength": 0, "maxLength": 20 }, - "channel": { - "description": "Classifies the Channel field on reservation screen through which the reservation is made.", + "roomType": { + "description": "", "type": "string", "minLength": 0, "maxLength": 20 }, - "adults": { - "description": "Number of adults of the reservation.", + "numberOfRooms": { + "description": "", "type": "integer" }, - "children": { - "description": "Number of children of the reservation.", + "amountBeforeTax": { + "description": "Rate amount Before Tax.", + "type": "number" + }, + "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 + } + } + }, + "rateByAgeBucketsType": { + "type": "array", + "description": "Rate amount by age bucket.", + "maxItems": 3, + "items": { + "$ref": "#/definitions/rateByAgeBucketType" + } + }, + "rateByAgeBucketType": { + "type": "object", + "description": "Rate amount by age bucket.", + "properties": { + "rateAmount": { + "description": "Rate amount by age bucket.", + "type": "number" + }, + "minimumAge": { + "description": "Minimum age for age bucket.", + "type": "integer" + }, + "maximumAge": { + "description": "Maximum age for age bucket.", "type": "integer" } } }, - "pMS_ResStatusType": { - "type": "string", - "description": "This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.", - "enum": [ - "Reserved", - "Requested", - "NoShow", - "Cancelled", - "InHouse", - "CheckedIn", - "CheckedOut", - "Waitlisted", - "DueIn", - "DueOut", - "Walkin", - "PendingCheckout" - ] + "paymentInstructionsMassUpdateCriteria": { + "type": "object", + "description": "Payment Instructions Mass Update criteria.", + "properties": { + "reservationIds": { + "description": "Unique ID of reservations to be updated.", + "type": "array", + "maxItems": 100, + "items": { + "$ref": "#/definitions/uniqueID_Type" + } + }, + "massUpdateFolioWindowTypes": { + "type": "array", + "description": "Collection of reservation folio windows.", + "maxItems": 8, + "items": { + "$ref": "#/definitions/massUpdateFolioWindowType" + } + }, + "updatePostingRestriction": { + "description": "Flag to indicate if postingRestriction is to be updated.", + "type": "boolean", + "default": false + }, + "postingRestriction": { + "description": "Indicates if the reservation has posting restriction.", + "type": "boolean", + "default": false + }, + "updatePreStayCharging": { + "description": "Flag to indicate if preStayCharging is to be updated.", + "type": "boolean", + "default": false + }, + "preStayCharging": { + "description": "Indicates if the reservation has charging privileges before arrival.", + "type": "boolean", + "default": false + }, + "updatePostStayCharging": { + "description": "Flag to indicate if postStayCharging is to be updated.", + "type": "boolean", + "default": false + }, + "postStayCharging": { + "description": "Indicates if the reservation has charging privileges after checkout.", + "type": "boolean", + "default": false + } + } }, - "criteria": { + "massUpdateFolioWindowType": { "type": "object", - "description": "Request object for fetching future reservations asynchronously.", + "description": "Folio window view which holds the set of folios for a reservation.", "properties": { - "criteria": { - "$ref": "#/definitions/reservationsDailySummarySearchType" + "paymentMethod": { + "description": "Payment Method Type", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "folioWindowNo": { + "type": "integer" } } }, - "reservationsDailySummaryDetails": { + "createRoomingListType": { "type": "object", - "description": "Reservation Daily Summary Details.", + "description": "Response object to create block rooming list. This object contains the details of created rooming list records.", "properties": { "reservations": { - "type": "array", + "description": "Collection of block reservations that were create successfully with unique identifiers.", + "$ref": "#/definitions/createRoomingListOutcomesType" + }, + "links": { + "$ref": "#/definitions/links" + }, + "warnings": { + "$ref": "#/definitions/warningsType" + } + } + }, + "createRoomingListOutcomesType": { + "type": "array", + "description": "Collection of outcome of creation of rooming list reservations.", + "maxItems": 4000, + "items": { + "$ref": "#/definitions/createRoomingListOutcomeType" + } + }, + "createRoomingListOutcomeType": { + "type": "object", + "description": "Response object for outcome of create rooming list reservations with Success or Fail status and Errors related to this operation.", + "properties": { + "reservationId": { + "description": "Unique Reservation Id", + "type": "number", + "minLength": 0, + "maxLength": 40 + }, + "reservationSeqNo": { + "description": "Sequential number of an individual reservation in rooming list.", + "type": "integer" + }, + "guestFullName": { + "description": "Guest's Full display name.", + "type": "string", + "minLength": 0, + "maxLength": 2000 + }, + "roomType": { + "description": "", + "type": "string", + "minLength": 0, + "maxLength": 20 + }, + "arrivalDate": { + "description": "Display the Arrival date of the guest.", + "type": "string", + "format": "date" + }, + "departureDate": { + "description": "Display the Departure date of the guest.", + "type": "string", + "format": "date" + }, + "createStatus": { + "type": "string", + "description": "Create Status.", + "enum": [ + "Success", + "Fail" + ] + }, + "confirmationNo": { + "description": "Unique Confirmation number", + "type": "number", + "minLength": 0, + "maxLength": 40 + }, + "profileNameId": { + "description": "Unique profile Id", + "type": "number", + "minLength": 0, + "maxLength": 40 + }, + "outcomeMessages": { + "description": "Status messages of create rooming list", "maxItems": 4000, "items": { - "$ref": "#/definitions/reservationDailySummaryType" + "$ref": "#/definitions/outcomeMessageType" } } } diff --git a/rest-api-specs/property/rsvcfg.json b/rest-api-specs/property/rsvcfg.json index 520e436..ec1fbf4 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -79,6 +79,42 @@ }, "204": { "description": "AlertCodeTemplates 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": [ @@ -143,6 +179,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -205,6 +277,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -269,6 +377,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -335,6 +479,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -420,6 +600,42 @@ }, "204": { "description": "BlockConversions 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": [ @@ -484,6 +700,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -559,6 +811,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -630,6 +918,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -715,6 +1039,42 @@ }, "204": { "description": "BlockRankings 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": [ @@ -779,6 +1139,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -854,6 +1250,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -925,6 +1357,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1010,6 +1478,42 @@ }, "204": { "description": "BookingTypes 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": [ @@ -1074,6 +1578,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1149,6 +1689,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1220,6 +1796,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1305,6 +1917,42 @@ }, "204": { "description": "CancellationCodes 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": [ @@ -1369,6 +2017,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1444,6 +2128,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1515,6 +2235,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1611,10 +2367,46 @@ }, "204": { "description": "CancellationPolicy not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -1686,6 +2478,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1753,6 +2581,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1826,6 +2690,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1901,6 +2801,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1968,6 +2904,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2041,6 +3013,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2137,6 +3145,42 @@ }, "204": { "description": "TemplateCancellationPolicy 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": [ @@ -2233,6 +3277,42 @@ }, "204": { "description": "DepositPolicy 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": [ @@ -2308,6 +3388,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2375,6 +3491,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2448,6 +3600,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2523,6 +3711,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2596,6 +3820,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2663,6 +3923,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2759,6 +4055,42 @@ }, "204": { "description": "TemplateDepositPolicy 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": [ @@ -2859,6 +4191,42 @@ }, "204": { "description": "DiscountReasons 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": [ @@ -2923,6 +4291,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2998,6 +4402,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3058,6 +4498,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3182,6 +4658,42 @@ }, "204": { "description": "ECouponCodes 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": [ @@ -3267,6 +4779,42 @@ }, "204": { "description": "EntryPoints 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": [ @@ -3331,6 +4879,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3406,6 +4990,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3477,6 +5097,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3562,6 +5218,42 @@ }, "204": { "description": "GlobalActionCodes 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": [ @@ -3626,6 +5318,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3701,6 +5429,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3772,6 +5536,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3838,6 +5638,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3924,6 +5760,42 @@ }, "204": { "description": "GlobalAlerts 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": [ @@ -3990,6 +5862,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4074,6 +5982,42 @@ }, "204": { "description": "TemplateGuaranteeCodes 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": [ @@ -4149,6 +6093,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4209,6 +6189,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4282,6 +6298,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4377,6 +6429,42 @@ }, "204": { "description": "GuaranteeCodes 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": [ @@ -4441,6 +6529,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4516,6 +6640,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4583,6 +6743,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4654,6 +6850,42 @@ }, "204": { "description": "GuestMessageTemplates 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": [ @@ -4718,6 +6950,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4780,6 +7048,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4844,6 +7148,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4935,6 +7275,42 @@ }, "204": { "description": "AlertCodes 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": [ @@ -5008,6 +7384,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5079,6 +7491,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5152,6 +7600,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5288,6 +7772,42 @@ }, "204": { "description": "AutoAttachElements 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": [ @@ -5361,6 +7881,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5434,6 +7990,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5509,6 +8101,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5584,6 +8212,42 @@ }, "204": { "description": "ReservationColors 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": [ @@ -5668,6 +8332,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5739,6 +8439,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5814,6 +8550,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5887,6 +8659,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5962,6 +8770,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6037,6 +8881,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6110,6 +8990,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6185,6 +9101,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6341,6 +9293,42 @@ }, "204": { "description": "GuaranteeCodeSchedules 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": [ @@ -6425,6 +9413,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6508,6 +9532,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6592,6 +9652,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6699,6 +9795,42 @@ }, "204": { "description": "GuestMessages 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": [ @@ -6772,6 +9904,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6845,6 +10013,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6916,6 +10120,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7030,6 +10270,42 @@ }, "204": { "description": "LocatorCodes 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": [ @@ -7103,6 +10379,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7176,6 +10488,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7247,6 +10595,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7331,6 +10715,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7400,6 +10820,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7482,6 +10938,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7566,6 +11058,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7648,6 +11176,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7717,6 +11281,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7838,6 +11438,42 @@ }, "204": { "description": "MembershipLevelRatings 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": [ @@ -7931,6 +11567,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8133,6 +11805,42 @@ }, "204": { "description": "PolicySchedules 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": [ @@ -8206,6 +11914,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8291,6 +12035,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8373,6 +12153,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8456,6 +12272,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8540,6 +12392,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8627,6 +12515,42 @@ }, "204": { "description": "PreCheckInRules 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": [ @@ -8700,6 +12624,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8959,6 +12919,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9032,6 +13028,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9150,6 +13182,42 @@ }, "204": { "description": "RatePlanRatings 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": [ @@ -9223,6 +13291,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9345,6 +13449,42 @@ }, "204": { "description": "RoomFeatureRatings 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": [ @@ -9418,6 +13558,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9540,6 +13716,42 @@ }, "204": { "description": "RoomSpecialRatings 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": [ @@ -9613,6 +13825,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9740,8 +13988,44 @@ "$ref": "#/definitions/roomRatings" } }, - "204": { - "description": "RoomRatings not found." + "204": { + "description": "RoomRatings 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": [ @@ -9826,6 +14110,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9928,6 +14248,42 @@ }, "204": { "description": "ServiceRequestCodes 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": [ @@ -10001,6 +14357,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10072,6 +14464,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10145,6 +14573,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10237,6 +14701,42 @@ }, "204": { "description": "ServiceRequestCodePriorities 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": [ @@ -10319,6 +14819,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10388,6 +14924,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10470,6 +15042,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10586,6 +15194,42 @@ }, "204": { "description": "SourceCodes 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": [ @@ -10659,6 +15303,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10743,6 +15423,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10812,6 +15528,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10928,6 +15680,42 @@ }, "204": { "description": "SourceGroups 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": [ @@ -11001,6 +15789,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11085,6 +15909,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11154,6 +16014,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11229,6 +16125,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11342,6 +16274,42 @@ }, "204": { "description": "HotelTurnAwayCodes 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": [ @@ -11415,6 +16383,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11488,6 +16492,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11559,6 +16599,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11707,6 +16783,42 @@ }, "204": { "description": "UpsellRules 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": [ @@ -11780,6 +16892,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11853,6 +17001,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -11928,6 +17112,42 @@ "schema": { "$ref": "#/definitions/upsellRulesToTestDetails" } + }, + "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": [ @@ -12003,6 +17223,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12074,6 +17330,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12149,6 +17441,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12244,6 +17572,42 @@ }, "204": { "description": "TemplateMarketCodes 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": [ @@ -12308,6 +17672,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12383,6 +17783,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12450,6 +17886,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12556,6 +18028,42 @@ }, "204": { "description": "MarketCodes 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": [ @@ -12631,6 +18139,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12698,6 +18242,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12771,6 +18351,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12866,6 +18482,42 @@ }, "204": { "description": "TemplateMarketGroups 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": [ @@ -12972,6 +18624,42 @@ }, "204": { "description": "MarketGroups 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": [ @@ -13057,6 +18745,42 @@ }, "204": { "description": "MoveReasonCodes 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": [ @@ -13121,6 +18845,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13196,6 +18956,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13267,6 +19063,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13352,6 +19184,42 @@ }, "204": { "description": "OriginCodes 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": [ @@ -13416,6 +19284,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13491,6 +19395,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13562,6 +19502,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13647,6 +19623,42 @@ }, "204": { "description": "PurposeOfStays 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": [ @@ -13711,6 +19723,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13786,6 +19834,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13857,6 +19941,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -13976,6 +20096,42 @@ }, "204": { "description": "Scripts 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": [ @@ -14040,6 +20196,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14115,6 +20307,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14197,6 +20425,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14300,6 +20564,42 @@ }, "204": { "description": "ServiceRequestCode 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": [ @@ -14396,6 +20696,42 @@ }, "204": { "description": "ServiceRequestCodePriority 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": [ @@ -14474,6 +20810,42 @@ }, "204": { "description": "LocatorCodesTemplate 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": [ @@ -14538,6 +20910,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14600,6 +21008,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14664,6 +21108,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14759,6 +21239,42 @@ }, "204": { "description": "TemplateSourceCodes 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": [ @@ -14823,6 +21339,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14898,6 +21450,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -14965,6 +21553,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15060,6 +21684,42 @@ }, "204": { "description": "TemplateSourceGroups 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": [ @@ -15124,6 +21784,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15182,6 +21878,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15246,6 +21978,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15328,6 +22096,42 @@ }, "204": { "description": "TraceTexts 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": [ @@ -15392,6 +22196,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15456,6 +22296,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15562,6 +22438,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15640,6 +22552,42 @@ }, "204": { "description": "TemplateTurnAwayCodes 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": [ @@ -15704,6 +22652,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15768,6 +22752,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15830,6 +22850,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -15915,6 +22971,42 @@ }, "204": { "description": "WaitlistCodes 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": [ @@ -15979,6 +23071,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16054,6 +23182,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16125,6 +23289,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16210,6 +23410,42 @@ }, "204": { "description": "WaitlistPriorities 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": [ @@ -16274,6 +23510,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16349,6 +23621,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -16420,6 +23728,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ diff --git a/rest-api-specs/property/rtp.json b/rest-api-specs/property/rtp.json index f2cd12a..9d8d9eb 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -93,6 +93,42 @@ }, "204": { "description": "DisplaySets 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": [ @@ -157,6 +193,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -232,6 +304,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -292,6 +400,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -438,6 +582,42 @@ }, "204": { "description": "BestAvailableRates 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": [ @@ -511,6 +691,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -696,6 +912,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -841,6 +1093,42 @@ }, "204": { "description": "RatePlansForBlock 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": [ @@ -911,6 +1199,42 @@ }, "204": { "description": "downloadExternalRatePlan 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": [ @@ -973,6 +1297,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1041,6 +1401,42 @@ }, "204": { "description": "MassRateChangeStatus 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": [ @@ -1116,6 +1512,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1229,6 +1661,42 @@ }, "204": { "description": "NegotiatedRates 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": [ @@ -1302,6 +1770,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1377,6 +1881,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1461,6 +2001,42 @@ "schema": { "$ref": "#/definitions/negotiatedRatesDetails" } + }, + "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": [ @@ -1583,6 +2159,42 @@ }, "204": { "description": "NegotiatedRatesForGivenHotelAndRate 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": [ @@ -1697,6 +2309,42 @@ }, "204": { "description": "HotelPackageForecastGroups 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": [ @@ -1770,6 +2418,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1843,6 +2527,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1914,6 +2634,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -1982,10 +2738,46 @@ }, "204": { "description": "PackageFormulaRanges not found." - } - }, - "consumes": [ - "application/json;charset=UTF-8" + }, + "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" @@ -2055,6 +2847,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2139,6 +2967,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2222,6 +3086,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2316,6 +3216,42 @@ }, "204": { "description": "PackageGroups 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": [ @@ -2388,6 +3324,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2460,6 +3432,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2531,6 +3539,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2621,6 +3665,42 @@ }, "204": { "description": "Package 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": [ @@ -2703,6 +3783,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2785,6 +3901,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2854,6 +4006,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -2931,6 +4119,42 @@ }, "204": { "description": "PackageRates 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": [ @@ -3020,6 +4244,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3139,6 +4399,42 @@ }, "204": { "description": "PromotionCodes 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": [ @@ -3222,6 +4518,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3303,6 +4635,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3422,6 +4790,42 @@ }, "204": { "description": "PromotionGroups 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": [ @@ -3496,6 +4900,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3579,6 +5019,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3660,6 +5136,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3729,6 +5241,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3803,6 +5351,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -3963,6 +5547,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4076,6 +5696,42 @@ }, "204": { "description": "RateCategory 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": [ @@ -4149,6 +5805,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4216,6 +5908,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4289,6 +6017,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4402,6 +6166,42 @@ }, "204": { "description": "RateClass 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": [ @@ -4475,6 +6275,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4559,6 +6395,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4628,6 +6500,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4728,8 +6636,44 @@ "$ref": "#/definitions/rateGroupsInfo" } }, - "204": { - "description": "RateGroups not found." + "204": { + "description": "RateGroups 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": [ @@ -4802,6 +6746,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4874,6 +6854,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -4934,6 +6950,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5023,6 +7075,42 @@ }, "204": { "description": "RatePlanScheduleYieldAdjustments 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": [ @@ -5107,6 +7195,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5198,6 +7322,42 @@ }, "204": { "description": "RatePlansByHotel 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": [ @@ -5271,6 +7431,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5345,6 +7541,42 @@ "examples": { "application/json": {} } + }, + "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": [ @@ -5438,6 +7670,42 @@ }, "204": { "description": "RatePlan 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": [ @@ -5520,6 +7788,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5589,6 +7893,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5673,6 +8013,42 @@ "schema": { "$ref": "#/definitions/ratePlansCopyDetails" } + }, + "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": [ @@ -5757,6 +8133,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -5917,6 +8329,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6001,6 +8449,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6083,6 +8567,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6174,6 +8694,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6258,6 +8814,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6340,6 +8932,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6420,6 +9048,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6575,8 +9239,44 @@ "$ref": "#/definitions/ratePlanSchedulesInfo" } }, - "204": { - "description": "RatePlanSchedules not found." + "204": { + "description": "RatePlanSchedules 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": [ @@ -6659,6 +9359,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6741,6 +9477,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -6912,6 +9684,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7014,6 +9822,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7113,6 +9957,42 @@ }, "204": { "description": "RateSeasons 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": [ @@ -7186,6 +10066,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7270,6 +10186,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7339,6 +10291,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7423,6 +10411,42 @@ }, "204": { "description": "RateStrategies 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": [ @@ -7496,6 +10520,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7580,6 +10640,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7649,6 +10745,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -7825,6 +10957,42 @@ }, "204": { "description": "RateActivityLog 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": [ @@ -7895,6 +11063,42 @@ }, "204": { "description": "validateRateCoupon 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": [ @@ -7965,6 +11169,42 @@ }, "204": { "description": "validateRatePromotion 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": [ @@ -8054,6 +11294,42 @@ }, "204": { "description": "validateRatePromotionCoupon 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": [ @@ -8129,6 +11405,42 @@ }, "204": { "description": "YieldAdjustments 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": [ @@ -8208,6 +11520,42 @@ }, "204": { "description": "TemplatePackageForecastGroups 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": [ @@ -8272,6 +11620,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8336,6 +11720,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8398,6 +11818,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8600,6 +12056,42 @@ }, "204": { "description": "Packages 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": [ @@ -8666,6 +12158,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -8805,6 +12333,42 @@ }, "204": { "description": "NegotiatedRatesForGivenProfile 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": [ @@ -8927,6 +12491,42 @@ }, "204": { "description": "TemplatePromotionCodes 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": [ @@ -9001,6 +12601,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9073,6 +12709,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9139,6 +12811,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9345,6 +13053,42 @@ }, "204": { "description": "RatePlans 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": [ @@ -9411,6 +13155,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9488,6 +13268,42 @@ }, "204": { "description": "TemplateRateCategory 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": [ @@ -9551,6 +13367,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9625,6 +13477,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9685,6 +13573,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9789,6 +13713,42 @@ }, "204": { "description": "TemplateRateClass 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": [ @@ -9853,6 +13813,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9928,6 +13924,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -9988,6 +14020,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10051,6 +14119,42 @@ }, "204": { "description": "TemplateRateSeasons 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": [ @@ -10115,6 +14219,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10190,6 +14330,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -10250,6 +14426,42 @@ "schema": { "$ref": "#/definitions/status" } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "consumes": [ @@ -12290,7 +16502,7 @@ "type": "boolean" }, "postingRhythm": { - "description": "The posting rhythm for this package.Posting Rhythm Type will be set as a default to Every Night when Posting Rhythm or Posting Rhythm Type is null.", + "description": "The posting rhythm for this package.Posting Rhythm Type will be set as default to Every Night when Posting Rhythm or Posting Rhythm Type is null.", "$ref": "#/definitions/packagePostingRhythmType" }, "priceCalculationRule": { diff --git a/rest-api-specs/property/rtpasync.json b/rest-api-specs/property/rtpasync.json index 6dbcca0..d554c70 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": "23.5", + "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.1", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" @@ -44,6 +44,42 @@ } }, "description": "Location of process status resource" + }, + "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" } }, "parameters": [ @@ -147,6 +183,42 @@ } }, "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "parameters": [ @@ -218,6 +290,42 @@ }, "204": { "description": "DailyRatePlanSchedules 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" } }, "parameters": [ @@ -292,6 +400,42 @@ } }, "description": "Location of process status resource" + }, + "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" } }, "parameters": [ @@ -396,6 +540,42 @@ } }, "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "parameters": [ @@ -467,6 +647,42 @@ }, "204": { "description": "BestAvailableRatePlans 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" } }, "parameters": [ @@ -541,6 +757,42 @@ } }, "description": "Location of process status resource" + }, + "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" } }, "parameters": [ @@ -646,6 +898,42 @@ } }, "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "parameters": [ @@ -720,6 +1008,42 @@ }, "204": { "description": "Hurdle Rates 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" } }, "parameters": [ @@ -797,6 +1121,42 @@ } }, "description": "Location of process status resource" + }, + "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" } }, "parameters": [ @@ -906,6 +1266,42 @@ } }, "description": "Response for status of scheduled asynchronous process." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "405": { + "$ref": "#/responses/405" + }, + "406": { + "$ref": "#/responses/406" + }, + "413": { + "$ref": "#/responses/413" + }, + "414": { + "$ref": "#/responses/414" + }, + "415": { + "$ref": "#/responses/415" + }, + "500": { + "$ref": "#/responses/500" + }, + "502": { + "$ref": "#/responses/502" + }, + "503": { + "$ref": "#/responses/503" } }, "parameters": [ @@ -980,6 +1376,42 @@ }, "204": { "description": "Hurdle Rates 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" } }, "parameters": [