@EchoToken 

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

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

@Type

1

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

@FiscalDate

0..1

This attribute transfers the actual date of the PMS system.

yyyy-mm-dd

OnPrem: by default not displayed, but if needed, it can be enabled

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

The travel sector the company is associated with, such as air, car and hotel. Refer to OpenTravel Code List Travel Sector (TVS). 

• "io.protel.onpremise"
• "io.protel.air"

@ProfileType

1

Numeric reference to the type of profile such as guest, company, agent etc. Refer to the OTA Code Lists: Profile Type (PRT)

pAir: Customer, Company and Travel Agent (If Company or Travel Agent - data to be sent in the Company Info element)

@StatusCode

1

Numeric reference to the status of a profile. Refer to the OTA Code Lists: Profile Status (PST).

Supported:

• 1 = "marked for deletion"
• 2 = "anonymized profile"
• 3 = "deleted profile"
• 4 = "Active"

Not supported:

• 5 = "inactive"

@RPH

0..1

This is a unique reference used as an index for this profile in a reservation.

@ShareAllOptOutInd

0..1

When yes, a customer has explicitly opted out of marketing communication. This is used in combination with the ShareAllMarketInd and only one of these attributes should have a value of yes.

If @ShareAllOptOutInd="Yes" then all 4 contact options (Letter, telephone, email, text message) in the optin field for marketing will be set to NO. If @ShareAllOptOutInd="No", then the Attribute @ShareMarketInd on each of the primary communication types (Address, Telephone, Email) will be checked and the flag will be set accordingly.

• "Yes"
• "No"

If @ShareAllOptOutInd="Yes" then all 4 contact options (Letter, telephone, email, text message) in the optin field for marketing will be set to NO. If @ShareAllOptOutInd="No", then the Attribute @ShareMarketInd on each of the primary communication types (Address, Telephone, Email) will be checked and the flag will be set accordingly.

@CreateDateTime

0..1

Timestamp of the creation.

@CreatorID

0..1

Identifies the profile creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.

@VIP_Indicator

0..1

A boolean value used to flag a very important person.

• "true"

• "true"

@CustomerValue

0..1

onPrem: A numeric and string reference (coalesced) representing a supplier’s customer ranking. This attribute relates directly to the primary and secondary VIP code assigned to a profile in the hotel property management system (PMS).

pAir:  A string reference representing the VIP Code of the guest.

@BirthDate

0..1

The customer’s birthday information.
yyyy-mm-dd

@Language

0..1

The language code for which the name data is represented.

While this value is optional, it is HIGHLY RECOMMENDED that it be used.

@Gender

0..1

A string value representing a customer’s gender.
Note: The values are case-sensitive!

• Male
• Female
• Unknown

• Male
• Female
• Unknown

@PhoneTechType

1

A numeric value represents the type of technology associated with this telephone number. Refer to OTA Code List: Phone Technology Type (PTT).

@PhoneNumber

1

Contains the actual number as a string of max 32 characters and it is Mandatory.

@PhoneLocationType

0..1

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

@FormattedInd

0..1

As country code and area code is not passed they appear in the PhoneNumber field. The entire number is passed in the PhoneNumber field and FormattedInd is set to NO to indicate that the PhoneNumber field contains the entire phone number without a specific format.

• "true"
• "false"

@ShareMarketInd

0..1

Permission for sharing data for marketing purposes.

reference to @ShareAllOptOutInd (only possible in OnPrem) 

• "Yes"
• "No"

@Remark

0..1

A remark associated with the telephone number.

onPrem: Only imported if the email address is shown under "more communication methods" in the guest profile.

@DefaultInd

0..1

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

• "true"
• "false"

@EmailType

0..1

A numeric value representing the type of email address. Refer to the OTA code lists: Email Address Type (EAT)

@ShareMarketInd

0..1

Permission for sharing data for marketing purposes

reference to @ShareAllOptOutInd (only possible in OnPrem)

• "Yes"
• "No"

@DefaultInd

0..1

A boolean value used to indicate whether the email address is the primary email address for the profile.

onPrem: If more than one email address is imported and for one this attribute is set to "Yes", then this one will be added to the "Communication methods" - all further email addresses will be added to "more communication methods".  If all passed email addresses have this attribute set to "Yes", then they will be added in order of sending - the first one to Communication methods and the remaining to "More communication methods".

• "true"
• "false"

@Remark

0..1

A remark associated with the email address.

OnPrem: Only imported if the email address is shown under "more communication methods" in the guest profile.

• "true"
• "false"

@Type

1

A numeric reference to the type of address. Refer to the OTA code lists: Communication Location Type(CLT).

pAir:

• 1= "Home"
• 2= "Business"
• if sending "3" the type will be left empty

@FormattedInd

0..1

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

• "true"
• "false"

@DefaultInd

0..1

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

• "true"
• "false"

@ShareMarketInd

0..1

