OTA_HotelRatePlanRQ/RS

OTA_HotelRatePlanRQ

The following request will be sent by Smarthotel to retrieve rate information:

<?xml version="1.0" encoding="utf-8"?>
<OTA_HotelRatePlanRQ EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
  <POS>
    <Source>
      <RequestorID ID="APIKEY" MessagePassword="APIPASSWORD"/>
    </Source>
  </POS>
  <RatePlans>
    <RatePlan>
      <HotelRef HotelCode="12345" />
    </RatePlan>
  </RatePlans>
</OTA_HotelRatePlanRQ>

Element / @Attribute	Parent	Info	Values	Occurrence
RatePlans	OTA_HotelRatePlanRQ	Collection of rate plans.		1
RatePlan	RatePlans	Provides the criteria to identify the rate plan to be returned.		1..n
HotelRef	RatePlan	Indicates the detail of hotel reference information.		1
@HotelCode	HotelRef	The ID of the hotel	[integer]	1
DestinationSystemsCode	RatePlan	A collection of destination system codes. These are systems for which this rate plan is targeted. A collection of DestinationSystemCode.		0..1
DestinationSystemsCode	DestinationSystemsCode	The ID of the channel	[integer]	1
RatePlanCandidates	RatePlan	Collection of requested rateplans		0..1
RatePlanCandidate	RatePlanCandidates	Element used to identify available products and rates.		1

OTA_HotelRatePlanRS

The response should include the rate codes and names, and the rooms that are connected to them.

<?xml version="1.0" encoding="utf-8"?>
<OTA_HotelRatePlanRS EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
  <Success />
  <RatePlans>
    <RatePlan RatePlanCode="1">
      <Description Name="Name">
        <Text>Standard rate</Text>
      </Description>
      <SellableProducts>
        <SellableProduct InvTypeCode="1" />
        <SellableProduct InvTypeCode="2" />
        <SellableProduct InvTypeCode="3" />
      </SellableProducts>
    </RatePlan>
    <RatePlan RatePlanCode="2">
      <Description Name="Name">
        <Text>Non refundable</Text>
      </Description>
      <SellableProducts>
        <SellableProduct InvTypeCode="1" />
        <SellableProduct InvTypeCode="2" />
      </SellableProducts>
    </RatePlan>
    <RatePlan RatePlanCode="3">
      <Description Name="Name">
        <Text>Breakfast included</Text>
      </Description>
      <SellableProducts>
        <SellableProduct InvTypeCode="3" />
      </SellableProducts>
    </RatePlan>
  </RatePlans>
</OTA_HotelRatePlanRS>

