@EchoToken 

0..1 

A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.

@CorrelationID

1

Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.

@TimeStamp 

1

Timestamp of the transaction. 

@Version 

0..1

Version of the message

@PrimaryLangID

0..1

Default language of the property.

@MessageContentCode 

0..1

This is the type of rate plan which is updated. Refer to OpenTravel Code List TDB.

Only supported:

8 = Rate

Only supported:

8 = Rate

@Type 

1

A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)

@ID 

1

The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages.

@ID_Context

1

Used to identify where the ID comes from.

@HotelCode 

0..1

This is the Hotel Cloud ID whose rates are being updated. 

@ChainCode

0..1

Could be set up by the user – not mandatory in the protel system.

Only supported by protel MPE.

@RatePlanCode 

1

This is the name of the rate code which is being updated.

@RatePlanID

0..1

This is the internal system reference number of the rate code.

@RatePlanCategory 

0..1 

This is the type of the rate group the updated rate code belongs to. Only one RatePlanCategory is acceptable per RatePlan code; therefore, the RatePlanCategory must be the same for all seasons passed. 

• pAir field: instead of RateGroups.TypeID -> RateGroups.Shortname
• pAir logic: instead of Type of Rate group -> Rate Group short
• SPE Logic: instead of Type of Rate group -> Rate Group short

@RatePlanType 

0..1

This is used to identify the type of the RatePlan. Refer to OpenTravel Code List Rate Plan Type (RPT)

@RatePlanNotifType 

0..1

This enumeration indicates whether the upload/download is meant to overwrite existing data or to add it. 

• New
• Overlay
• Delta

@Start

1

In general, the Start and End attributes used at the RatePlan level should be used as follows: the Start attribute should be equal to the earliest Start attribute at the Rate level, and the End attribute should be equal to the latest End attribute at the Rate level. In other words, the Start and End attributes at the RatePlan level should specify the entire span of dates representing the Rate elements found in the Rates collection. This value is to be globally applied to any child element where the date spans are absent. 

@AdjustedAmount 

0..1 

The amount which should be added to the base rate plan to determine the price of this derived rate plan. Specifies an amount, max 3 decimals. 

@AdjustedPercentage 

0..1 

The percentage off the base rate plan amount used to determine the price of this derived rate plan. Used for percentage values. 

@AdjustUpIndicator 

0..1 

When true, the adjusted amount or adjusted percentage is added to the amount specified for the base rate plan to determine the derived rate amount. When false, the adjusted amount or adjusted percentage is subtracted from the amount specified for the base rate plan to determine the derived rate amount. 

@YieldableIndicator 

0..1 

Used to indicate the rate plan is subject to yield management logic. When true, the rate plan is yieldable. When false, the rate plan is not yieldable. 

• "true"
• "false"

@RestrictedDisplayIndicator 

0..1 

This attribute is a boolean to indicate if the rate is to be considered “Confidential” / marked as a special rate only bookable for specific companies/travel agents.

Only one Confidential attribute is acceptable for each RatePlan code; therefore, the attribute must be the same for all seasons passed. 

• "true"
• "false"

• "true"
• "false"

@Name 

0..1 

This element is repeated twice: one instance for the short description and another for the long description of the rate that is being sent. Its value must be "Short Description" and "Long Description" respectively. 

We are using the attribute to display if the rate is "active" or "deactivated"
There is a possiblity to disable this attribute in our OTA_RatePlanNotifRQ  outbound message.

• Active
• Deactivated

• Active
• Deactivated

@Start

1 

This set of Start and End attributes represents the start and end of validity of the specific rate. 

@End 

1

This set of Start and End attributes represents the start and end of validity of the specific rate. 

@MinGuestApplicable

0..1

Minimum number of occupants for which this rate is valid.

@MaxGuestApplicable

0..1

Maximum number of occupants for which this rate is valid.

@CurrencyCode 

1 

This is the currency associated to the rate that is being sent – it could be different from the currency loaded for the property. 

@Mon
@Tue
@Weds
@Thur
@Fri
@Sat
@Sun 

0..1

These DOW indicators are used to specify to which days the rate value is valid.

• "true"
• "false"

Not supported for now - please send one Rate element per day.

@InvTypeCode 

0..1

This is the room type for which the rates are transferred. For each room type a new instance of the Rate element is passed. If the room type is transmitted with rate values attached it will be considered opened at the price indicated. If the room type is passed with a 0 value it will be considered closed for that rate plan (i.e., not applicable for the rate plan). If in a modification message a room type that was previously loaded is not sent, then it remains unchanged. 

@AgeQualifyingCode 

0..1 

Defines an age range or age category of a guest (e.g., under 21, over 65, teen, infant). Refer to OpenTravel Code List Age Qualifying Code (AQC)

Only supported:

"10" = Adult

@NumberOfGuests 

0..1

The NumberOfGuest attribute indicates what type of rate is being passed – if NumberOfGuests is = 1 then we are transmitting a single rate, if higher than 1 then it is a double or full occupancy rate. 

@AmountAfterTax 

0..1

The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). 

Defines an age range or age category of a guest (e.g., under 21, over 65, teen, infant). Refer to OpenTravel Code List Age Qualifying Code (AQC)

@AgeQualifyingCode = 7 => Infant
@AgeQualifyingCode = 8 => Child
@AgeQualifyingCode = 9 => Teenager
@AgeQualifyingCode = 10 => Adult

Only supported:

"10" = Adult

@Amount

• "true"
• "false"

• PlainText
• HTML

@ID

1

The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages.

@ID_Context

1

Used to identify where the ID comes from.

@Type

1

A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)

18 = Packages

@EchoToken 

0..1 

A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.

@CorrelationID

1

Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.

@TimeStamp 

1

Timestamp of the transaction. 

@Version 

0..1

Version of the message

@PrimaryLangID

0..1

Default language of the property.

@Type 

1

Mandatory. Refer to the OTA Code List: Error Warning Type (EWT).

@Code 

0..1 

Refers to the OTA Code List: Error Codes (ERR). 

@RecordID 

0..1 

If the receiving system is able to identify within a batch of rateplan messages which specific message failed, the UniqueID of the message should be reported here. 

@ShortText

0..1

Describes the occurring error in short.

@Type 

1

Mandatory. Refer to the OTA Code List: Error Warning Type (EWT).

@Code 

0..1 

Refers to the OTA Code List: Error Codes (ERR). 

@RecordID 

0..1 

If the receiving system is able to identify within a batch of rate plan messages which specific message failed, the UniqueID of the message should be reported here. 

@ShortText

0..1

Describes the occurring error in short.