Permission for sharing data for marketing purposes.

• "Yes"
• "No"

@UseType

0..1

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

0..1

@Code

0..1

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

@Code

0..1

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

@DefaultInd

0..1

When true, indicates a default value should be used.

• "true"
• "false"

@DocIssueCountry

0..1

Country where the document was issued.

@ExpireDate

0..1

Indicates the ending date.
yyyy-mm-dd

@EffectiveDate

0..1

Indicates the starting date.
yyyy-mm-dd

@DocIssueLocation

0..1

Indicates the location where the document was issued.

@DocID

0..1

Unique number assigned by authorities to document.

@DocType

0..1

Indicates the type of document (e.g.; Passport, Driver’s License and national ID).

@ProgramID

0..1

The ProgramID attribute can be used to indicate the program that is being passed. For instance, we could use it to pass: Frequent Guest, Frequent Traveller and Company ID.

@MembershipID

0..1

The membershipID attribute will indicate the actual number.

@RPH

0..1

A reference placeholder for this loyalty membership.

@LoyalLevel

0..1

Indicates special privileges in program assigned to individual.

@EffectiveDate

1

Indicates the starting date of the program.

@ExpireDate

1

Indicates the expiration date of the program.

@SignupDate

0..1

Indicates the customer’s sign-up date.

@AllianceLoyaltyLevelName

0..1

Name of the program including level

@PrimaryLoyaltyIndicator

0..1

When true, indicates this is the primary customer loyalty program and when false, indicates this is not the primary customer loyalty program.

• "true"
• "false"

• "true"
• "false"

@ShareMarketInd

0..1

Permission for sharing data for marketing purposes. If the value=Inherit, specifies data sharing permissions for marketing purposes.

• "Yes"
• "No"

@ShareSynchInd

0..1

Permission for sharing data for synchronisation of information held by other travel service providers. If the value = "Inherit," specifies data sharing permissions for synchronisation of information held by other travel service providers.

• "Yes"
• "No"

@Remark

0..1

A remark associated with the customer’s loyalty program.

onPrem:  only in "more communication mehtods"

@VendorCode

0..1

Name of the program including level.

@Type

0..1

 Describes the type of sub account (e.g. miles, points, vouchers, stays).

@Balance

0..1

The current balance for this sub account.

@CompanyShortName

0..1

Identifies the company’s short name if it is mentioned in the guest’s profile

@Department

0..1

Identifies the department the guest is working for if it is mentioned in the guest’s profile

@CompanyShortName

0..1

Identifies the company’s short name.

@Department

0..1

The department name or ID with which the company contact is associated.

Indicates the type of relationship with the person or company in the profile

• Booker (Person who is responsable for the Reservation)
• InvoiceRecipient (Person who is responsable for the Invoice)

@PhoneTechType

1

A numeric value represents the type of technology associated with this telephone number. Refer to OTA Code List: Phone Technology Type (PTT).

@PhoneNumber

1

Contains the actual number as a string of max 32 characters and it is Mandatory.

@PhoneLocationType

0..1

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

@FormattedInd

0..1

As country code and area code is not passed they appear in the PhoneNumber field. The entire number is passed in the PhoneNumber field and FormattedInd is set to NO to indicate that the PhoneNumber field contains the entire phone number without a specific format.

• "true"
• "false"

@ShareMarketInd

0..1

Permission for sharing data for marketing purposes.

reference to @ShareAllOptOutInd (only possible in OnPrem) 

• "Yes"
• "No"

@Remark

0..1

A remark associated with the telephone number.

onPrem: Only imported if the email address is shown under "more communication methods" in the guest profile.

@DefaultInd

0..1

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

• "true"
• "false"

@EmailType

0..1

A numeric value representing the type of email address. Refer to the OTA code lists: Email Address Type (EAT)

@ShareMarketInd

0..1

Permission for sharing data for marketing purposes

reference to @ShareAllOptOutInd (only possible in OnPrem)

• "Yes"
• "No"

@DefaultInd

0..1

A boolean value is used to indicate whether the email address is the primary for the profile.

• "true"
• "false"

@Remark

0..1

A remark associated with the email address.

OnPrem: Only imported if the email address is shown under "more communication methods" in the guest profile.

• "true"
• "false"

@Type

1

A numeric reference to the type of address. Refer to the OTA code lists: Communication Location Type(CLT).

pAir:

• 1= "Home"
• 2= "Business"
• if sending "3" the type will be left empty

@FormattedInd

0..1

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

• "true"
• "false"

@DefaultInd

0..1

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

• "true"
• "false

pAir: Recognises 1="Home" or 2="Business"

onPrem: a maximum of two addresses are imported

@ShareMarketInd

0..1

Permission for sharing data for marketing purposes.

• "Yes"
• "No"

@UseType

0..1

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

@Code

0..1

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

pAir: All comments added to field Preferences in the Preferences Tab