Element / @Attribute	Parent	Info	Values	Occurrence
RatePlans	OTA_HotelRatePlanRS	A collection of rate plans.		1
RatePlan	RatePlans	An individual rate plan. All details pertaining to a specific rate plan.		0..n
@RatePlanCode	RatePlan	The ID of the rate.	[integer]	1
@DestinationSystemsCode	RatePlan	The ID of the channel.	[integer]	1
HotelRef	RatePlan	Indicates the detail of hotel reference information.		1
@HotelCode	HotelRef	The ID of the hotel.	[integer]	1
Description	RatePlan	Description of the RatePlan. An indication of a new paragraph for a sub-section of a formatted text message.		1
@Name	Description	Indicates the type of the description.	`Name`	1
Text	Description	Formatted text content.		1
RatePlanLevelFee	RatePlan	A Fee that is attached directly to the RatePlan. Can be used to send a global surcharge at the RatePlan level.		0..1
Fee	RatePlanLevelFee	Fee Amount that is applied to the rate. Fees are used for non-tax amounts like service charges.		1
@MealPlanCode	Fee	This describes meal plans associated with a rate plan.	Refer to OpenTravel Code List Meal Plan Type (MPT)	1
BookingRules	RatePlan	A collection of booking rules.		1
BookingRule	BookingRules	The BookingRule element defines restrictions to rates and stays at the hotel for a given rate plan, room type or rate plan/room type combination.		1
@MaxAdvancedBookingOffset	BookingRule	Maximum days before the arrival date for which this rate plan may be booked.	[integer]	0..1
RequiredPaymts	BookingRule	A collection of required payments that are part of the booking restriction. A collection of required payments.		0..1
GuaranteePayment	RequiredPaymts	Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.		1
AmountPercent	GuaranteePayment	Payment expressed as a fixed amount, or a percentage of/or room nights.		1
@Percent	AmountPercent	The percentage used to calculate the amount.	[double]	1
CancelPenalties	BookingRule	A collection of required payments that are part of the booking restriction. A collection of CancelPenalty.		1
@CancelPolicyIndicator	CancelPenalties	When `True`, indicates a cancel policy exists. When `False`, no cancel policy exists. Typically this indicator is used when details are not being sent.	`True` `False`	1
CancelPenalty	CancelPenalties	Defines the cancellation penalty of the hotel facility. The CancelPenalty class defines the cancellation policy of the hotel facility.		1
@NonRefundable	CancelPenalty	Indicates that any prepayment for the reservation is non-refundable, therefore a 100% penalty on the prepayment is applied, irrespective of deadline.	`True` `False`	1
@PolicyCode	CancelPenalty	The ID of the cancellation policy.	Refer to Code List Policy Codes	1
Deadline	CancelPenalty	Cancellation deadline, absolute or relative.		0..1
@AbsoluteDeadline	Deadline	Defines the absolute deadline. Either this or the offset attributes may be used.	[HH:mm:ss]	0..1
@OffsetDropTime	Deadline	An enumerated type indicating when the deadline drop time goes into effect.	`BeforeArrival`	0..1
@OffsetTimeUnit	Deadline	The units of time, e.g.: days, hours, etc., that apply to the deadline.	`Days` `Hours`	0..1
@OffsetUnitMultiplier	Deadline	The number of units of DeadlineTimeUnit.	[integer]	0..1
PenaltyDescription	CancelPenalty	Text description of the Penalty in a given language. An indication of a new paragraph for a sub-section of a formatted text message.		0..1
Text	PenaltyDescription	Formatted text content.	[string]	0..1
AmountPercent	CancelPenalty	Cancellation fee expressed as a fixed amount, or percentage of/or room nights. Defines the percentage basis for calculating the fee amount or the amount.		0..1
@ApplyAs	AmountPercent	Used to specify how the amount needs to be applied with respect to the stay.	`FirstNightPayment`	0..1
@NmbrOfNights	AmountPercent	The number of nights of the hotel stay that are used to calculate the fee amount.	[integer]	0..1
@Percent	AmountPercent	The percentage used to calculate the amount.	[double]	0..1
@BasisType	AmountPercent	Provides the basis for how the amount of the guarantee is calculated.	`FullStay` `Nights`	1
SellableProducts	RatePlan	A collection of Sellable Products. The SellableProduct class defines the inventoried item for this rate plan.		0..1
SellableProduct	SellableProducts	The individual sellable product. A sellable product may be a guest room, a meeting room or an inventory block. Attributes of SellableProduct are the inventory codes, information on the use, application and sequencing of the inventory information.		1..n
@InvTypeCode	SellableProduct	The ID of the room to link to as mentioned in the @Code attribute in the GuestRoom element in the OTA_HotelDescriptiveInfoRS	[integer]	1
TPA_Extensions	OTA_HotelRatePlanRS	A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA). Allows extensions to be added to the OpenTravel specification per trading partner agreement.		1
RatePlans	TPA_Extensions	A collection of rate plans.		1
RatePlan	RatePlans	An individual rate plan. All details pertaining to a specific rate plan.		0..n
@RatePlanCode	RatePlan	The ID of the rate code	[integer]	1
@RatePlanTypeCode	RatePlan	The code of the rate.	[string]	1
@Sort	RatePlan	The sort index.	[integer]	1
@IncludesTaxInd	RatePlan	Indicates whether tax is included.	`True` `False`	1
@RateType	RatePlan	The type of the rate:	`BaseRate` `Default` `CalculatedRate` `BestBarByDay` `NoRnAUpdate`	1
@MasterRate	RatePlan	Indicates whether the rate is a master rate.	`True` `False`	1
@Default	RatePlan	The rate default.	[integer]	1
@Threshold	RatePlan	The rate threshold.	[integer]	1
@CorporateType	RatePlan	The corporate type.	`NotApplicable` `Corporate` `FixedCorporate` `TradeFair`	1
@BBARTrigger	RatePlan	The BBAR trigger.	`None` `OpenClose` `CTA` `FPLOS`	1
RatePlanGroups	TPA_Extensions	A collection of RatePlanGroup		1
RatePlanGroup	RatePlanGroups	A RatePlan		0..n
@RatePlanCode	RatePlanGroup	The ID of the rate plan group.	[integer]	1
@RatePlanTypeCode	RatePlanGroup	The code of the rate plan group.	[string]	1
@Sort	RatePlanGroup	The sort index	[integer]	1
Description	RatePlanGroup	Description of the rate plan group.		1
@Name	Description	Indicates the type of the description.	Name	1
Text	Description	Formatted text content.	[string]	1