HotelRulesRsp |
element |
|
|
|
Response showing rule details of a given
hotel property and room rate code |
| CommandHistory |
string simple type |
|
Optional |
|
HTTP link to download command history and debugging information of the request that generated this response. Must be enabled on the system. |
| ResponseTime |
decimal simple type |
|
Optional |
|
The time (in ms) the system spent processing this request, not including transmission times. |
| TraceId |
string simple type |
|
Optional |
|
Unique identifier for this atomic transaction traced by the user. Use is optional. |
| TransactionId |
string simple type |
|
Optional |
|
System generated unique identifier for this atomic transaction. |
| ResponseMessage |
element |
|
|
|
A simple textual fare note. Used within several other objects. |
| Code |
decimal simple type |
|
Required |
|
|
| Type |
string simple type |
Warning , Error , Info |
Optional |
|
Indicates the type of message (Warning, Error, Info) |
| ProviderCode |
string simple type |
|
Optional |
|
|
| SupplierCode |
string simple type |
|
Optional |
|
|
| HotelRateDetail |
element |
|
|
|
Returns hotel rate details during the stay if rates are available for requested property. |
| ApproximateBase |
string simple type |
|
Optional |
|
Hotel base rate expressed in another currency |
| ApproximateRateGuaranteed |
boolean simple type |
|
Optional |
|
If true, approximate rate is guaranteed by vendor. Supported Providers: 1G,1V |
| ApproximateSurcharge |
string simple type |
|
Optional |
|
Surcharge associated with the room expressed in another currency. |
| ApproximateTax |
string simple type |
|
Optional |
|
Taxes expressed in another currency |
| ApproximateTotal |
string simple type |
|
Optional |
|
Hotel total rate expressed in another currency. |
| BookableQuantity |
nonNegativeInteger simple type |
|
Optional |
|
The number of rooms which can be booked on the rate returned in HotelRateDetails. When the aggregator responds ‘IsPackage’= true (pricing for all rooms together), the BookableQuantity value will be ‘1’. |
| ExtraFeesIncluded |
string simple type |
true , false , unknown |
Optional |
|
When true, total amounts includes additional fees or charges." Enumerated values are true, false, and unknown |
| InPolicy |
boolean simple type |
|
Optional |
|
This attribute will be used to indicate if a fare or rate has been determined to be ‘in policy’ based on the associated policy settings. |
| Key |
string simple type |
|
Optional |
|
|
| RateCategory |
positiveInteger simple type |
|
Optional |
|
An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OpenTravel Code List Rate Plan Type (RPT). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelRateCategory". |
| RateChangeIndicator |
string simple type |
true , false , unknown |
Optional |
|
Determines if the rate changes during the length of stay. Enumerated values are true, false, and unknown. |
| RateGuaranteed |
boolean simple type |
|
Optional |
|
|
| RateOfferId |
string simple type |
|
Optional |
|
Offer Identifier. Maybe required for hotels provided by aggregators. |
| RatePlanType |
string simple type |
|
Required |
|
|
| RateSupplier |
string simple type |
|
Optional |
|
Indicates the source of the rate. |
| Base |
string simple type |
|
Optional |
|
This attribute is used to describe the Hotel Supplier Base Rate |
| Surcharge |
string simple type |
|
Optional |
|
This attribute used to describe Surcharge associated with the room |
| Tax |
string simple type |
|
Optional |
|
This attribute used to describe Tax associated with the room |
| Total |
string simple type |
|
Optional |
|
This attribute used to describe Hotel Supplier Total Rate |
| PolicyCodesList |
typePolicyCodesList complex type |
|
|
|
A list of codes that indicate why an item was determined to be ‘out of policy’. |
| PolicyCode |
anonymous simple type |
|
|
|
A code that indicates why an item was determined to be ‘out of policy’. |
| MinPolicyCode |
anonymous simple type |
|
|
|
A code that indicates why the minimum fare or rate was determined to be ‘out of policy’. |
| MaxPolicyCode |
anonymous simple type |
|
|
|
A code that indicates why the maximum fare or rate was determined to be ‘out of policy’. |
| RoomRateDescription |
typeHotelRateDescription complex type |
|
|
|
A code that indicates why the maximum fare or rate was determined to be ‘out of policy’. |
| Name |
string simple type |
|
Optional |
|
Optional context name of the text block being returned i.e. Room details |
| Text |
anonymous simple type |
|
|
|
Optional context name of the text block being returned i.e. Room details |
| HotelRateByDate |
element |
|
|
|
The daily rate details |
| ApproximateBase |
string simple type |
|
Optional |
|
Hotel base rate expressed in another currency |
| ApproximateTotal |
string simple type |
|
Optional |
|
Hotel total rate expressed in another currency. Supported Providers: 1P |
| Contents |
string simple type |
|
Optional |
|
Contents will be representing all unformatted data returned by HOST, those are not uAPI supported. Support provider 1P. |
| EffectiveDate |
string simple type |
|
Optional |
|
|
| ExpireDate |
string simple type |
|
Optional |
|
|
| Base |
string simple type |
|
Optional |
|
This attribute is used to describe the Hotel Supplier Base Rate |
| Surcharge |
string simple type |
|
Optional |
|
This attribute used to describe Surcharge associated with the room |
| Tax |
string simple type |
|
Optional |
|
This attribute used to describe Tax associated with the room |
| Total |
string simple type |
|
Optional |
|
This attribute used to describe Hotel Supplier Total Rate |
| CorporateDiscountID |
element |
|
|
|
These are zero or more negotiated rate codes |
| NegotiatedRateCode |
boolean simple type |
|
Optional |
|
When set to true,
the data in the CorporateDiscountID is a negotiated rate code.
Otherwise, this data is a Corporate Discount ID rate. |
| AcceptedPayment |
element |
|
|
|
When set to true,
the data in the CorporateDiscountID is a negotiated rate code.
Otherwise, this data is a Corporate Discount ID rate. |
| PaymentCode |
string simple type |
|
Optional |
|
The issuer of the form of payment, such as the credit card bank. |
| Commission |
element |
|
|
|
The issuer of the form of payment, such as the credit card bank. |
| ApproxCommissionAmount |
string simple type |
|
Optional |
|
The approximate commission amount in the agency’s provisioned or requested currency. |
| ApproxCommissionOnSurcharges |
string simple type |
|
Optional |
|
The approximate commission on surcharges in the agency’s provisioned or requested currency. |
| CommissionAmount |
string simple type |
|
Optional |
|
The commission amount in the aggregator’s or supplier’s currency. |
| CommissionOnSurcharges |
string simple type |
|
Optional |
|
Commission on surcharges in the aggregator’s or supplier’s currency. |
| Indicator |
string simple type |
true , false , unknown |
Optional |
|
Indicates if the Rate Plan is commissionable.True: Rate is commissionable.False: Rate is not commissionable.Unknown: Commission indicator is not returned by the hotel supplier (chain or property). |
| Percent |
string simple type |
|
Optional |
|
The percentage applied to the commissionable amount to determine the payable commission amount. |
| RateMatchIndicator |
element |
|
|
|
"Match" Indicators for certain request parameters, e.g. Child Count, Extra Adults etc. |
| Status |
string simple type |
Available , NotAvailable , SubstituteOffered , MaximumExceeded |
Required |
|
|
| Type |
string simple type |
RateCategory , RoomCount , AdultCount , ChildCount , AdultRollaway , ChildRollaway , Crib |
Required |
|
|
| Value |
string simple type |
|
Optional |
|
|
| TaxDetails |
element |
|
|
|
|
| Tax |
element |
|
|
|
|
| Code |
positiveInteger simple type |
|
Required |
|
Code identifying fee (e.g. agency fee, bed tax etc.). Refer to OPEN Travel Code List for Fee Tax Type. Possible values are OTA Code against FTT. |
| CollectionFreq |
string simple type |
|
Optional |
|
Indicates how often the tax is collected. Values can be Once or Daily |
| EffectiveDate |
date simple type |
|
Optional |
|
|
| ExpirationDate |
date simple type |
|
Optional |
|
|
| Term |
string simple type |
|
Optional |
|
Indicates how the tax is applied. Values can be PerPerson, PerNight and PerStay |
| Amount |
typeMoney simple type |
|
|
|
Indicates how the tax is applied. Values can be PerPerson, PerNight and PerStay |
| Percentage |
float simple type |
|
|
|
Indicates how the tax is applied. Values can be PerPerson, PerNight and PerStay |
| CancelInfo |
element |
|
|
|
Returns cancellation information for certain hotel returned in response. This information is available through GDS transactions |
| CancelDeadline |
dateTime simple type |
|
Optional |
|
Last date/time the reservation can be canceled without penalty. |
| CancelPenaltyAmount |
string simple type |
|
Optional |
|
This will contain the cancellation penalty amount. |
| CancelPenaltyPercent |
float simple type |
|
Optional |
|
This will contain the cancellation penalty expressed as a percentage. |
| CancelPenaltyPercentAppliesTo |
string simple type |
|
Optional |
|
This will contain the cost qualifier that explains what the percentage is applied to in order to calculate the cancel penalty. |
| FeeInclusive |
boolean simple type |
|
Optional |
|
Indicates whether or not the Penalty amount includes fees. |
| Method |
string simple type |
|
Optional |
|
Cancellation method, either "API", "URL", "INFO", or "NONE". |
| NonRefundableStayIndicator |
string simple type |
true , false , unknown |
Optional |
|
True if Deposit or Payment is non-refundable |
| NumberOfNights |
integer simple type |
|
Optional |
|
This will contain the number of nights that will be assessed as the cancelation penalty. |
| Supported |
boolean simple type |
|
Optional |
|
If true, the booking can be canceled. If false, the booking cannot be canceled. |
| TaxInclusive |
boolean simple type |
|
Optional |
|
Indicates whether or not the Penalty amount includes taxes. |
| URL |
string simple type |
|
Optional |
|
The URL provided by the supplier to cancel the booking, if @Method="URL". For all other values of @Method, @URL is not returned. |
| OffsetDropTime |
string simple type |
|
Optional |
|
An enumerated type indicating when the deadline drop time goes into effect. Enumerated values are “AfterBooking” and “BeforeArrival”. |
| OffsetTimeUnit |
string simple type |
|
Optional |
|
The units of time, e.g: days, hours, etc that apply to the deadline. Enumerated values are “Year”, “Month”, “Day”, and “Hour”. |
| OffsetUnitMultiplier |
integer simple type |
|
Optional |
|
The number of units of DeadlineTimeUnit. |
| CancellationPolicy |
string simple type |
|
|
|
Return cancellation policy text by the aggregator. |
| Text |
string simple type |
|
|
|
The informational text provided by the supplier to cancel the booking, if @Method="INFO". For all other values of @Method, Text is not returned. |
| GuaranteeInfo |
element |
|
|
|
The informational text provided by the supplier to cancel the booking, if @Method="INFO". For all other values of @Method, Text is not returned. |
| AbsoluteDeadline |
dateTime simple type |
|
Optional |
|
Latest date/time when deposit/payment/guarantee is required. |
| CredentialsRequired |
boolean simple type |
|
Optional |
|
Identification required at booking/checkin. Not supported by 1P. |
| GuaranteeType |
string simple type |
Deposit , Guarantee , Prepayment |
Optional |
|
Deposit, Guarantee, or Prepayment required to hold/book the room. Applicable only for HotelSupershopper, Hotel Details and Hotel rules. |
| HoldTime |
string simple type |
|
Optional |
|
Expiration time for room reservation held without deposit/guarantee. |
| OffsetDropTime |
string simple type |
|
Optional |
|
An enumerated type indicating when the deadline drop time goes into effect. Enumerated values are “AfterBooking” and “BeforeArrival”. |
| OffsetTimeUnit |
string simple type |
|
Optional |
|
The units of time, e.g: days, hours, etc that apply to the deadline. Enumerated values are “Year”, “Month”, “Day”, and “Hour”. |
| OffsetUnitMultiplier |
integer simple type |
|
Optional |
|
The number of units of DeadlineTimeUnit. |
| DepositAmount |
element |
|
|
|
Amount required for deposit/prepayment |
| Amount |
string simple type |
|
Optional |
|
Supplier deposit amount required for
deposit/prepayment.Supported by all Providers when supported by
supplier |
| ApproximateAmount |
string simple type |
|
Optional |
|
Approximate deposit amount required for
deposit/prepayment. |
| DepositNights |
integer simple type |
|
|
|
Number of Nights required for deposit/prepayment |
| DepositPercent |
integer simple type |
|
|
|
Percentage of stay required for deposit/prepayment |
| GuaranteePaymentType |
element |
|
|
|
Accepted payment types. Applicable only for HotelSupershopper, Hotel Details and Hotel rules. |
| Description |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
|
Required |
|
Accepted payment types: CreditCard, AgencyIATA/ARC, FrequentGuest, SpecialIndustry, CDNumber, HomeAddress, CompanyAddress, Override, Other, or None |
| SupplementalRateInfo |
string simple type |
|
|
|
Supplemental rate information provided by the aggregator. |
| RoomCapacity |
element |
|
|
|
The maximum number of guests for a room or for each room in a package. |
| IsPackage |
boolean simple type |
|
Optional |
|
If true, the rooms are offered as a package by the aggregator. |
| Capacity |
positiveInteger simple type |
|
|
|
The maximum number of guests per room. |
| ExtraCharges |
element |
|
|
|
Additional charges applied to the hotel rate. |
| AdultRollawayCharge |
string simple type |
|
Optional |
|
Additional charge for an extra rollaway bed provided for an adult guest. |
| ChildRollawayCharge |
string simple type |
|
Optional |
|
Additional charge for an extra rollaway bed provided for a child guest. |
| CribAmount |
string simple type |
|
Optional |
|
Additional charge for a crib. |
| ExtraAdultAmount |
string simple type |
|
Optional |
|
Additional charge for an extra guest. |
| ExtraChildAmount |
string simple type |
|
Optional |
|
dditional charge for an extra child guest. |
| Inclusions |
element |
|
|
|
Additional items included in the hotel rate plan. |
| SmokingRoomIndicator |
string simple type |
true , false , unknown |
Optional |
|
Indicates if the room is designated as nonsmoking or smoking.
true = Smoking
false = NonSmoking
unknown = Information is not returned by the hotel supplier (chain or property). |
| BedTypes |
element |
|
|
|
Bed types in the rate plan. |
| Code |
positiveInteger simple type |
|
Optional |
|
Bed Type Code. Uses Open Travel Code List Room Amenity Type (RMA). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelAmenities”. |
| Quantity |
integer simple type |
|
Optional |
|
Bed Quantity. |
| MealPlans |
element |
|
|
|
Meal options available for the rate plan. |
| Breakfast |
string simple type |
true , false , unknown |
Optional |
|
Indicates whether a daily breakfast is included in the meal plan.
true = Breakfast is included
false = Breakfast is not included
unknown = Information is not returned by the hotel supplier (chain or property). |
| Dinner |
string simple type |
true , false , unknown |
Optional |
|
Indicates whether a daily dinner is included in the meal plan.
true = Dinner is included
false = Dinner is not included
unknown = Information is not returned by the hotel supplier (chain or property). |
| Lunch |
string simple type |
true , false , unknown |
Optional |
|
Indicates whether a daily lunch is included in the meal plan.
true = Lunch is included
false = Lunch is not included
unknown = Information is not returned by the hotel supplier (chain or property). |
| MealPlan |
element |
|
|
|
Meal plan. |
| Code |
positiveInteger simple type |
|
Optional |
|
Meal plan code. Uses Open Travel Code List Meal Plan Type (MPT). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelMealPlans”. |
| RoomView |
element |
|
|
|
Meal plan code. Uses Open Travel Code List Meal Plan Type (MPT). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelMealPlans”. |
| Code |
positiveInteger simple type |
|
Optional |
|
OTA code represents different hotel room views. |
| HotelRuleItem |
element |
|
|
|
Textual information about the hotel rule |
| Name |
string simple type |
|
Required |
|
|
| Text |
string simple type |
|
|
|
|
| HotelType |
element |
|
|
|
|
| SourceLink |
boolean simple type |
|
Optional |
|
Indicates whether results are returned from the vendor or from the database. If true, vendor results were returned. Supported providers:1G, 1V |