This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.
", "version": "26.2.0.0", "termsOfService": "https://www.oracle.com/legal/terms.html", "contact": { "email": "hospitality_apis_ww_grp@oracle.com" }, "license": { "name": "UPL", "url": "https://opensource.org/licenses/upl" } }, "schemes": [ "https" ], "basePath": "/par/v1", "produces": [ "application/json" ], "paths": { "/availability": { "get": { "summary": "Get Hotel Availability", "description": " This API fetches hotel availablity for multiple hotels, given dates, RatePlans, Rate Category, Rate Group, Membership Rates, Number of People.OperationId:getHotelAvailabilityCRO
This API allows a time span of 90 days.
", "operationId": "getHotelAvailabilityCRO", "deprecated": true, "parameters": [ { "name": "cro", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Central reservation office Code who is requesting Rate Availability.", "items": { "type": "string" }, "required": false }, { "name": "hotelIds", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Hotel code of the Hotel whose Rate Availability is requested.", "items": { "type": "string" }, "required": false }, { "name": "includeClosedRates", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Used to indicate if closed rates are to be included in the Rate Plan set.", "items": { "type": "boolean" }, "required": false }, { "name": "includeDefaultRatePlanSet", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Used to indicate if the configured default rate plan set will be included.", "items": { "type": "boolean" }, "required": false }, { "name": "includeNoRatePlanSet", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Includes the rate codes which do not have a rate plan set associated. This parameter is applicable when the property has not configured a default rate plan set.", "items": { "type": "boolean" }, "required": false }, { "name": "initialRatePlanSet", "in": "query", "type": "array", "collectionFormat": "multi", "description": "If InitialRatePlanSet is set to true response will return most relevant Rate Plan Set(e.g. NEGOTIATED if profiles has Negotiated Rates) depending on the request. if request does not requires special Rate Plan Set, it will return default Rate Plan Set if RatePlanSet value is not set.", "items": { "type": "boolean" }, "required": false }, { "name": "limit", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Indicates maximum number of records a Web Service should return.", "items": { "type": "integer" }, "required": false }, { "name": "pagePointerKey", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Specifies fetched record's key as pointer to fetch additional records from. If key is composite use comma separated string.", "items": { "type": "string" }, "required": false }, { "name": "ratePlanSet", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Rate Plan Set code to filter Rate Plans based on the predefined set. if not specified it will not filter any Rate Plans by Rate Plan Set. When InitialRatePlanSet is true response may not always return Rate Plans for the supplied Rate Plan Set(See InitialRatePlanSet documentation).", "items": { "type": "string" }, "required": false }, { "name": "redeemAwards", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Used to indicate if the awards are to be redeemed.", "items": { "type": "boolean" }, "required": false }, { "name": "roomStayStartDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "roomStayEndDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "roomStayQuantity", "in": "query", "required": false, "type": "integer" }, { "name": "adults", "in": "query", "required": false, "description": "Defines the number of Adults.", "type": "integer" }, { "name": "children", "in": "query", "required": false, "description": "Defines the number of Children.", "type": "integer" }, { "name": "childAge", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Age of a child in years.", "items": { "type": "integer" }, "required": false }, { "name": "bucket1Count", "in": "query", "required": false, "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1).", "type": "integer" }, { "name": "bucket2Count", "in": "query", "required": false, "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2).", "type": "integer" }, { "name": "bucket3Count", "in": "query", "required": false, "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3).", "type": "integer" }, { "name": "bucket4Count", "in": "query", "required": false, "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).", "type": "integer" }, { "name": "bucket5Count", "in": "query", "required": false, "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).", "type": "integer" }, { "name": "fullStayTimeSpanStartDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "fullStayTimeSpanEndDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "prevailingRate", "in": "query", "required": false, "type": "boolean" }, { "name": "rateCategory", "in": "query", "required": false, "type": "string" }, { "name": "rateClass", "in": "query", "required": false, "type": "string" }, { "name": "rateGroup", "in": "query", "required": false, "type": "string" }, { "name": "ratePlanCode", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "promotionCode", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Promotion code associated with the rate plan.", "items": { "type": "string" }, "required": false }, { "name": "roomType", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "roomClass", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "bedType", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "feature", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "reservationGuestId", "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": "reservationGuestIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "reservationProfileType", "in": "query", "type": "array", "collectionFormat": "multi", "uniqueItems": true, "items": { "type": "string", "enum": [ "Guest", "Company", "Group", "TravelAgent", "Source", "ReservationContact", "BillingContact", "Addressee" ] }, "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" }, "required": false }, { "name": "hotelReservationId", "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": "hotelReservationIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "ratePlanInfo", "in": "query", "required": false, "description": "If true Rate Plan Code Master information will be included in the response.", "type": "boolean" }, { "name": "returnOnlyAvailableRateCodes", "in": "query", "required": false, "description": "If true Only availability check will be done and it will return available rate codes.", "type": "boolean" }, { "name": "resGuaranteeInfo", "in": "query", "required": false, "description": "If true Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true.", "type": "boolean" }, { "name": "roomTypeInfo", "in": "query", "required": false, "description": "If true Room Type Master information will be included in the response.", "type": "boolean" }, { "name": "membershipIdNumber", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Membership id Number of the guest.", "items": { "type": "integer" }, "required": false }, { "name": "membershipLevel", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Membership id Number of the guest.", "items": { "type": "string" }, "required": false }, { "name": "membershipType", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Membership id Number of the guest.", "items": { "type": "string" }, "required": false }, { "name": "pointsAvailable", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Used to indicate Points Available for Profile Primary Membership Type.", "items": { "type": "integer" }, "required": false }, { "name": "membershipCardNumber", "in": "query", "type": "array", "collectionFormat": "multi", "required": false, "description": "Member Card number associated with the guest membership.", "items": { "type": "string" } }, { "name": "smokingPreference", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Smoking preference to search a reservation. This is compared to the preference on the guest profile of the reservation.", "items": { "type": "string" }, "required": false }, { "name": "hotelPackage", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Hotel Package Code to filter the search result.", "items": { "type": "string" }, "required": false }, { "name": "yieldMarketCode", "in": "query", "required": false, "type": "string" }, { "name": "accessibleRoomTypesOnly", "in": "query", "type": "boolean", "description": "Used to fetch accessible room types only in the Rate Plan set.", "required": false }, { "name": "includeLocalRates", "in": "query", "required": false, "description": "Used to indicate if local rates are to be included in the Rate Plan set.", "type": "boolean" }, { "name": "includeOffshoreRates", "in": "query", "required": false, "description": "Used to indicate if offshore rates are to be included in the Rate Plan set.", "type": "boolean" }, { "name": "postingInterval", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Optional posting interval filter. When nothing is provided in this filter then only Nightly rates will be returned", "uniqueItems": true, "items": { "type": "string", "enum": [ "Nightly", "Weekly", "Monthly" ] } }, { "name": "ownerType", "in": "query", "required": false, "type": "string", "uniqueItems": true, "enum": [ "Owner", "Referral", "Regular" ], "description": "Owner Room Type - can be either Owner or Referral" }, { "name": "controlSegment", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "required": false, "description": "Control Segment to check for casino restrction for a patron profile.", "items": { "type": "string" } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object to search hotel availability based on request segment.", "schema": { "$ref": "#/definitions/hotelAvailability" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/availability/searches": { "post": { "summary": "Get Hotel Availability", "description": " This API fetches hotel availablity for multiple hotels, given dates, RatePlans, Rate Category, Rate Group, Membership Rates, Number of People.OperationId:searchHotelAvailabilityCRO
This API allows a time span of 90 days.
", "operationId": "searchHotelAvailabilityCRO", "parameters": [ { "in": "body", "name": "searchHotelAvailabilityCRORequest", "description": "Hotel Availability Request", "required": false, "schema": { "$ref": "#/definitions/searchHotelAvailabilityCRORequest" } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object to search hotel availability based on request segment.", "schema": { "$ref": "#/definitions/hotelAvailability" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/externalControlSegment": { "post": { "summary": "External Control Segment Lookup", "description": "Use this API To LookUp Control Segment In An External System:OperationId:retriveExternalControlSegment
", "operationId": "retriveExternalControlSegment", "parameters": [ { "name": "externalControlSegmentCriteria", "in": "body", "required": true, "description": "The request element which contains criteria to fetch control segment", "schema": { "allOf": [ { "$ref": "#/definitions/externalControlSegmentCriteria" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/externalControlSegmentDetails" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/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": [ "AvailabilityExternal" ] } }, "/hotels": { "get": { "summary": "Search hotels for the sales process", "description": "This API is to search hotels for the sales process.OperationId:getHotels
", "operationId": "getHotels", "parameters": [ { "name": "cro", "in": "query", "required": false, "description": "Central Reservation Office Code who is conducting the search. This will search only hotels handled by the CRO.", "type": "string" }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "quantity", "in": "query", "required": false, "type": "integer" }, { "name": "adults", "in": "query", "required": false, "description": "Defines the number of Adults.", "type": "integer" }, { "name": "children", "in": "query", "required": false, "description": "Defines the number of Children.", "type": "integer" }, { "name": "alternateHotels", "in": "query", "required": false, "description": "If true or not specified Alternate Hotels will be returned in the result. To search specific hotels send it false.", "type": "boolean" }, { "name": "hotelId", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Hotel Code to be searched.", "items": { "type": "string" }, "required": false }, { "name": "regionCode", "in": "query", "required": false, "description": "Region Code where the given cities are located.", "type": "string" }, { "name": "city", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "City Code to filter the search result.", "items": { "type": "string" }, "required": false }, { "name": "hotelType", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Hotel Type to filter the search result.", "items": { "type": "string" }, "required": false }, { "name": "hotelAmenity", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Hotel Amenity Code to filter the search result.", "items": { "type": "string" }, "required": false }, { "name": "attraction", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Attaction Code to filter the search result.", "items": { "type": "string" }, "required": false }, { "name": "hotelPackage", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Hotel Package Code to filter the search result.", "items": { "type": "string" }, "required": false }, { "name": "prevailingRate", "in": "query", "required": false, "type": "boolean" }, { "name": "rateCategory", "in": "query", "required": false, "type": "string" }, { "name": "rateClass", "in": "query", "required": false, "type": "string" }, { "name": "rateGroup", "in": "query", "required": false, "type": "string" }, { "name": "ratePlanCode", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "ratePlanId", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "promotionCode", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Promotion code associated with the rate plan.", "items": { "type": "string" }, "required": false }, { "name": "roomType", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "roomClass", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "bedType", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "feature", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "reservationGuestId", "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": "reservationGuestIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "reservationProfileType", "in": "query", "type": "array", "collectionFormat": "multi", "uniqueItems": true, "items": { "type": "string", "enum": [ "Guest", "Company", "Group", "TravelAgent", "Source", "ReservationContact", "BillingContact", "Addressee" ] }, "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": "currencyExchangeRates", "in": "query", "required": false, "description": "If true Currency Exchange Rates information will be included in the response.", "type": "boolean" }, { "name": "ratePlanInfo", "in": "query", "required": false, "description": "If true Rate Plan Code Master information will be included in the response.", "type": "boolean" }, { "name": "resGuaranteeInfo", "in": "query", "required": false, "description": "If true Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true.", "type": "boolean" }, { "name": "returnAllRates", "in": "query", "required": false, "description": "Indicates whether to return only 'Requested' rate codes or 'All' rate codes. The default value is true which means all available ratecodes will be returned.", "type": "boolean" }, { "name": "roomTypeInfo", "in": "query", "required": false, "description": "If true Room Type Master information will be included in the response.", "type": "boolean" }, { "name": "orderBy", "in": "query", "required": false, "type": "string", "description": "A collection of supported sorting options for search hotels results.", "uniqueItems": true, "enum": [ "MOSTAVAIL", "LEASTAVAIL", "MOSTPERCAVAIL", "LISTPERCAVAIL", "SHORTESTDISTANCE", "DEFAULT", "ALPHABETICAL", "RATELOWTOHIGH", "RATEHIGHTOLOW" ] }, { "name": "sellMessages", "in": "query", "required": false, "description": "If true Sell Messages information will be included in the response.", "type": "boolean" }, { "name": "blockId", "in": "query", "required": false, "description": "Block Id to query for sell messages.", "type": "number" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object to search hotel availability.", "schema": { "$ref": "#/definitions/searchHotelsDetails" }, "examples": { "application/json": { "hotels": { "hotel": [ { "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-13T08:42:51.099Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.099Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "contactNumbers": [ { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T08:42:51.099Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.099Z", "lastModifierId": "string", "purgeDate": "2020-07-13" } ], "minRate": { "amount": 0, "currencyCode": "string" }, "maxRate": { "amount": 0, "currencyCode": "string" }, "relativePosition": { "distance": 0, "distanceType": "string", "drivingTime": "string" }, "hotelAmenities": [ { "description": "string", "code": "string", "type": "string", "displayOrder": 0 } ], "event": true, "rateRoomDetails": { "memberships": [ { "membershipId": "string", "membershipLevel": [ "string" ], "membershipType": [ "string" ], "associatedReservationsOnly": true } ], "restrictionType": "Closed", "roomStays": [ { "roomRates": [ { "total": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "totalPoints": { "awardsType": "string", "points": 0 }, "rates": { "rate": [ { "base": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "additionalGuestAmounts": [ { "amount": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "ageQualifyingCode": "ADULT" } ], "discount": { "discountReason": "string", "percent": 0, "amount": 0, "currencyCode": "string", "discountCode": "string" }, "shareRatePercentage": 0, "shareDistributionInstruction": "Full", "total": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "requiredPoints": { "awardsType": "string", "points": 0 }, "effectiveRate": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "start": "2020-07-13", "end": "2020-07-13" } ], "rateRange": [ { "base": [ { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true } ], "rateChange": true } ] }, "packages": [ { "amount": { "amount": 0, "currencyCode": "string" }, "allowance": { "amount": 0, "currencyCode": "string" }, "description": [ "string" ], "startDate": "2020-07-13", "endDate": "2020-07-13", "packageCode": "string", "calculationRule": "string", "postingRhythm": "string", "quantity": 0, "includedInRate": true, "addRateSeprateLine": true, "addRateCombinedLine": true, "startTime": "string", "endTime": "string", "sellSeparate": true } ], "stayProfiles": [ { "profileIdList": [ { "id": "string", "type": "string" } ], "profile": { "customer": { "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" } ], "anonymization": { "anonymizationStatus": "Requested", "anonymizationDate": "2020-07-13T08:42:51.099Z" }, "citizenCountry": { "value": "string", "code": "string" }, "identifications": { "identificationInfo": [ { "identification": { "idType": "string", "idNumber": "string", "idNumberMasked": "string", "issuedCountry": "string", "issuedDate": "2020-07-13", "issuedPlace": "string", "expirationDate": "2020-07-13", "registeredProperty": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profession": "string", "alienInfo": { "alienRegistrationNo": "string", "immigrationStatus": "string", "visaValidityType": "string" }, "birthCountry": { "value": "string", "code": "string" }, "legalCompany": "string", "companyInfo": { "legalCompany": "string", "department": "string", "position": "string" }, "businessTitle": "string", "gender": "Male", "birthDate": "2020-07-13", "birthDateMasked": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "customerValue": "string", "creditRating": "string", "vipStatus": "string", "vipDescription": "string", "birthPlace": "string", "privateProfile": true, "blacklist": true }, "company": { "companyName": "string", "companyName2": "string", "companyName3": "string", "alternateName": "string", "alternateLanguage": "string", "businessLocale": "string", "iATAInfo": { "iATACompany": "string", "iATAConsortia": "string", "iATAValidationResult": true }, "businessTitle": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "commissionCode": "string", "creditRating": "string", "corporateIdType": "string", "vipStatus": "string", "vipDescription": "string", "blacklist": true }, "profileImage": { "language": "string", "imageSet": "string", "sequenceId": 0, "imageStyle": "Full", "imageType": "string", "hotelId": "string", "chainCode": "string", "imageURL": "string", "description": "string", "imageOrder": 0, "website": "string" }, "addresses": { "addressInfo": [ { "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-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "businessSegments": [ "string" ], "territory": "string", "traceCode": "string", "ownerCode": "string", "influenceCode": "string", "telephones": { "telephoneInfo": [ { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "uRLs": { "uRLInfo": [ { "url": { "type": "string", "typeDescription": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "comments": { "commentInfo": [ { "comment": { "text": { "value": "string", "language": "string" }, "image": "string", "url": "string", "commentTitle": "string", "notificationLocation": "string", "type": "string", "typeDescription": "string", "internal": true, "confidential": true, "overrideInternal": true, "protectDescription": true, "hotelId": "string", "actionType": "string", "actionDate": "2020-07-13", "createDateTime": "2020-07-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "createDateTime": "2020-07-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profileMemberships": { "profileMembership": [ { "comment": { "text": { "value": "string", "language": "string" }, "image": "string", "url": "string" }, "newMembershipNumber": "string", "nameOnCard": "string", "programDescription": "string", "membershipLevel": "string", "membershipLevelDescription": "string", "membershipClass": "string", "earningPreference": "Points", "inactive": true, "benefits": [ { "code": "string", "message": "string", "inactive": true } ], "tierAdministration": "Disabled", "downgrade": "Grace", "reIssueNewCard": "Pending", "excludeFromBatch": true, "upgradeDescription": "string", "downgradeDescription": "string", "rating": "string", "membershipEnrollmentCode": "string", "memberStatus": "string", "currentPoints": 0, "pointsLabel": "string", "enrollmentSource": "string", "enrollmentResort": "string", "preferredCard": true, "membershipId": "string", "membershipType": "string", "primaryMembershipYn": "string", "primaryMembership": true, "membershipIdNo": 0, "playerRanking": 0, "centralSetup": true, "signupDate": "2020-07-13", "effectiveDate": "2020-07-13", "expireDate": "2020-07-13", "expireDateExclusiveIndicator": true, "orderSequence": 0, "createDateTime": "2020-07-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "preferenceCollection": { "preferenceType": [ { "preference": [ { "preferenceValue": "string", "description": "string", "global": true, "source": "string", "hotels": [ "string" ], "preferenceId": "string", "excludedPreferencesCount": 0 } ], "preferenceType": "string", "preferenceTypeDescription": "string", "sequence": "string", "maxQuantity": 0, "availableQuantity": 0, "maxResortUsedQuantity": 0, "reservationPreference": true, "createDateTime": "2020-07-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "keywords": { "keyword": [ { "keywordDetail": { "newKeyword": "string" }, "type": "string", "keyword": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "negotiatedRates": { "negotiatedRate": [ { "negotiatedInfoList": [ { "corporateAgreementId": "string", "comissionCode": "string", "order": 0, "inactive": true, "start": "2020-07-13", "end": "2020-07-13" } ], "hotelId": "string", "rateCode": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "gdsNegotiatedRates": { "gdsNegotiatedRate": [ { "gdsNegotiatedInfoList": [ { "accessCode": "string", "order": 0, "inactive": true, "start": "2020-07-13", "end": "2020-07-13" } ], "bookingChannelCode": "string", "hotelId": "string", "channelRatePlanCode": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profileIndicators": [ { "indicatorName": "string", "count": 0 } ], "relationships": { "relationship": [ { "changeRelationship": { "id": "string", "relation": "string", "relationDescription": "string", "targetRelation": "string", "targetRelationDescription": "string" }, "relationshipProfile": { "customer": { "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" } ], "anonymization": { "anonymizationStatus": "Requested", "anonymizationDate": "2020-07-13T08:42:51.100Z" }, "citizenCountry": { "value": "string", "code": "string" }, "identifications": { "identificationInfo": [ { "identification": { "idType": "string", "idNumber": "string", "idNumberMasked": "string", "issuedCountry": "string", "issuedDate": "2020-07-13", "issuedPlace": "string", "expirationDate": "2020-07-13", "registeredProperty": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profession": "string", "alienInfo": { "alienRegistrationNo": "string", "immigrationStatus": "string", "visaValidityType": "string" }, "birthCountry": { "value": "string", "code": "string" }, "legalCompany": "string", "companyInfo": { "legalCompany": "string", "department": "string", "position": "string" }, "businessTitle": "string", "gender": "Male", "birthDate": "2020-07-13", "birthDateMasked": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "customerValue": "string", "creditRating": "string", "vipStatus": "string", "vipDescription": "string", "birthPlace": "string", "privateProfile": true, "blacklist": true }, "company": { "companyName": "string", "companyName2": "string", "companyName3": "string", "alternateName": "string", "alternateLanguage": "string", "businessLocale": "string", "iATAInfo": { "iATACompany": "string", "iATAConsortia": "string", "iATAValidationResult": true }, "businessTitle": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "commissionCode": "string", "creditRating": "string", "corporateIdType": "string", "vipStatus": "string", "vipDescription": "string", "blacklist": true }, "telephone": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "address": { "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-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "email": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "uRLs": { "url": { "type": "string", "typeDescription": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" }, "primaryOwner": { "hotel": { "code": "string", "description": "string" }, "userId": { "id": "string", "type": "string" }, "userName": "string", "ownerCode": "string", "profileId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "name": { "namePrefix": "string", "givenName": "string", "middleName": "string", "surname": "string", "nameSuffix": "string", "nameTitle": "string", "nameTitleSuffix": 0, "envelopeGreeting": "string", "salutation": "string", "nameType": "Primary", "language": "string", "externalSystem": "string" }, "department": { "code": "string", "description": "string" }, "email": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "phone": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T08:42:51.100Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.100Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "relationship": { "code": "string", "description": "string" }, "primary": true }, "profileIdList": [ { "id": "string", "type": "string" } ], "changeProfileIdList": [ { "id": "string", "type": "string" } ], "primary": "string", "id": "string", "statusCode": "Active", "profileType": "Guest" }, "masterAccountInfo": { "masterAccountId": { "id": "string", "type": "string" }, "masterAccountName": "string" }, "id": "string", "relation": "string", "relationDescription": "string", "targetRelation": "string", "targetRelationDescription": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "reservationInfoList": { "historyList": { "reservationInfo": [ { "reservationIdList": [ { "id": "string", "type": "string" } ], "roomStay": { "arrivalDate": "2020-07-13", "departureDate": "2020-07-13", "originalTimeSpan": { "startDate": "2020-07-13", "endDate": "2020-07-13", "duration": "string" }, "expectedTimes": { "reservationExpectedArrivalTime": "2020-07-13T08:42:51.101Z", "reservationExpectedDepartureTime": "2020-07-13T08:42:51.101Z" }, "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-13", "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-13", "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-13T08:42:51.101Z" }, "accompanyGuests": [ { "firstName": "string", "lastName": "string", "fullName": "string", "registrationCardNo": "string", "profileIdList": [ { "id": "string", "type": "string" } ] } ], "externalInfo": { "givenName": "string", "surname": "string" }, "guestLastStayInfo": { "lastStayDate": "2020-07-13", "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": [ { "name": "string", "profileIdList": [ { "id": "string", "type": "string" } ], "reservationProfileType": "Company" } ], "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-13", "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" }, "percent": 0 }, "emailFolioInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T08:42:51.102Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.102Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "emailFolio": true, "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-13T08:42:51.102Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.102Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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" }, "balance": { "amount": 0, "currencyCode": "string" }, "paymentMethod": "string", "folioWindowNo": 0 } ], "specials": "string", "lastPrivacyPromptDate": "2020-07-13", "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-13", "endDate": "2020-07-13", "duration": "string", "durationInSeconds": 0 }, "guestTextInfo": { "sentTime": "2020-07-13T08:42:51.102Z", "sentBy": "string" }, "priority": 0, "averageQueueTimeToCheckIn": 0, "averageQueueTimeCurrentReservations": 0, "queueDate": "2020-07-13" }, "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-13" }, "linenChange": true, "turndownRequested": true, "serviceTime": "2020-07-13", "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" } }, "billingPrivileges": { "postingRestriction": true, "preStayCharging": true, "postStayCharging": true, "folioCloseDate": "2020-07-13", "scheduledCheckout": true, "scheduledCheckoutTime": "2020-07-13", "directBillAuthorized": true, "videoCheckout": true, "allowAutoCheckin": true, "autoSettlement": true, "autoSettlementType": "string", "autoSettlementFreq": 0, "creditLimitAutoPay": true }, "taxType": { "hotelId": "string", "code": "string", "description": "string", "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, "minimumLengthOfStay": 0, "taxExemptNo": "string" }, "bedTaxReporting": { "taxRegistrationNo": 0, "visaNumber": "string", "visaIssueDate": "2020-07-13", "visaExpiryDate": "2020-07-13", "taxableDays": 0 }, "folioTexts": { "folioText": [ { "text": "string", "row": 0 } ] }, "periodicFolio": { "lastSettlementDate": "2020-07-13", "lastFolioDate": "2020-07-13", "frequency": 0 }, "compAccounting": { "compType": "string", "authorizer": "string" }, "reservationPreConfiguredRoutingInstruction": { "ratePlanCode": "string", "profileType": "Company", "promotionCode": "string" }, "financiallyResponsible": true, "proratedBilling": true, "lastRoomAndTaxPostedDate": "2020-07-13", "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-13", "postingDate": "2020-07-13", "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" }, "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-13T08:42:51.102Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.102Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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-13T08:42:51.102Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.102Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 } }, "advanceCheckIn": { "advanceCheckedIn": true, "expectedReturnTime": "2020-07-13T08:42:51.102Z", "eTRComments": "string" }, "welcomeOffer": true, "cancellationInfo": { "description": "string", "code": "string", "date": "2020-07-13" }, "keyCount": 0, "hotelId": "string", "hotelName": "string", "expectedServiceTime": "string", "roomStayReservation": true, "createDateTime": "2020-07-13T08:42:51.102Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.102Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "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 }, "futureList": { "reservationInfo": [ { "reservationIdList": [ { "id": "string", "type": "string" } ], "roomStay": { "arrivalDate": "2020-07-13", "departureDate": "2020-07-13", "originalTimeSpan": { "startDate": "2020-07-13", "endDate": "2020-07-13", "duration": "string" }, "expectedTimes": { "reservationExpectedArrivalTime": "2020-07-13T08:42:51.102Z", "reservationExpectedDepartureTime": "2020-07-13T08:42:51.102Z" }, "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-13", "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-13", "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-13T08:42:51.102Z" }, "accompanyGuests": [ { "firstName": "string", "lastName": "string", "fullName": "string", "registrationCardNo": "string", "profileIdList": [ { "id": "string", "type": "string" } ] } ], "externalInfo": { "givenName": "string", "surname": "string" }, "guestLastStayInfo": { "lastStayDate": "2020-07-13", "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": [ { "name": "string", "profileIdList": [ { "id": "string", "type": "string" } ], "reservationProfileType": "Company" } ], "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-13", "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" }, "percent": 0 }, "emailFolioInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T08:42:51.103Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.103Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "emailFolio": true, "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-13T08:42:51.103Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.103Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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" }, "balance": { "amount": 0, "currencyCode": "string" }, "paymentMethod": "string", "folioWindowNo": 0 } ], "specials": "string", "lastPrivacyPromptDate": "2020-07-13", "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-13", "endDate": "2020-07-13", "duration": "string", "durationInSeconds": 0 }, "guestTextInfo": { "sentTime": "2020-07-13T08:42:51.103Z", "sentBy": "string" }, "priority": 0, "averageQueueTimeToCheckIn": 0, "averageQueueTimeCurrentReservations": 0, "queueDate": "2020-07-13" }, "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-13" }, "linenChange": true, "turndownRequested": true, "serviceTime": "2020-07-13", "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" } }, "billingPrivileges": { "postingRestriction": true, "preStayCharging": true, "postStayCharging": true, "folioCloseDate": "2020-07-13", "scheduledCheckout": true, "scheduledCheckoutTime": "2020-07-13", "directBillAuthorized": true, "videoCheckout": true, "allowAutoCheckin": true, "autoSettlement": true, "autoSettlementType": "string", "autoSettlementFreq": 0, "creditLimitAutoPay": true }, "taxType": { "hotelId": "string", "code": "string", "description": "string", "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, "minimumLengthOfStay": 0, "taxExemptNo": "string" }, "bedTaxReporting": { "taxRegistrationNo": 0, "visaNumber": "string", "visaIssueDate": "2020-07-13", "visaExpiryDate": "2020-07-13", "taxableDays": 0 }, "folioTexts": { "folioText": [ { "text": "string", "row": 0 } ] }, "periodicFolio": { "lastSettlementDate": "2020-07-13", "lastFolioDate": "2020-07-13", "frequency": 0 }, "compAccounting": { "compType": "string", "authorizer": "string" }, "reservationPreConfiguredRoutingInstruction": { "ratePlanCode": "string", "profileType": "Company", "promotionCode": "string" }, "financiallyResponsible": true, "proratedBilling": true, "lastRoomAndTaxPostedDate": "2020-07-13", "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-13", "postingDate": "2020-07-13", "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" }, "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-13T08:42:51.103Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.103Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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-13T08:42:51.103Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.103Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 } }, "advanceCheckIn": { "advanceCheckedIn": true, "expectedReturnTime": "2020-07-13T08:42:51.103Z", "eTRComments": "string" }, "welcomeOffer": true, "cancellationInfo": { "description": "string", "code": "string", "date": "2020-07-13" }, "keyCount": 0, "hotelId": "string", "hotelName": "string", "expectedServiceTime": "string", "roomStayReservation": true, "createDateTime": "2020-07-13T08:42:51.103Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.103Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "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 } }, "lastStayInfo": { "lastVisit": "2020-07-13", "lastRoom": "string", "lastRate": { "amount": 0, "currencyCode": "string" }, "totalStay": 0 }, "profileAccessType": { "chainCode": "string", "croCode": "string", "hotelId": "string", "sharedLevel": "Global" }, "profileRestrictions": { "reason": "string", "reasonDescription": "string", "restricted": true }, "mailingActions": { "mailingAction": [ { "code": "string", "description": "string" } ], "active": true, "hasMore": true, "totalResults": 0, "count": 0 }, "privacyInfo": { "marketResearchParticipation": true, "lastPrivacyPromptDate": "2020-07-13", "infoFromThirdParty": true, "autoEnrollLoyaltyProgram": true, "allowPhone": true, "allowSMS": true, "allowEmail": true, "optInMailingList": true, "optInMarketResearch": true, "optInThirdParty": true, "optInAutoEnrollmentMember": true, "optInPhone": true, "optInSms": true, "optInEmail": true }, "cashiering": { "directBillingList": [ { "hotelId": "string", "aRNumber": "string" } ], "autoFolioSettlementType": "string", "paymentDueDays": 0, "taxPercent1": 0, "taxPercent2": 0, "taxPercent3": 0, "taxPercent4": 0, "taxPercent5": 0, "arNoCentral": "string", "referenceCurrency": "string", "vATOffsetYN": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0 }, "commissionInfoList": [ { "hotelId": "string", "commissionCode": "string", "bankAccount": "string", "paymentMethod": "Cent", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0 } ], "userDefinedFields": { "characterUDFs": [ { "name": "string", "value": "string", "alternateName": "string" } ], "numericUDFs": [ { "name": "string", "value": 0, "alternateName": "string" } ], "dateUDFs": [ { "name": "string", "value": "2020-07-13", "alternateName": "string" } ] }, "webUserAccounts": [ { "securityQuestion": { "code": "string", "description": "string" }, "securityAnswer": "string", "comments": "string", "history": { "createDateTime": "2020-07-13T08:42:51.104Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.104Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "lastLogin": "2020-07-13", "lastPasswordChange": "2020-07-13", "inactiveDate": "2020-07-13" }, "newLoginName": "string", "newPassword": "string", "autoGeneratePassword": true, "loginName": "string", "domainCode": "string", "locked": true, "inactive": true } ], "taxInfo": { "tax1No": "string", "tax2No": "string", "taxCategory": "string", "taxOffice": "string", "taxType": "string", "businessId": "string", "businessRegistration": "string" }, "salesInfo": { "scope": "string", "scopeCity": "string", "accountType": "string", "accountSource": "string", "industryCode": "string", "businessSegments": "string", "priority": "string", "roomsPotential": "string", "actionCode": "string", "competitionCode": "string", "influence": "string", "preferredRoom": "string", "hotelId": "string" }, "eCertificates": [ { "certificateId": 0, "voucherNo": "string", "certificateNo": "string", "eCertificateInfo": { "certificateType": "string", "membershipType": "string", "awardCode": "string", "promotionCode": "string", "voucherBenefitCode": "string", "hotels": { "code": [ "string" ], "scope": "Global" }, "description": "string", "longDescription": "string", "label": "string", "maxExtensionAllowed": 0, "usageCriteria": { "reservation": true, "web": true, "webAllowed": true, "benefit": true, "hotel": true, "verifyCertificateNo": true, "cancelAllowed": true, "generateInLieuCertificate": true }, "value": { "amount": 0, "currencyCode": "string" }, "cost": { "amount": 0, "currencyCode": "string" }, "benefitSummary": "string" }, "expiryDate": "2020-07-13", "newExpiryDate": "2020-07-13", "profileId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "consumptionDetail": { "hotelId": "string", "source": "Central", "surname": "string", "firstName": "string", "middleName": "string", "email": "string", "date": "2020-07-13", "userName": "string", "userNotes": "string", "referenceId": { "id": "string", "type": "string" }, "locationType": "string", "authorizationCode": "string", "serviceDate": "2020-07-13" }, "status": "Cancelled", "printed": true, "inactiveDate": "2020-07-13", "awardId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "databaseId": "string", "source": "Opera", "issueType": "Assigned", "issueDate": "2020-07-13", "awardPoints": 0, "generationDetail": { "ruleId": { "id": "string", "type": "string" }, "generationDetail": "string", "referenceValue": "string" }, "originalVoucherNo": "string", "originalCertificateNo": "string", "inLieuSequence": 0, "cancelRequestDate": "2020-07-13", "extensionCount": 0 } ], "subscriptions": [ { "profileId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "externalProfileId": { "id": "string", "type": "string" }, "profileInfo": { "name": "string", "fullName": "string", "namePrefix": "string", "givenName": "string", "middleName": "string", "nameSuffix": "string", "nameTitle": "string", "nameType": "Primary", "profileType": "Guest" }, "distributed": true, "force": true, "subscriptionDate": "2020-07-13T08:42:51.104Z", "lastDistributionDate": "2020-07-13T08:42:51.104Z", "lastExternalUpdateDate": "2020-07-13T08:42:51.104Z", "inactive": true } ], "localizationGuestType": "string", "eligibleForFiscalFolio": "string", "profileType": "Guest", "statusCode": "Active", "registeredProperty": "string", "requestForHotel": "string", "protectedBy": "string", "createDateTime": "2020-07-13T08:42:51.104Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T08:42:51.104Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "markAsRecentlyAccessed": true, "markForHistory": true, "hasCommission": true, "inheritedNegRates": true }, "reservationProfileType": "Company" } ], "guestCounts": { "childAges": [ { "age": 0 } ], "childBuckets": { "bucket1Count": 0, "bucket2Count": 0, "bucket3Count": 0, "bucket4Count": 0, "bucket5Count": 0 }, "adults": 0, "children": 0 }, "taxFreeGuestCounts": { "childAges": [ { "age": 0 } ], "childBuckets": { "bucket1Count": 0, "bucket2Count": 0, "bucket3Count": 0, "bucket4Count": 0, "bucket5Count": 0 }, "adults": 0, "children": 0 }, "awards": { "membershipNo": { "id": "string", "type": "string" }, "awardVouchers": { "awardVoucher": [ { "awardCode": "string", "voucherNo": "string" } ] }, "originalRoomType": "string", "upgradeRoomType": "string" }, "foreignExchange": { "type": "string", "effectiveDate": "2020-07-13" }, "reservationBlock": { "blockIdList": [ { "id": "string", "type": "string" } ], "blockName": "string", "hotelId": "string" }, "roomRateInfo": "string", "mealPlans": [ { "code": "string", "included": true, "breakfastIncluded": true, "lunchIncluded": true, "dinnerIncluded": true } ], "roomType": "string", "ratePlanCode": "string", "promotionCode": "string", "start": "2020-07-13", "end": "2020-07-13", "availability": "Available", "suppressRate": true, "marketCode": "string", "marketCodeDescription": "string", "sourceCode": "string", "sourceCodeDescription": "string", "numberOfUnits": 0, "roomId": "string", "pseudoRoom": true, "roomTypeCharged": "string", "commissionCode": "string", "commissionable": true, "houseUseOnly": true, "complimentary": true, "inventoryLender": "string", "fixedRate": true, "barRanking": 0, "rateGroup": "string", "discountAllowed": true, "bogoDiscount": true, "rateLevel": "string", "commissionPercentage": 0, "commissionAmount": 0, "credentialsRequired": true, "taxIncluded": true, "rateDescription": "string" } ], "guestCounts": { "childAges": [ { "age": 0 } ], "childBuckets": { "bucket1Count": 0, "bucket2Count": 0, "bucket3Count": 0, "bucket4Count": 0, "bucket5Count": 0 }, "adults": 0, "children": 0 }, "arrivalDate": "2020-07-13", "departureDate": "2020-07-13", "expectedTimes": { "reservationExpectedArrivalTime": "2020-07-13T08:42:51.104Z", "reservationExpectedDepartureTime": "2020-07-13T08:42:51.104Z" }, "originalTimeSpan": { "startDate": "2020-07-13", "endDate": "2020-07-13", "duration": "string" }, "guarantee": { "guaranteeCode": "string", "shortDescription": "string", "onHold": true }, "promotion": { "promotionCode": "string", "promotionName": "string", "couponCode": "string" }, "suiteWith": "string", "total": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "totalPoints": { "awardsType": "string", "points": 0 }, "multiValueAttrs": [ "string" ], "upsellInfo": { "originalInfo": { "rateCode": "string", "totalAmount": { "amount": 0, "currencyCode": "string" }, "roomType": { "code": "string", "description": "string" }, "nights": 0 }, "upsellInfo": { "totalUpsellCharge": { "amount": 0, "currencyCode": "string" }, "totalUpsellMoneyAmount": { "amount": 0, "currencyCode": "string" }, "firstNightUpsellAmount": { "amount": 0, "currencyCode": "string" }, "firstNightUpsellCharge": { "amount": 0, "currencyCode": "string" }, "totalUpsellPoints": 0, "totalActualRateAmount": { "amount": 0, "currencyCode": "string" }, "roomType": { "code": "string", "description": "string" }, "roomLongDescription": "string", "ruleId": 0, "ruleCode": "string", "ruleDescription": "string", "percentageSavings": 0, "upsellDate": "2020-07-13", "upsellUser": "string" } }, "mobileNotifications": { "roomReady": "Pending", "keyReady": "Pending", "checkoutMessageReceived": true, "requiresAction": true, "errorMessage": "string" }, "roomNumberLocked": true, "printRate": true, "primaryShareType": "Primary", "remoteCheckInAllowed": true, "bookingMedium": "string", "bookingMediumDescription": "string" } ] }, "channelSummaryInfo": { "bookingChannel": { "channelCode": "string", "channelName": "string", "channelType": "string" }, "messageId": "string", "summaryOnly": true }, "sellMessages": { "sellMessage": [ { "message": "string", "croCode": "string", "chainCode": "string", "hotelId": "string", "roomType": "string", "ratePlanCode": "string", "languageCode": "string", "stickyFlagYn": "string", "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 } ], "hasMore": true, "totalResults": 0, "count": 0 }, "currencyExchangeRates": [ { "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "description": "string", "exchangeRate": { "amount": 0, "currencyCode": "string" } } ], "chainCode": "string", "hotelId": "string", "hotelCityCode": "string", "hotelName": "string", "hotelCodeContext": "string", "chainName": "string", "hotelType": "string", "negotiated": true, "alternate": true, "displayOrder": 0, "inventoryRooms": 0, "availableRooms": 0, "physicalRooms": 0, "checkInTime": "2022-11-18T15:00:10.503Z", "checkOutTime": "2022-11-18T15:00:10.503Z", "timeZoneRegion": "string", "currencyCode": "USD", "numberOfEvents": 0 } ] }, "links": [ { "href": "string", "rel": "string", "templated": false, "method": "GET", "targetSchema": "string", "operationId": "string", "title": "string" } ] } } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/analyzeRateAvailability": { "get": { "summary": "Analyze Rate Availability ", "description": "This API allows to Analyze Rate Availability. Rate analysis request to include the rate code, room type and room span to analyze whether a rate is closed and the reasons.OperationId:analyzeRateAvailability
This API allows a time span of 90 days.
", "operationId": "analyzeRateAvailability", "deprecated": true, "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "ratePlanCode", "in": "query", "required": false, "description": "The Rate Code for which the Analysis is requested.", "type": "string" }, { "name": "roomType", "in": "query", "required": false, "description": "The Room Type for which the Analysis is requested. Analysis is done to determine whether the Rate Code is available for this Room Type.", "type": "string" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "duration", "in": "query", "required": false, "type": "string" }, { "name": "numberOfRooms", "in": "query", "required": false, "description": "The number of rooms requested. The Analysis to check if this Rate Code is available for this number of rooms.", "type": "integer" }, { "name": "adults", "in": "query", "required": false, "description": "Defines the number of Adults.", "type": "integer" }, { "name": "children", "in": "query", "required": false, "description": "Defines the number of Children.", "type": "integer" }, { "name": "childAge", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Age of a child in years.", "items": { "type": "integer" }, "required": false }, { "name": "bucket1Count", "in": "query", "required": false, "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1).", "type": "integer" }, { "name": "bucket2Count", "in": "query", "required": false, "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2).", "type": "integer" }, { "name": "bucket3Count", "in": "query", "required": false, "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3).", "type": "integer" }, { "name": "bucket4Count", "in": "query", "required": false, "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).", "type": "integer" }, { "name": "bucket5Count", "in": "query", "required": false, "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).", "type": "integer" }, { "name": "blockId", "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": "blockIdType", "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" }, "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" }, "required": false }, { "name": "controlSegment", "in": "query", "required": false, "description": "Control Segment to check for casino restrction for a patron profile.", "type": "string" }, { "name": "reservationGuestId", "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" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response to the fetch Rate Availability Analysis.", "schema": { "$ref": "#/definitions/rateAnalysisDetails" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/analyzeRateAvailability/searches": { "post": { "summary": "Analyze Rate Availability ", "description": "This API allows to Analyze Rate Availability. Rate analysis request to include the rate code, room type and room span to analyze whether a rate is closed and the reasons.OperationId:searchAnalyzeRateAvailability
This API allows a time span of 90 days.
", "operationId": "searchAnalyzeRateAvailability", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "in": "body", "name": "searchAnalyzeRateAvailabilityRequest", "description": "Analyze Rate Availability Request", "required": false, "schema": { "$ref": "#/definitions/searchAnalyzeRateAvailabilityRequest" } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response to the fetch Rate Availability Analysis.", "schema": { "$ref": "#/definitions/rateAnalysisDetails" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/availability": { "get": { "summary": "Get Hotel Availability", "description": " This API fetches hotel availability for any specific hotel, given dates, rate plans, rate category, rate group, membership rates, and number of people. It returns a list of available rate plan codes, room types, and room rates for any given search criteria.OperationId:getHotelAvailability
This API allows a time span of 90 days.
", "operationId": "getHotelAvailability", "deprecated": true, "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "includeLocalRates", "in": "query", "required": false, "description": "Used to indicate if local rates are to be included in the Rate Plan set.", "type": "boolean" }, { "name": "includeOffshoreRates", "in": "query", "required": false, "description": "Used to indicate if offshore rates are to be included in the Rate Plan set.", "type": "boolean" }, { "name": "cro", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Central reservation office Code who is requesting Rate Availability.", "items": { "type": "string" }, "required": false }, { "name": "includeClosedRates", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Used to indicate if closed rates are to be included in the Rate Plan set.", "items": { "type": "boolean" }, "required": false }, { "name": "includeDefaultRatePlanSet", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Used to indicate if the configured default rate plan set will be included.", "items": { "type": "boolean" }, "required": false }, { "name": "includeNoRatePlanSet", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Includes the rate codes which do not have a rate plan set associated. This parameter is applicable when the property has not configured a default rate plan set.", "items": { "type": "boolean" }, "required": false }, { "name": "initialRatePlanSet", "in": "query", "type": "array", "collectionFormat": "multi", "description": "If InitialRatePlanSet is set to true response will return most relevant Rate Plan Set(e.g. NEGOTIATED if profiles has Negotiated Rates) depending on the request. if request does not requires special Rate Plan Set, it will return default Rate Plan Set if RatePlanSet value is not set.", "items": { "type": "boolean" }, "required": false }, { "name": "limit", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Indicates maximum number of records a Web Service should return.", "items": { "type": "integer" }, "required": false }, { "name": "pagePointerKey", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Specifies fetched record's key as pointer to fetch additional records from. If key is composite use comma separated string.", "items": { "type": "string" }, "required": false }, { "name": "ratePlanSet", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Rate Plan Set code to filter Rate Plans based on the predefined set. if not specified it will not filter any Rate Plans by Rate Plan Set. When InitialRatePlanSet is true response may not always return Rate Plans for the supplied Rate Plan Set(See InitialRatePlanSet documentation).", "items": { "type": "string" }, "required": false }, { "name": "redeemAwards", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Used to indicate if the awards are to be redeemed.", "items": { "type": "boolean" }, "required": false }, { "name": "roomStayStartDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "roomStayEndDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "roomStayQuantity", "in": "query", "required": false, "type": "integer" }, { "name": "adults", "in": "query", "required": false, "description": "Defines the number of Adults.", "type": "integer" }, { "name": "children", "in": "query", "required": false, "description": "Defines the number of Children.", "type": "integer" }, { "name": "childAge", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Age of a child in years.", "items": { "type": "integer" }, "required": false }, { "name": "bucket1Count", "in": "query", "required": false, "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1).", "type": "integer" }, { "name": "bucket2Count", "in": "query", "required": false, "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2).", "type": "integer" }, { "name": "bucket3Count", "in": "query", "required": false, "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3).", "type": "integer" }, { "name": "bucket4Count", "in": "query", "required": false, "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).", "type": "integer" }, { "name": "bucket5Count", "in": "query", "required": false, "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).", "type": "integer" }, { "name": "fullStayTimeSpanStartDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "fullStayTimeSpanEndDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "prevailingRate", "in": "query", "required": false, "type": "boolean" }, { "name": "rateCategory", "in": "query", "required": false, "type": "string" }, { "name": "rateClass", "in": "query", "required": false, "type": "string" }, { "name": "rateGroup", "in": "query", "required": false, "type": "string" }, { "name": "ratePlanCode", "in": "query", "type": "array", "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "promotionCode", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Promotion code associated with the rate plan.", "items": { "type": "string" }, "required": false }, { "name": "roomType", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "feature", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "items": { "type": "string" }, "required": false }, { "name": "reservationGuestId", "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": "reservationGuestIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "reservationProfileType", "in": "query", "type": "array", "collectionFormat": "multi", "uniqueItems": true, "items": { "type": "string", "enum": [ "Guest", "Company", "Group", "TravelAgent", "Source", "ReservationContact", "BillingContact", "Addressee" ] }, "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" }, "required": false }, { "name": "hotelReservationId", "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": "hotelReservationIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "ratePlanInfo", "in": "query", "required": false, "description": "If true Rate Plan Code Master information will be included in the response.", "type": "boolean" }, { "name": "returnOnlyAvailableRateCodes", "in": "query", "required": false, "description": "If true Only availability check will be done and it will return available rate codes.", "type": "boolean" }, { "name": "resGuaranteeInfo", "in": "query", "required": false, "description": "If true Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true.", "type": "boolean" }, { "name": "roomTypeInfo", "in": "query", "required": false, "description": "If true Room Type Master information will be included in the response.", "type": "boolean" }, { "name": "membershipIdNumber", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Membership id Number of the guest.", "items": { "type": "integer" }, "required": false }, { "name": "membershipLevel", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Membership id Number of the guest.", "items": { "type": "string" }, "required": false }, { "name": "membershipType", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Membership id Number of the guest.", "items": { "type": "string" }, "required": false }, { "name": "pointsAvailable", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Used to indicate Points Available for Profile Primary Membership Type.", "items": { "type": "integer" }, "required": false }, { "name": "membershipCardNumber", "in": "query", "type": "array", "collectionFormat": "multi", "required": false, "description": "Member Card number associated with the guest membership.", "items": { "type": "string" } }, { "name": "smokingPreference", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Smoking preference to search a reservation. This is compared to the preference on the guest profile of the reservation.", "items": { "type": "string" }, "required": false }, { "name": "hotelPackage", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Hotel Package Code to filter the search result.", "items": { "type": "string" }, "required": false }, { "name": "ownerType", "in": "query", "required": false, "type": "string", "uniqueItems": true, "enum": [ "Owner", "Referral", "Regular" ], "description": "Owner Room Type - can be either Owner or Referral" }, { "name": "controlSegment", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "required": false, "description": "Control Segment to check for casino restrction for a patron profile.", "items": { "type": "string" } }, { "name": "postingInterval", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Optional posting interval filter. When nothing is provided in this filter then only Nightly rates will be returned", "uniqueItems": true, "items": { "type": "string", "enum": [ "Nightly", "Weekly", "Monthly" ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object to search hotel availability based on request segment.", "schema": { "$ref": "#/definitions/hotelAvailability" }, "examples": { "application/json": { "hotelAvailability": [ { "roomStays": [ { "roomRates": [ { "total": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "totalPoints": { "awardsType": "string", "points": 0 }, "rates": { "rate": [ { "base": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "additionalGuestAmounts": [ { "amount": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "ageQualifyingCode": "ADULT" } ], "discount": { "discountReason": "string", "percent": 0, "amount": 0, "currencyCode": "string", "discountCode": "string" }, "shareRatePercentage": 0, "shareDistributionInstruction": "Full", "total": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "requiredPoints": { "awardsType": "string", "points": 0 }, "effectiveRate": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "start": "2020-07-13", "end": "2020-07-13" } ], "rateRange": [ { "base": [ { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true } ], "rateChange": true } ] }, "packages": [ { "amount": { "amount": 0, "currencyCode": "string" }, "allowance": { "amount": 0, "currencyCode": "string" }, "description": [ "string" ], "startDate": "2020-07-13", "endDate": "2020-07-13", "packageCode": "string", "calculationRule": "string", "postingRhythm": "string", "quantity": 0, "includedInRate": true, "addRateSeprateLine": true, "addRateCombinedLine": true, "startTime": "string", "endTime": "string", "sellSeparate": true } ], "stayProfiles": [ { "profileIdList": [ { "id": "string", "type": "string" } ], "profile": { "customer": { "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" } ], "anonymization": { "anonymizationStatus": "Requested", "anonymizationDate": "2020-07-13T14:53:56.497Z" }, "citizenCountry": { "value": "string", "code": "string" }, "identifications": { "identificationInfo": [ { "identification": { "idType": "string", "idNumber": "string", "idNumberMasked": "string", "issuedCountry": "string", "issuedDate": "2020-07-13", "issuedPlace": "string", "expirationDate": "2020-07-13", "registeredProperty": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profession": "string", "alienInfo": { "alienRegistrationNo": "string", "immigrationStatus": "string", "visaValidityType": "string" }, "birthCountry": { "value": "string", "code": "string" }, "legalCompany": "string", "companyInfo": { "legalCompany": "string", "department": "string", "position": "string" }, "businessTitle": "string", "gender": "Male", "birthDate": "2020-07-13", "birthDateMasked": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "customerValue": "string", "creditRating": "string", "vipStatus": "string", "vipDescription": "string", "birthPlace": "string", "privateProfile": true, "blacklist": true }, "company": { "companyName": "string", "companyName2": "string", "companyName3": "string", "alternateName": "string", "alternateLanguage": "string", "businessLocale": "string", "iATAInfo": { "iATACompany": "string", "iATAConsortia": "string", "iATAValidationResult": true }, "businessTitle": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "commissionCode": "string", "creditRating": "string", "corporateIdType": "string", "vipStatus": "string", "vipDescription": "string", "blacklist": true }, "profileImage": { "language": "string", "imageSet": "string", "sequenceId": 0, "imageStyle": "Full", "imageType": "string", "hotelId": "string", "chainCode": "string", "imageURL": "string", "description": "string", "imageOrder": 0, "website": "string" }, "addresses": { "addressInfo": [ { "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-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "businessSegments": [ "string" ], "territory": "string", "traceCode": "string", "ownerCode": "string", "influenceCode": "string", "telephones": { "telephoneInfo": [ { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "uRLs": { "uRLInfo": [ { "url": { "type": "string", "typeDescription": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "comments": { "commentInfo": [ { "comment": { "text": { "value": "string", "language": "string" }, "image": "string", "url": "string", "commentTitle": "string", "notificationLocation": "string", "type": "string", "typeDescription": "string", "internal": true, "confidential": true, "overrideInternal": true, "protectDescription": true, "hotelId": "string", "actionType": "string", "actionDate": "2020-07-13", "createDateTime": "2020-07-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "createDateTime": "2020-07-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profileMemberships": { "profileMembership": [ { "comment": { "text": { "value": "string", "language": "string" }, "image": "string", "url": "string" }, "newMembershipNumber": "string", "nameOnCard": "string", "programDescription": "string", "membershipLevel": "string", "membershipLevelDescription": "string", "membershipClass": "string", "earningPreference": "Points", "inactive": true, "benefits": [ { "code": "string", "message": "string", "inactive": true } ], "tierAdministration": "Disabled", "downgrade": "Grace", "reIssueNewCard": "Pending", "excludeFromBatch": true, "upgradeDescription": "string", "downgradeDescription": "string", "rating": "string", "membershipEnrollmentCode": "string", "memberStatus": "string", "currentPoints": 0, "pointsLabel": "string", "enrollmentSource": "string", "enrollmentResort": "string", "preferredCard": true, "membershipId": "string", "membershipType": "string", "primaryMembershipYn": "string", "primaryMembership": true, "membershipIdNo": 0, "playerRanking": 0, "centralSetup": true, "signupDate": "2020-07-13", "effectiveDate": "2020-07-13", "expireDate": "2020-07-13", "expireDateExclusiveIndicator": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "preferenceCollection": { "preferenceType": [ { "preference": [ { "preferenceValue": "string", "description": "string", "global": true, "source": "string", "hotels": [ "string" ], "preferenceId": "string", "excludedPreferencesCount": 0 } ], "preferenceType": "string", "preferenceTypeDescription": "string", "sequence": "string", "maxQuantity": 0, "availableQuantity": 0, "maxResortUsedQuantity": 0, "reservationPreference": true, "createDateTime": "2020-07-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "keywords": { "keyword": [ { "keywordDetail": { "newKeyword": "string" }, "type": "string", "keyword": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "negotiatedRates": { "negotiatedRate": [ { "negotiatedInfoList": [ { "corporateAgreementId": "string", "comissionCode": "string", "order": 0, "inactive": true, "start": "2020-07-13", "end": "2020-07-13" } ], "hotelId": "string", "rateCode": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "gdsNegotiatedRates": { "gdsNegotiatedRate": [ { "gdsNegotiatedInfoList": [ { "accessCode": "string", "order": 0, "inactive": true, "start": "2020-07-13", "end": "2020-07-13" } ], "bookingChannelCode": "string", "hotelId": "string", "channelRatePlanCode": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profileIndicators": [ { "indicatorName": "string", "count": 0 } ], "relationships": { "relationship": [ { "changeRelationship": { "id": "string", "relation": "string", "relationDescription": "string", "targetRelation": "string", "targetRelationDescription": "string" }, "relationshipProfile": { "customer": { "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" } ], "anonymization": { "anonymizationStatus": "Requested", "anonymizationDate": "2020-07-13T14:53:56.497Z" }, "citizenCountry": { "value": "string", "code": "string" }, "identifications": { "identificationInfo": [ { "identification": { "idType": "string", "idNumber": "string", "idNumberMasked": "string", "issuedCountry": "string", "issuedDate": "2020-07-13", "issuedPlace": "string", "expirationDate": "2020-07-13", "registeredProperty": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profession": "string", "alienInfo": { "alienRegistrationNo": "string", "immigrationStatus": "string", "visaValidityType": "string" }, "birthCountry": { "value": "string", "code": "string" }, "legalCompany": "string", "companyInfo": { "legalCompany": "string", "department": "string", "position": "string" }, "businessTitle": "string", "gender": "Male", "birthDate": "2020-07-13", "birthDateMasked": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "customerValue": "string", "creditRating": "string", "vipStatus": "string", "vipDescription": "string", "birthPlace": "string", "privateProfile": true, "blacklist": true }, "company": { "companyName": "string", "companyName2": "string", "companyName3": "string", "alternateName": "string", "alternateLanguage": "string", "businessLocale": "string", "iATAInfo": { "iATACompany": "string", "iATAConsortia": "string", "iATAValidationResult": true }, "businessTitle": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "commissionCode": "string", "creditRating": "string", "corporateIdType": "string", "vipStatus": "string", "vipDescription": "string", "blacklist": true }, "telephone": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "address": { "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-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "email": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "uRLs": { "url": { "type": "string", "typeDescription": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" }, "primaryOwner": { "hotel": { "code": "string", "description": "string" }, "userId": { "id": "string", "type": "string" }, "userName": "string", "ownerCode": "string", "profileId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "name": { "namePrefix": "string", "givenName": "string", "middleName": "string", "surname": "string", "nameSuffix": "string", "nameTitle": "string", "nameTitleSuffix": 0, "envelopeGreeting": "string", "salutation": "string", "nameType": "Primary", "language": "string", "externalSystem": "string" }, "department": { "code": "string", "description": "string" }, "email": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "phone": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.497Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.497Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "relationship": { "code": "string", "description": "string" }, "primary": true }, "profileIdList": [ { "id": "string", "type": "string" } ], "changeProfileIdList": [ { "id": "string", "type": "string" } ], "primary": "string", "id": "string", "statusCode": "Active", "profileType": "Guest" }, "masterAccountInfo": { "masterAccountId": { "id": "string", "type": "string" }, "masterAccountName": "string" }, "id": "string", "relation": "string", "relationDescription": "string", "targetRelation": "string", "targetRelationDescription": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "reservationInfoList": { "historyList": { "reservationInfo": [ { "reservationIdList": [ { "id": "string", "type": "string" } ], "roomStay": { "arrivalDate": "2020-07-13", "departureDate": "2020-07-13", "originalTimeSpan": { "startDate": "2020-07-13", "endDate": "2020-07-13", "duration": "string" }, "expectedTimes": { "reservationExpectedArrivalTime": "2020-07-13T14:53:56.497Z", "reservationExpectedDepartureTime": "2020-07-13T14:53:56.497Z" }, "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-13", "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-13", "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-13T14:53:56.497Z" }, "accompanyGuests": [ { "firstName": "string", "lastName": "string", "fullName": "string", "registrationCardNo": "string", "profileIdList": [ { "id": "string", "type": "string" } ] } ], "externalInfo": { "givenName": "string", "surname": "string" }, "guestLastStayInfo": { "lastStayDate": "2020-07-13", "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": [ { "name": "string", "profileIdList": [ { "id": "string", "type": "string" } ], "reservationProfileType": "Company" } ], "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-13", "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" }, "percent": 0 }, "emailFolioInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.498Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.498Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "emailFolio": true, "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-13T14:53:56.498Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.498Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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" }, "balance": { "amount": 0, "currencyCode": "string" }, "paymentMethod": "string", "folioWindowNo": 0 } ], "specials": "string", "lastPrivacyPromptDate": "2020-07-13", "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-13", "endDate": "2020-07-13", "duration": "string", "durationInSeconds": 0 }, "guestTextInfo": { "sentTime": "2020-07-13T14:53:56.498Z", "sentBy": "string" }, "priority": 0, "averageQueueTimeToCheckIn": 0, "averageQueueTimeCurrentReservations": 0, "queueDate": "2020-07-13" }, "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-13" }, "linenChange": true, "turndownRequested": true, "serviceTime": "2020-07-13", "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" } }, "billingPrivileges": { "postingRestriction": true, "preStayCharging": true, "postStayCharging": true, "folioCloseDate": "2020-07-13", "scheduledCheckout": true, "scheduledCheckoutTime": "2020-07-13", "directBillAuthorized": true, "videoCheckout": true, "allowAutoCheckin": true, "autoSettlement": true, "autoSettlementType": "string", "autoSettlementFreq": 0, "creditLimitAutoPay": true }, "taxType": { "hotelId": "string", "code": "string", "description": "string", "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, "minimumLengthOfStay": 0, "taxExemptNo": "string" }, "bedTaxReporting": { "taxRegistrationNo": 0, "visaNumber": "string", "visaIssueDate": "2020-07-13", "visaExpiryDate": "2020-07-13", "taxableDays": 0 }, "folioTexts": { "folioText": [ { "text": "string", "row": 0 } ] }, "periodicFolio": { "lastSettlementDate": "2020-07-13", "lastFolioDate": "2020-07-13", "frequency": 0 }, "compAccounting": { "compType": "string", "authorizer": "string" }, "reservationPreConfiguredRoutingInstruction": { "ratePlanCode": "string", "profileType": "Company", "promotionCode": "string" }, "financiallyResponsible": true, "proratedBilling": true, "lastRoomAndTaxPostedDate": "2020-07-13", "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-13", "postingDate": "2020-07-13", "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" }, "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-13T14:53:56.498Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.498Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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-13T14:53:56.498Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.498Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 } }, "advanceCheckIn": { "advanceCheckedIn": true, "expectedReturnTime": "2020-07-13T14:53:56.498Z", "eTRComments": "string" }, "welcomeOffer": true, "cancellationInfo": { "description": "string", "code": "string", "date": "2020-07-13" }, "keyCount": 0, "hotelId": "string", "hotelName": "string", "expectedServiceTime": "string", "roomStayReservation": true, "createDateTime": "2020-07-13T14:53:56.498Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.498Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "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 }, "futureList": { "reservationInfo": [ { "reservationIdList": [ { "id": "string", "type": "string" } ], "roomStay": { "arrivalDate": "2020-07-13", "departureDate": "2020-07-13", "originalTimeSpan": { "startDate": "2020-07-13", "endDate": "2020-07-13", "duration": "string" }, "expectedTimes": { "reservationExpectedArrivalTime": "2020-07-13T14:53:56.498Z", "reservationExpectedDepartureTime": "2020-07-13T14:53:56.498Z" }, "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-13", "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-13", "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-13T14:53:56.498Z" }, "accompanyGuests": [ { "firstName": "string", "lastName": "string", "fullName": "string", "registrationCardNo": "string", "profileIdList": [ { "id": "string", "type": "string" } ] } ], "externalInfo": { "givenName": "string", "surname": "string" }, "guestLastStayInfo": { "lastStayDate": "2020-07-13", "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": [ { "name": "string", "profileIdList": [ { "id": "string", "type": "string" } ], "reservationProfileType": "Company" } ], "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-13", "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" }, "percent": 0 }, "emailFolioInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.498Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.498Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "emailFolio": true, "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-13T14:53:56.498Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.498Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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" }, "balance": { "amount": 0, "currencyCode": "string" }, "paymentMethod": "string", "folioWindowNo": 0 } ], "specials": "string", "lastPrivacyPromptDate": "2020-07-13", "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-13", "endDate": "2020-07-13", "duration": "string", "durationInSeconds": 0 }, "guestTextInfo": { "sentTime": "2020-07-13T14:53:56.498Z", "sentBy": "string" }, "priority": 0, "averageQueueTimeToCheckIn": 0, "averageQueueTimeCurrentReservations": 0, "queueDate": "2020-07-13" }, "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-13" }, "linenChange": true, "turndownRequested": true, "serviceTime": "2020-07-13", "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" } }, "billingPrivileges": { "postingRestriction": true, "preStayCharging": true, "postStayCharging": true, "folioCloseDate": "2020-07-13", "scheduledCheckout": true, "scheduledCheckoutTime": "2020-07-13", "directBillAuthorized": true, "videoCheckout": true, "allowAutoCheckin": true, "autoSettlement": true, "autoSettlementType": "string", "autoSettlementFreq": 0, "creditLimitAutoPay": true }, "taxType": { "hotelId": "string", "code": "string", "description": "string", "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, "minimumLengthOfStay": 0, "taxExemptNo": "string" }, "bedTaxReporting": { "taxRegistrationNo": 0, "visaNumber": "string", "visaIssueDate": "2020-07-13", "visaExpiryDate": "2020-07-13", "taxableDays": 0 }, "folioTexts": { "folioText": [ { "text": "string", "row": 0 } ] }, "periodicFolio": { "lastSettlementDate": "2020-07-13", "lastFolioDate": "2020-07-13", "frequency": 0 }, "compAccounting": { "compType": "string", "authorizer": "string" }, "reservationPreConfiguredRoutingInstruction": { "ratePlanCode": "string", "profileType": "Company", "promotionCode": "string" }, "financiallyResponsible": true, "proratedBilling": true, "lastRoomAndTaxPostedDate": "2020-07-13", "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-13", "postingDate": "2020-07-13", "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" }, "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-13T14:53:56.498Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.499Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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-13T14:53:56.499Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.499Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 } }, "advanceCheckIn": { "advanceCheckedIn": true, "expectedReturnTime": "2020-07-13T14:53:56.499Z", "eTRComments": "string" }, "welcomeOffer": true, "cancellationInfo": { "description": "string", "code": "string", "date": "2020-07-13" }, "keyCount": 0, "hotelId": "string", "hotelName": "string", "expectedServiceTime": "string", "roomStayReservation": true, "createDateTime": "2020-07-13T14:53:56.499Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.499Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "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 } }, "lastStayInfo": { "lastVisit": "2020-07-13", "lastRoom": "string", "lastRate": { "amount": 0, "currencyCode": "string" }, "totalStay": 0 }, "profileAccessType": { "chainCode": "string", "croCode": "string", "hotelId": "string", "sharedLevel": "Global" }, "profileRestrictions": { "reason": "string", "reasonDescription": "string", "restricted": true }, "mailingActions": { "mailingAction": [ { "code": "string", "description": "string" } ], "active": true, "hasMore": true, "totalResults": 0, "count": 0 }, "privacyInfo": { "marketResearchParticipation": true, "lastPrivacyPromptDate": "2020-07-13", "infoFromThirdParty": true, "autoEnrollLoyaltyProgram": true, "allowPhone": true, "allowSMS": true, "allowEmail": true, "optInMailingList": true, "optInMarketResearch": true, "optInThirdParty": true, "optInAutoEnrollmentMember": true, "optInPhone": true, "optInSms": true, "optInEmail": true }, "cashiering": { "directBillingList": [ { "hotelId": "string", "aRNumber": "string" } ], "autoFolioSettlementType": "string", "paymentDueDays": 0, "taxPercent1": 0, "taxPercent2": 0, "taxPercent3": 0, "taxPercent4": 0, "taxPercent5": 0, "arNoCentral": "string", "referenceCurrency": "string", "vATOffsetYN": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0 }, "commissionInfoList": [ { "hotelId": "string", "commissionCode": "string", "bankAccount": "string", "paymentMethod": "Cent", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0 } ], "userDefinedFields": { "characterUDFs": [ { "name": "string", "value": "string", "alternateName": "string" } ], "numericUDFs": [ { "name": "string", "value": 0, "alternateName": "string" } ], "dateUDFs": [ { "name": "string", "value": "2020-07-13", "alternateName": "string" } ] }, "webUserAccounts": [ { "securityQuestion": { "code": "string", "description": "string" }, "securityAnswer": "string", "comments": "string", "history": { "createDateTime": "2020-07-13T14:53:56.500Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.500Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "lastLogin": "2020-07-13", "lastPasswordChange": "2020-07-13", "inactiveDate": "2020-07-13" }, "newLoginName": "string", "newPassword": "string", "autoGeneratePassword": true, "loginName": "string", "domainCode": "string", "locked": true, "inactive": true } ], "taxInfo": { "tax1No": "string", "tax2No": "string", "taxCategory": "string", "taxOffice": "string", "taxType": "string", "businessId": "string", "businessRegistration": "string" }, "salesInfo": { "scope": "string", "scopeCity": "string", "accountType": "string", "accountSource": "string", "industryCode": "string", "businessSegments": "string", "priority": "string", "roomsPotential": "string", "actionCode": "string", "competitionCode": "string", "influence": "string", "preferredRoom": "string", "hotelId": "string" }, "eCertificates": [ { "certificateId": 0, "voucherNo": "string", "certificateNo": "string", "eCertificateInfo": { "certificateType": "string", "membershipType": "string", "awardCode": "string", "promotionCode": "string", "voucherBenefitCode": "string", "hotels": { "code": [ "string" ], "scope": "Global" }, "description": "string", "longDescription": "string", "label": "string", "maxExtensionAllowed": 0, "usageCriteria": { "reservation": true, "web": true, "webAllowed": true, "benefit": true, "hotel": true, "verifyCertificateNo": true, "cancelAllowed": true, "generateInLieuCertificate": true }, "value": { "amount": 0, "currencyCode": "string" }, "cost": { "amount": 0, "currencyCode": "string" }, "benefitSummary": "string" }, "expiryDate": "2020-07-13", "newExpiryDate": "2020-07-13", "profileId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "consumptionDetail": { "hotelId": "string", "source": "Central", "surname": "string", "firstName": "string", "middleName": "string", "email": "string", "date": "2020-07-13", "userName": "string", "userNotes": "string", "referenceId": { "id": "string", "type": "string" }, "locationType": "string", "authorizationCode": "string", "serviceDate": "2020-07-13" }, "status": "Cancelled", "printed": true, "inactiveDate": "2020-07-13", "awardId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "databaseId": "string", "source": "Opera", "issueType": "Assigned", "issueDate": "2020-07-13", "awardPoints": 0, "generationDetail": { "ruleId": { "id": "string", "type": "string" }, "generationDetail": "string", "referenceValue": "string" }, "originalVoucherNo": "string", "originalCertificateNo": "string", "inLieuSequence": 0, "cancelRequestDate": "2020-07-13", "extensionCount": 0 } ], "subscriptions": [ { "profileId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "externalProfileId": { "id": "string", "type": "string" }, "profileInfo": { "name": "string", "fullName": "string", "namePrefix": "string", "givenName": "string", "middleName": "string", "nameSuffix": "string", "nameTitle": "string", "nameType": "Primary", "profileType": "Guest" }, "distributed": true, "force": true, "subscriptionDate": "2020-07-13T14:53:56.500Z", "lastDistributionDate": "2020-07-13T14:53:56.500Z", "lastExternalUpdateDate": "2020-07-13T14:53:56.500Z", "inactive": true } ], "localizationGuestType": "string", "eligibleForFiscalFolio": "string", "profileType": "Guest", "statusCode": "Active", "registeredProperty": "string", "requestForHotel": "string", "protectedBy": "string", "createDateTime": "2020-07-13T14:53:56.500Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.500Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "markAsRecentlyAccessed": true, "markForHistory": true, "hasCommission": true, "inheritedNegRates": true }, "reservationProfileType": "Company" } ], "guestCounts": { "childAges": [ { "age": 0 } ], "childBuckets": { "bucket1Count": 0, "bucket2Count": 0, "bucket3Count": 0, "bucket4Count": 0, "bucket5Count": 0 }, "adults": 0, "children": 0 }, "taxFreeGuestCounts": { "childAges": [ { "age": 0 } ], "childBuckets": { "bucket1Count": 0, "bucket2Count": 0, "bucket3Count": 0, "bucket4Count": 0, "bucket5Count": 0 }, "adults": 0, "children": 0 }, "awards": { "membershipNo": { "id": "string", "type": "string" }, "awardVouchers": { "awardVoucher": [ { "awardCode": "string", "voucherNo": "string" } ] }, "originalRoomType": "string", "upgradeRoomType": "string" }, "foreignExchange": { "type": "string", "effectiveDate": "2020-07-13" }, "reservationBlock": { "blockIdList": [ { "id": "string", "type": "string" } ], "blockName": "string", "hotelId": "string" }, "roomRateInfo": "string", "mealPlans": [ { "code": "string", "included": true, "breakfastIncluded": true, "lunchIncluded": true, "dinnerIncluded": true } ], "roomType": "string", "ratePlanCode": "string", "promotionCode": "string", "start": "2020-07-13", "end": "2020-07-13", "availability": "Available", "suppressRate": true, "marketCode": "string", "marketCodeDescription": "string", "sourceCode": "string", "sourceCodeDescription": "string", "numberOfUnits": 0, "roomId": "string", "pseudoRoom": true, "roomTypeCharged": "string", "commissionCode": "string", "commissionable": true, "houseUseOnly": true, "complimentary": true, "inventoryLender": "string", "fixedRate": true, "barRanking": 0, "rateGroup": "string", "discountAllowed": true, "bogoDiscount": true, "rateLevel": "string", "commissionPercentage": 0, "commissionAmount": 0, "credentialsRequired": true, "taxIncluded": true, "rateDescription": "string" } ], "guestCounts": { "childAges": [ { "age": 0 } ], "childBuckets": { "bucket1Count": 0, "bucket2Count": 0, "bucket3Count": 0, "bucket4Count": 0, "bucket5Count": 0 }, "adults": 0, "children": 0 }, "arrivalDate": "2020-07-13", "departureDate": "2020-07-13", "expectedTimes": { "reservationExpectedArrivalTime": "2020-07-13T14:53:56.500Z", "reservationExpectedDepartureTime": "2020-07-13T14:53:56.500Z" }, "originalTimeSpan": { "startDate": "2020-07-13", "endDate": "2020-07-13", "duration": "string" }, "guarantee": { "guaranteeCode": "string", "shortDescription": "string", "onHold": true }, "promotion": { "promotionCode": "string", "promotionName": "string", "couponCode": "string" }, "suiteWith": "string", "total": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "totalPoints": { "awardsType": "string", "points": 0 }, "multiValueAttrs": [ "string" ], "upsellInfo": { "originalInfo": { "rateCode": "string", "totalAmount": { "amount": 0, "currencyCode": "string" }, "roomType": { "code": "string", "description": "string" }, "nights": 0 }, "upsellInfo": { "totalUpsellCharge": { "amount": 0, "currencyCode": "string" }, "totalUpsellMoneyAmount": { "amount": 0, "currencyCode": "string" }, "firstNightUpsellAmount": { "amount": 0, "currencyCode": "string" }, "firstNightUpsellCharge": { "amount": 0, "currencyCode": "string" }, "totalUpsellPoints": 0, "totalActualRateAmount": { "amount": 0, "currencyCode": "string" }, "roomType": { "code": "string", "description": "string" }, "roomLongDescription": "string", "ruleId": 0, "ruleCode": "string", "ruleDescription": "string", "percentageSavings": 0, "upsellDate": "2020-07-13", "upsellUser": "string" } }, "mobileNotifications": { "roomReady": "Pending", "keyReady": "Pending", "checkoutMessageReceived": true, "requiresAction": true, "errorMessage": "string" }, "roomNumberLocked": true, "printRate": true, "primaryShareType": "Primary", "remoteCheckInAllowed": true, "bookingMedium": "string", "bookingMediumDescription": "string" } ], "masterInfo": { "roomTypes": { "roomType": [ { "longDescription": "string", "webName": "string", "webPage": "string", "roomFeatures": [ { "code": "string", "description": "string", "orderSequence": 0, "quantity": 0 } ], "roomTypeAttributes": { "defaultOccupancy": 0, "maximumOccupancy": 0, "noOfPhysicalRooms": 0 }, "bookingChannelMappings": [ { "bookingChannelCode": "string", "code": "string", "name": "string", "description": "string" } ], "bedTypeCodes": [ "string" ], "roomType": "string", "hotelId": "string", "roomClass": "string", "description": "string", "suite": true, "component": true, "invBlockCode": "string", "roomViewCode": "string", "promotionCode": "string", "roomQualifierCode": "string", "roomQualifierMatchIndicator": "string" } ], "hotelId": "string" }, "ratePlans": { "ratePlan": [ { "shortInfo": "string", "longInfo": "string", "webPage": "string", "description": "string", "ratePlanChannelInfo": { "ratePlanLevel": "string", "ratePlanId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "ratePlanWebName": "string" }, "currencyCode": "string", "bookingChannelMappings": { "bookingChannelMapping": [ { "bookingChannelCode": "string", "code": "string", "name": "string", "description": "string" } ] }, "ratePlanLevel": "string", "guarantee": { "description": "string", "policyRequirements": { "requirementCode": "string", "cancellation": true, "phoneNumber": true, "address": true, "creditCard": true, "arrivalTime": true, "deposit": true }, "shortDescription": { "defaultText": "string", "translatedTexts": { "text": [ { "value": "string", "language": "string" } ] } }, "paymentTypes": [ "string" ], "guaranteeCode": "string", "onHold": true, "reserveInventory": true, "orderSequence": 0, "lateArrival": "string" }, "cancelPenalty": { "deadline": { "absoluteDeadline": "2020-07-13T14:53:56.500Z", "offsetFromArrival": 0, "offsetDropTime": "2020-07-13T14:53:56.500Z", "offsetFromBookingDate": 0 }, "amountPercent": { "basisType": "FlatAmount", "nights": 0, "percent": 0, "amount": 0, "currencyCode": "string" }, "penaltyDescription": "string", "offsetUnit": "Year", "formattedRule": "string", "policyCode": "string", "manual": true, "nonRefundable": true }, "mealPlans": [ { "code": "string", "included": true, "breakfastIncluded": true, "lunchIncluded": true, "dinnerIncluded": true } ], "ratePlanCode": "string", "hotelId": "string", "ratePlanCategory": "string", "taxInclusive": true, "serviceFeeInclusive": true, "rateCommission": { "commissionCode": "string", "commissionPercentage": 0, "commissionAmount": 0 }, "resGuarantees": [ { "description": "string", "policyRequirements": { "requirementCode": "string", "cancellation": true, "phoneNumber": true, "address": true, "creditCard": true, "arrivalTime": true, "deposit": true }, "shortDescription": { "defaultText": "string", "translatedTexts": { "text": [ { "value": "string", "language": "string" } ] } }, "paymentTypes": [ "string" ], "guaranteeCode": "string", "onHold": true, "reserveInventory": true, "orderSequence": 0, "lateArrival": "string", "cancelPenalty": { "deadline": { "absoluteDeadline": "2020-07-13T14:53:56.500Z", "offsetFromArrival": 0, "offsetDropTime": "2020-07-13T14:53:56.500Z", "offsetFromBookingDate": 0 }, "amountPercent": { "basisType": "FlatAmount", "nights": 0, "percent": 0, "amount": 0, "currencyCode": "string" }, "penaltyDescription": "string", "offsetUnit": "Year", "formattedRule": "string", "policyCode": "string", "manual": true, "nonRefundable": true, "effective": true, "estimatedAmount": 0 }, "depositPolicy": { "revenueType": "Rooms", "policy": { "amountPercent": { "basisType": "FlatAmount", "nights": 0, "percent": 0, "amount": 0, "currencyCode": "string" }, "deadline": { "absoluteDeadline": "2020-07-13T14:53:56.500Z", "offsetFromArrival": 0, "offsetDropTime": "2020-07-13T14:53:56.500Z", "offsetFromBookingDate": 0 }, "description": "string", "depositReceiptNo": 0, "transactionDate": "2020-07-13", "depositReqReversed": true, "formattedRule": "string", "typeOfCharges": "Rooms", "policyCode": "string", "manual": true }, "comments": "string", "amountPaid": { "amount": 0, "currencyCode": "string" }, "amountDue": { "amount": 0, "currencyCode": "string" }, "policyId": { "id": "string", "type": "string" }, "estimatedAmount": 0 }, "defaultGuarantee": true } ], "negotiatedBy": "Guest", "marketCode": "string", "sourceCode": "string", "hotelUseOnly": true, "discountAllowed": true, "credentialsRequired": true } ], "hotelId": "string" } }, "hotelAlert": "string", "restriction": "Closed", "rateChange": "FirstNight", "hotelInfo": { "primaryDetails": { "legalOwner": "string" }, "generalInformation": { "hotelType": "string", "roomCount": 0, "bedCount": 0, "floorCount": 0, "checkInTime": "2020-07-13T14:53:56.500Z", "checkOutTime": "2020-07-13T14:53:56.500Z", "hotelInfoWebsite": { "type": "string", "typeDescription": "string", "primaryInd": true, "orderSequence": 0 }, "longitude": 0, "latitude": 0, "baseLanguage": "string" }, "accommodationDetails": { "singleRooms": 0, "doubleRooms": 0, "twinRooms": 0, "familyRooms": 0, "connectingRooms": 0, "accessibleRooms": 0, "nonSmokingRooms": 0, "maxAdultsInFamilyRoom": 0, "maxChildrenInFamilyRoom": 0, "guestRoomFloors": 0, "guestRoomElevators": 0, "suites": 0, "executiveFloorNo": "string", "roomAmenties": "string", "shopDescription": "string" }, "propertyControls": { "sellControls": { "startDate": "2020-07-13", "endDate": "2020-07-13", "hotelId": "string" }, "currencyFormatting": { "currencyCode": "string", "currencyFormat": "string", "currencySymbol": "string", "decimalPositions": 0 }, "cateringCurrencyFormatting": { "currencyCode": "string", "currencyFormat": "string" }, "dateTimeFormatting": { "longDateFormat": "string", "shortDateFormat": "string", "timeFormat": "string", "timeZoneRegion": "string" }, "applicationMode": { "configurationMode": "string", "countryMode": "string", "expHotelCode": "string", "touristNumber": "string", "mBSSupported": true } }, "communication": { "phoneNumber": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.500Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.500Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "tollFreeNumber": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.500Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.500Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "faxNumber": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.500Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.500Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "emailAddress": "string", "webPage": { "type": "string", "typeDescription": "string", "primaryInd": true, "orderSequence": 0 } }, "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-13T14:53:56.500Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.500Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "regionCode": "string" }, "hotelRestaurants": [ { "restaurantName": "string", "restaurantType": "string", "hours": "string", "priceRange": "string", "comments": "string", "category": "Restaurant", "timeSpan": { "startDate": "2020-07-13", "endDate": "2020-07-13", "duration": "string" }, "newRestaurantCode": "string", "restaurantCode": "string", "orderBy": 0, "hotelId": "string" } ], "hotelRateRanges": [ { "timeSpan": { "startDate": "2020-07-13", "endDate": "2020-07-13", "duration": "string" }, "minRate": 0, "maxRate": 0, "currencyCode": "string", "hotelId": "string" } ], "alternateHotels": [ { "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-13T14:53:56.501Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.501Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "contactNumbers": { "contactNumber": [ { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.501Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.501Z", "lastModifierId": "string", "purgeDate": "2020-07-13" } ] }, "minRate": { "amount": 0, "currencyCode": "string" }, "maxRate": { "amount": 0, "currencyCode": "string" }, "relativePosition": { "distance": 0, "distanceType": "string", "drivingTime": "string" }, "hotelAmenities": { "hotelAmenity": [ { "description": "string", "code": "string", "type": "string", "displayOrder": 0 } ] }, "event": true, "rateRoomDetails": { "memberships": [ { "membershipId": "string", "membershipLevel": [ "string" ], "membershipType": [ "string" ], "associatedReservationsOnly": true } ], "restrictionType": "Closed", "roomStays": [ { "roomRates": [ { "total": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "totalPoints": { "awardsType": "string", "points": 0 }, "rates": { "rate": [ { "base": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "additionalGuestAmounts": [ { "amount": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "ageQualifyingCode": "ADULT" } ], "discount": { "discountReason": "string", "percent": 0, "amount": 0, "currencyCode": "string", "discountCode": "string" }, "shareRatePercentage": 0, "shareDistributionInstruction": "Full", "total": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "requiredPoints": { "awardsType": "string", "points": 0 }, "effectiveRate": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "start": "2020-07-13", "end": "2020-07-13" } ], "rateRange": [ { "base": [ { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true } ], "rateChange": true } ] }, "packages": [ { "amount": { "amount": 0, "currencyCode": "string" }, "allowance": { "amount": 0, "currencyCode": "string" }, "description": [ "string" ], "startDate": "2020-07-13", "endDate": "2020-07-13", "packageCode": "string", "calculationRule": "string", "postingRhythm": "string", "quantity": 0, "includedInRate": true, "addRateSeprateLine": true, "addRateCombinedLine": true, "startTime": "string", "endTime": "string", "sellSeparate": true } ], "stayProfiles": [ { "profileIdList": [ { "id": "string", "type": "string" } ], "profile": { "customer": { "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" } ], "anonymization": { "anonymizationStatus": "Requested", "anonymizationDate": "2020-07-13T14:53:56.501Z" }, "citizenCountry": { "value": "string", "code": "string" }, "identifications": { "identificationInfo": [ { "identification": { "idType": "string", "idNumber": "string", "idNumberMasked": "string", "issuedCountry": "string", "issuedDate": "2020-07-13", "issuedPlace": "string", "expirationDate": "2020-07-13", "registeredProperty": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profession": "string", "alienInfo": { "alienRegistrationNo": "string", "immigrationStatus": "string", "visaValidityType": "string" }, "birthCountry": { "value": "string", "code": "string" }, "legalCompany": "string", "companyInfo": { "legalCompany": "string", "department": "string", "position": "string" }, "businessTitle": "string", "gender": "Male", "birthDate": "2020-07-13", "birthDateMasked": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "customerValue": "string", "creditRating": "string", "vipStatus": "string", "vipDescription": "string", "birthPlace": "string", "privateProfile": true, "blacklist": true }, "company": { "companyName": "string", "companyName2": "string", "companyName3": "string", "alternateName": "string", "alternateLanguage": "string", "businessLocale": "string", "iATAInfo": { "iATACompany": "string", "iATAConsortia": "string", "iATAValidationResult": true }, "businessTitle": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "commissionCode": "string", "creditRating": "string", "corporateIdType": "string", "vipStatus": "string", "vipDescription": "string", "blacklist": true }, "profileImage": { "language": "string", "imageSet": "string", "sequenceId": 0, "imageStyle": "Full", "imageType": "string", "hotelId": "string", "chainCode": "string", "imageURL": "string", "description": "string", "imageOrder": 0, "website": "string" }, "addresses": { "addressInfo": [ { "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-13T14:53:56.501Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.501Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "businessSegments": [ "string" ], "territory": "string", "traceCode": "string", "ownerCode": "string", "influenceCode": "string", "telephones": { "telephoneInfo": [ { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.501Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.501Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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-13T14:53:56.501Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.501Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "uRLs": { "uRLInfo": [ { "url": { "type": "string", "typeDescription": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "comments": { "commentInfo": [ { "comment": { "text": { "value": "string", "language": "string" }, "image": "string", "url": "string", "commentTitle": "string", "notificationLocation": "string", "type": "string", "typeDescription": "string", "internal": true, "confidential": true, "overrideInternal": true, "protectDescription": true, "hotelId": "string", "actionType": "string", "actionDate": "2020-07-13", "createDateTime": "2020-07-13T14:53:56.501Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.501Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "createDateTime": "2020-07-13T14:53:56.501Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.501Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profileMemberships": { "profileMembership": [ { "comment": { "text": { "value": "string", "language": "string" }, "image": "string", "url": "string" }, "newMembershipNumber": "string", "nameOnCard": "string", "programDescription": "string", "membershipLevel": "string", "membershipLevelDescription": "string", "membershipClass": "string", "earningPreference": "Points", "inactive": true, "benefits": [ { "code": "string", "message": "string", "inactive": true } ], "tierAdministration": "Disabled", "downgrade": "Grace", "reIssueNewCard": "Pending", "excludeFromBatch": true, "upgradeDescription": "string", "downgradeDescription": "string", "rating": "string", "membershipEnrollmentCode": "string", "memberStatus": "string", "currentPoints": 0, "pointsLabel": "string", "enrollmentSource": "string", "enrollmentResort": "string", "preferredCard": true, "membershipId": "string", "membershipType": "string", "primaryMembershipYn": "string", "primaryMembership": true, "membershipIdNo": 0, "playerRanking": 0, "centralSetup": true, "signupDate": "2020-07-13", "effectiveDate": "2020-07-13", "expireDate": "2020-07-13", "expireDateExclusiveIndicator": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.502Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.502Z", "lastModifierId": "string", "purgeDate": "2020-07-13" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "preferenceCollection": { "preferenceType": [ { "preference": [ { "preferenceValue": "string", "description": "string", "global": true, "source": "string", "hotels": [ "string" ], "preferenceId": "string", "excludedPreferencesCount": 0 } ], "preferenceType": "string", "preferenceTypeDescription": "string", "sequence": "string", "maxQuantity": 0, "availableQuantity": 0, "maxResortUsedQuantity": 0, "reservationPreference": true, "createDateTime": "2020-07-13T14:53:56.503Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.503Z", "lastModifierId": "string", "purgeDate": "2020-07-13" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "keywords": { "keyword": [ { "keywordDetail": { "newKeyword": "string" }, "type": "string", "keyword": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "negotiatedRates": { "negotiatedRate": [ { "negotiatedInfoList": [ { "corporateAgreementId": "string", "comissionCode": "string", "order": 0, "inactive": true, "start": "2020-07-13", "end": "2020-07-13" } ], "hotelId": "string", "rateCode": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "gdsNegotiatedRates": { "gdsNegotiatedRate": [ { "gdsNegotiatedInfoList": [ { "accessCode": "string", "order": 0, "inactive": true, "start": "2020-07-13", "end": "2020-07-13" } ], "bookingChannelCode": "string", "hotelId": "string", "channelRatePlanCode": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profileIndicators": [ { "indicatorName": "string", "count": 0 } ], "relationships": { "relationship": [ { "changeRelationship": { "id": "string", "relation": "string", "relationDescription": "string", "targetRelation": "string", "targetRelationDescription": "string" }, "relationshipProfile": { "customer": { "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" } ], "anonymization": { "anonymizationStatus": "Requested", "anonymizationDate": "2020-07-13T14:53:56.503Z" }, "citizenCountry": { "value": "string", "code": "string" }, "identifications": { "identificationInfo": [ { "identification": { "idType": "string", "idNumber": "string", "idNumberMasked": "string", "issuedCountry": "string", "issuedDate": "2020-07-13", "issuedPlace": "string", "expirationDate": "2020-07-13", "registeredProperty": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "profession": "string", "alienInfo": { "alienRegistrationNo": "string", "immigrationStatus": "string", "visaValidityType": "string" }, "birthCountry": { "value": "string", "code": "string" }, "legalCompany": "string", "companyInfo": { "legalCompany": "string", "department": "string", "position": "string" }, "businessTitle": "string", "gender": "Male", "birthDate": "2020-07-13", "birthDateMasked": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "customerValue": "string", "creditRating": "string", "vipStatus": "string", "vipDescription": "string", "birthPlace": "string", "privateProfile": true, "blacklist": true }, "company": { "companyName": "string", "companyName2": "string", "companyName3": "string", "alternateName": "string", "alternateLanguage": "string", "businessLocale": "string", "iATAInfo": { "iATACompany": "string", "iATAConsortia": "string", "iATAValidationResult": true }, "businessTitle": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "language": "string", "nationality": "string", "nationalityDescription": "string", "commissionCode": "string", "creditRating": "string", "corporateIdType": "string", "vipStatus": "string", "vipDescription": "string", "blacklist": true }, "telephone": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.503Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.503Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "address": { "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-13T14:53:56.503Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.503Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "email": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.503Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.503Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "uRLs": { "url": { "type": "string", "typeDescription": "string", "primaryInd": true, "orderSequence": 0 }, "id": "string", "type": "string" }, "primaryOwner": { "hotel": { "code": "string", "description": "string" }, "userId": { "id": "string", "type": "string" }, "userName": "string", "ownerCode": "string", "profileId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "name": { "namePrefix": "string", "givenName": "string", "middleName": "string", "surname": "string", "nameSuffix": "string", "nameTitle": "string", "nameTitleSuffix": 0, "envelopeGreeting": "string", "salutation": "string", "nameType": "Primary", "language": "string", "externalSystem": "string" }, "department": { "code": "string", "description": "string" }, "email": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.503Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.503Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "phone": { "telephone": { "phoneTechType": "string", "phoneUseType": "string", "phoneUseTypeDescription": "string", "phoneNumber": "string", "extension": "string", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.503Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.503Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" }, "relationship": { "code": "string", "description": "string" }, "primary": true }, "profileIdList": [ { "id": "string", "type": "string" } ], "changeProfileIdList": [ { "id": "string", "type": "string" } ], "primary": "string", "id": "string", "statusCode": "Active", "profileType": "Guest" }, "masterAccountInfo": { "masterAccountId": { "id": "string", "type": "string" }, "masterAccountName": "string" }, "id": "string", "relation": "string", "relationDescription": "string", "targetRelation": "string", "targetRelationDescription": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 }, "reservationInfoList": { "historyList": { "reservationInfo": [ { "reservationIdList": [ { "id": "string", "type": "string" } ], "roomStay": { "arrivalDate": "2020-07-13", "departureDate": "2020-07-13", "originalTimeSpan": { "startDate": "2020-07-13", "endDate": "2020-07-13", "duration": "string" }, "expectedTimes": { "reservationExpectedArrivalTime": "2020-07-13T14:53:56.503Z", "reservationExpectedDepartureTime": "2020-07-13T14:53:56.503Z" }, "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-13", "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-13", "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-13T14:53:56.503Z" }, "accompanyGuests": [ { "firstName": "string", "lastName": "string", "fullName": "string", "registrationCardNo": "string", "profileIdList": [ { "id": "string", "type": "string" } ] } ], "externalInfo": { "givenName": "string", "surname": "string" }, "guestLastStayInfo": { "lastStayDate": "2020-07-13", "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": [ { "name": "string", "profileIdList": [ { "id": "string", "type": "string" } ], "reservationProfileType": "Company" } ], "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-13", "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" }, "percent": 0 }, "emailFolioInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.503Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.503Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "emailFolio": true, "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-13T14:53:56.503Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.503Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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" }, "balance": { "amount": 0, "currencyCode": "string" }, "paymentMethod": "string", "folioWindowNo": 0 } ], "specials": "string", "lastPrivacyPromptDate": "2020-07-13", "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-13", "endDate": "2020-07-13", "duration": "string", "durationInSeconds": 0 }, "guestTextInfo": { "sentTime": "2020-07-13T14:53:56.504Z", "sentBy": "string" }, "priority": 0, "averageQueueTimeToCheckIn": 0, "averageQueueTimeCurrentReservations": 0, "queueDate": "2020-07-13" }, "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-13" }, "linenChange": true, "turndownRequested": true, "serviceTime": "2020-07-13", "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" } }, "billingPrivileges": { "postingRestriction": true, "preStayCharging": true, "postStayCharging": true, "folioCloseDate": "2020-07-13", "scheduledCheckout": true, "scheduledCheckoutTime": "2020-07-13", "directBillAuthorized": true, "videoCheckout": true, "allowAutoCheckin": true, "autoSettlement": true, "autoSettlementType": "string", "autoSettlementFreq": 0, "creditLimitAutoPay": true }, "taxType": { "hotelId": "string", "code": "string", "description": "string", "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, "minimumLengthOfStay": 0, "taxExemptNo": "string" }, "bedTaxReporting": { "taxRegistrationNo": 0, "visaNumber": "string", "visaIssueDate": "2020-07-13", "visaExpiryDate": "2020-07-13", "taxableDays": 0 }, "folioTexts": { "folioText": [ { "text": "string", "row": 0 } ] }, "periodicFolio": { "lastSettlementDate": "2020-07-13", "lastFolioDate": "2020-07-13", "frequency": 0 }, "compAccounting": { "compType": "string", "authorizer": "string" }, "reservationPreConfiguredRoutingInstruction": { "ratePlanCode": "string", "profileType": "Company", "promotionCode": "string" }, "financiallyResponsible": true, "proratedBilling": true, "lastRoomAndTaxPostedDate": "2020-07-13", "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-13", "postingDate": "2020-07-13", "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" }, "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-13T14:53:56.504Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.504Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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-13T14:53:56.504Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.504Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 } }, "advanceCheckIn": { "advanceCheckedIn": true, "expectedReturnTime": "2020-07-13T14:53:56.504Z", "eTRComments": "string" }, "welcomeOffer": true, "cancellationInfo": { "description": "string", "code": "string", "date": "2020-07-13" }, "keyCount": 0, "hotelId": "string", "hotelName": "string", "expectedServiceTime": "string", "roomStayReservation": true, "createDateTime": "2020-07-13T14:53:56.504Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.504Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "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 }, "futureList": { "reservationInfo": [ { "reservationIdList": [ { "id": "string", "type": "string" } ], "roomStay": { "arrivalDate": "2020-07-13", "departureDate": "2020-07-13", "originalTimeSpan": { "startDate": "2020-07-13", "endDate": "2020-07-13", "duration": "string" }, "expectedTimes": { "reservationExpectedArrivalTime": "2020-07-13T14:53:56.504Z", "reservationExpectedDepartureTime": "2020-07-13T14:53:56.504Z" }, "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-13", "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-13", "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-13T14:53:56.504Z" }, "accompanyGuests": [ { "firstName": "string", "lastName": "string", "fullName": "string", "registrationCardNo": "string", "profileIdList": [ { "id": "string", "type": "string" } ] } ], "externalInfo": { "givenName": "string", "surname": "string" }, "guestLastStayInfo": { "lastStayDate": "2020-07-13", "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": [ { "name": "string", "profileIdList": [ { "id": "string", "type": "string" } ], "reservationProfileType": "Company" } ], "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-13", "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" }, "percent": 0 }, "emailFolioInfo": { "email": { "emailAddress": "string", "type": "string", "typeDescription": "string", "emailFormat": "Html", "primaryInd": true, "orderSequence": 0, "createDateTime": "2020-07-13T14:53:56.504Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.504Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "emailFolio": true, "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-13T14:53:56.504Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.504Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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" }, "balance": { "amount": 0, "currencyCode": "string" }, "paymentMethod": "string", "folioWindowNo": 0 } ], "specials": "string", "lastPrivacyPromptDate": "2020-07-13", "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-13", "endDate": "2020-07-13", "duration": "string", "durationInSeconds": 0 }, "guestTextInfo": { "sentTime": "2020-07-13T14:53:56.504Z", "sentBy": "string" }, "priority": 0, "averageQueueTimeToCheckIn": 0, "averageQueueTimeCurrentReservations": 0, "queueDate": "2020-07-13" }, "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-13" }, "linenChange": true, "turndownRequested": true, "serviceTime": "2020-07-13", "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" } }, "billingPrivileges": { "postingRestriction": true, "preStayCharging": true, "postStayCharging": true, "folioCloseDate": "2020-07-13", "scheduledCheckout": true, "scheduledCheckoutTime": "2020-07-13", "directBillAuthorized": true, "videoCheckout": true, "allowAutoCheckin": true, "autoSettlement": true, "autoSettlementType": "string", "autoSettlementFreq": 0, "creditLimitAutoPay": true }, "taxType": { "hotelId": "string", "code": "string", "description": "string", "collectingAgentTax": true, "printAutoAdjust": true, "reportExemptDays": 0, "reportTaxPercentage": 0, "minimumLengthOfStay": 0, "taxExemptNo": "string" }, "bedTaxReporting": { "taxRegistrationNo": 0, "visaNumber": "string", "visaIssueDate": "2020-07-13", "visaExpiryDate": "2020-07-13", "taxableDays": 0 }, "folioTexts": { "folioText": [ { "text": "string", "row": 0 } ] }, "periodicFolio": { "lastSettlementDate": "2020-07-13", "lastFolioDate": "2020-07-13", "frequency": 0 }, "compAccounting": { "compType": "string", "authorizer": "string" }, "reservationPreConfiguredRoutingInstruction": { "ratePlanCode": "string", "profileType": "Company", "promotionCode": "string" }, "financiallyResponsible": true, "proratedBilling": true, "lastRoomAndTaxPostedDate": "2020-07-13", "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-13", "postingDate": "2020-07-13", "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" }, "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-13T14:53:56.504Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.504Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "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-13T14:53:56.504Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.504Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "id": "string", "type": "string" } ], "hasMore": true, "totalResults": 0, "count": 0 } }, "advanceCheckIn": { "advanceCheckedIn": true, "expectedReturnTime": "2020-07-13T14:53:56.504Z", "eTRComments": "string" }, "welcomeOffer": true, "cancellationInfo": { "description": "string", "code": "string", "date": "2020-07-13" }, "keyCount": 0, "hotelId": "string", "hotelName": "string", "expectedServiceTime": "string", "roomStayReservation": true, "createDateTime": "2020-07-13T14:53:56.505Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.505Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "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 } }, "lastStayInfo": { "lastVisit": "2020-07-13", "lastRoom": "string", "lastRate": { "amount": 0, "currencyCode": "string" }, "totalStay": 0 }, "profileAccessType": { "chainCode": "string", "croCode": "string", "hotelId": "string", "sharedLevel": "Global" }, "profileRestrictions": { "reason": "string", "reasonDescription": "string", "restricted": true }, "mailingActions": { "mailingAction": [ { "code": "string", "description": "string" } ], "active": true, "hasMore": true, "totalResults": 0, "count": 0 }, "privacyInfo": { "marketResearchParticipation": true, "lastPrivacyPromptDate": "2020-07-13", "infoFromThirdParty": true, "autoEnrollLoyaltyProgram": true, "allowPhone": true, "allowSMS": true, "allowEmail": true, "optInMailingList": true, "optInMarketResearch": true, "optInThirdParty": true, "optInAutoEnrollmentMember": true, "optInPhone": true, "optInSms": true, "optInEmail": true }, "cashiering": { "directBillingList": [ { "hotelId": "string", "aRNumber": "string" } ], "autoFolioSettlementType": "string", "paymentDueDays": 0, "taxPercent1": 0, "taxPercent2": 0, "taxPercent3": 0, "taxPercent4": 0, "taxPercent5": 0, "arNoCentral": "string", "referenceCurrency": "string", "vATOffsetYN": "string", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0 }, "commissionInfoList": [ { "hotelId": "string", "commissionCode": "string", "bankAccount": "string", "paymentMethod": "Cent", "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0 } ], "userDefinedFields": { "characterUDFs": [ { "name": "string", "value": "string", "alternateName": "string" } ], "numericUDFs": [ { "name": "string", "value": 0, "alternateName": "string" } ], "dateUDFs": [ { "name": "string", "value": "2020-07-13", "alternateName": "string" } ] }, "webUserAccounts": [ { "securityQuestion": { "code": "string", "description": "string" }, "securityAnswer": "string", "comments": "string", "history": { "createDateTime": "2020-07-13T14:53:56.506Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.506Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "lastLogin": "2020-07-13", "lastPasswordChange": "2020-07-13", "inactiveDate": "2020-07-13" }, "newLoginName": "string", "newPassword": "string", "autoGeneratePassword": true, "loginName": "string", "domainCode": "string", "locked": true, "inactive": true } ], "taxInfo": { "tax1No": "string", "tax2No": "string", "taxCategory": "string", "taxOffice": "string", "taxType": "string", "businessId": "string", "businessRegistration": "string" }, "salesInfo": { "scope": "string", "scopeCity": "string", "accountType": "string", "accountSource": "string", "industryCode": "string", "businessSegments": "string", "priority": "string", "roomsPotential": "string", "actionCode": "string", "competitionCode": "string", "influence": "string", "preferredRoom": "string", "hotelId": "string" }, "eCertificates": [ { "certificateId": 0, "voucherNo": "string", "certificateNo": "string", "eCertificateInfo": { "certificateType": "string", "membershipType": "string", "awardCode": "string", "promotionCode": "string", "voucherBenefitCode": "string", "hotels": { "code": [ "string" ], "scope": "Global" }, "description": "string", "longDescription": "string", "label": "string", "maxExtensionAllowed": 0, "usageCriteria": { "reservation": true, "web": true, "webAllowed": true, "benefit": true, "hotel": true, "verifyCertificateNo": true, "cancelAllowed": true, "generateInLieuCertificate": true }, "value": { "amount": 0, "currencyCode": "string" }, "cost": { "amount": 0, "currencyCode": "string" }, "benefitSummary": "string" }, "expiryDate": "2020-07-13", "newExpiryDate": "2020-07-13", "profileId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "consumptionDetail": { "hotelId": "string", "source": "Central", "surname": "string", "firstName": "string", "middleName": "string", "email": "string", "date": "2020-07-13", "userName": "string", "userNotes": "string", "referenceId": { "id": "string", "type": "string" }, "locationType": "string", "authorizationCode": "string", "serviceDate": "2020-07-13" }, "status": "Cancelled", "printed": true, "inactiveDate": "2020-07-13", "awardId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "databaseId": "string", "source": "Opera", "issueType": "Assigned", "issueDate": "2020-07-13", "awardPoints": 0, "generationDetail": { "ruleId": { "id": "string", "type": "string" }, "generationDetail": "string", "referenceValue": "string" }, "originalVoucherNo": "string", "originalCertificateNo": "string", "inLieuSequence": 0, "cancelRequestDate": "2020-07-13", "extensionCount": 0 } ], "subscriptions": [ { "profileId": { "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 }, "externalProfileId": { "id": "string", "type": "string" }, "profileInfo": { "name": "string", "fullName": "string", "namePrefix": "string", "givenName": "string", "middleName": "string", "nameSuffix": "string", "nameTitle": "string", "nameType": "Primary", "profileType": "Guest" }, "distributed": true, "force": true, "subscriptionDate": "2020-07-13T14:53:56.506Z", "lastDistributionDate": "2020-07-13T14:53:56.506Z", "lastExternalUpdateDate": "2020-07-13T14:53:56.506Z", "inactive": true } ], "localizationGuestType": "string", "eligibleForFiscalFolio": "string", "profileType": "Guest", "statusCode": "Active", "registeredProperty": "string", "requestForHotel": "string", "protectedBy": "string", "createDateTime": "2020-07-13T14:53:56.506Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.506Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "markAsRecentlyAccessed": true, "markForHistory": true, "hasCommission": true, "inheritedNegRates": true }, "reservationProfileType": "Company" } ], "guestCounts": { "childAges": [ { "age": 0 } ], "childBuckets": { "bucket1Count": 0, "bucket2Count": 0, "bucket3Count": 0, "bucket4Count": 0, "bucket5Count": 0 }, "adults": 0, "children": 0 }, "taxFreeGuestCounts": { "childAges": [ { "age": 0 } ], "childBuckets": { "bucket1Count": 0, "bucket2Count": 0, "bucket3Count": 0, "bucket4Count": 0, "bucket5Count": 0 }, "adults": 0, "children": 0 }, "awards": { "membershipNo": { "id": "string", "type": "string" }, "awardVouchers": { "awardVoucher": [ { "awardCode": "string", "voucherNo": "string" } ] }, "originalRoomType": "string", "upgradeRoomType": "string" }, "foreignExchange": { "type": "string", "effectiveDate": "2020-07-13" }, "reservationBlock": { "blockIdList": [ { "id": "string", "type": "string" } ], "blockName": "string", "hotelId": "string" }, "roomRateInfo": "string", "mealPlans": [ { "code": "string", "included": true, "breakfastIncluded": true, "lunchIncluded": true, "dinnerIncluded": true } ], "roomType": "string", "ratePlanCode": "string", "promotionCode": "string", "start": "2020-07-13", "end": "2020-07-13", "availability": "Available", "suppressRate": true, "marketCode": "string", "marketCodeDescription": "string", "sourceCode": "string", "sourceCodeDescription": "string", "numberOfUnits": 0, "roomId": "string", "pseudoRoom": true, "roomTypeCharged": "string", "commissionCode": "string", "commissionable": true, "houseUseOnly": true, "complimentary": true, "inventoryLender": "string", "fixedRate": true, "barRanking": 0, "rateGroup": "string", "discountAllowed": true, "bogoDiscount": true, "rateLevel": "string", "commissionPercentage": 0, "commissionAmount": 0, "credentialsRequired": true, "taxIncluded": true, "rateDescription": "string" } ], "guestCounts": { "childAges": [ { "age": 0 } ], "childBuckets": { "bucket1Count": 0, "bucket2Count": 0, "bucket3Count": 0, "bucket4Count": 0, "bucket5Count": 0 }, "adults": 0, "children": 0 }, "arrivalDate": "2020-07-13", "departureDate": "2020-07-13", "expectedTimes": { "reservationExpectedArrivalTime": "2020-07-13T14:53:56.506Z", "reservationExpectedDepartureTime": "2020-07-13T14:53:56.506Z" }, "originalTimeSpan": { "startDate": "2020-07-13", "endDate": "2020-07-13", "duration": "string" }, "guarantee": { "guaranteeCode": "string", "shortDescription": "string", "onHold": true }, "promotion": { "promotionCode": "string", "promotionName": "string", "couponCode": "string" }, "suiteWith": "string", "total": { "taxes": { "tax": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "fees": { "fee": [ { "description": "string", "type": "Inclusive", "code": "string", "amount": 0, "currencyCode": "string" } ], "amount": 0, "currencyCode": "string" }, "description": "string", "amountBeforeTax": 0, "amountAfterTax": 0, "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "code": "string", "rateOverride": true }, "totalPoints": { "awardsType": "string", "points": 0 }, "multiValueAttrs": [ "string" ], "upsellInfo": { "originalInfo": { "rateCode": "string", "totalAmount": { "amount": 0, "currencyCode": "string" }, "roomType": { "code": "string", "description": "string" }, "nights": 0 }, "upsellInfo": { "totalUpsellCharge": { "amount": 0, "currencyCode": "string" }, "totalUpsellMoneyAmount": { "amount": 0, "currencyCode": "string" }, "firstNightUpsellAmount": { "amount": 0, "currencyCode": "string" }, "firstNightUpsellCharge": { "amount": 0, "currencyCode": "string" }, "totalUpsellPoints": 0, "totalActualRateAmount": { "amount": 0, "currencyCode": "string" }, "roomType": { "code": "string", "description": "string" }, "roomLongDescription": "string", "ruleId": 0, "ruleCode": "string", "ruleDescription": "string", "percentageSavings": 0, "upsellDate": "2020-07-13", "upsellUser": "string" } }, "mobileNotifications": { "roomReady": "Pending", "keyReady": "Pending", "checkoutMessageReceived": true, "requiresAction": true, "errorMessage": "string" }, "roomNumberLocked": true, "printRate": true, "primaryShareType": "Primary", "remoteCheckInAllowed": true, "bookingMedium": "string", "bookingMediumDescription": "string" } ] }, "channelSummaryInfo": { "bookingChannel": { "channelCode": "string", "channelName": "string", "channelType": "string" }, "messageId": "string", "summaryOnly": true }, "sellMessages": { "sellMessage": [ { "message": "string", "croCode": "string", "chainCode": "string", "hotelId": "string", "roomType": "string", "ratePlanCode": "string", "languageCode": "string", "stickyFlagYn": "string", "url": "string", "type": "string", "instance": "string", "idContext": "string", "id": "string", "idExtension": 0 } ], "hasMore": true, "totalResults": 0, "count": 0 }, "currencyExchangeRates": [ { "currencyCode": "string", "currencySymbol": "string", "decimalPlaces": 0, "description": "string", "exchangeRate": { "amount": 0, "currencyCode": "string" } } ], "chainCode": "string", "hotelId": "string", "hotelCityCode": "string", "hotelName": "string", "hotelCodeContext": "string", "chainName": "string", "hotelType": "string", "negotiated": true, "alternate": true, "displayOrder": 0, "inventoryRooms": 0, "availableRooms": 0, "comments": "string", "direction": "string", "reciprocalRelationship": true, "alternateHotelCode": "string", "newAlternateHotelCode": "string" } ], "hotelContacts": [ { "nameId": { "id": "string", "type": "string" }, "hotelId": "string", "name": "string", "roles": [ "Lead" ], "ownerCode": "string", "communicationMethod": "string", "communicationAddress": "string", "primary": true } ], "hotelEventSpaces": { "eventSpaceDetails": [ { "code": "string", "description": "string", "maxCapacity": 0, "maxOccupancies": [ 0 ] } ], "eventSpaceSummaries": [ { "no": 0, "spaceType": "string", "maxCapacity": 0, "maxOccupancies": [ 0 ] } ], "setupStyles": [ "string" ] }, "hotelNotes": [ { "comment": { "text": { "value": "string", "language": "string" }, "image": "string", "url": "string", "commentTitle": "string", "notificationLocation": "string", "type": "string", "typeDescription": "string", "internal": true, "confidential": true, "overrideInternal": true, "protectDescription": true, "hotelId": "string", "actionType": "string", "actionDate": "2020-07-13", "createDateTime": "2020-07-13T14:53:56.507Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.507Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "createDateTime": "2020-07-13T14:53:56.507Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.507Z", "lastModifierId": "string", "purgeDate": "2020-07-13", "id": "string", "type": "string" } ], "hotelCorporateInformations": { "brandCode": "string", "hotelCategory": "string", "businessUnit": [ { "primary": true, "codeDescription": { "code": "string", "description": "string" } } ], "departmentCode": [ { "primary": true, "codeDescription": { "code": "string", "description": "string" } } ], "division": [ { "primary": true, "codeDescription": { "code": "string", "description": "string" } } ], "opertingUnit": [ { "primary": true, "codeDescription": { "code": "string", "description": "string" } } ] }, "attractions": [ { "name": { "defaultText": "string", "translatedTexts": { "text": [ { "value": "string", "language": "string" } ] } }, "type": "string", "class": "string", "generalDirections": "string", "relativePosition": { "distance": 0, "distanceType": "string", "drivingTime": "string" }, "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-13T14:53:56.507Z", "creatorId": "string", "lastModifyDateTime": "2020-07-13T14:53:56.507Z", "lastModifierId": "string", "purgeDate": "2020-07-13" }, "website": { "type": "string", "typeDescription": "string", "primaryInd": true, "orderSequence": 0 }, "priceRange": "string", "operationHours": "string", "displaySeq": 0, "code": "string" } ], "meetingRooms": [ { "code": "string", "charge": "string", "description": "string" } ], "chainCode": "string", "hotelId": "string", "hotelCityCode": "string", "hotelName": "string", "hotelCodeContext": "string", "chainName": "string" }, "channelInformation": { "channelSummaryInfo": { "bookingChannel": { "channelCode": "string", "channelName": "string", "channelType": "string" }, "messageId": "string", "summaryOnly": true }, "channelMarketingInfo": { "marketingText": [ { "description": "string", "policyType": "Deposit", "ratePlanCode": "string" } ] } }, "ratePlanSet": "string", "hotelId": "string", "closed": true, "redemption": true, "hasMore": true, "totalResults": 0, "count": 0, "pagingKey": "string" } ], "links": [ { "href": "string", "rel": "string", "templated": false, "method": "GET", "targetSchema": "string", "operationId": "string", "title": "string" } ] } } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/availability/alternate": { "get": { "summary": "Get Alternate Availability", "description": "This API allows to fetch alternate dates for closed rates. Criteria for to search for alternate dates, room stay information, profile block or guest information can be specified.OperationId:getAlternateAvailability
This API allows a time span of 90 days.
", "operationId": "getAlternateAvailability", "deprecated": true, "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "ratePlanCode", "in": "query", "required": false, "description": "Requested Rate code", "type": "string" }, { "name": "redemption", "in": "query", "required": false, "description": "Used to indicate if award redemption flag is to be set.", "type": "boolean" }, { "name": "roomType", "in": "query", "required": false, "description": "Requested Room type.", "type": "string" }, { "name": "roomNumber", "in": "query", "required": false, "description": "Requested Room Number.", "type": "string" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "duration", "in": "query", "required": false, "type": "string" }, { "name": "quantity", "in": "query", "required": false, "type": "integer" }, { "name": "adults", "in": "query", "required": false, "description": "Defines the number of Adults.", "type": "integer" }, { "name": "children", "in": "query", "required": false, "description": "Defines the number of Children.", "type": "integer" }, { "name": "childAge", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Age of a child in years.", "items": { "type": "integer" }, "required": false }, { "name": "bucket1Count", "in": "query", "required": false, "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1).", "type": "integer" }, { "name": "bucket2Count", "in": "query", "required": false, "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2).", "type": "integer" }, { "name": "bucket3Count", "in": "query", "required": false, "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3).", "type": "integer" }, { "name": "bucket4Count", "in": "query", "required": false, "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).", "type": "integer" }, { "name": "bucket5Count", "in": "query", "required": false, "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).", "type": "integer" }, { "name": "reservationGuestId", "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": "reservationGuestIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "reservationProfileType", "in": "query", "type": "array", "collectionFormat": "multi", "uniqueItems": true, "items": { "type": "string", "enum": [ "Guest", "Company", "Group", "TravelAgent", "Source", "ReservationContact", "BillingContact", "Addressee" ] }, "required": false }, { "name": "blockCode", "in": "query", "required": false, "type": "string" }, { "name": "blockName", "in": "query", "required": false, "type": "string" }, { "name": "blockId", "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": "blockIdType", "in": "query", "required": false, "description": "A reference to the type of object defined by the UniqueID element.", "type": "string" }, { "name": "membershipLevel", "in": "query", "required": false, "description": "Membership id Number of the guest.", "type": "string" }, { "name": "membershipType", "in": "query", "required": false, "description": "Membership id Number of the guest.", "type": "string" }, { "name": "controlSegment", "in": "query", "required": false, "description": "Control Segment to check for casino restrction for a patron profile.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetch alternate availability operation", "schema": { "$ref": "#/definitions/alternateAvailability" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/availability/alternate/searches": { "post": { "summary": "Get Alternate Availability", "description": "This API allows to fetch alternate dates for closed rates. Criteria for to search for alternate dates, room stay information, profile block or guest information can be specified.OperationId:searchAlternateAvailability
This API allows a time span of 90 days.
", "operationId": "searchAlternateAvailability", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "in": "body", "name": "searchAlternateAvailabilityRequest", "description": "Alternate Availability Request", "required": false, "schema": { "$ref": "#/definitions/searchAlternateAvailabilityRequest" } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetch alternate availability operation", "schema": { "$ref": "#/definitions/alternateAvailability" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/availability/searches": { "post": { "summary": "Get Hotel Availability", "description": " This API fetches hotel availability for any specific hotel, given dates, rate plans, rate category, rate group, membership rates, and number of people. It returns a list of available rate plan codes, room types, and room rates for any given search criteria.OperationId:searchHotelAvailability
This API allows a time span of 90 days.
", "operationId": "searchHotelAvailability", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "in": "body", "name": "searchHotelAvailabilityRequest", "description": "Hotel Availability Request", "required": false, "schema": { "$ref": "#/definitions/searchHotelAvailabilityRequest" } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object to search hotel availability based on request segment.", "schema": { "$ref": "#/definitions/hotelAvailability" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/availableUpsells": { "get": { "summary": "Get for Available Up-sells", "description": "This API allows to fetch for Available Up-sells for specific hotel and date range.OperationId:getAvailableUpsells
This API allows a time span of 90 days.
", "operationId": "getAvailableUpsells", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "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": "profileId", "in": "query", "required": false, "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", "type": "string" }, { "name": "reservationStatus", "in": "query", "required": false, "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.", "uniqueItems": true, "enum": [ "Reserved", "Requested", "NoShow", "Cancelled", "InHouse", "CheckedOut", "Waitlisted", "DueIn", "DueOut", "Walkin", "PendingCheckout" ] }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "ratePlanCode", "in": "query", "required": false, "description": "Rate plan code", "type": "string" }, { "name": "roomType", "in": "query", "required": false, "description": "Room type", "type": "string" }, { "name": "adults", "in": "query", "required": false, "description": "Defines the number of Adults.", "type": "integer" }, { "name": "children", "in": "query", "required": false, "description": "Defines the number of Children.", "type": "integer" }, { "name": "rateAmount", "in": "query", "required": false, "description": "A monetary amount.", "type": "number" }, { "name": "guaranteeCode", "in": "query", "required": false, "description": "Guarantee code", "type": "string" }, { "name": "marketCode", "in": "query", "required": false, "description": "Market code", "type": "string" }, { "name": "fixedRate", "in": "query", "required": false, "description": "Fixed Rate flag", "type": "boolean" }, { "name": "rateDate", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Reservation date", "items": { "type": "string", "format": "date" }, "required": false }, { "name": "requiredAmount", "in": "query", "type": "array", "collectionFormat": "multi", "description": "A monetary amount.", "items": { "type": "number" }, "required": false }, { "name": "numberOfRooms", "in": "query", "required": false, "description": "Number of Rooms", "type": "integer" }, { "name": "bucket1Count", "in": "query", "required": false, "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1).", "type": "integer" }, { "name": "bucket2Count", "in": "query", "required": false, "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2).", "type": "integer" }, { "name": "bucket3Count", "in": "query", "required": false, "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3).", "type": "integer" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for fetching available upsells.", "schema": { "$ref": "#/definitions/availableUpsells" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/guarantees": { "get": { "summary": "Get Reservation Guarantee ", "description": "This API allows to Fetch Reservation Guarantee. The criteria can include the rate plan code, arrival date, guarantee code and the profile information.OperationId:getReservationGuarantees
", "operationId": "getReservationGuarantees", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "arrivalDate", "in": "query", "required": true, "description": "Arrival Date of the guest.", "type": "string", "format": "date" }, { "name": "ratePlanCode", "in": "query", "required": false, "description": "Rate Plan Code to find associated Guarantee Codes.", "type": "string" }, { "name": "blockId", "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": "reservationGuestId", "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": "companyId", "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": "travelAgentId", "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": "sourceId", "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": "groupId", "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": "guaranteeCode", "in": "query", "required": false, "description": "Guarantee Code should be supplied only for the code verification purpose, if the supplied code is valid for the rest of the criteria it will return the response with the Guarantee Code information.", "type": "string" }, { "name": "calculateEstimateAmount", "in": "query", "required": false, "description": "Determines whether estimated amount to be calculated or not", "type": "boolean" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date" }, { "name": "numberOfRooms", "in": "query", "required": false, "type": "integer" }, { "name": "numberOfAdults", "in": "query", "required": false, "description": "Defines the number of Adults.", "type": "integer" }, { "name": "numberOfChildren", "in": "query", "required": false, "description": "Defines the number of Children.", "type": "integer" }, { "name": "roomType", "in": "query", "required": false, "description": "Room Type for the reservation", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object to fetch reservation guarantees.", "schema": { "$ref": "#/definitions/reservationGuaranteesPolicies" }, "examples": { "application/json": { "resGuarantees": [ { "guaranteeCode": "4PM", "shortDescription": { "defaultText": "4PM Hold" }, "policyRequirements": { "phoneNumber": false, "address": false, "creditCard": false, "arrivalTime": false, "deposit": false }, "onHold": false, "reserveInventory": true, "orderSequence": "1" }, { "guaranteeCode": "GNON", "shortDescription": { "defaultText": "Group Non Deduct" }, "policyRequirements": { "phoneNumber": false, "address": false, "creditCard": false, "arrivalTime": false, "deposit": false }, "onHold": false, "reserveInventory": false, "orderSequence": "3" }, { "guaranteeCode": "GDED", "shortDescription": { "defaultText": "Group Deduct" }, "policyRequirements": { "phoneNumber": false, "address": false, "creditCard": false, "arrivalTime": false, "deposit": false }, "onHold": false, "reserveInventory": true, "orderSequence": "4" }, { "guaranteeCode": "CC", "shortDescription": { "defaultText": "Credit Card Guarantee" }, "policyRequirements": { "phoneNumber": false, "address": false, "creditCard": true, "arrivalTime": false, "deposit": false }, "onHold": false, "reserveInventory": true, "orderSequence": "6" }, { "guaranteeCode": "DEPR", "shortDescription": { "defaultText": "Deposit Required" }, "policyRequirements": { "phoneNumber": false, "address": false, "creditCard": false, "arrivalTime": true, "deposit": false }, "onHold": false, "reserveInventory": true } ] } } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/hurdles": { "get": { "summary": "Get Hurdle Rates", "description": "This API allows to fetch existing Hurdle Rates.OperationId:getHurdleRates
", "operationId": "getHurdleRates", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "hurdleDate", "in": "query", "required": false, "description": "Date criteria for which the hurdle rate is scheduled.", "type": "string", "format": "date" }, { "name": "limit", "in": "query", "required": false, "default": 25, "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": "roomTypesCode", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "hurdleRangeStart", "in": "query", "type": "string", "description": "Hurdle date start range from which the hurdle rate is scheduled.", "format": "date", "required": false }, { "name": "hurdleRangeEnd", "in": "query", "type": "string", "description": "Hurdle date end range to which the hurdle rate is scheduled.", "format": "date", "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching Hurdle rates.", "schema": { "$ref": "#/definitions/hurdleRates" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] }, "post": { "summary": "Create Hurdle Rates", "description": "This API allows to create hurdle rates.OperationId:postHurdleRates
", "operationId": "postHurdleRates", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "createHurdleRates", "in": "body", "required": true, "description": "Request object for creating new Hurdle Rates.", "schema": { "allOf": [ { "$ref": "#/definitions/createHurdleRates" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] }, "put": { "summary": "Change Hurdle Rates", "description": "This API allows to update an existing Hurdle Rate.OperationId:putHurdleRates
", "operationId": "putHurdleRates", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "changeHurdleRates", "in": "body", "required": true, "description": "Request object for changing existing Hurdle Rates.", "schema": { "allOf": [ { "$ref": "#/definitions/changeHurdleRates" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] }, "delete": { "summary": "Delete Hurdle Rates", "description": "This API allows to delete hurdles rates.OperationId:deleteHurdleRates
", "operationId": "deleteHurdleRates", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "hurdleDate", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Hurdle date for which the hurdle rate is scheduled.", "items": { "type": "string", "format": "date" }, "required": false }, { "name": "roomType", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Room type for which the hurdle rate applies to.", "items": { "type": "string" }, "required": false }, { "name": "roomCategory", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Internal room category of the room type for which the hurdle rate applies to.", "items": { "type": "string" }, "required": false }, { "name": "yieldCategory", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Yield category for which the hurdle rate applies to.", "items": { "type": "string" }, "required": false }, { "name": "lengthOfStay", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Length of stay for which the hurdle rate applies to.", "items": { "type": "number" }, "required": false }, { "name": "yieldMarketCode", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Yield market code for which the hurdle rate applies to.", "items": { "type": "string" }, "required": false }, { "name": "hurdleRangeStart", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Hurdle date start range from which the hurdle rate is scheduled.", "items": { "type": "string", "format": "date" }, "required": false }, { "name": "hurdleRangeEnd", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Hurdle date end range to which the hurdle rate is scheduled.", "items": { "type": "string", "format": "date" }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/rates": { "get": { "summary": "Get the Rate Plan Information ", "description": "This API allows to fetch Rate Plan information.OperationId:getAvailabilityRatePlanInfoByMultipleRatePlans
", "operationId": "getAvailabilityRatePlanInfoByMultipleRatePlans", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "ratePlanCodeList", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Rate Plan code.", "items": { "type": "string" }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching rate plans.", "schema": { "$ref": "#/definitions/availabilityRatePlanInfo" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/rates/{ratePlanCode}": { "get": { "summary": "Get Rate Plan Information ", "description": "This API fetches the ratePlan information like description, short information, long information, Web URL for the ratePlan and Commission Code. The rate plan code list can be passed as part of the criteria in the request.OperationId:getAvailabilityRatePlanInfo
", "operationId": "getAvailabilityRatePlanInfo", "parameters": [ { "name": "ratePlanCode", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Rate Plan Code." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "ratePlanCodeList", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Rate Plan code.", "items": { "type": "string" }, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching rate plans.", "schema": { "$ref": "#/definitions/availabilityRatePlanInfo" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/restrictions": { "get": { "summary": "Get the Restrictions ", "description": "This API allows to fetch the Restrictions for a hotel in given date range. The search criteria can include filter codes or restriction control types, date range and the hotel information.OperationId:getRestrictionsByDateRange
", "operationId": "getRestrictionsByDateRange", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "chainName", "in": "query", "required": false, "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", "type": "string" }, { "name": "end", "in": "query", "required": false, "description": "The ending value of the date range.", "type": "string", "format": "date" }, { "name": "fetchSizeByDay", "in": "query", "required": false, "description": "Defines the maximum amount of restrictions by day.", "type": "integer" }, { "name": "limit", "in": "query", "required": false, "description": "Indicates maximum number of records a Web Service should return.", "type": "integer" }, { "name": "restrictionInfo", "in": "query", "required": false, "type": "string", "uniqueItems": true, "enum": [ "Detail", "Overview", "Year" ] }, { "name": "restrictionSearchCriteriaStartDate", "in": "query", "required": false, "description": "The starting value of the date range.", "type": "string", "format": "date" }, { "name": "bookingChannelCode", "in": "query", "required": false, "description": "Indicates restriction is applicable to specified Booking Channel Code in conjunction with other codes, if specified.", "type": "string" }, { "name": "ratePlanCategory", "in": "query", "required": false, "description": "Indicates restriction is applicable to specified Rate Plan Category in conjunction with other codes, if specified.", "type": "string" }, { "name": "ratePlanCode", "in": "query", "required": false, "description": "Indicates restriction is applicable to specified Rate Plan Code in conjunction with other codes, if specified.", "type": "string" }, { "name": "roomClass", "in": "query", "required": false, "description": "Indicates restriction is applicable to specified Room Category in conjunction with other codes, if specified.", "type": "string" }, { "name": "roomType", "in": "query", "required": false, "description": "Indicates restriction is applicable to specified Room Type in conjunction with other codes, if specified.", "type": "string" }, { "name": "filterCodeCategory", "in": "query", "required": false, "description": "An enumerated type defining the Filter Code Categort or Type. Values: BookingChannelCode, RoomClass, RoomType, RatePlanCategory, RatePlanCode.", "type": "string", "uniqueItems": true, "enum": [ "BookingChannelCode", "RoomClass", "RoomType", "RatePlanCategory", "RatePlanCode" ] }, { "name": "filterCode", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Defines BookingChannelCode, RoomClass, RoomType, RatePlanCategory or RatePlanCode to filter the Restriction.", "items": { "type": "string" }, "required": false }, { "name": "houseLevelRestriction", "in": "query", "required": false, "description": "Applicable when Always Display House Level Restrictions Parameter is On. If true, API returns restrictions at the House level when searching by channel, room class, room type, rate category and rate code.", "type": "boolean" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for fetching restrictions based on date range.", "schema": { "$ref": "#/definitions/restrictionsByDateRange" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] }, "post": { "summary": "Create a Restriction ", "description": "This API allows you to create restrictions on various levels such as house level, rate class, rate category, rate plan, room class, room type, and booking channel code.OperationId:postRestriction
", "operationId": "postRestriction", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "createRestriction", "in": "body", "required": true, "description": "Request object for creating a new restriction.", "schema": { "allOf": [ { "$ref": "#/definitions/createRestriction" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "201": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "HATEOAS links which help the consumer to navigate to resources", "schema": { "$ref": "#/definitions/status" } }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] }, "put": { "summary": "Clear all Restrictions", "description": "This API allows Clear all Restrictions for a hotel on given date. The hotel code and the date will need to be passed as part of the request.OperationId:clearAllRestrictions
", "operationId": "clearAllRestrictions", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "clearAllRestrictions", "in": "body", "required": true, "description": "Request object for clearing all restrictions based on date.", "schema": { "allOf": [ { "$ref": "#/definitions/clearAllRestrictions" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/restrictions/{restrictionId}": { "delete": { "summary": "Delete a Restriction ", "description": "This API allows to Delete a given restriction. The date range is passed along with the restriction control type details which can include house, room type, room class or rate plan information. The unique criteria has been defined with one of these combinations: restrictionType, restrictionStartDate, restrictionEndDate, bookingChannelCode, ratePlanCategory, ratePlanCode, roomClass, roomType.OperationId:deleteRestriction
", "operationId": "deleteRestriction", "parameters": [ { "name": "restrictionId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Indicates the Restriction Type of the restriction and mandatory to delete the restriction." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Indicates restriction is applicable to specified property and mandatory to delete the restriction." }, { "name": "restrictionEndDate", "in": "query", "required": false, "description": "Indicates the End date of the restriction and mandatory to delete the restriction.", "type": "string", "format": "date" }, { "name": "restrictionStartDate", "in": "query", "required": false, "description": "Indicates the start date of the restriction and mandatory to delete the restriction.", "type": "string", "format": "date" }, { "name": "bookingChannelCode", "in": "query", "required": false, "description": "Indicates restriction is applicable to specified Booking Channel Code in conjunction with other codes, if specified.", "type": "string" }, { "name": "ratePlanCategory", "in": "query", "required": false, "description": "Indicates restriction is applicable to specified Rate Plan Category in conjunction with other codes, if specified.", "type": "string" }, { "name": "ratePlanCode", "in": "query", "required": false, "description": "Indicates restriction is applicable to specified Rate Plan Code in conjunction with other codes, if specified.", "type": "string" }, { "name": "roomClass", "in": "query", "required": false, "description": "Indicates restriction is applicable to specified Room Category in conjunction with other codes, if specified.", "type": "string" }, { "name": "roomType", "in": "query", "required": false, "description": "Indicates restriction is applicable to specified Room Type in conjunction with other codes, if specified.", "type": "string" }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "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": [ "Availability" ] } }, "/hotels/{hotelId}/restrictionsHistory": { "get": { "summary": "Get the Restriction history ", "description": "This API allows to fetch the Restriction history. Specify filter codes or restriction control types. The date range can be passed as part of the request.OperationId:getRestrictionsHistory
", "operationId": "getRestrictionsHistory", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "chainName", "in": "query", "required": false, "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", "type": "string" }, { "name": "date", "in": "query", "required": false, "type": "string", "format": "date", "description": "The date for which a restriction log exists." }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date", "description": "The date for which a restriction log exists. When start date is passed, end date must be provided which will fetch all restrictions logs that has an overlap in the provided range." }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date", "description": "The date for which a restriction log exists. When start date is passed, end date must be provided which will fetch all restrictions logs that has an overlap in the provided range." }, { "name": "bookingChannelCode", "in": "query", "required": false, "description": "Indicates restriction is applicable to specified Booking Channel Code in conjunction with other codes, if specified.", "type": "string" }, { "name": "ratePlanCategory", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Indicates restriction is applicable to specified Rate Plan Category in conjunction with other codes, if specified.", "items": { "type": "string" }, "maxItems": 10, "required": false }, { "name": "ratePlanCode", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Indicates restriction is applicable to specified Rate Plan Code in conjunction with other codes, if specified.", "items": { "type": "string" }, "maxItems": 10, "required": false }, { "name": "roomClass", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Indicates restriction is applicable to specified Room Category in conjunction with other codes, if specified.", "items": { "type": "string" }, "maxItems": 10, "required": false }, { "name": "roomType", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Indicates restriction is applicable to specified Room Type in conjunction with other codes, if specified.", "items": { "type": "string" }, "maxItems": 10, "required": false }, { "name": "restrictionType", "in": "query", "type": "array", "collectionFormat": "multi", "uniqueItems": true, "enum": [ "Closed", "ClosedForArrival", "ClosedForDeparture", "MinimumStayThrough", "MaximumStayThrough", "MinimumLengthOfStay", "MaximumLengthOfStay", "LOSNotAvailable", "MinimumAdvanceBooking", "MaximumAdvanceBooking", "Open", "OpenForArrival", "OpenForDeparture", "Hurdle", "MinimumOccupancy", "MaximumOccupancy", "RateStrategy", "RateDetailsNotSet", "InventoryItemNotAvailable", "RankRestriction", "MaximumAuth", "InventoryNotAvailable", "RoomClassNotAvailable", "RoomTypeNotAvailable", "BlockSellLimit", "OnRequest" ], "description": "Indicates the restriction types.", "items": { "type": "string" }, "maxItems": 10, "required": false }, { "name": "limit", "in": "query", "required": false, "default": 50, "maximum": 100, "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": "orderBy", "in": "query", "type": "string", "collectionFormat": "multi", "enum": [ "ActionType", "StartDate", "EndDate", "RateCode", "RestrictionType", "CreationDateTime", "RoomType" ], "required": false }, { "name": "sortOrder", "in": "query", "type": "string", "collectionFormat": "multi", "uniqueItems": true, "enum": [ "Asc", "Desc" ], "required": false }, { "name": "userId", "in": "query", "type": "array", "collectionFormat": "multi", "description": "Indicates restriction is created by User ID in conjunction with other Users, if specified.", "items": { "type": "integer" }, "maxItems": 10, "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object for searching restrictions history.", "schema": { "$ref": "#/definitions/restrictionsHistory" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/validateGuarantees": { "put": { "summary": "Get Reservation Guarantee ", "description": "This API allows to Fetch Reservation Guarantee. The criteria can include the rate plan code, arrival date, guarantee code and the profile information.OperationId:validateReservationGuarantees
", "operationId": "validateReservationGuarantees", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "validateReservationGuarantees", "in": "body", "required": true, "description": "Request object to fetch reservation guarantees.", "schema": { "allOf": [ { "$ref": "#/definitions/validateReservationGuarantees" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response object to fetch reservation guarantees.", "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/hotels/{hotelId}/yieldMarketType": { "get": { "summary": "Yield Market Type LookUp.", "description": "Use this API To LookUp Yield Market Type In An External System:OperationId:getExternalYieldMarketType
", "operationId": "getExternalYieldMarketType", "parameters": [ { "name": "membershipId", "in": "query", "required": false, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Membership Card Number." }, { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "The Code That Uniquely Identifies A Single Hotel Property." }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response object Of Yield Market Type LookUp.", "schema": { "$ref": "#/definitions/yieldMarketTypeDetails" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "AvailabilityExternal" ] } }, "/hurdles": { "get": { "summary": "Get multiple property Hurdle Rates", "description": "This API allows to fetch multiple properties existing Hurdle Rates.OperationId:getHurdleRates
", "operationId": "getMultiPropHurdleRates", "parameters": [ { "name": "hotelIds", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Hotel code.", "items": { "type": "string" }, "required": false }, { "name": "hurdleDate", "in": "query", "required": false, "description": "Date criteria for which the hurdle rate is scheduled.", "type": "string", "format": "date" }, { "name": "limit", "in": "query", "required": false, "default": 25, "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": "roomTypesCode", "in": "query", "type": "array", "maxItems": 4000, "collectionFormat": "multi", "description": "Codes to be searched.", "items": { "type": "string" }, "required": false }, { "name": "wildCard", "in": "query", "required": false, "description": "Wildcard search on the code.", "type": "string" }, { "name": "hurdleRangeStart", "in": "query", "type": "string", "description": "Hurdle date start range from which the hurdle rate is scheduled.", "format": "date", "required": false }, { "name": "hurdleRangeEnd", "in": "query", "type": "string", "description": "Hurdle date end range to which the hurdle rate is scheduled.", "format": "date", "required": false }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" }, { "$ref": "#/parameters/x-hubid" } ], "responses": { "200": { "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 Hurdle rates.", "schema": { "$ref": "#/definitions/hurdleRates" } }, "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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/services/availability/status": { "get": { "summary": "Get the Availability Service version", "description": "This API allows to retrieve the Availability Service version.OperationId:pingAvailabilityService
", "operationId": "pingAvailabilityService", "parameters": [ { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" } }, "description": "Response for Ping operation.", "schema": { "$ref": "#/definitions/operaVersion" } }, "204": { "description": "pingAvailabilityService not found." }, "400": { "$ref": "#/responses/400" }, "401": { "$ref": "#/responses/401" }, "403": { "$ref": "#/responses/403" }, "404": { "$ref": "#/responses/404" }, "405": { "$ref": "#/responses/405" }, "406": { "$ref": "#/responses/406" }, "413": { "$ref": "#/responses/413" }, "414": { "$ref": "#/responses/414" }, "415": { "$ref": "#/responses/415" }, "500": { "$ref": "#/responses/500" }, "502": { "$ref": "#/responses/502" }, "503": { "$ref": "#/responses/503" } }, "consumes": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } }, "/upsert/hotels/{hotelId}/hurdles": { "put": { "summary": "Create/Change Hurdle Rates", "description": "This API allows to create/change an existing Hurdle Rate.OperationId:putUpsertHurdleRates
", "operationId": "putUpsertHurdleRates", "parameters": [ { "name": "hotelId", "in": "path", "required": true, "type": "string", "minLength": 1, "maxLength": 2000, "description": "Unique ID that identifies a single hotel property." }, { "name": "changeHurdleRates", "in": "body", "required": true, "description": "Request object for changing existing Hurdle Rates.", "schema": { "allOf": [ { "$ref": "#/definitions/changeHurdleRates" } ] } }, { "$ref": "#/parameters/authKey" }, { "$ref": "#/parameters/externalData" }, { "$ref": "#/parameters/x-app-key" }, { "$ref": "#/parameters/x-request-id" }, { "$ref": "#/parameters/x-originating-application" }, { "$ref": "#/parameters/x-hotelid" }, { "$ref": "#/parameters/x-externalsystem" }, { "$ref": "#/parameters/Accept-Language" } ], "responses": { "200": { "headers": { "Content-Language": { "type": "string", "description": "Audience language", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*", "x-example": "en-GB" }, "Location": { "type": "string", "description": "Location of newly created resource" } }, "description": "Response Body.", "schema": { "$ref": "#/definitions/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": [ "application/json;charset=UTF-8" ], "produces": [ "application/json;charset=UTF-8" ], "tags": [ "Availability" ] } } }, "parameters": { "externalData": { "name": "externalData", "type": "string", "description": "Pass this header as true, if payload needs DVM", "in": "header" }, "authKey": { "name": "authorization", "description": "Bearer token that needs to be passed which is generated post user authentication", "type": "string", "in": "header", "required": true }, "x-app-key": { "name": "x-app-key", "description": "Client or Partner's Application Key", "type": "string", "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$", "in": "header", "required": true }, "x-request-id": { "name": "x-request-id", "type": "string", "pattern": "~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "description": "Request Id of an incoming request", "in": "header" }, "x-originating-application": { "name": "x-originating-application", "type": "string", "description": "Customer's Integration Application Id", "in": "header" }, "x-hotelid": { "name": "x-hotelid", "type": "string", "description": "Mandatory parameter to identify the hotel code where the end user is logged in", "in": "header", "required": true }, "x-externalsystem": { "name": "x-externalsystem", "type": "string", "maxLength": 40, "description": "External system code.", "in": "header", "x-example": "EXTERNALSYSTEMCODE" }, "Accept-Language": { "name": "Accept-Language", "type": "string", "description": "Language code", "in": "header" }, "x-hubid": { "name": "x-hubid", "type": "string", "description": "x-hubid is a logical grouping of multiple properties that allows api consumers to manage data from a group of properties. This x-hubid is a valid list of hub codes configured in OPERA to which the user has access. Rest APIs without hotelId in the operation path can support hub level integration using x-hubid", "in": "header" } }, "responses": { "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "405": { "description": "Method not allowed" }, "406": { "description": "Not acceptable." }, "413": { "description": "Request Entity Too Large" }, "414": { "description": "Request URI Too Large" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "System Error", "schema": { "$ref": "#/definitions/exceptionDetailType" } }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "definitions": { "hotelAvailability": { "type": "object", "description": "Response object to search hotel availability based on request segment.", "properties": { "hotelAvailability": { "type": "array", "items": { "$ref": "#/definitions/availResponseSegmentType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "availResponseSegmentType": { "type": "object", "properties": { "roomStays": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/roomStayType" } }, "masterInfo": { "$ref": "#/definitions/availResponseMasterInfoType" }, "hotelAlert": { "description": "Hotel Alert Message.", "type": "string", "minLength": 0, "maxLength": 2000 }, "restriction": { "description": "Indicates the restriction types.", "$ref": "#/definitions/masterRestrictionStatusesType" }, "rateChange": { "description": "Indicates the amount returned is FIRSTNIGHT/HIGHEST/LOWEST/MOSTCOMMON/AVERAGE when there is rate change in the stay dates.", "$ref": "#/definitions/rateChangeTypeType" }, "hotelInfo": { "description": "Hotel information like hotel name,address,communication etc and also alternate hotel information if requested property is not available.", "$ref": "#/definitions/hotelInfoType" }, "channelInformation": { "description": "Channel related information if availability request is send for a channel.", "$ref": "#/definitions/channelAvailRSInfoType" }, "ratePlanSet": { "description": "Rate Plan Set whose Rate Plans are returned in the response.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "description": "Hotel Code whose Rate Plans are returned in the response.", "type": "string", "minLength": 0, "maxLength": 20 }, "closed": { "description": "If the availability response has a house level restriction, this flag will be true.", "type": "boolean" }, "redemption": { "description": "Used to indicate if the Room Rates returned are calculated based on points.", "type": "boolean" }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" }, "pagingKey": { "description": "Used to indicate the paging key(rate room) when more rate rooms available.", "type": "string" } } }, "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" } } }, "uniqueID_Type": { "type": "object", "description": "An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).", "properties": { "id": { "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.", "type": "string", "minLength": 0, "maxLength": 80 }, "type": { "description": "A reference to the type of object defined by the UniqueID element.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "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" } } }, "codeListType": { "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "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 }, "guaranteedYn": { "type": "string", "minLength": 0, "maxLength": 1 }, "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 }, "offshoreRate": { "type": "boolean", "description": "If true, indicates that rate code is Offshore Rate." } } }, "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" } } }, "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 } } }, "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" ] }, "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 } } }, "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" } } }, "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" } } } }, "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 } } }, "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" ] }, "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" }, "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" } } }, "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 } } }, "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" } } }, "profileIdList": { "type": "array", "description": "Unique Id that references an object uniquely in the system.", "maxItems": 4000, "items": { "$ref": "#/definitions/uniqueID_Type" } }, "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": { "addressInfo": { "description": "Collection of Detailed information on an address for the customer.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/addressInfoType" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "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" } }, "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" } } }, "uRLs": { "description": "List of Information on a URL for the customer.", "type": "object", "properties": { "uRLInfo": { "description": "Collection of Detailed information on web url/address for the customer.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/uRLInfoType" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "comments": { "description": "List of Notes for the customer.", "type": "object", "properties": { "commentInfo": { "description": "Collection of Detailed information on comments for the customer.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/commentInfoType" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "profileDeliveryMethods": { "description": "List of Delivery methods configured against a Property for this Profile.", "type": "object", "properties": { "profileDeliveryMethod": { "description": "Collection of delivery methods for this Profile.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/profileDeliveryMethod" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "profileMemberships": { "description": "List of loyalty program(s) the profile is subscribed to.", "type": "object", "properties": { "profileMembership": { "description": "Collection of Detailed information on memberships for the customer.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/profileMembershipType" } }, "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" } } }, "preferenceCollection": { "description": "List of customer preferences.", "type": "object", "properties": { "preferenceType": { "description": "Collection of Detailed information on preferences of the customer.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/preferenceTypeType" } }, "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" } } }, "keywords": { "description": "List of customer keywords.", "type": "object", "properties": { "keyword": { "description": "Collection of keywords attached to the profile.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/keywordType" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "negotiatedRates": { "description": "List of profile negotiated rates.", "type": "object", "properties": { "negotiatedRate": { "description": "Collection of Detailed information on profile negotiated rates.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/negotiatedType" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "gdsNegotiatedRates": { "description": "List of channel negotiated rates that this profile has been assigned to.", "type": "object", "properties": { "gdsNegotiatedRate": { "description": "Collection of Detailed information on channel negotiated rates for the profile.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/gdsNegotiatedType" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "profileIndicators": { "description": "Indicators of additional information attached to the profile", "$ref": "#/definitions/indicatorsType" }, "relationships": { "description": "Contains a collection of profiles that have a relationship with this profile.", "type": "object", "properties": { "relationship": { "description": "A collection of the profiles that have a relationship with this profile.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/relationshipInfoType" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "relationshipsSummary": { "description": "Contains a collection of profiles that have a relationship with this profile.", "type": "object", "properties": { "relationship": { "description": "A collection of the profiles summary that have a relationship with this profile.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/relationshipInfoSummaryType" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "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/profileCommissionType" } }, "userDefinedFields": { "description": "Collections of user defined fields.", "$ref": "#/definitions/userDefinedFieldsType" }, "webUserAccounts": { "description": "List of Web User Accounts of the profile.", "$ref": "#/definitions/webUserAccountsType" }, "taxInfo": { "description": "Profile information about tax.", "$ref": "#/definitions/profileTaxInfoType" }, "salesInfo": { "description": "Sales information of the profiles.", "$ref": "#/definitions/salesInfoType" }, "eCertificates": { "description": "E-Certificate assosiated with the profile.", "$ref": "#/definitions/eCertificatesType" }, "subscriptions": { "description": "List of profile subscriptions.", "$ref": "#/definitions/profileSubscriptionListType" }, "localizationGuestType": { "description": "Localization Guest Type assocaited to the profile.", "type": "string", "minLength": 0, "maxLength": 20 }, "eligibleForFiscalFolio": { "description": "Eligible for Fiscal Folio/Payload generation.", "type": "string", "minLength": 0, "maxLength": 20 }, "profileType": { "description": "Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.", "$ref": "#/definitions/profileTypeType" }, "statusCode": { "description": "Status of the profile. Active/Inactive", "$ref": "#/definitions/profileStatusType" }, "registeredProperty": { "description": "Hotel which this profile is registered with. This attribute is not used for configuration.", "type": "string", "minLength": 0, "maxLength": 20 }, "requestForHotel": { "description": "Hotel which this profile is to be registered. This attribute is only used during creation of profile.", "type": "string", "minLength": 0, "maxLength": 20 }, "protectedBy": { "description": "What level this profile is protected.", "type": "string", "minLength": 0, "maxLength": 40 }, "createDateTime": { "description": "Time stamp of the creation.", "type": "string", "format": "date-time" }, "creatorId": { "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible 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 }, "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" } } }, "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" } }, "anonymization": { "description": "Provides information about the guest's anonymization status", "$ref": "#/definitions/anonymizationType" }, "citizenCountry": { "description": "Name of the (self-professed) country that is claimed for citizenship.", "$ref": "#/definitions/countryNameType" }, "identifications": { "description": "List of identification of the customer.", "type": "object", "properties": { "identificationInfo": { "description": "Collection of detailed information on the identification of the customer.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/identificationInfoType" } }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "profession": { "description": "Profession of a person.", "type": "string", "minLength": 0, "maxLength": 80 }, "alienInfo": { "description": "Immigration/visa information of a foreign person.", "$ref": "#/definitions/alienInfoType" }, "birthCountry": { "description": "Country of birth.", "$ref": "#/definitions/countryNameType" }, "legalCompany": { "description": "Name Of the company the individual is associated with.", "type": "string", "minLength": 0, "maxLength": 80 }, "companyInfo": { "description": "Company Information of the Profile.", "$ref": "#/definitions/companyInfoType" }, "businessTitle": { "description": "Business Title.", "type": "string", "minLength": 0, "maxLength": 80 }, "gender": { "description": "Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration.", "type": "string", "minLength": 0, "maxLength": 20 }, "birthDate": { "description": "Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.", "type": "string", "format": "date", "maxLength": 8 }, "birthDateMasked": { "description": "Indicates the date of birth as masked.", "type": "string" }, "currencyCode": { "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", "type": "string", "minLength": 0, "maxLength": 20 }, "currencySymbol": { "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", "type": "string", "minLength": 0, "maxLength": 10 }, "decimalPlaces": { "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", "type": "integer" }, "language": { "description": "Language identification.", "type": "string", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, "nationality": { "description": "Nationality code identification", "type": "string", "minLength": 0, "maxLength": 20 }, "nationalityDescription": { "description": "Nationality code description", "type": "string", "minLength": 0, "maxLength": 80 }, "customerValue": { "description": "The supplier's ranking of the customer (e.g., VIP, numerical ranking).", "type": "string", "minLength": 0, "maxLength": 20 }, "creditRating": { "description": "Credit Rating of the customer.", "type": "string", "minLength": 0, "maxLength": 20 }, "vipStatus": { "description": "VIP status of the customer.", "type": "string", "minLength": 0, "maxLength": 20 }, "vipDescription": { "description": "Description of the VIP status.", "type": "string", "minLength": 0, "maxLength": 2000 }, "birthPlace": { "description": "Place of birth.", "type": "string", "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" } } }, "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 } } }, "personNameTypeType": { "type": "string", "description": "Person's name in an external system.", "enum": [ "Primary", "Alternate", "Incognito", "External", "Phonetic" ] }, "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" ] }, "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 } } }, "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": 40 } } }, "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" } } }, "alienInfoType": { "type": "object", "description": "immigration/visa information of a foreign person.", "properties": { "alienRegistrationNo": { "description": "Alien Registration Number.", "type": "string" }, "immigrationStatus": { "description": "Immigration Status on an Alien.", "type": "string", "minLength": 0, "maxLength": 40 }, "visaValidityType": { "description": "Visa Type of an Alien.", "type": "string", "minLength": 0, "maxLength": 40 } } }, "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 } } }, "companyType": { "type": "object", "properties": { "companyName": { "description": "Name of the company.", "type": "string", "minLength": 0, "maxLength": 40 }, "companyName2": { "description": "Second Name of the company.", "type": "string", "minLength": 0, "maxLength": 40 }, "companyName3": { "description": "Third 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 }, "alternateLanguage": { "description": "Alternate Language of the company.", "type": "string", "minLength": 0, "maxLength": 20 }, "businessLocale": { "description": "A jurisdiction(Territory) in which a company is authorized to do business.", "type": "string", "minLength": 0, "maxLength": 40 }, "iATAInfo": { "description": "IATA Information of the profile.", "$ref": "#/definitions/iATAInfoType" }, "businessTitle": { "description": "Business Title.", "type": "string", "minLength": 0, "maxLength": 80 }, "currencyCode": { "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code.", "type": "string", "minLength": 0, "maxLength": 20 }, "currencySymbol": { "description": "The symbol for the currency, e.g, for currencyCode USD the symbol is $.", "type": "string", "minLength": 0, "maxLength": 10 }, "decimalPlaces": { "description": "Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard \"minor unit\". Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=\"2\" to represent $85).", "type": "integer" }, "language": { "description": "Language identification.", "type": "string", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, "nationality": { "description": "Nationality code identification", "type": "string", "minLength": 0, "maxLength": 20 }, "nationalityDescription": { "description": "Nationality code description", "type": "string", "minLength": 0, "maxLength": 80 }, "commissionCode": { "description": "Commission code of the company.", "type": "string", "minLength": 0, "maxLength": 20 }, "creditRating": { "description": "Credit Rating of the company.", "type": "string", "minLength": 0, "maxLength": 20 }, "corporateIdType": { "description": "The type of corporate ID", "type": "string", "minLength": 0, "maxLength": 20 }, "vipStatus": { "description": "VIP status of the company.", "type": "string", "minLength": 0, "maxLength": 20 }, "vipDescription": { "description": "Description of the VIP status.", "type": "string", "minLength": 0, "maxLength": 2000 }, "blacklist": { "description": "This element tells if profile is blacklisted or not.", "type": "boolean" } } }, "iATAInfoType": { "type": "object", "description": "IATA Information of the profile.", "properties": { "iATACompany": { "description": "IATA Company Detail.", "type": "string", "minLength": 0, "maxLength": 20 }, "iATAConsortia": { "description": "IATA Consortia.", "type": "string", "minLength": 0, "maxLength": 40 }, "iATAValidationResult": { "description": "IATA Validation Result.", "type": "boolean" } } }, "imageSetType": { "type": "object", "description": "Represents on image set record.", "properties": { "language": { "description": "Language identification.", "type": "string", "pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*" }, "imageSet": { "description": "The image set name.", "type": "string", "minLength": 0, "maxLength": 800 }, "sequenceId": { "description": "The image set sequence ID.", "type": "integer" }, "imageStyle": { "description": "The image set enumerated style.", "$ref": "#/definitions/imageStyleType" }, "imageType": { "description": "The image set type.", "type": "string", "minLength": 0, "maxLength": 80 }, "hotelId": { "description": "The image set hotel code.", "type": "string", "minLength": 0, "maxLength": 20 }, "chainCode": { "description": "The image set chain code.", "type": "string", "minLength": 0, "maxLength": 20 }, "imageURL": { "description": "The image set URL.", "type": "string", "minLength": 0, "maxLength": 2000 }, "description": { "description": "The image set description.", "type": "string", "minLength": 0, "maxLength": 2000 }, "imageOrder": { "description": "The image set order.", "type": "integer" }, "website": { "description": "The image set website.", "type": "string", "minLength": 0, "maxLength": 2000 } } }, "imageStyleType": { "type": "string", "description": "An enumeration of image styles.", "enum": [ "Full", "Thumbnail", "Icon", "Square", "Banner", "Button", "Lowres", "Highres" ] }, "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": 40 } } }, "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" }, "barCode": { "description": "The postal barcode for the address.", "type": "string", "minLength": 0, "maxLength": 100 }, "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 responsible 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 } } }, "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": 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", "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 responsible 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 } } }, "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": 40 } } }, "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 responsible 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 } } }, "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": 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.", "type": "string", "format": "date-time" }, "creatorId": { "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible 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 }, "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 } } }, "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 responsible 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 } } }, "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})*" } } }, "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" } } }, "profileDeliveryModuleType": { "type": "string", "description": "Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..", "enum": [ "EfolioExport" ] }, "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, policyRequirements 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 responsible 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 } } }, "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" ] }, "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" ] }, "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 responsible 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 } }, "preferenceId": { "type": "string", "minLength": 0, "maxLength": 20 }, "excludedPreferencesCount": { "description": "Specifies the count of preferences excluded for the attached reservation preference.", "type": "integer" } } }, "keywordType": { "type": "object", "properties": { "keywordDetail": { "description": "The keyword new value, in case keyword value is modified.", "$ref": "#/definitions/keywordDetailType" }, "type": { "description": "The type of keyword", "type": "string", "minLength": 0, "maxLength": 20 }, "keyword": { "description": "The keyword value.", "type": "string", "minLength": 0, "maxLength": 80 } } }, "keywordDetailType": { "type": "object", "properties": { "newKeyword": { "description": "The new keyword value.", "type": "string", "minLength": 0, "maxLength": 80 } } }, "negotiatedType": { "type": "object", "description": "This holds a list of NegotiatedInfoType.", "properties": { "negotiatedInfoList": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/negotiatedInfoType" } }, "hotelId": { "description": "Hotel code for the negotiated rate.", "type": "string", "minLength": 0, "maxLength": 20 }, "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", "minLength": 0, "maxLength": 80 }, "comissionCode": { "description": "Informational purposes only in numeric format.", "type": "string", "minLength": 0, "maxLength": 20 }, "order": { "description": "The sell order.", "type": "integer" }, "inactive": { "description": "Negotiated Rate is inactive or not", "type": "boolean" }, "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 } } }, "gdsNegotiatedType": { "type": "object", "description": "This holds a list of GdsNegotiatedInfoType.", "properties": { "gdsNegotiatedInfoList": { "description": "List of channel negotiated rates for the profile.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/gdsNegotiatedInfoType" } }, "bookingChannelCode": { "description": "Booking Channel Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "description": "Hotel Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "channelRatePlanCode": { "description": "Channel Room Type.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "gdsNegotiatedInfoType": { "type": "object", "description": "This provides information for a channel negotiated rate.", "properties": { "accessCode": { "description": "The GDS negotiated rate code.", "type": "string", "minLength": 0, "maxLength": 20 }, "order": { "description": "The sell order.", "type": "integer" }, "inactive": { "description": "The GDS Negotiated Rate is inactive or not", "type": "boolean" }, "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 } } }, "indicatorsType": { "type": "array", "description": "Collection of lamp indicators.", "maxItems": 4000, "items": { "$ref": "#/definitions/indicatorType" } }, "indicatorType": { "type": "object", "description": "Lamp indicator Type.", "properties": { "indicatorName": { "description": "Name of the indicator.", "type": "string", "minLength": 0, "maxLength": 80 }, "count": { "description": "Indicates number of occurrences of the indicator.", "type": "integer" } } }, "relationshipInfoType": { "type": "object", "description": "Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.", "properties": { "changeRelationship": { "description": "Information about the changes in relationship for the profile", "$ref": "#/definitions/changeRelationsType" }, "relationshipProfile": { "description": "Refer to Relationship Profile type document.", "$ref": "#/definitions/relationshipProfileType" }, "masterAccountInfo": { "description": "Refer to Master Profile type document.", "$ref": "#/definitions/masterAccountInfoType" }, "id": { "description": "Relationship identifier.", "type": "string", "minLength": 0, "maxLength": 80 }, "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 }, "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 }, "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 }, "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", "minLength": 0, "maxLength": 80 }, "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 }, "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 }, "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 }, "targetRelationDescription": { "description": "Displays the description of the target relation(Target Profile).", "type": "string", "minLength": 0, "maxLength": 200 } } }, "relationshipProfileType": { "type": "object", "properties": { "customer": { "description": "Detailed information of the customer", "$ref": "#/definitions/customerType" }, "company": { "description": "Detailed information of the Company.", "$ref": "#/definitions/companyType" }, "telephone": { "description": "Information on telephone details for the customer/company", "$ref": "#/definitions/telephoneInfoType" }, "address": { "description": "Information on address details for the customer/company", "$ref": "#/definitions/addressInfoType" }, "email": { "description": "Information on email address for the customer/company", "$ref": "#/definitions/emailInfoType" }, "uRLs": { "description": "Information on web url/address for the customer/company", "$ref": "#/definitions/uRLInfoType" }, "primaryOwner": { "description": "Primary Owner of the profile", "$ref": "#/definitions/ownerType" }, "profileIdList": { "description": "Original profile details for which the relationships was created", "$ref": "#/definitions/uniqueIDListType" }, "changeProfileIdList": { "description": "Updated/changed profile details for the relationships created", "$ref": "#/definitions/uniqueIDListType" }, "primary": { "description": "Indicates if this relationship is the primary relationship.", "type": "string", "minLength": 0, "maxLength": 20 }, "id": { "description": "Relationship identifier.", "type": "string", "minLength": 0, "maxLength": 80 }, "statusCode": { "description": "Status of the profile. Active/Inactive", "$ref": "#/definitions/profileStatusType" }, "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" }, "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" } } }, "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 } } }, "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" } } }, "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" ] }, "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" ] }, "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 } } }, "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" }, "masterAccountDetails": { "description": "Refer to Master Profile type document.", "$ref": "#/definitions/masterAccountInfoType" }, "relationshipID": { "description": "Relationship identifier.", "type": "string", "minLength": 0, "maxLength": 80 }, "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 }, "sourceRelationDescription": { "description": "Displays the description of relationship the current profile(Source Profile) has with the related profile(Target Profile).", "type": "string", "minLength": 0, "maxLength": 200 }, "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 }, "targetRelationDescription": { "description": "Displays the description of the target relation(Target Profile).", "type": "string", "minLength": 0, "maxLength": 200 } } }, "relationshipProfileSummaryType": { "type": "object", "properties": { "customerName": { "description": "Name of the customer", "type": "string", "minLength": 0, "maxLength": 40 }, "companyName": { "description": "Name of the company.", "type": "string", "minLength": 0, "maxLength": 40 }, "telephoneNumber": { "description": "Telephone number assigned to a single location", "type": "string", "minLength": 0, "maxLength": 40 }, "address": { "description": "Information on address details for the customer/company", "$ref": "#/definitions/relationshipAddressType" }, "emailAddress": { "description": "Defines the e-mail address.", "type": "string", "minLength": 0, "maxLength": 2000 }, "ownerCode": { "description": "Unique Code to identify the owner.", "type": "string", "minLength": 0, "maxLength": 20 }, "profileIdList": { "description": "Original profile details for which the relationships was created", "$ref": "#/definitions/uniqueIDListType" }, "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" } } }, "relationshipAddressType": { "type": "object", "description": "Provides address information for a Relationship.", "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", "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", "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).", "type": "string", "minLength": 0, "maxLength": 200 } } }, "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" } } }, "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" }, "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 responsible 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" } } }, "reservationIdList": { "type": "array", "description": "Unique Id that references an object uniquely in the system.", "maxItems": 4000, "items": { "$ref": "#/definitions/uniqueID_Type" } }, "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" } } }, "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": { "startDate": { "type": "string", "format": "date", "maxLength": 8 }, "endDate": { "type": "string", "format": "date", "maxLength": 8 }, "duration": { "type": "string" } } }, "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" } } }, "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 } } }, "blockIdList": { "type": "array", "description": "Unique Id that references an object uniquely in the system.", "maxItems": 4000, "items": { "$ref": "#/definitions/uniqueID_Type" } }, "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 } } }, "guestHousekeepingServiceRequestType": { "type": "string", "description": "Possible values for the Guest Service Status.", "enum": [ "DoNotDisturb", "MakeUpRoom", "NoStatusSelected" ] }, "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": 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" } } }, "namePrefixType": { "type": "string", "description": "Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)", "minLength": 0, "maxLength": 40 }, "givenNameType": { "type": "string", "description": "Given name, first name or names", "minLength": 0, "maxLength": 40 }, "surnameType": { "type": "string", "description": "Family name, last name.", "minLength": 0, "maxLength": 40 }, "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 } } }, "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" } } }, "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" } } }, "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" } } }, "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" } } }, "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/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" } } }, "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" } } }, "resProfileTypeType": { "type": "string", "enum": [ "Guest", "Company", "Group", "TravelAgent", "Source", "ReservationContact", "BillingContact", "Addressee" ] }, "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": 40 } } }, "paymentMethod": { "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "type": "string", "minLength": 0, "maxLength": 2000 }, "folioView": { "type": "integer" } } }, "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" }, "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" } } }, "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": { "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" } } }, "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" } } }, "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 } } }, "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" } } }, "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" ] }, "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 } } }, "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 } } }, "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 }, "priorityCode": { "description": "Waitlist Priority Code.", "type": "string", "minLength": 0, "maxLength": 20 }, "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" } } }, "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 } } }, "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 } } }, "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 } } }, "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", "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" } } }, "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 } } }, "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" } } }, "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" } } }, "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" } } } }, "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 } } }, "resPreConfiguredRoutingInstrType": { "type": "object", "description": "Instruction to attach Pre-Configured Routing Instructions to a Reservation.", "properties": { "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 } } }, "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" } } }, "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" ] }, "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" } } } }, "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" ] }, "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 } } }, "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" ] }, "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" ] }, "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" } } } } }, "advanceCheckInType": { "type": "object", "description": "Information relating to Reservation's Advance Checked In state and Expected Time of Return", "properties": { "advanceCheckedIn": { "description": "Indicates if the reservation is marked as Advance Checked In", "type": "boolean" }, "expectedReturnTime": { "description": "Expected Return Time. Uses the hotel's time zone.", "type": "string", "format": "date-time" }, "eTRComments": { "description": "ETR Comments", "type": "string", "minLength": 0, "maxLength": 2000 } } }, "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" ] }, "resAccessRestrictionType": { "type": "string", "description": "Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.", "enum": [ "Change", "Cancel", "ChangeOrCancel" ] }, "commissionPayoutToType": { "type": "string", "enum": [ "TravelAgent", "Source", "TravelAgentSource", "None" ] }, "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" } } }, "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" } } }, "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" } } }, "profileAccessType": { "type": "object", "properties": { "chainCode": { "description": "Indicates the Chain code where the profile was created", "type": "string", "minLength": 0, "maxLength": 200 }, "croCode": { "description": "Indicates the CRO code where the profile was created", "type": "string", "minLength": 0, "maxLength": 200 }, "hotelId": { "description": "Indicates the Hotel code where the profile was created", "type": "string", "minLength": 0, "maxLength": 200 }, "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", "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" } } }, "mailingActionsType": { "type": "object", "description": "Defines mailing action list for the profile.", "properties": { "mailingAction": { "description": "Defines mailing action code and description.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/codeDescriptionType" } }, "active": { "description": "When true indicates that profile has subscribed to the mailing list.", "type": "boolean" }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "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" } } }, "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 } } }, "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" ] }, "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" } } }, "characterUDFsType": { "type": "array", "description": "Used to hold collection of user defined fields of Character/String Type.", "maxItems": 4000, "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": 4000, "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 } } }, "dateUDFsType": { "type": "array", "description": "Used to hold collection of user defined fields of Date Type.", "maxItems": 4000, "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 } } }, "webUserAccountsType": { "type": "array", "description": "Web User Accounts List.", "maxItems": 4000, "items": { "$ref": "#/definitions/webUserAccountType" } }, "webUserAccountType": { "type": "object", "description": "Web User Account of the guest.", "properties": { "securityQuestion": { "description": "Security Question and its Code associated with the account to verify the user.", "$ref": "#/definitions/codeDescriptionType" }, "securityAnswer": { "description": "Answer to the Security Question.", "type": "string", "minLength": 0, "maxLength": 4000 }, "comments": { "description": "Comments.", "type": "string", "minLength": 0, "maxLength": 4000 }, "history": { "description": "Web User Account History.", "$ref": "#/definitions/webUserHistoryType" }, "newLoginName": { "description": "New Login Name of the guest.", "type": "string", "minLength": 0, "maxLength": 80 }, "newPassword": { "description": "Login Password.", "type": "string", "minLength": 0, "maxLength": 2000 }, "autoGeneratePassword": { "description": "A flag which determines if the password is auto generated.", "type": "boolean" }, "loginName": { "description": "Login Name of the guest.", "type": "string", "minLength": 0, "maxLength": 80 }, "domainCode": { "description": "Domain code.", "type": "string", "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" } } }, "webUserHistoryType": { "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", "format": "date-time" }, "creatorId": { "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible 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 }, "lastLogin": { "description": "Last login date.", "type": "string", "format": "date", "maxLength": 8 }, "lastPasswordChange": { "description": "Last Password change date.", "type": "string", "format": "date", "maxLength": 8 }, "inactiveDate": { "description": "Inactive date.", "type": "string", "format": "date", "maxLength": 8 } } }, "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 } } }, "salesInfoType": { "type": "object", "description": "Provides sales information about the profiles of type company, travel agent, source and contact.", "properties": { "scope": { "description": "Defines the scope.", "type": "string", "minLength": 0, "maxLength": 2000 }, "scopeCity": { "description": "Defines the scope city.", "type": "string", "minLength": 0, "maxLength": 2000 }, "accountType": { "description": "Defines the account type.", "type": "string", "minLength": 0, "maxLength": 20 }, "accountSource": { "description": "Defines the account source.", "type": "string", "minLength": 0, "maxLength": 2000 }, "industryCode": { "description": "Defines the industry code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "businessSegments": { "description": "Defines the Business segments.", "type": "string", "minLength": 0, "maxLength": 2000 }, "priority": { "description": "Defines the priority.", "type": "string", "minLength": 0, "maxLength": 4000 }, "roomsPotential": { "description": "Defines the rooms potential.", "type": "string", "minLength": 0, "maxLength": 4000 }, "actionCode": { "description": "Defines the action code.", "type": "string", "minLength": 0, "maxLength": 4000 }, "competitionCode": { "description": "Defines the competition code.", "type": "string", "minLength": 0, "maxLength": 4000 }, "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", "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" } } }, "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" } } }, "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" ] }, "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": { "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" } } }, "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": { "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 } } }, "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": { "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": { "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" }, "profileType": { "description": "OPERA profile type such as Individual or Company", "$ref": "#/definitions/profileTypeType" } } }, "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. Uses database time zone.", "type": "string", "format": "date-time" }, "lastDistributionDate": { "description": "Timestamp of the most recent distribution of this profile to the external system. Uses database time zone.", "type": "string", "format": "date-time" }, "lastExternalUpdateDate": { "description": "Timestamp of the most recent update of the subscription information by the external system. Uses database time zone.", "type": "string", "format": "date-time" }, "inactive": { "description": "Indicates whether this subscription is active or inactive.", "type": "boolean" } } }, "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" } } }, "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" } } }, "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 } } }, "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", "RestrictedDueToCasinoRestriction" ] }, "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 } } } } }, "ownerResTypeType": { "type": "string", "enum": [ "Owner", "AuthorizedUser" ] }, "primaryShareTypeType": { "type": "string", "enum": [ "Primary", "NonPrimary" ] }, "availResponseMasterInfoType": { "type": "object", "description": "Availability master info type", "properties": { "roomTypes": { "description": "Collection of room type information", "$ref": "#/definitions/roomTypeMasterInfoType" }, "ratePlans": { "description": "Collection of rate plan information", "$ref": "#/definitions/availRatePlanInfoType" } } }, "roomTypeMasterInfoType": { "type": "object", "description": "The RoomType element is used to contain all the room type information for a single room type.", "properties": { "roomType": { "description": "Room type information", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/roomTypeInfoType" } }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "roomTypeInfoType": { "type": "object", "properties": { "longDescription": { "description": "Detail description of the Room Type.", "type": "string", "minLength": 0, "maxLength": 2000 }, "webName": { "description": "Name corresponding to a RoomType.", "type": "string", "minLength": 0, "maxLength": 80 }, "webPage": { "description": "URL providing more information about the Room Type.", "type": "string", "minLength": 0, "maxLength": 2000 }, "roomFeatures": { "description": "Collection of room features.", "$ref": "#/definitions/roomFeaturesType" }, "roomTypeAttributes": { "description": "Room type attributes.", "$ref": "#/definitions/roomTypeAttributesType" }, "bookingChannelMappings": { "description": "Booking Channels mapping for the Room Type.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/bookingChannelMappingType" } }, "bedTypeCodes": { "description": "Bed type code associated with room.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "roomType": { "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 }, "roomClass": { "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "type": "string", "minLength": 0, "maxLength": 2000 }, "suite": { "description": "Indicates room type is a suite.", "type": "boolean" }, "component": { "description": "Indicates room type is a Component Room.", "type": "boolean" }, "invBlockCode": { "description": "Block code.", "type": "string", "minLength": 0, "maxLength": 40 }, "roomViewCode": { "description": "Represents the room view code like City view, River view, Ocean view etc.", "type": "string", "minLength": 0, "maxLength": 40 }, "promotionCode": { "description": "Represents the promotional code.", "type": "string", "minLength": 0, "maxLength": 40 }, "roomQualifierCode": { "description": "Represents the room qualifier code like Deluxe,Economy,Suite etc.", "type": "string", "minLength": 0, "maxLength": 40 }, "roomQualifierMatchIndicator": { "description": "Represents the match indicator of room qualifier code returned in the response with the requested room qualifier code.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "roomFeaturesType": { "type": "array", "description": "A recurring element that identifies the room features.", "maxItems": 4000, "items": { "$ref": "#/definitions/roomFeatureType" } }, "roomFeatureType": { "type": "object", "description": "Room Feature Information.", "properties": { "code": { "description": "A code representing a room feature.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "A code representing a room feature.", "type": "string", "minLength": 0, "maxLength": 2000 }, "orderSequence": { "description": "Display Order sequence.", "type": "number" }, "quantity": { "description": "Indicates quantity.", "type": "integer" } } }, "roomTypeAttributesType": { "type": "object", "description": "Attributes of property room type.", "properties": { "defaultOccupancy": { "description": "Default occupancy of property room type.", "type": "integer" }, "maximumOccupancy": { "description": "Max occupancy of property room type.", "type": "integer" }, "noOfPhysicalRooms": { "description": "Number of physical rooms of property room type.", "type": "integer" } } }, "bookingChannelMappingType": { "type": "object", "properties": { "bookingChannelCode": { "type": "string", "minLength": 0, "maxLength": 20 }, "code": { "type": "string", "minLength": 0, "maxLength": 20 }, "name": { "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "type": "string", "minLength": 0, "maxLength": 2000 } } }, "availRatePlanInfoType": { "type": "object", "description": "The rate plan element is used to contain all the rate information for a single Rate Plan", "properties": { "ratePlan": { "description": "Rate plan information", "type": "array", "maxItems": 4000, "items": { "type": "object", "properties": { "shortInfo": { "description": "Brief Information of the Rate Code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "longInfo": { "description": "Detail Information of the Rate Code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "webPage": { "description": "URL providing more information about the Rate Code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "description": { "description": "Description of the Rate Code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "ratePlanChannelInfo": { "description": "To populate RatePlanLevel, RatePlanWebName, and RatePlanID according to the setup made under channel.", "$ref": "#/definitions/ratePlanChannelInfoType" }, "currencyCode": { "description": "Currency Code of the rate code.", "type": "string", "minLength": 0, "maxLength": 20 }, "bookingChannelMappings": { "description": "Booking Channel mapping for the Rate Plan Code.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/bookingChannelMappingType" } }, "ratePlanLevel": { "description": "All rate codes are associated with rate plan level ( or rate category )for Channels. So if rate plans are given in the request, get all rate codes associated with the rate plan level.", "type": "string", "minLength": 0, "maxLength": 20 }, "guarantee": { "description": "Guarantee details for rate plan code.", "$ref": "#/definitions/guaranteeType" }, "cancelPenalty": { "description": "Cancellation details for rate plan code.", "$ref": "#/definitions/cancelPenaltyType" }, "mealPlans": { "description": "Meal plan codes for rate plan code.", "$ref": "#/definitions/mealPlansType" }, "ratePlanCode": { "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 }, "ratePlanCategory": { "type": "string", "minLength": 0, "maxLength": 20 }, "taxInclusive": { "description": "Indicates if tax is included in the rate code amount.", "type": "boolean" }, "serviceFeeInclusive": { "description": "Indicates if service fee is included in the rate code amount.", "type": "boolean" }, "rateCommission": { "description": "Commission details for Rate plan code.", "$ref": "#/definitions/ratePlanCommissionType" }, "resGuarantees": { "description": "A collection of Guarantee Codes information with cancellation penalty and deposit policy information.", "$ref": "#/definitions/guaranteePoliciesType" }, "negotiatedBy": { "description": "If Rate plane is negotiated by Guest or any attached profiles, this indicates how negotiated it. Applicable values are Guest, Company, Agent and Source.", "$ref": "#/definitions/profileTypeType" }, "marketCode": { "description": "Holds the market code.", "type": "string", "minLength": 0, "maxLength": 20 }, "sourceCode": { "description": "Holds the source code.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelUseOnly": { "description": "If true, indicates this rates is not allowed to be sold by CRO. For CRO this is information only.", "type": "boolean" }, "discountAllowed": { "description": "If true, indicates additional discount could be applied on the Rate.", "type": "boolean" }, "credentialsRequired": { "description": "If true, indicates that credentials is required to sell the rate code.", "type": "boolean" }, "postingInterval": { "description": "Specifies the frequency at which charges are posted for this rate plan.", "type": "string", "minLength": 0, "maxLength": 20 } } } }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "ratePlanChannelInfoType": { "type": "object", "properties": { "ratePlanLevel": { "description": "All rate codes are associated with rate plan level ( or rate category )for Channels. So if rate plans are given in the request, get all rate codes associated with the rate plan level.", "type": "string", "minLength": 0, "maxLength": 20 }, "ratePlanId": { "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).", "type": "object", "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" } } }, "ratePlanWebName": { "description": "To populate the RatePlanName, setup for the channel.", "type": "string", "minLength": 0, "maxLength": 80 } } }, "guaranteeType": { "type": "object", "description": "Specifies Guarantee Code attributes.", "properties": { "description": { "description": "Description of the Guarantee Code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "policyRequirements": { "description": "Specifies various policyRequirements for the guarantee code.", "$ref": "#/definitions/guaranteeRequirementsType" }, "shortDescription": { "description": "Brief description of the Guarantee Code.", "$ref": "#/definitions/translationTextType80" }, "paymentTypes": { "description": "Specifies various payment types for the guarantee code.", "$ref": "#/definitions/paymentTypesType" }, "guaranteeCode": { "description": "Code assigned to the Guarantee.", "type": "string", "minLength": 0, "maxLength": 20 }, "onHold": { "description": "If true indicates this Guarantee Code is used only to hold the inventory during reservation process.", "type": "boolean" }, "reserveInventory": { "description": "If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.", "type": "boolean" }, "orderSequence": { "description": "Display Order sequence.", "type": "number" }, "lateArrival": { "description": "Represents the late arrival time.", "type": "string" } } }, "guaranteeRequirementsType": { "type": "object", "description": "Specifies various requirement for the guarantee code.", "properties": { "requirementCode": { "description": "Requirement Code.", "type": "string" }, "cancellation": { "description": "When true indicates cancellation on the reservation is required for this guarantee code.", "type": "boolean" }, "phoneNumber": { "description": "When true indicates phone number on the reservation is required for this guarantee code.", "type": "boolean" }, "address": { "description": "When true indicates address on the reservation is required for this guarantee code.", "type": "boolean" }, "creditCard": { "description": "When true indicates Credit Card on the reservation is required for this guarantee code.", "type": "boolean" }, "arrivalTime": { "description": "When true indicates arrival Time on the reservation is required for this guarantee code.", "type": "boolean" }, "deposit": { "description": "When true indicates deposit is required for this guarantee code.", "type": "boolean" } } }, "translationTextType80": { "type": "object", "description": "Contains Multiple translated texts and language codes.", "properties": { "defaultText": { "description": "Default text with Character length from 0 to 80.", "type": "string", "minLength": 0, "maxLength": 80 }, "translatedTexts": { "description": "List of translated text and language codes.", "$ref": "#/definitions/translationsTextType" } } }, "translationsTextType": { "type": "array", "description": "Language code for the translation.", "maxItems": 4000, "items": { "type": "object", "properties": { "value": { "type": "string", "description": "Used for Character Strings, length 0 to 2000.", "minLength": 0, "maxLength": 2000 }, "language": { "description": "Language identification.", "type": "string", "minLength": 0, "maxLength": 20 } }, "description": "Language code for the translation." } }, "paymentTypesType": { "type": "array", "description": "Payment card code like AX,VI etc.", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "cancelPenaltyType": { "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" } } }, "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" } } }, "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" ] }, "offsetUnitType": { "type": "string", "description": "Indicates deadline offset unit type.", "enum": [ "Year", "Month", "Day", "Hour" ] }, "ratePlanCommissionType": { "type": "object", "properties": { "commissionCode": { "description": "commission code used by the rate plan.", "type": "string", "minLength": 0, "maxLength": 20 }, "commissionPercentage": { "description": "commission percentage used by the rate plan.", "type": "number" }, "commissionAmount": { "description": "commission amount used by the rate plan.", "type": "number" } } }, "guaranteePoliciesType": { "type": "array", "description": "Guarantee Code information with cancellation penalty and deposit policy information.", "maxItems": 4000, "items": { "$ref": "#/definitions/guaranteePolicyType" } }, "guaranteePolicyType": { "type": "object", "description": "Specifies Guarantee Code attributes.", "properties": { "guaranteeCode": { "description": "Code assigned to the Guarantee.", "type": "string", "minLength": 0, "maxLength": 20 }, "shortDescription": { "description": "Brief description of the Guarantee Code.", "$ref": "#/definitions/translationTextType80" }, "policyRequirements": { "description": "Specifies various policyRequirements for the guarantee code.", "$ref": "#/definitions/guaranteeRequirementsType" }, "description": { "description": "Description of the Guarantee Code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "paymentTypes": { "description": "Specifies various payment types for the guarantee code.", "$ref": "#/definitions/paymentTypesType" }, "onHold": { "description": "If true indicates this Guarantee Code is used only to hold the inventory during reservation process.", "type": "boolean" }, "reserveInventory": { "description": "If true indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.", "type": "boolean" }, "orderSequence": { "description": "Display Order sequence.", "type": "number" }, "lateArrival": { "description": "Represents the late arrival time.", "type": "string", "maxLength": 2000 }, "cancelPenalty": { "description": "The CancelPenalty class defines the cancellation policy of the hotel facility.", "type": "object", "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" }, "estimatedAmount": { "description": "Message.", "type": "number" } } }, "depositPolicy": { "description": "A deposit policy attached with the reservation.", "type": "object", "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" }, "estimatedAmount": { "description": "Message.", "type": "number" } } }, "defaultGuarantee": { "description": "If true indicates this can be the default guarantee type to be selected for a reservation.", "type": "boolean" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "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 cancellation policy is manual.", "type": "boolean" } } }, "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 } } }, "masterRestrictionStatusesType": { "type": "string", "enum": [ "Closed", "ClosedForArrival", "ClosedForDeparture", "MinimumStayThrough", "MaximumStayThrough", "MinimumLengthOfStay", "MaximumLengthOfStay", "LOSNotAvailable", "MinimumAdvanceBooking", "MaximumAdvanceBooking", "Open", "OpenForArrival", "OpenForDeparture", "Hurdle", "MinimumOccupancy", "MaximumOccupancy", "RateStrategy", "RateDetailsNotSet", "InventoryItemNotAvailable", "RankRestriction", "MaximumAuth", "InventoryNotAvailable", "RoomClassNotAvailable", "RoomTypeNotAvailable", "BlockSellLimit", "OnRequest", "CasinoRestriction" ] }, "rateChangeTypeType": { "type": "string", "description": "Indicates the rate amount returned is first night or highest rate.", "enum": [ "FirstNight", "Highest", "Lowest", "MostCommon", "Average" ] }, "hotelInfoType": { "type": "object", "description": "Contains the basic configuration information about a Hotel.", "properties": { "primaryDetails": { "description": "Primary Information of the hotel.", "type": "object", "properties": { "legalOwner": { "description": "Legal owner of the hotel.", "type": "string", "minLength": 0, "maxLength": 80 } } }, "generalInformation": { "description": "General Information of the hotel.", "type": "object", "properties": { "hotelType": { "description": "The type of the Hotel.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomCount": { "description": "The total number of rooms in the Hotel.", "type": "integer" }, "bedCount": { "description": "The total number of beds in the Hotel.", "type": "integer" }, "floorCount": { "description": "The total number of floors of the Hotel.", "type": "integer" }, "checkInTime": { "description": "The official check in time of the Hotel.", "type": "string", "format": "date-time" }, "checkOutTime": { "description": "The official check out time of the Hotel.", "type": "string", "format": "date-time" }, "hotelInfoWebsite": { "description": "URL where property information is located.", "$ref": "#/definitions/uRLType" }, "longitude": { "description": "Longitude of the hotel.", "type": "number" }, "latitude": { "description": "Latitude of the hotel.", "type": "number" }, "baseLanguage": { "description": "The base language of the Hotel.", "$ref": "#/definitions/languageType" } } }, "accommodationDetails": { "description": "Accommodation Details of the hotel.", "type": "object", "properties": { "singleRooms": { "description": "The number of Single Rooms of the Hotel.", "type": "integer" }, "doubleRooms": { "description": "The number of Double Rooms of the Hotel.", "type": "integer" }, "twinRooms": { "description": "The number of Twin Rooms of the Hotel.", "type": "integer" }, "familyRooms": { "description": "The number of Family Rooms of the Hotel.", "type": "integer" }, "connectingRooms": { "description": "The number of Connecting Rooms of the Hotel.", "type": "integer" }, "accessibleRooms": { "description": "The number of Accessible Rooms of the Hotel.", "type": "integer" }, "nonSmokingRooms": { "description": "The number of Non-Smoking Rooms of the Hotel.", "type": "integer" }, "maxAdultsInFamilyRoom": { "description": "Maximum Adults for Family Room Type.", "type": "integer" }, "maxChildrenInFamilyRoom": { "description": "Maximum Children for Family Room Type.", "type": "integer" }, "guestRoomFloors": { "description": "The total number of the Guest Room Floors.", "type": "integer" }, "guestRoomElevators": { "description": "The number of Guest Room Elevators.", "type": "integer" }, "suites": { "description": "The number of Suites of the Hotel.", "type": "integer" }, "executiveFloorNo": { "description": "The floor number of Executive Floors of the Hotel.", "type": "string", "minLength": 0, "maxLength": 1000 }, "roomAmenties": { "description": "The information about the Room Amenities.", "type": "string", "minLength": 0, "maxLength": 2000 }, "shopDescription": { "description": "The Description of the shops in the Hotel.", "type": "string", "minLength": 0, "maxLength": 2000 } } }, "propertyControls": { "description": "Property controls information configuration of the hotel.", "type": "object", "properties": { "sellControls": { "description": "The sell controls information configuration of the hotel.", "type": "object", "properties": { "startDate": { "description": "Date when the hotel become valid for use.", "type": "string", "format": "date", "maxLength": 8 }, "endDate": { "description": "The end date of the hotel.", "type": "string", "format": "date", "maxLength": 8 }, "hotelId": { "description": "The hotel code.", "type": "string", "minLength": 0, "maxLength": 80 } } }, "currencyFormatting": { "description": "Currency Formatting information configuration of the hotel.", "type": "object", "properties": { "currencyCode": { "description": "The base currency code for this hotel..", "type": "string", "minLength": 0, "maxLength": 20 }, "currencyFormat": { "description": "Format for the local currency.", "type": "string", "minLength": 0, "maxLength": 80 }, "currencySymbol": { "description": "Symbol to designate the default currency of the hotel.", "type": "string", "minLength": 0, "maxLength": 20 }, "decimalPositions": { "description": "Number of decimal positions used for this currency type.", "type": "integer" } } }, "cateringCurrencyFormatting": { "description": "Catering Currency Formatting information configuration of the hotel.", "type": "object", "properties": { "currencyCode": { "description": "The base currency code for this hotel..", "type": "string", "minLength": 0, "maxLength": 20 }, "currencyFormat": { "description": "Format for the local currency.", "type": "string", "minLength": 0, "maxLength": 80 } } }, "dateTimeFormatting": { "description": "Date Time Formatting information configuration of the hotel", "type": "object", "properties": { "longDateFormat": { "description": "Long date format of the hotel.", "type": "string", "minLength": 0, "maxLength": 20 }, "shortDateFormat": { "description": "Short date format of the hotel.", "type": "string", "minLength": 0, "maxLength": 20 }, "timeFormat": { "description": "Time format for the hotel.", "type": "string", "minLength": 0, "maxLength": 20 }, "timeZoneRegion": { "description": "Time zone region of the hotel.", "type": "string", "minLength": 0, "maxLength": 80 } } }, "applicationMode": { "description": "Application Mode information configuration of the hotel.", "type": "object", "properties": { "configurationMode": { "description": "The hotel's configuration mode if applicable.", "type": "string", "minLength": 0, "maxLength": 20 }, "countryMode": { "description": "The hotel's country code.", "type": "string", "minLength": 0, "maxLength": 20 }, "expHotelCode": { "description": "Hotel Code used for third party exports.", "type": "string", "minLength": 0, "maxLength": 20 }, "touristNumber": { "description": "The Tourist Number of the hotel.", "type": "string", "minLength": 0, "maxLength": 20 }, "mBSSupported": { "description": "Indicates if the hotel uses MBS (Marriott Business Services).", "type": "boolean" } } } } }, "communication": { "description": "Communication information of the hotel.", "type": "object", "properties": { "phoneNumber": { "description": "The direct dial phone number of the hotel.", "$ref": "#/definitions/telephoneType" }, "tollFreeNumber": { "description": "Toll free phone number of the hotel.", "$ref": "#/definitions/telephoneType" }, "faxNumber": { "description": "Fax phone number of the hotel.", "$ref": "#/definitions/telephoneType" }, "emailAddress": { "description": "Email address of the hotel.", "$ref": "#/definitions/basicEmailType" }, "webPage": { "description": "The web address of the hotel.", "$ref": "#/definitions/uRLType" } } }, "address": { "description": "Provides address information.", "type": "object", "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" }, "barCode": { "description": "The postal barcode for the address.", "type": "string", "minLength": 0, "maxLength": 100 }, "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 responsible 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 }, "regionCode": { "description": "The region code of the hotel.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "hotelRestaurants": { "description": "Names of restaurants which can be found in the Hotel.", "$ref": "#/definitions/hotelRestaurantsType" }, "hotelRateRanges": { "description": "The rate ranges which are offered by the hotels.", "$ref": "#/definitions/hotelRateRangesType" }, "alternateHotels": { "description": "Informations about alternative hotels provided by the Hotel.", "$ref": "#/definitions/alternateHotelsType" }, "hotelContacts": { "description": "The contacts information the hotels.", "$ref": "#/definitions/hotelContactsType" }, "hotelEventSpaces": { "description": "Even Space information of the hotel.", "$ref": "#/definitions/hotelEventSpacesType" }, "hotelNotes": { "description": "List of notes for the hotel.", "$ref": "#/definitions/hotelNotesType" }, "hotelCorporateInformations": { "$ref": "#/definitions/hotelCorporateInformationsType" }, "attractions": { "description": "List of Attractions for the hotel.", "$ref": "#/definitions/hotelAttractionsType" }, "meetingRooms": { "description": "List of Meeting Rooms for the hotel.", "$ref": "#/definitions/meetingRoomsType" }, "chainCode": { "description": "The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelCityCode": { "description": "The IATA city code; for example DCA, ORD.", "type": "string", "minLength": 0, "maxLength": 40 }, "hotelName": { "description": "A text field used to communicate the proper name of the hotel.", "type": "string", "minLength": 0, "maxLength": 80 }, "hotelCodeContext": { "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.", "type": "string", "minLength": 0, "maxLength": 40 }, "chainName": { "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", "type": "string", "minLength": 0, "maxLength": 80 } } }, "languageType": { "type": "string", "minLength": 0, "maxLength": 40 }, "hotelRestaurantsType": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelRestaurantType" } }, "hotelRestaurantType": { "type": "object", "description": "Information about the Restaurants in the hotel.", "properties": { "restaurantName": { "description": "The name of the Restaurant.", "type": "string", "minLength": 0, "maxLength": 1000 }, "restaurantType": { "description": "The Type of Restaurant.", "type": "string", "minLength": 0, "maxLength": 1000 }, "hours": { "description": "The Hours of Operation of the Restaurant.", "type": "string", "minLength": 0, "maxLength": 1000 }, "priceRange": { "description": "The price range of the Restaurant.", "type": "string", "minLength": 0, "maxLength": 40 }, "comments": { "description": "Comments about the Restaurant.", "type": "string", "minLength": 0, "maxLength": 2000 }, "category": { "description": "The category that the Restaurant belongs to.", "$ref": "#/definitions/restaurantCategoryType" }, "timeSpan": { "description": "The Start Date and End Date of the Restaurant.", "$ref": "#/definitions/timeSpanType" }, "newRestaurantCode": { "description": "The new Restaurant Code which is used in the change method.", "type": "string", "minLength": 0, "maxLength": 20 }, "restaurantCode": { "type": "string", "minLength": 0, "maxLength": 20 }, "orderBy": { "type": "integer" }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "restaurantCategoryType": { "type": "string", "description": "Simple type for Hotel Restaurant.", "enum": [ "Restaurant", "Retail" ] }, "hotelRateRangesType": { "type": "array", "description": "Lists of rate ranges of the hotel.", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelRateRangeType" } }, "hotelRateRangeType": { "type": "object", "description": "The rate rage information of the hotel.", "properties": { "timeSpan": { "description": "The Start Date and End Date of the Hotel rate range.", "$ref": "#/definitions/timeSpanType" }, "minRate": { "description": "Minimum Rate offered by the hotel.", "type": "number" }, "maxRate": { "description": "Maximum Rate offered by the hotel.", "type": "number" }, "currencyCode": { "description": "The base currency code for rate range(The currency code used by the hotel which the rate range belongs to).", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "alternateHotelsType": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/alternateHotelType" } }, "alternateHotelType": { "type": "object", "properties": { "address": { "$ref": "#/definitions/addressType" }, "contactNumbers": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/telephoneType" } }, "minRate": { "$ref": "#/definitions/currencyAmountType" }, "maxRate": { "$ref": "#/definitions/currencyAmountType" }, "relativePosition": { "$ref": "#/definitions/relativePositionType" }, "hotelAmenities": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelAmenityType" } }, "event": { "description": "True if the hotel has any scheduled events within the requested date range.", "type": "boolean" }, "rateRoomDetails": { "description": "Any additional information like membership, restriction status, room stay information of the requested hotels etc.", "$ref": "#/definitions/rateRoomDetailsType" }, "channelSummaryInfo": { "description": "Channel related information if availability request is send for a channel.", "$ref": "#/definitions/channelSummaryInfoType" }, "sellMessages": { "description": "Sell messages retrieved based on the Time Span criteria for all Rate Codes and Room Types of the requested hotel.", "$ref": "#/definitions/sellMessagesType" }, "currencyExchangeRates": { "description": "Exchange Rate information for currency codes of the requested hotel.", "$ref": "#/definitions/currencyExchangeRatesType" }, "chainCode": { "description": "The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelCityCode": { "description": "The IATA city code; for example DCA, ORD.", "type": "string", "minLength": 0, "maxLength": 40 }, "hotelName": { "description": "A text field used to communicate the proper name of the hotel.", "type": "string", "minLength": 0, "maxLength": 80 }, "hotelCodeContext": { "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.", "type": "string", "minLength": 0, "maxLength": 40 }, "chainName": { "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", "type": "string", "minLength": 0, "maxLength": 80 }, "hotelType": { "type": "string", "minLength": 0, "maxLength": 20 }, "negotiated": { "type": "boolean" }, "alternate": { "type": "boolean" }, "displayOrder": { "type": "number" }, "inventoryRooms": { "type": "integer" }, "availableRooms": { "type": "integer" }, "comments": { "description": "Comments of alternate Hotel.", "type": "string", "minLength": 0, "maxLength": 2000 }, "direction": { "description": "Compass direction to the attraction from the hotel (North/South, etc).", "type": "string", "minLength": 0, "maxLength": 20 }, "reciprocalRelationship": { "description": "whether the alternate relationship should be applied to the alternate hotel as well. If this flag is true, not only will the AlternateHotelCode hotel be an alternate for HotelCode hotel, but HotelCode hotel will also be an alternate for AlternateHotelCode hotel.", "type": "boolean" }, "alternateHotelCode": { "type": "string", "minLength": 0, "maxLength": 20 }, "newAlternateHotelCode": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "relativePositionType": { "type": "object", "description": "Defines the position of an entity in relation to another entity (e.g. from an airport to a hotel, the relationship is dependent on use).", "properties": { "distance": { "description": "Defines the distance between two points.", "type": "number" }, "distanceType": { "description": "The unit of measure in a code format.", "type": "string", "minLength": 0, "maxLength": 20 }, "drivingTime": { "description": "The driving time in a free text format.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "hotelAmenityType": { "type": "object", "properties": { "description": { "type": "string", "minLength": 0, "maxLength": 2000 }, "code": { "type": "string", "minLength": 0, "maxLength": 20 }, "type": { "type": "string", "minLength": 0, "maxLength": 2000 }, "displayOrder": { "type": "number" } } }, "rateRoomDetailsType": { "type": "object", "properties": { "memberships": { "description": "Detail regarding customer loyalty program.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/membershipSearchType" } }, "restrictionType": { "description": "Indicates the restriction types if hotel is not available.", "$ref": "#/definitions/masterRestrictionStatusesType" }, "roomStays": { "description": "Room stay information.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/roomStayType" } } } }, "membershipSearchType": { "type": "object", "description": "Identifies criteria for searching frequent customer reward program.", "properties": { "membershipId": { "description": "Membership ID criteria.", "type": "string" }, "membershipLevel": { "description": "Membership Level criteria.", "$ref": "#/definitions/codeListType" }, "membershipType": { "description": "Membership Type criteria.", "$ref": "#/definitions/codeListType" }, "associatedReservationsOnly": { "description": "If this is true,the reservations which has membership information associated will be resulted .", "type": "boolean" } } }, "channelSummaryInfoType": { "type": "object", "description": "Depicts channel information such as the type and code.", "properties": { "bookingChannel": { "$ref": "#/definitions/bookingChannelType" }, "messageId": { "description": "Indicates the transaction identifier.", "type": "string" }, "summaryOnly": { "description": "Used to indicate whether to return summarized or detailed rate room information.", "type": "boolean" } } }, "bookingChannelType": { "type": "object", "properties": { "channelCode": { "type": "string", "minLength": 0, "maxLength": 20 }, "channelName": { "type": "string", "minLength": 0, "maxLength": 80 }, "channelType": { "type": "string", "minLength": 0, "maxLength": 240 } } }, "sellMessagesType": { "type": "object", "description": "The SellMessagesType is the list of message and attributes returned by web service.", "properties": { "sellMessage": { "description": "This is the message text.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/sellMessageType" } }, "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" } } }, "sellMessageType": { "type": "object", "description": "The SellMessagesType defines the standard attributes that will be retrieved with the sell message.", "properties": { "message": { "description": "This is the message text.", "type": "string", "minLength": 0, "maxLength": 2000 }, "croCode": { "description": "This is the Central Reservation office code.", "type": "string", "minLength": 0, "maxLength": 20 }, "chainCode": { "description": "This is the chain code.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "description": "This is the hotel code or resort.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomType": { "description": "This represents the room type code.", "type": "string", "minLength": 0, "maxLength": 20 }, "ratePlanCode": { "description": "This represents the rate plan code of the room type.", "type": "string", "minLength": 0, "maxLength": 20 }, "languageCode": { "description": "This is the language code.", "type": "string", "minLength": 0, "maxLength": 20 }, "stickyFlagYn": { "description": "Flag which tells if this message is Sticky (Y/N).", "type": "string", "minLength": 0, "maxLength": 1 }, "usedInModule": { "description": "This represents the correct moduletype which should be used for fetching SellMessages.", "$ref": "#/definitions/usedInModuleType" }, "beginDate": { "description": "This is the Begin date for the configured SellMessage.", "type": "string", "format": "date", "maxLength": 8 }, "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" } } }, "usedInModuleType": { "type": "string", "description": "Simple type for indicating the module for which user wants to create the SellMessage. Valid module types are Look To Book Sales,Reservations,Blocks,Function Diary and Group Rooms Control.", "enum": [ "Blocks", "Reservations", "FunctionDiary", "LookToBookSales", "GroupRoomsControl" ] }, "currencyExchangeRatesType": { "type": "array", "description": "Exchange Rate information for a currency code.", "maxItems": 4000, "items": { "$ref": "#/definitions/currencyExchangeRateType" } }, "currencyExchangeRateType": { "type": "object", "description": "Currency code configuration.", "properties": { "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" }, "description": { "description": "Description of the currency code.", "type": "string", "minLength": 0, "maxLength": 2000 }, "exchangeRate": { "description": "Exchange Rate for the currency code. Exchange rate is based on the current business date of the property.", "$ref": "#/definitions/currencyAmountType" } } }, "hotelContactsType": { "type": "array", "description": "Lists of contacts of the hotel.", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelContactType" } }, "hotelContactType": { "type": "object", "description": "Contact identification details.", "properties": { "nameId": { "description": "Contact or employee identifier..", "$ref": "#/definitions/uniqueID_Type" }, "hotelId": { "description": "The code of the hotel.", "type": "string", "minLength": 0, "maxLength": 20 }, "name": { "description": "Name of the hotel contact.", "type": "string", "minLength": 0, "maxLength": 2000 }, "roles": { "description": "List of HotelContactType.", "$ref": "#/definitions/hotelContactRolesType" }, "ownerCode": { "description": "The contact's code in the hotel.", "type": "string", "minLength": 0, "maxLength": 20 }, "communicationMethod": { "description": "The preferred method of communication for the contact.", "type": "string", "minLength": 0, "maxLength": 20 }, "communicationAddress": { "description": "Details about the preferred communication method. Example: email address, fax number, etc.", "type": "string", "minLength": 0, "maxLength": 80 }, "primary": { "description": "Primary flag.", "type": "boolean" } } }, "hotelContactRolesType": { "type": "array", "description": "Lists of HotelContactRoles of the hotel.", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelContactRoleType" } }, "hotelContactRoleType": { "type": "string", "description": "The contact's role in the hotel. Possible values are Lead, General, and Contract.", "enum": [ "Lead", "General", "Contract" ] }, "hotelEventSpacesType": { "type": "object", "description": "The Detail and Summary info of event space about the hotel", "properties": { "eventSpaceDetails": { "description": "Even Space Detail information of the hotel.", "$ref": "#/definitions/hotelEventSpaceDetailsType" }, "eventSpaceSummaries": { "description": "Event Space Summary information of the hotel.", "$ref": "#/definitions/hotelEventSpaceSummariesType" }, "setupStyles": { "description": "List of hotel setup style codes of the hotel.", "$ref": "#/definitions/hotelSetupStylesType" } } }, "hotelEventSpaceDetailsType": { "type": "array", "description": "List of detail info of hotel event space", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelEventSpaceDetailType" } }, "hotelEventSpaceDetailType": { "type": "object", "description": "The detail info of hotel event space", "properties": { "code": { "description": "The code of hotel event space.", "type": "string", "minLength": 0, "maxLength": 20 }, "description": { "description": "Th description of the hotel event space", "type": "string", "minLength": 0, "maxLength": 2000 }, "maxCapacity": { "description": "Th max capacity of the hotel event space", "type": "integer" }, "maxOccupancies": { "description": "List of max occupancies of the event space based on the setup code.", "$ref": "#/definitions/eventSpaceMaxOccupanciesType" } } }, "eventSpaceMaxOccupanciesType": { "type": "array", "description": "List of event space max occupancy.", "maxItems": 5, "items": { "type": "integer" } }, "hotelEventSpaceSummariesType": { "type": "array", "description": "List of summary info of hotel event space", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelEventSpaceSummaryType" } }, "hotelEventSpaceSummaryType": { "type": "object", "description": "The summary info of hotel event space", "properties": { "no": { "description": "The total event space number which has the same space type, max capacity and setup style.", "type": "integer" }, "spaceType": { "description": "The type of the event space", "type": "string", "minLength": 0, "maxLength": 2000 }, "maxCapacity": { "description": "The max capacity of this event space group", "type": "integer" }, "maxOccupancies": { "description": "List of max occupancies of the event space based on the setup code.", "$ref": "#/definitions/eventSpaceMaxOccupanciesType" } } }, "hotelSetupStylesType": { "type": "array", "description": "List of event space setup style codes.", "maxItems": 5, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "hotelNotesType": { "type": "array", "description": "List of Notes of the hotel.", "maxItems": 4000, "items": { "$ref": "#/definitions/commentInfoType" } }, "hotelCorporateInformationsType": { "type": "object", "description": "Corporate information details of the property", "properties": { "brandCode": { "type": "string", "minLength": 0, "maxLength": 20 }, "hotelCategory": { "type": "string", "minLength": 0, "maxLength": 20 }, "businessUnit": { "$ref": "#/definitions/primaryCodesType" }, "departmentCode": { "$ref": "#/definitions/primaryCodesType" }, "division": { "$ref": "#/definitions/primaryCodesType" }, "opertingUnit": { "$ref": "#/definitions/primaryCodesType" } } }, "primaryCodesType": { "type": "array", "description": "List of codes with primary flag", "maxItems": 4000, "items": { "$ref": "#/definitions/primaryCodeType" } }, "primaryCodeType": { "type": "object", "description": "Primary flag with code and description.", "properties": { "primary": { "type": "boolean" }, "codeDescription": { "$ref": "#/definitions/codeDescriptionType" } } }, "hotelAttractionsType": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelAttractionType" } }, "hotelAttractionType": { "type": "object", "description": "Information about the attractions near the hotel.", "properties": { "name": { "description": "Attraction name for the hotel.", "$ref": "#/definitions/translationTextType2000" }, "type": { "description": "The type of the attraction.", "type": "string", "minLength": 0, "maxLength": 60 }, "class": { "description": "The class of the attraction.", "type": "string", "minLength": 0, "maxLength": 60 }, "generalDirections": { "description": "Directions to the attraction from the hotel.", "type": "string", "minLength": 0, "maxLength": 2000 }, "relativePosition": { "$ref": "#/definitions/relativePositionType" }, "address": { "description": "Address of the attraction.", "$ref": "#/definitions/addressType" }, "website": { "description": "Website for the attraction.", "$ref": "#/definitions/uRLType" }, "priceRange": { "description": "Price range for the attraction.", "type": "string", "minLength": 0, "maxLength": 40 }, "operationHours": { "description": "Price range for the attraction.", "type": "string", "minLength": 0, "maxLength": 20 }, "displaySeq": { "description": "Display sequence of the attraction.", "type": "integer" }, "code": { "type": "string", "minLength": 0, "maxLength": 20 } } }, "translationTextType2000": { "type": "object", "description": "Contains Multiple translated texts and language codes.", "properties": { "defaultText": { "description": "Default text with Character length from 0 to 2000.", "type": "string", "minLength": 0, "maxLength": 2000 }, "translatedTexts": { "description": "List of translated text and language codes.", "$ref": "#/definitions/translationsTextType" } } }, "meetingRoomsType": { "type": "array", "description": "List of meeting rooms of the hotel.", "maxItems": 4000, "items": { "$ref": "#/definitions/meetingRoomType" } }, "meetingRoomType": { "type": "object", "description": "Information about the meeting rooms of the hotel.", "properties": { "code": { "description": "the code of the meeting room", "type": "string", "minLength": 0, "maxLength": 20 }, "charge": { "description": "The charge for the meeting room.", "type": "string", "minLength": 0, "maxLength": 40 }, "description": { "description": "A description of the meeting room.", "type": "string", "minLength": 0, "maxLength": 200 } } }, "channelAvailRSInfoType": { "type": "object", "description": "Channel specific information to be returned in availability response.", "properties": { "channelSummaryInfo": { "description": "Channel information like channel code etc.", "$ref": "#/definitions/channelSummaryInfoType" }, "channelMarketingInfo": { "description": "Channel Marketing Text like cancel,deposit,tax,commission policy etc.", "$ref": "#/definitions/channelMarketingInfoType" } } }, "channelMarketingInfoType": { "type": "array", "description": "Marketing Text like cancel policy, deposit policy etc.", "maxItems": 4000, "items": { "type": "object", "properties": { "description": { "description": "Marketing Text like cancel policy, deposit policy etc.", "type": "string", "minLength": 0, "maxLength": 4000 }, "policyType": { "description": "Indicates the policy type like cancel,deposit etc.", "$ref": "#/definitions/marketingPolicyType" }, "ratePlanCode": { "description": "Indicates the rate code for which the policy is associated with.", "type": "string", "minLength": 0, "maxLength": 20 } } } }, "marketingPolicyType": { "type": "string", "description": "Indicates the channel policy type like deposit,cancel etc.", "enum": [ "Deposit", "Commission", "Cancel", "Guarantee", "General", "Penalty", "Tax", "Promotion" ] }, "links": { "type": "array", "items": { "$ref": "#/definitions/instanceLink" } }, "instanceLink": { "type": "object", "description": "Metadata describing link description objects that MAY appear in the JSON instance representation.", "properties": { "href": { "description": "URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.", "type": "string" }, "rel": { "description": "Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.", "type": "string" }, "templated": { "description": "Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.", "type": "boolean", "default": false }, "method": { "description": "HTTP method for requesting the target of the link.", "type": "string", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD" ] }, "targetSchema": { "description": "Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..", "type": "string" }, "operationId": { "description": "The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.", "type": "string" }, "title": { "description": "Exact copy of the \"summary\" field on the linked operation.", "type": "string" } } }, "exceptionDetailType": { "title": "Error Detail", "description": "Complex type that contains error details for a REST call.", "type": "object", "properties": { "type": { "type": "string", "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." }, "title": { "type": "string", "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "HTTP status code for this occurrence of the problem, set by the origin server." }, "detail": { "type": "string", "description": "Human-readable description specific to this occurrence of the problem." }, "instance": { "type": "string", "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." }, "o:errorCode": { "type": "string", "description": "Application error code, which is different from HTTP error code." }, "o:errorPath": { "type": "string", "description": "Path to the problem at the resource or property level." }, "o:errorDetails": { "description": "Details of the error message, consisting of a hierarchical tree structure.", "type": "array", "items": { "$ref": "#/definitions/errorInstance" } }, "links": { "$ref": "#/definitions/links" } }, "required": [ "type", "title" ] }, "errorInstance": { "title": "Error Instance Details", "description": "Complex type that contains error instance details for a REST call.", "type": "object", "properties": { "type": { "type": "string", "description": "Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML)." }, "title": { "type": "string", "description": "Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "HTTP status code for this occurrence of the problem, set by the origin server." }, "detail": { "type": "string", "description": "Human-readable description specific to this occurrence of the problem." }, "instance": { "type": "string", "description": "Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced." }, "o:errorCode": { "type": "string", "description": "Application error code, which is different from HTTP error code." }, "o:errorPath": { "type": "string", "description": "Path to the problem at the resource or property level." } }, "required": [ "type", "title" ] }, "searchHotelsDetails": { "type": "object", "description": "Response object to search hotel availability.", "properties": { "hotels": { "type": "object", "properties": { "hotel": { "type": "array", "items": { "$ref": "#/definitions/hotelSummaryInfoType" } } } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "hotelSummaryInfoType": { "type": "object", "properties": { "address": { "$ref": "#/definitions/addressType" }, "contactNumbers": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/telephoneType" } }, "minRate": { "$ref": "#/definitions/currencyAmountType" }, "maxRate": { "$ref": "#/definitions/currencyAmountType" }, "relativePosition": { "$ref": "#/definitions/relativePositionType" }, "hotelAmenities": { "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/hotelAmenityType" } }, "event": { "description": "True if the hotel has any scheduled events within the requested date range.", "type": "boolean" }, "rateRoomDetails": { "description": "Any additional information like membership, restriction status, room stay information of the requested hotels etc.", "$ref": "#/definitions/rateRoomDetailsType" }, "channelSummaryInfo": { "description": "Channel related information if availability request is send for a channel.", "$ref": "#/definitions/channelSummaryInfoType" }, "sellMessages": { "description": "Sell messages retrieved based on the Time Span criteria for all Rate Codes and Room Types of the requested hotel.", "$ref": "#/definitions/sellMessagesType" }, "currencyExchangeRates": { "description": "Exchange Rate information for currency codes of the requested hotel.", "$ref": "#/definitions/currencyExchangeRatesType" }, "chainCode": { "description": "The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelCityCode": { "description": "The IATA city code; for example DCA, ORD.", "type": "string", "minLength": 0, "maxLength": 40 }, "hotelName": { "description": "A text field used to communicate the proper name of the hotel.", "type": "string", "minLength": 0, "maxLength": 80 }, "hotelCodeContext": { "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.", "type": "string", "minLength": 0, "maxLength": 40 }, "chainName": { "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", "type": "string", "minLength": 0, "maxLength": 80 }, "hotelType": { "type": "string", "minLength": 0, "maxLength": 20 }, "negotiated": { "type": "boolean" }, "alternate": { "type": "boolean" }, "displayOrder": { "type": "number" }, "inventoryRooms": { "description": "The Maximum number of rooms in this hotel. This number includes the sell limits. Also the number of deduct rooms already sold and the number of Owner Exclusive Rooms(applicable when Ownership Records functionality is active).", "type": "integer" }, "sellableRooms": { "description": "The Maximum number of rooms that can be sold in this hotel. This number excludes the number of Owner Exclusive Rooms(applicable when Ownership Records functionality is active). It includes the sell limits and Also the number of deduct rooms already sold.", "type": "integer" }, "ownerExclusiveRooms": { "description": "The total number of Owner Exclusive rooms in this hotel. This is only applicable Ownership Records functionality is active.", "type": "integer" }, "availableRooms": { "description": "The number of rooms that are actually available in this hotel. This number includes the sell limits. It excludes the number of deduct rooms already sold and the number of Owner Exclusive rooms.", "type": "integer" }, "physicalRooms": { "description": "The total number of physical rooms in a hotel.", "type": "integer" }, "checkInTime": { "description": "The official check in time of the Hotel. Uses the hotel's time zone.", "type": "string", "format": "date-time" }, "checkOutTime": { "description": "The official check out time of the Hotel. Uses the hotel's time zone.", "type": "string", "format": "date-time" }, "timeZoneRegion": { "description": "Time zone region of the hotel.", "type": "string", "minLength": 0, "maxLength": 80 }, "currencyCode": { "description": "Provides the hotel's currency code.", "type": "string", "minLength": 3, "maxLength": 3 }, "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 } } }, "rateAnalysisDetails": { "type": "object", "description": "Response to the fetch Rate Availability Analysis.", "properties": { "analysis": { "description": "Rate availability analysis record for each date of the stay.", "type": "array", "items": { "$ref": "#/definitions/rateAnalysisType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "rateAnalysisType": { "type": "object", "description": "Analysis type which would be returned by the Analysis procedure.", "properties": { "description": { "description": "The description of the restriction which was analyzed.", "type": "string", "minLength": 0, "maxLength": 2000 }, "date": { "description": "The date of the analysis.", "type": "string", "format": "date", "maxLength": 8 }, "code": { "description": "The type of restriction currently applicable to the date.", "$ref": "#/definitions/rateAnalysisCodeType" } } }, "rateAnalysisCodeType": { "type": "string", "enum": [ "Closed", "ClosedForArrival", "ClosedForDeparture", "MinimumStayThrough", "MaximumStayThrough", "MinimumLengthOfStay", "MaximumLengthOfStay", "LOSNotAvailable", "MinimumAdvanceBooking", "MaximumAdvanceBooking", "Open", "OpenForArrival", "OpenForDeparture", "Hurdle", "MinimumOccupancy", "MaximumOccupancy", "RateStrategy", "RateDetailsNotSet", "InventoryItemNotAvailable", "RankRestriction", "MaximumAuth", "InventoryNotAvailable", "RoomClassNotAvailable", "RoomTypeNotAvailable", "BlockSellLimit", "CasinoRestriction" ] }, "alternateAvailability": { "type": "object", "description": "Response object for fetch alternate availability operation", "properties": { "alternates": { "description": "List of Alternate dates", "$ref": "#/definitions/alternateAvailDatesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "alternateAvailDatesType": { "type": "array", "description": "List of alternate dates.", "maxItems": 4000, "items": { "$ref": "#/definitions/alternateAvailDateType" } }, "alternateAvailDateType": { "type": "object", "description": "Type containing information about an alternate date.", "properties": { "rateAmount": { "description": "Rate amount for the requested room-rate combination if it's available in this particular date.", "$ref": "#/definitions/currencyAmountType" }, "date": { "description": "A specific date from the alternate dates.", "type": "string", "format": "date", "maxLength": 8 }, "status": { "description": "Status of the availability for the date.", "$ref": "#/definitions/availabilityStatusType" } } }, "availabilityStatusType": { "type": "string", "description": "Status when there are not enough sell control items available.", "enum": [ "Restricted", "Available", "InventoryNotAvailable", "PointsNotEnough", "InventoryitemsNotAvailable", "RoomNotAvailable", "CasinoRestriction" ] }, "restrictionStatusesType": { "type": "string", "enum": [ "Closed", "ClosedForArrival", "ClosedForDeparture", "MinimumStayThrough", "MaximumStayThrough", "MinimumLengthOfStay", "MaximumLengthOfStay", "LOSNotAvailable", "MinimumAdvanceBooking", "MaximumAdvanceBooking", "Open", "OpenForArrival", "OpenForDeparture" ] }, "availableUpsells": { "type": "object", "description": "Response for fetching available up-sells.", "properties": { "upsells": { "$ref": "#/definitions/upsellsType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "upsellsType": { "type": "object", "description": "List of upsell information", "properties": { "upsell": { "description": "Holds upsell information", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/upsellType" } }, "availableAmount": { "description": "Amount / number of points available to guest", "$ref": "#/definitions/amountPointsType" } } }, "upsellType": { "type": "object", "description": "Holds upsell information", "properties": { "ruleId": { "description": "Rule unique identifier", "$ref": "#/definitions/uniqueID_Type" }, "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 }, "upsellType": { "description": "Rate code redemption type.", "type": "string", "minLength": 0, "maxLength": 1 }, "ratePlanCode": { "description": "Rate code", "type": "string", "minLength": 0, "maxLength": 20 }, "roomType": { "description": "Detailed information regarding room type to upsell to", "$ref": "#/definitions/roomTypeInfoType" }, "firstNightAmount": { "description": "First night upsell amount / number of points required", "$ref": "#/definitions/amountPointsType" }, "totalStayAmount": { "description": "Total stay upsell amount / number of points required", "$ref": "#/definitions/amountPointsType" }, "rates": { "description": "List of reservation date and its corresponding upsell rate amount", "$ref": "#/definitions/upsellDailyRatesType" } } }, "amountPointsType": { "type": "object", "description": "Holds monetary value expressed with a currency code / number of points", "properties": { "amount": { "description": "Monetary value expressed with a currency code", "$ref": "#/definitions/currencyAmountType" }, "points": { "description": "Number of points", "type": "integer" } } }, "upsellDailyRatesType": { "type": "array", "description": "Reservation date and its corresponding upsell rate amount", "maxItems": 4000, "items": { "$ref": "#/definitions/upsellDailyRateType" } }, "upsellDailyRateType": { "type": "object", "description": "Reservation date and its corresponding upsell rate amount", "properties": { "date": { "description": "Reservation date", "type": "string", "format": "date", "maxLength": 8 }, "requiredAmount": { "description": "Amount / number of points required to upgrade", "$ref": "#/definitions/amountPointsType" } } }, "reservationGuaranteesPolicies": { "type": "object", "description": "Response object to fetch reservation guarantees.", "properties": { "resGuarantees": { "description": "A collection of Guarantee Codes information with cancellation penalty and deposit policy information.", "$ref": "#/definitions/guaranteePoliciesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "hurdleRates": { "type": "object", "description": "Response object for fetching Hurdle rates.", "properties": { "hurdleRates": { "description": "Collection of Hurdle rates.", "$ref": "#/definitions/hurdleRatesType" }, "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" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "hurdleRatesType": { "type": "array", "description": "Details for hurdle rate.", "maxItems": 4000, "items": { "$ref": "#/definitions/hurdleRateType" } }, "hurdleRateType": { "type": "object", "description": "Unique identifier for hurdle rate.", "properties": { "hotelId": { "description": "Hotel code for which the hurdle rate belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "hurdleDate": { "description": "Hurdle date for which the hurdle rate is scheduled.", "type": "string", "format": "date", "maxLength": 8 }, "roomType": { "description": "Room type for which the hurdle rate applies to.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomCategory": { "description": "Internal room category of the room type for which the hurdle rate applies to.", "type": "string", "minLength": 0, "maxLength": 20 }, "yieldCategory": { "description": "Yield category for which the hurdle rate applies to.", "type": "string", "minLength": 0, "maxLength": 20 }, "lengthOfStay": { "description": "Length of stay for which the hurdle rate applies to.", "type": "number" }, "yieldMarketCode": { "description": "Yield market code for which the hurdle rate applies to.", "type": "string", "minLength": 0, "maxLength": 20 }, "hurdle": { "description": "Defines the amount to be reached before rate code or room type is made available.", "type": "number" }, "delta": { "description": "Defines the amount to be added to hurdle rate for each additional rooms sold up to the ceiling.", "type": "number" }, "ceiling": { "description": "Maximum number of rooms to sell for which the delta is applicable to be aded to hurdle rate.", "type": "number" }, "maxSolds": { "description": "Maximum number of rooms to sell.", "type": "number" }, "roomsSold": { "description": "Defines the actual number of rooms sold.", "type": "number" }, "override": { "description": "Specifies whether to override hurdle rate or not.", "type": "boolean" }, "hurdleRangeStart": { "description": "Hurdle date start range from which the hurdle rate is scheduled.", "type": "string", "format": "date" }, "hurdleRangeEnd": { "description": "Hurdle date end range to which the hurdle rate is scheduled.", "type": "string", "format": "date" }, "managedBy": { "$ref": "#/definitions/managedByOptions" } } }, "managedByOptions": { "description": "Describes of the Configuration is Managed by Enterprise or Property.", "type": "string", "enum": [ "EnterpriseManaged", "PropertyManaged", "EnterpriseEnforced", "PropertyOverridden" ] }, "createHurdleRates": { "type": "object", "description": "Request object for creating new Hurdle Rates.", "properties": { "hurdleRates": { "description": "Details of the Hurdle Rates to be created.", "$ref": "#/definitions/hurdleRatesType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "status": { "type": "object", "description": "Response Body.", "properties": { "warnings": { "$ref": "#/definitions/warningsType" }, "links": { "$ref": "#/definitions/links" } } }, "changeHurdleRates": { "type": "object", "description": "Request object for changing existing Hurdle Rates.", "properties": { "hurdleRates": { "description": "Details of the Hurdle Rates to be changed.", "$ref": "#/definitions/hurdleRatesEditType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "hurdleRatesEditType": { "type": "array", "description": "Details for hurdle rate to be modified.", "maxItems": 4000, "items": { "$ref": "#/definitions/hurdleRateEditType" } }, "hurdleRateEditType": { "type": "object", "description": "Unique identifier for hurdle rate.", "properties": { "hotelId": { "description": "Hotel code for which the hurdle rate belongs to.", "type": "string", "minLength": 0, "maxLength": 20 }, "hurdleDate": { "description": "Hurdle date for which the hurdle rate is scheduled.", "type": "string", "format": "date", "maxLength": 8 }, "roomType": { "description": "Room type for which the hurdle rate applies to.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomCategory": { "description": "Internal room category of the room type for which the hurdle rate applies to.", "type": "string", "minLength": 0, "maxLength": 20 }, "yieldCategory": { "description": "Yield category for which the hurdle rate applies to.", "type": "string", "minLength": 0, "maxLength": 20 }, "lengthOfStay": { "description": "Length of stay for which the hurdle rate applies to.", "type": "number" }, "yieldMarketCode": { "description": "Yield market code for which the hurdle rate applies to.", "type": "string", "minLength": 0, "maxLength": 20 }, "newHurdleRate": { "description": "Details for hurdle rate to be modified.", "$ref": "#/definitions/hurdleRateType" } } }, "changeHurdleRatesDetails": { "type": "object", "description": "Response Body.", "properties": { "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "availabilityRatePlanInfo": { "type": "object", "description": "Response object for fetching rate plans.", "properties": { "availRatePlanInfoType": { "description": "Rate plan info based on the search criteria.", "$ref": "#/definitions/availRatePlanInfoType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "restrictionsByDateRange": { "type": "object", "description": "Response object for fetching restrictions based on date range.", "properties": { "restrictionsByDateRange": { "description": "Response of Restrictions By Date Range", "$ref": "#/definitions/fetchRestrictionsByDateRangeRSType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "fetchRestrictionsByDateRangeRSType": { "type": "object", "description": "Response object for searching restrictions by date range.", "properties": { "restrictionsByDateRange": { "description": "Requested restrictions by date Range.", "$ref": "#/definitions/restrictionsByDateRangeType" } } }, "restrictionsByDateRangeType": { "type": "object", "description": "Restriction by date range for the requested Hotel.", "properties": { "restrictionSets": { "description": "Restriction set for a date range.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/restrictionSetType" } }, "chainCode": { "description": "The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelCityCode": { "description": "The IATA city code; for example DCA, ORD.", "type": "string", "minLength": 0, "maxLength": 40 }, "hotelName": { "description": "A text field used to communicate the proper name of the hotel.", "type": "string", "minLength": 0, "maxLength": 80 }, "hotelCodeContext": { "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.", "type": "string", "minLength": 0, "maxLength": 40 }, "chainName": { "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", "type": "string", "minLength": 0, "maxLength": 80 }, "hasMore": { "description": "Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.", "type": "boolean" }, "totalResults": { "description": "Total number of rows queried", "type": "integer" }, "count": { "description": "Total number of rows returned", "type": "integer" } } }, "restrictionSetType": { "type": "object", "description": "Indicates Restriction set applicable for the date range.", "properties": { "restrictionControl": { "description": "Indicates the applicability of the restriction.", "$ref": "#/definitions/restrictionControlType" }, "restrictionStatus": { "description": "Indicates the type of the restriction.", "$ref": "#/definitions/restrictionStatusType" }, "actualTimeSpan": { "description": "Actual time span of the restriction.", "$ref": "#/definitions/timeSpanType" }, "onRequest": { "description": "Indicates whether the Closed restriction is flagged as On Request.", "type": "boolean" }, "actionType": { "description": "Indicates the action performed on restriction", "type": "string", "minLength": 0, "maxLength": 2000 }, "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 }, "sunday": { "type": "boolean" }, "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" } } }, "restrictionControlType": { "type": "object", "description": "The RestrictionControlType is used to indicate the applicability of the restriction.", "properties": { "house": { "description": "Indicates the restriction is applicable at the House Level. When this is true all other attributes are ignored.", "type": "boolean" }, "bookingChannelCode": { "description": "Indicates restriction is applicable to specified Booking Channel Code in conjunction with other codes, if specified.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomClass": { "description": "Indicates restriction is applicable to specified Room Category in conjunction with other codes, if specified.", "type": "string", "minLength": 0, "maxLength": 20 }, "roomType": { "description": "Indicates restriction is applicable to specified Room Type in conjunction with other codes, if specified.", "type": "string", "minLength": 0, "maxLength": 20 }, "ratePlanCategory": { "description": "Indicates restriction is applicable to specified Rate Plan Category in conjunction with other codes, if specified.", "type": "string", "minLength": 0, "maxLength": 20 }, "ratePlanCode": { "description": "Indicates restriction is applicable to specified Rate Plan Code in conjunction with other codes, if specified.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "restrictionStatusType": { "type": "object", "description": "The RestrictionStatusType is used to indicate the type of restriction applied. An enumerated restriction type is defined in the attribute group.", "properties": { "code": { "description": "Identifies the type of restriction. I.E. Closed, ClosedForArrival, etc.", "$ref": "#/definitions/restrictionStatusesType" }, "unit": { "description": "Defines restriction in conjunction with Restriction Code. Value must be specified for Restriction Codes MinimumStayThrough, MaximumStayThrough, MinimumLengthOfStay, MaximumLengthOfStay, MinimumAdvanceBooking, MaximumAdvanceBooking.", "type": "integer" }, "lOS1": { "description": "Indicates Length of Stay 1 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", "type": "boolean" }, "lOS2": { "description": "Indicates Length of Stay 2 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", "type": "boolean" }, "lOS3": { "description": "Indicates Length of Stay 3 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", "type": "boolean" }, "lOS4": { "description": "Indicates Length of Stay 4 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", "type": "boolean" }, "lOS5": { "description": "Indicates Length of Stay 5 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", "type": "boolean" }, "lOS6": { "description": "Indicates Length of Stay 6 is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", "type": "boolean" }, "lOS7": { "description": "Indicates Length of Stay 7 or more is not available. Defines restriction in conjunction with Restriction Code LOSNotAvailable.", "type": "boolean" } } }, "createRestriction": { "type": "object", "description": "Request object for creating a new restriction.", "properties": { "restriction": { "$ref": "#/definitions/createRestrictionType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "createRestrictionType": { "type": "object", "properties": { "restrictionStatus": { "description": "Indicates the type of the restriction.", "$ref": "#/definitions/restrictionStatusType" }, "ratePlanCodes": { "description": "The rate code for which the restriction will be applied.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "rateClasses": { "description": "The rate class for which the restriction will be applied.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "roomClasses": { "description": "The room class for which the restriction will be applied.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "bookingChannels": { "description": "Booking channel.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "roomTypes": { "description": "The room type for which the restriction will be applied.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "ratePlanCategories": { "description": "The rate category for which the restriction will be applied.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 20 } }, "seasonCode": { "description": "The season code during which the restrictions are valid.", "type": "string", "minLength": 0, "maxLength": 20 }, "blockId": { "description": "Unique block identifier of the block for which restriction will be applied.", "$ref": "#/definitions/blockId" }, "bookingChannelOnRequest": { "description": "Booking channel on request.", "type": "string", "minLength": 0, "maxLength": 1 }, "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 }, "sunday": { "type": "boolean" }, "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" }, "yieldStatus": { "description": "Yield status condition.", "$ref": "#/definitions/roomTypeYieldableType" }, "hotelId": { "description": "The property to which the restriction is applied.", "type": "string", "minLength": 0, "maxLength": 20 } } }, "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" } } }, "roomTypeYieldableType": { "type": "string", "description": "Simple type for Yieldable or Non Yieldable", "enum": [ "Yieldable", "NonYieldable" ] }, "clearAllRestrictions": { "type": "object", "description": "Request object for clearing all restrictions based on date.", "properties": { "hotelId": { "description": "Refer to Generic common types document.", "$ref": "#/definitions/stringLength20" }, "date": { "description": "Use date for which the restrictions is to be cleared.", "type": "string", "format": "date" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "stringLength20": { "type": "string", "description": "Used for Character Strings, length 0 to 20.", "maxLength": 20, "minLength": 0 }, "restrictionsHistory": { "type": "object", "description": "Response object for searching restrictions history.", "properties": { "restrictionsHistory": { "description": "Response of Restrictions History", "$ref": "#/definitions/fetchRestrictionsHistoryRSType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "fetchRestrictionsHistoryRSType": { "type": "object", "description": "Response object to fetch restriction search filtered by search criteria.", "properties": { "restrictionsHistory": { "description": "Requested restrictions history.", "$ref": "#/definitions/restrictionsHistoryType" } } }, "restrictionsHistoryType": { "type": "object", "description": "Restriction history for the requested Hotel.", "properties": { "restrictionSets": { "description": "Restriction set for a date range.", "type": "array", "maxItems": 4000, "items": { "$ref": "#/definitions/restrictionSetHistoryType" } }, "chainCode": { "description": "The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. This attribute is optional if the hotel is an independent property that can be identified by the HotelCode attribute.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelId": { "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.", "type": "string", "minLength": 0, "maxLength": 20 }, "hotelCityCode": { "description": "The IATA city code; for example DCA, ORD.", "type": "string", "minLength": 0, "maxLength": 40 }, "hotelName": { "description": "A text field used to communicate the proper name of the hotel.", "type": "string", "minLength": 0, "maxLength": 80 }, "hotelCodeContext": { "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes.", "type": "string", "minLength": 0, "maxLength": 40 }, "chainName": { "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt).", "type": "string", "minLength": 0, "maxLength": 80 }, "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" } } }, "restrictionSetHistoryType": { "type": "object", "properties": { "restrictionControl": { "description": "Indicates the applicability of the restriction.", "$ref": "#/definitions/restrictionControlType" }, "restrictionStatus": { "description": "Indicates the type of the restriction.", "$ref": "#/definitions/restrictionStatusType" }, "actualTimeSpan": { "description": "Actual time span of the restriction.", "$ref": "#/definitions/timeSpanType" }, "onRequest": { "description": "Indicates whether the Closed restriction is flagged as On Request.", "type": "boolean" }, "actionType": { "description": "Indicates the action performed on restriction", "type": "string", "minLength": 0, "maxLength": 2000 }, "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 }, "sunday": { "type": "boolean" }, "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" }, "appliedDate": { "description": "Uses the hotel's time zone.", "type": "string", "format": "date-time" }, "seasonCode": { "description": "The season code during which the restrictions are valid.", "type": "string" }, "logUserId": { "type": "integer" }, "logUserName": { "type": "string", "minLength": 0, "maxLength": 40 } }, "description": "Indicates Restriction set applicable for the date range." }, "validateReservationGuarantees": { "type": "object", "description": "Request object to fetch reservation guarantees.", "properties": { "criteria": { "$ref": "#/definitions/resGuaranteeSearchType" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "resGuaranteeSearchType": { "type": "object", "description": "Contains Search criteria to get applicable Reservation Guarantee Codes.", "properties": { "hotelId": { "description": "Hotel Code to request Guarantee Codes.", "type": "string", "minLength": 0, "maxLength": 20 }, "arrivalDate": { "description": "Arrival Date of the guest.", "type": "string", "format": "date", "maxLength": 8 }, "ratePlanCode": { "description": "Rate Plan Code to find associated Guarantee Codes.", "type": "string", "minLength": 0, "maxLength": 20 }, "blockId": { "description": "Block ID.", "$ref": "#/definitions/blockId" }, "resGuestId": { "description": "Reservation Guest's Unique ID.", "$ref": "#/definitions/uniqueID_Type" }, "resAttachedProfiles": { "description": "Reservation's Attached Profiles unique IDs.", "$ref": "#/definitions/resAttachedProfileListType" }, "guaranteeCode": { "description": "Guarantee Code should be supplied only for the code verification purpose, if the supplied code is valid for the rest of the criteria it will return the response with the Guarantee Code information.", "type": "string", "minLength": 0, "maxLength": 20 }, "fetchInstruction": { "description": "Fetch Instructions for guarantee code", "$ref": "#/definitions/resGuaranteeFetchInstructionsType" }, "roomStayDetails": { "description": "Reservation room stay details.", "$ref": "#/definitions/roomStaySearchType" }, "roomType": { "description": "Room Type for the reservation", "type": "string", "minLength": 0, "maxLength": 2000 }, "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" } }, "resvRateAmount": { "description": "Rate amount Before Tax to calculate the total rate on event of rate change.", "$ref": "#/definitions/currencyAmountType" } } }, "resGuaranteeFetchInstructionsType": { "type": "object", "description": "", "properties": { "calculateEstimateAmount": { "description": "Determines whether estimated amount to be calculated or not", "type": "boolean" } } }, "roomStaySearchType": { "type": "object", "properties": { "timeSpan": { "$ref": "#/definitions/timeSpanType" }, "quantity": { "type": "integer" }, "guestCounts": { "$ref": "#/definitions/guestCountsType" } } }, "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" } } }, "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" } } }, "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 } } }, "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 charges such as taxes.", "$ref": "#/definitions/amountDeterminationType" } } }, "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" }, "useLovYn": { "description": "Specifies if the function argument is an lov or not.", "type": "boolean" }, "lovAllowMultiSelectYn": { "description": "Specifies if the function argument lov is single select or multi select lov.", "type": "boolean" }, "lovName": { "description": "Specifies the lov name of the function argument.", "type": "string", "minLength": 0, "maxLength": 100 } } }, "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" ] }, "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" } } }, "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" } } }, "actionType": { "type": "string", "description": "Action types allowed by the event api.", "enum": [ "CREATE", "UPDATE", "DELETE" ] }, "yieldMarketTypeDetails": { "type": "object", "description": "Response object Of Yield Market Type LookUp.", "properties": { "yieldMarketTypeInfo": { "description": "Type contains Yield Market Type information.", "$ref": "#/definitions/yieldMarketInfoType" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "yieldMarketInfoType": { "type": "object", "description": "Type provides the Yield Market Type information.", "properties": { "membershipId": { "description": "Membership Card Number.", "type": "string", "minLength": 1, "maxLength": 2000 }, "yieldMarketType": { "description": "Yield Market Type.", "type": "string", "minLength": 1, "maxLength": 2000 }, "hotelId": { "description": "Hotel Code.", "type": "string", "minLength": 1, "maxLength": 2000 }, "flexValues": { "description": "Yield Market Type FlexValues.", "type": "array", "maxItems": 4000, "items": { "type": "string", "minLength": 0, "maxLength": 2000 } } } }, "operaVersion": { "type": "object", "description": "Response for Ping operation.", "properties": { "operaVersion": { "description": "Current Opera Version Number", "type": "string" }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "searchAnalyzeRateAvailabilityRequest": { "type": "object", "properties": { "ratePlanCode": { "type": "string", "description": "The Rate Code for which the Analysis is requested." }, "roomType": { "type": "string", "description": "The Room Type for which the Analysis is requested. Analysis is done to determine whether the Rate Code is available for this Room Type." }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "duration": { "type": "string" }, "numberOfRooms": { "type": "integer", "description": "The number of rooms requested. The Analysis to check if this Rate Code is available for this number of rooms." }, "adults": { "type": "integer", "description": "Defines the number of Adults." }, "children": { "type": "integer", "description": "Defines the number of Children." }, "childAge": { "type": "array", "items": { "type": "integer" }, "description": "Age of a child in years." }, "bucket1Count": { "type": "integer", "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1)." }, "bucket2Count": { "type": "integer", "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2)." }, "bucket3Count": { "type": "integer", "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3)." }, "bucket4Count": { "type": "integer", "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4)." }, "bucket5Count": { "type": "integer", "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5)." }, "blockId": { "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." }, "blockIdType": { "type": "string", "description": "A reference to the type of object defined by the UniqueID element." }, "reservationId": { "type": "array", "items": { "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." }, "reservationIdType": { "type": "array", "items": { "type": "string" }, "description": "A reference to the type of object defined by the UniqueID element." }, "controlSegment": { "type": "string", "description": "Control Segment to check for casion restrction for a patron profile." }, "reservationGuestId": { "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." } } }, "searchAlternateAvailabilityRequest": { "type": "object", "properties": { "ratePlanCode": { "type": "string", "description": "Requested Rate code" }, "redemption": { "type": "boolean", "description": "Used to indicate if award redemption flag is to be set." }, "roomType": { "type": "string", "description": "Requested Room type." }, "roomId": { "type": "string", "description": "Requested Room Number." }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "duration": { "type": "string" }, "quantity": { "type": "integer" }, "adults": { "type": "integer", "description": "Defines the number of Adults." }, "children": { "type": "integer", "description": "Defines the number of Children." }, "childAge": { "type": "array", "items": { "type": "integer" }, "description": "Age of a child in years." }, "bucket1Count": { "type": "integer", "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1)." }, "bucket2Count": { "type": "integer", "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2)." }, "bucket3Count": { "type": "integer", "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3)." }, "bucket4Count": { "type": "integer", "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4)." }, "bucket5Count": { "type": "integer", "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5)." }, "reservationGuestId": { "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." }, "reservationGuestIdType": { "type": "string", "description": "A reference to the type of object defined by the UniqueID element." }, "reservationProfileType": { "type": "array", "items": { "$ref": "#/definitions/reservationProfileTypeEnum" }, "description": "Type of profile or reservation." }, "blockCode": { "type": "string" }, "blockName": { "type": "string" }, "blockId": { "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." }, "blockIdType": { "type": "string", "description": "A reference to the type of object defined by the UniqueID element." }, "membershipLevel": { "type": "string", "description": "Membership id Number of the guest." }, "membershipType": { "type": "string", "description": "Membership id Number of the guest." }, "controlSegment": { "type": "string", "description": "Control Segment to check for casion restrction for a patron profile." } } }, "reservationProfileTypeEnum": { "type": "string", "enum": [ "Guest", "Company", "Group", "TravelAgent", "Source", "ReservationContact", "BillingContact", "Addressee" ] }, "searchHotelAvailabilityRequest": { "type": "object", "properties": { "includeLocalRates": { "type": "boolean", "description": "Used to indicate if local rates are to be included in the Rate Plan set." }, "includeOffshoreRates": { "type": "boolean", "description": "Used to indicate if offshore rates are to be included in the Rate Plan set." }, "cro": { "type": "array", "items": { "type": "string" }, "description": "Central reservation office Code who is requesting Rate Availability." }, "includeClosedRates": { "type": "array", "items": { "type": "boolean" }, "description": "Used to indicate if closed rates are to be included in the Rate Plan set." }, "includeDefaultRatePlanSet": { "type": "array", "items": { "type": "boolean" }, "description": "Used to indicate if the configured default rate plan set will be included." }, "includeNoRatePlanSet": { "type": "array", "items": { "type": "boolean" }, "description": "Includes the rate codes which do not have a rate plan set associated. This parameter is applicable when the property has not configured a default rate plan set." }, "initialRatePlanSet": { "type": "array", "items": { "type": "boolean" }, "description": "If InitialRatePlanSet is set to true response will return most relevant Rate Plan Set(e.g. NEGOTIATED if profiles has Negotiated Rates) depending on the request. if request does not requires special Rate Plan Set, it will return default Rate Plan Set if RatePlanSet value is not set." }, "limit": { "type": "array", "items": { "type": "integer" }, "description": "Indicates maximum number of records a Web Service should return." }, "pagePointerKey": { "type": "array", "items": { "type": "string" }, "description": "Specifies fetched record's key as pointer to fetch additional records from. If key is composite use comma separated string." }, "ratePlanSet": { "type": "array", "items": { "type": "string" }, "description": "Rate Plan Set code to filter Rate Plans based on the predefined set. if not specified it will not filter any Rate Plans by Rate Plan Set. When InitialRatePlanSet is true response may not always return Rate Plans for the supplied Rate Plan Set(See InitialRatePlanSet documentation)." }, "redeemAwards": { "type": "array", "items": { "type": "boolean" }, "description": "Used to indicate if the awards are to be redeemed." }, "roomStayStartDate": { "type": "string", "format": "date" }, "roomStayEndDate": { "type": "string", "format": "date" }, "roomStayQuantity": { "type": "integer" }, "adults": { "type": "integer", "description": "Defines the number of Adults." }, "children": { "type": "integer", "description": "Defines the number of Children." }, "childAge": { "type": "array", "items": { "type": "integer" }, "description": "Age of a child in years." }, "bucket1Count": { "type": "integer", "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1)." }, "bucket2Count": { "type": "integer", "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2)." }, "bucket3Count": { "type": "integer", "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3)." }, "bucket4Count": { "type": "integer", "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4)." }, "bucket5Count": { "type": "integer", "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5)." }, "fullStayTimeSpanStartDate": { "type": "string", "format": "date" }, "fullStayTimeSpanEndDate": { "type": "string", "format": "date" }, "prevailingRate": { "type": "boolean" }, "rateCategory": { "type": "string" }, "rateClass": { "type": "string" }, "rateGroup": { "type": "string" }, "ratePlanCode": { "type": "array", "items": { "type": "string" } }, "promotionCode": { "type": "array", "items": { "type": "string" }, "description": "Promotion code associated with the rate plan." }, "roomType": { "type": "array", "items": { "type": "string" } }, "feature": { "type": "array", "items": { "type": "string" } }, "reservationGuestId": { "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." }, "reservationGuestIdType": { "type": "string", "description": "A reference to the type of object defined by the UniqueID element." }, "reservationProfileType": { "type": "array", "items": { "$ref": "#/definitions/reservationProfileTypeEnum" }, "description": "Type of profile or reservation." }, "attachedProfileId": { "type": "array", "items": { "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." }, "hotelReservationId": { "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." }, "hotelReservationIdType": { "type": "string", "description": "A reference to the type of object defined by the UniqueID element." }, "ratePlanInfo": { "type": "boolean", "description": "If true Rate Plan Code Master information will be included in the response." }, "returnOnlyAvailableRateCodes": { "type": "boolean", "description": "If true Only availability check will be done and it will return available rate codes." }, "resGuaranteeInfo": { "type": "boolean", "description": "If true Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true." }, "roomTypeInfo": { "type": "boolean", "description": "If true Room Type Master information will be included in the response." }, "membershipIdNumber": { "type": "array", "items": { "type": "integer" }, "description": "Membership id Number of the guest." }, "membershipLevel": { "type": "array", "items": { "type": "string" }, "description": "Membership id Number of the guest." }, "membershipType": { "type": "array", "items": { "type": "string" }, "description": "Membership id Number of the guest." }, "pointsAvailable": { "type": "array", "items": { "type": "integer" }, "description": "Used to indicate Points Available for Profile Primary Membership Type." }, "membershipCardNumber": { "type": "array", "items": { "type": "string" }, "description": "Member Card number associated with the guest membership." }, "smokingPreference": { "type": "array", "items": { "type": "string" }, "description": "Smoking preference to search a reservation. This is compared to the preference on the guest profile of the reservation." }, "hotelPackage": { "type": "array", "items": { "type": "string" }, "description": "Hotel Package Code to filter the search result." }, "ownerType": { "type": "string", "$ref": "#/definitions/ownerProfileTypeEnum" }, "controlSegment": { "type": "array", "items": { "type": "string" }, "description": "Control Segment to check for casion restrction for a patron profile." }, "postingInterval": { "type": "array", "items": { "$ref": "#/definitions/ratePostingInterval" }, "description": "Optional posting interval filter. When nothing is provided in this filter then only Nightly rates will be returned" } } }, "ownerProfileTypeEnum": { "type": "string", "enum": [ "Owner", "Referral", "Regular" ] }, "searchHotelAvailabilityCRORequest": { "type": "object", "properties": { "cro": { "type": "array", "items": { "type": "string" }, "description": "Central reservation office Code who is requesting Rate Availability." }, "hotelIds": { "type": "array", "items": { "type": "string" }, "description": "Hotel code of the Hotel whose Rate Availability is requested." }, "includeClosedRates": { "type": "array", "items": { "type": "boolean" }, "description": "Used to indicate if closed rates are to be included in the Rate Plan set." }, "includeDefaultRatePlanSet": { "type": "array", "items": { "type": "boolean" }, "description": "Used to indicate if the configured default rate plan set will be included." }, "includeNoRatePlanSet": { "type": "array", "items": { "type": "boolean" }, "description": "Includes the rate codes which do not have a rate plan set associated. This parameter is applicable when the property has not configured a default rate plan set." }, "initialRatePlanSet": { "type": "array", "items": { "type": "boolean" }, "description": "If InitialRatePlanSet is set to true response will return most relevant Rate Plan Set(e.g. NEGOTIATED if profiles has Negotiated Rates) depending on the request. if request does not requires special Rate Plan Set, it will return default Rate Plan Set if RatePlanSet value is not set." }, "limit": { "type": "array", "items": { "type": "integer" }, "description": "Indicates maximum number of records a Web Service should return." }, "pagePointerKey": { "type": "array", "items": { "type": "string" }, "description": "Specifies fetched record's key as pointer to fetch additional records from. If key is composite use comma separated string." }, "ratePlanSet": { "type": "array", "items": { "type": "string" }, "description": "Rate Plan Set code to filter Rate Plans based on the predefined set. if not specified it will not filter any Rate Plans by Rate Plan Set. When InitialRatePlanSet is true response may not always return Rate Plans for the supplied Rate Plan Set(See InitialRatePlanSet documentation)." }, "redeemAwards": { "type": "array", "items": { "type": "boolean" }, "description": "Used to indicate if the awards are to be redeemed." }, "roomStayStartDate": { "type": "string", "format": "date" }, "roomStayEndDate": { "type": "string", "format": "date" }, "roomStayQuantity": { "type": "integer" }, "adults": { "type": "integer", "description": "Defines the number of Adults." }, "children": { "type": "integer", "description": "Defines the number of Children." }, "childAge": { "type": "array", "items": { "type": "integer" }, "description": "Age of a child in years." }, "bucket1Count": { "type": "integer", "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1)." }, "bucket2Count": { "type": "integer", "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2)." }, "bucket3Count": { "type": "integer", "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3)." }, "bucket4Count": { "type": "integer", "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4)." }, "bucket5Count": { "type": "integer", "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5)." }, "fullStayTimeSpanStartDate": { "type": "string", "format": "date" }, "fullStayTimeSpanEndDate": { "type": "string", "format": "date" }, "prevailingRate": { "type": "boolean" }, "rateCategory": { "type": "string" }, "rateClass": { "type": "string" }, "rateGroup": { "type": "string" }, "ratePlanCode": { "type": "array", "items": { "type": "string" } }, "promotionCode": { "type": "array", "items": { "type": "string" }, "description": "Promotion code associated with the rate plan." }, "roomType": { "type": "array", "items": { "type": "string" } }, "roomClass": { "type": "array", "items": { "type": "string" } }, "bedType": { "type": "array", "items": { "type": "string" } }, "feature": { "type": "array", "items": { "type": "string" } }, "reservationGuestId": { "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." }, "reservationGuestIdType": { "type": "string", "description": "A reference to the type of object defined by the UniqueID element." }, "reservationProfileType": { "type": "array", "items": { "$ref": "#/definitions/reservationProfileTypeEnum" }, "description": "Type of profile or reservation." }, "attachedProfileId": { "type": "array", "items": { "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." }, "hotelReservationId": { "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." }, "hotelReservationIdType": { "type": "string", "description": "A reference to the type of object defined by the UniqueID element." }, "ratePlanInfo": { "type": "boolean", "description": "If true Rate Plan Code Master information will be included in the response." }, "returnOnlyAvailableRateCodes": { "type": "boolean", "description": "If true Only availability check will be done and it will return available rate codes." }, "resGuaranteeInfo": { "type": "boolean", "description": "If true Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true." }, "roomTypeInfo": { "type": "boolean", "description": "If true Room Type Master information will be included in the response." }, "membershipIdNumber": { "type": "array", "items": { "type": "integer" }, "description": "Membership id Number of the guest." }, "membershipLevel": { "type": "array", "items": { "type": "string" }, "description": "Membership id Number of the guest." }, "membershipType": { "type": "array", "items": { "type": "string" }, "description": "Membership id Number of the guest." }, "pointsAvailable": { "type": "array", "items": { "type": "integer" }, "description": "Used to indicate Points Available for Profile Primary Membership Type." }, "membershipCardNumber": { "type": "array", "items": { "type": "string" }, "description": "Member Card number associated with the guest membership." }, "smokingPreference": { "type": "array", "items": { "type": "string" }, "description": "Smoking preference to search a reservation. This is compared to the preference on the guest profile of the reservation." }, "hotelPackage": { "type": "array", "items": { "type": "string" }, "description": "Hotel Package Code to filter the search result." }, "yieldMarketCode": { "type": "string" }, "accessibleRoomTypesOnly": { "type": "boolean", "description": "Used to fetch accessible room types only in the Rate Plan set." }, "includeLocalRates": { "type": "boolean", "description": "Used to indicate if local rates are to be included in the Rate Plan set." }, "includeOffshoreRates": { "type": "boolean", "description": "Used to indicate if offshore rates are to be included in the Rate Plan set." }, "postingInterval": { "type": "array", "items": { "$ref": "#/definitions/ratePostingIntervalEnum" }, "description": "Optional posting interval filter. When nothing is provided in this filter then only Nightly rates will be returned" }, "ownerType": { "type": "string", "$ref": "#/definitions/ownerProfileTypeEnum" }, "controlSegment": { "type": "array", "items": { "type": "string" }, "description": "Control Segment to check for casion restrction for a patron profile." } } }, "ratePostingIntervalEnum": { "type": "string", "enum": [ "Nightly", "Weekly", "Monthly" ] }, "externalControlSegmentCriteria": { "type": "object", "description": "The request element containing criteria to retrieve control segment code.", "properties": { "externalControlSegmentCriteria": { "type": "array", "items": { "$ref": "#/definitions/externalControlSegmentCriteriaType" }, "minItems": 1, "maxItems": 80, "description": "External control segment criteria" } } }, "externalControlSegmentDetails": { "type": "object", "description": "Response object Of Control Segment Look Up.", "properties": { "externalControlSegments": { "description": "Type contains Control Segment information.", "type": "array", "items": { "$ref": "#/definitions/externalControlSegmentType" } }, "links": { "$ref": "#/definitions/links" }, "warnings": { "$ref": "#/definitions/warningsType" } } }, "externalControlSegmentType": { "type": "object", "description": "Type provides the Control Segment information.", "properties": { "membershipId": { "description": "Membership Card Number.", "type": "string", "minLength": 1, "maxLength": 2000 }, "controlSegment": { "description": "Control Segment.", "type": "string", "minLength": 1, "maxLength": 2000 }, "hotelId": { "description": "Hotel Code.", "type": "string", "minLength": 1, "maxLength": 2000 } } }, "externalControlSegmentCriteriaType": { "type": "object", "description": "The request element containing criteria to retrieve control segment code.", "properties": { "membershipId": { "description": "Membership card number.", "type": "string", "minLength": 1, "maxLength": 2000 }, "hotelId": { "description": "Unique Id(s) for the Hotel(s) queried.", "type": "string", "minLength": 1, "maxLength": 40 } } } }, "tags": [ { "name": "Availability", "description": "The Availability module provides APIs to fetch a properties room/rate availability, manage restrictions and hurdles. Restrictions can be set for the entire property or for a rate category, rate code, room class or room type.