@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.

@PrimaryLangID

0..1

The primary language preference for the message encoded as ISO 639-3.

@TimeStamp

Time of the transaction.

@Version

0..1

Version of the message

@CorrelationID

1

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

@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.

• true 
• false

• true 
• false

@Type

1

Indicates the type of booking channel per the Open Travel BCT codes. 

@FiscalDate

0..1

The FiscalDate transports the actual date of the PMS. 

@InvBlockStatusCode

1

A numeric value indicating the status of the allotment. Refer to the OTA Code List: Inventory Block Status (IBS).

"Definite" indicates an allotment that is deducting from available room inventory.
"Prospect" indicates an allotment that is not affecting available room inventory.

OnPrem only:

• InvBlockStatusCode is mandatory
• Cancelled blocks can be re-instated by sending TransactionAction "Modify" in combination with InvBlockStatusCode "5" and BookingStatus "Closed"

Possible combinations of InvBlockStatusCode & TransactionAction:

• "1" & "Cancel"
• "2" &  "Book"/"Commit" OR "Modify"
• "5" &  "Book"/"Commit" OR "Modify"

@InvBlockTypeCode

0..1

Describes the type of inventory the block is being created for. Refer to OTA Code List: Inventory Block Type (IBT).

@InvBlockCode

1

This is the internal ID of the block in protel.

• "0" = new block
• to modify an existing block the internal protel ID needs to be sent (it is delivered in the RS sent back for a new block)

@PMS_InvBlockID

0..1

This is the keyword of the block.

@InvBlockLongName

0..1

This is the full name of the inventory block.

@InvBlockName

0..1

This is the short name of the inventory block.

@TransactionAction

1

Enumerated list that describes the action associated to the message.
Used to set a new block, modify, cancel or other action as per enumerated list to be agreed between partners.

• "Commit" OR "Book"
  (to create a block)
• "Modify"
• "Cancel"

• "Commit" OR "Book"
  (to create a block)
• "Modify"
• "Cancel"

@BookingStatus

0..1

Closed = Rooms are not available for pick-up.
Open = Rooms are available for pick-up.

We only allow the following combinations:

• InvBlockStatusCode="5" BookingStatus="Closed"
• InvBlockStatusCode="2" BookingStatus="Open"
• InvBlockStatusCode="1" BookingStatus="Open" or "Closed"

@HotelCode

0..1

This is the code of the property whose inventory blocks are being updated.

@HotelName

0..1

Name for the hotel.

@ChainCode

0..1

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

@ChainName

0..1

The name of the hotel chain (e.g., Hilton, Marriott, Hyatt, Starwood).

@Start

1

This is the first day for which the inventory block is bookable.

@End

1

This represents the last date for which the inventory block is bookable.

@AbsoluteCutoff

0..1

Used to determine when the inventory block is released back into house inventory.
Defines the absolute deadline.

@OffsetDuration

0..1

Defines the amount of offset time before unused block inventory is returned to general inventory depending on the specific OffsetCalculationMode.

@OffsetCalculationMode

0..1

A string value to indicate the offset mode.
This value determines the point from which the OffsetDuration days becomes applicable.

• "BeforeBlockStartDate" whereby rooms will be released on the date calculated by subtracting the offset duration from the block start (arrival) date.
  This is also known as a "rolling" release date.
  
  

• "AfterBlockCreation" - The offset duration is applied from the block creation date
  (not supported).

@RoomTypeCode

1

Room type codes of each room type used as part of the block.
If no specific room type is allocated but only a global number of rooms protel sends the value "n/a" (not allocated).

• sending of RoomTypeCode="n/a" creates a block in the PMS with a number of rooms but no specific room type - this works only in combination with InvBlockStatusCode="5"

@RoomTypePickUpStatus

1

A numeric value referencing the type of inventory being counted. Refer to the OTA Code list: Inventory Count Type (INV).

As soon as the current booking date passes the block's @AbsoluteCutOffDate, allocation counts (@NumberOfUnits) for statuses "1," "2" and "3" are reduced to zero (0).
In the same situation, allocation counts for statuses "4" and "5" will remain unchanged.

If needed there is a configuration setting to keep the numbers of status "1" even after passing the CutOffDate.

Supported Values:

1

@Start

1

Used in conjunction with END to determine different number of rooms of a specific type for different dates.

@End

1

Used in conjunction with START to determine different number of rooms of a specific type for different dates.

@NumberOfUnits

1

Number of units of a specific room type that are allocated as part of the inventory block.

@SellLimit

0..1

This attribute is only required for @RoomTypePickUpStatusCode = 1 and indicates the initially allocated number of rooms even if the Cut Off date is reached (a configuration is needed for keep the numbers in the past).

@RatePlanCode

1

Rate plan used for reservations made against the inventory block. If no Rate plan is assigned to the block (as this is not mandatory in protel/pAir) – we will send a "n/a" with "0.00" values instead.

@CurrencyCode

1

This is the currency associated to the rate assigned to the block – it could be different than the local currency loaded for the property.

@Start

1

The starting value of the time span the rate code is valid for.

Format: yyyy-mm-dd

@End

1

The ending value of the time span the rate code is valid for.

Format: yyyy-mm-dd

"true"
"false" 

@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.

@AmountBeforeTax

0..1

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

@AmountAfterTax

0..1

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

@AgeQualifyingCode

0..1

A code representing a business rule that determines the charges for a guest based upon age range (e.g.; Adult, Child, Senior, Child With Adult, Child Without Adult).
This attribute allows for an increase in rate by occupant class. Refer to OpenTravel Code List Age Qualifying Code (AQC).

@CurrencyCode

1

This is the currency associated to the rate assigned to the block – it could be different than the currency loaded for the property.

@TaxInclusive

0..1

This indicates whether the instalment includes TAX. 

"true" or "false" 

true=includes TAX
false=exclusive TAX

@MarketCode

1

The name of the market segment the rooms are being sold to.
This is set up in the inventory block and is valid for all reservations of this block.

@MarketCodeName

0..1

The descriptive name of the code that relates to the market being sold to.
This is set up in the inventory block and is valid for all reservations of this block.

@CreateDateTime

0..1

Creation time stamp.

@LastModifyDateTime

0..1

Last modification time stamp.

Currently only possible value is "SourceOfBusiness"

@TextFormat

0..1

Indicates the format of text used in the description.

If the TextFormat is "HTML" the PWS will display line breaks with <br />

@ContactType

1

This is a string value representing the type of contact.

pAir/onPrem

• Customer
• Company
• Travel Agency
• Wholesaler
• Group

On Prem

• Customer
• Company
• Travel Agency
• Wholesaler
• Group

A reference placeholder used to link the various profiles to the block when importing them to PMS. Needs to be repeated in TPA_Extensions.

One RPH per contact in block.

@PhoneLocationType

0..1

A numeric value representing the type of the phone. Refer to the OTA code lists: Phone Location Type (PLT).

@PhoneTechType 

0..1

The PhoneTechType attribute indicates which type of number is transmitted.

@PhoneNumber

1

PhoneNumber contains the actual number as a string of max 32 characters.

@ShareMarketInd

0..1

Permission for sharing data for marketing purposes.

• "No"
• "Yes"

• "No"
• "Yes"

A boolean value used to indicate whether the phone number is the primary phone number for the profile.

• "true"
• "false"

• "true"
• "false"

@EmailType

0..1

A numeric value representing the type of email address. Refer to the OTA code lists: Email Address Type (EAT).
Info:
Only "Type= 1" supported yet.

• "No"
• "Yes"

@DefaultInd

0..1

DefaultInd is optional and would indicate whether the email is the primary email for the profile.

• "true"
• "false"

A remark associated with the email address.

onPrem:  only in "more communication methods"

@Type

0..1

The Type attribute indicates the type of address provided.

If more than one address element is sent, this attribute is required.

@DefaultInd

0..1

DefaultInd is Optional and would indicate whether the address is the primary address for the profile.

@FormattedInd

0..1

Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted.

• "No"
• "Yes"

Describes the use of the address (e.g. mailing, delivery, billing, etc.). Refer to the OTA Code List: Address Use Type (AUT).

Info:
Only UseType=6 supported yet.

@StateCode

0..1

This field would be used to pass the contact’s State expressed in the Standard 2-8 characters code.

Example: "TX"

(must be the same in the PMS)

@Code

0..1

A 2 character country code as defined in ISO 3166 alpha-2

Example: "AU"

(must be the same in the PMS)

@Type 

1

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

1 = "Cancel"
2 = "Lost"
3 = "Refused"

A reference placeholder used to link the various profiles to the block (repeated from Contacts section).

One RPH per contact in block.

Type of the transported profile.

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

• "1" = Customer
• "4" = Company
• "5" = Travel agent
• "7" = Source | Wholesaler
• "9" = Group

• "1" = Customer
• "4" = Company
• "5" = Travel agent
• "7" = Source | Wholesaler
• "9" = Group

• "protelIO" for a profile ID from the PMS (as soon as it is known)
• use your own ID_Context to transfer your own profile IDs

• "Conf"
• "Opt."
• "VO"
• "NS"
• "Non-Binding"
• "Waiting-List"

• "Conf"
• "Opt."
• "VO"
• "NS"
• "Non-Binding"
• "Waiting-List"

A reference placeholder used to link the internal block number to the allotment reservation status.

14 - Cancel

@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 availability status messages which specific message failed, the UniqueID of the message should be reported here. 

@ShortText

0..1

Describes the occurring error in short.Example: "A rate plan 'XY' was not found for the code provided."

@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 availability status messages which specific message failed, the UniqueID of the message should be reported here. 

@ShortText

0..1

Describes the occurring error in short.Example: "A rate plan 'XY' was not found for the code provided."

@InvBlockCode

1

Identifies the inventory block code assigned by the originator of the request message (PMS).

@InvSystemInvBlockCode

1

The InvBlockCode assigned by the inventory system in response to an inventory block notification.

@HotelCode

1

The code that uniquely identifies a single hotel property. The hotel code is decided between vendors.

A reference placeholder used to link the various profiles to the block (repeated from Contacts section).

One RPH per contact in block.

Used to identify the source of the identifier.

• "protelIO" for a profile ID from the PMS
• use your own ID_Context to transfer your own profile IDs