Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.


Element | AttributeTypeNumDescription +  ContentComments outboundpAirOnPrem

ProfileInfo | UniqueID

0..9

Used to allow additional IDs for matching purposes.

Profile


1

Root element for profile content


(Haken)(Haken)

@ProfileType

@Type

OTA_CodeType
UIT
PRT

1

A

Numeric reference to the type of

object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)Unique ID Type (UIT)(Haken)(Haken)

@ID

string

1

The unique profile ID from the PMS.

(Haken)(Haken)

@ID_Context

string

1

Used to identify the source of the ID. For inbound (to protelIO) requests, this will carry a string value identifying the protel I/O Integration Partner.

“protelIO"(Haken)(Haken)

ProfileInfo | Profile

1

Root element for profile content

(Haken)(Haken)

@ProfileType

OTA_CodeType PRT

1

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

Profile Type (PRT)(Haken)(Haken)

@StatusCode

OTA_CodeType PST

1

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

Profile Status (PST)

(Haken)(Haken)

@RPH

0..1

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

(Haken)(Haken)

@ShareAllOptOutInd

0..1

When yes, a customer has explicitly opted out of marketing communication. This is used in

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


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117818430" target="_blank">Profile Type (PRT)</a>


(Haken)(Haken)

@StatusCode

OTA_CodeType PST

1

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


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117818434" target="_blank">Profile Status (PST)</a>


Please note: 

The PMS's send different StatusCodes because the handling is different: 
pAir sends StatusCode="1" for a marked profile to be deleted. 
onPrem sends StatusCode="3" for a deleted profile.
(Warnung) Please also note that if the profile is permanently deleted from the PMS, no update will be sent for this profile.

(Haken)(Haken)

@RPH

RPH_Type

0..1

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


(Haken)(Haken)

@ShareAllOptOutInd

YesNoType

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"
(Haken)(Haken)

@CreateDateTime

dateTime
0..

1

Timestamp of the creation.


(Haken)(Haken)

@CreatorID

string
StringLength1to32
0..

1

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


(Haken)(Haken)
@LastModifyDateTimedateTime0..1Timestamp of last modification.
(Haken)(Haken)
@LastModifierID
string
StringLength1to320..1Identifies the last software system or person to modify a record.
(Haken)(Haken)
ProfileInfo |

Profile | Customer


0..1

Contains basic data on the customer’s identity, location, relationships, finances, memberships, etc.


(Haken)(Haken)

@VIP_Indicator

boolean

0..1

A boolean value is used to flag a very important person.

  • "true"
  • "true"
(Haken)(Haken)

@CustomerValue

string
StringLength1to64

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.


(Haken)(Haken)

@BirthDate

date

0..1

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

yyyy-mm-dd(Haken)(Haken)

@Language

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.


(Haken)(Haken)

@Gender

NMTOKEN

0..1

A string value

representing

represents a customer’s gender.
Note: The values are case-sensitive!

  • Male
  • Female
  • Unknown
  • Male
Femal
  • Female
  • Unknown
(Haken)(Haken)
ProfileInfo |

Profile | Customer | PersonName


0..5

Detailed name information for the customer.


(Haken)(Haken)
ProfileInfo |

Profile | Customer | PersonName

| Surname

| Surname

string
StringLength1to64

1

Mandatory if a guest profile is passed. This path is used to transmit the Customer details. Details of the company or Travel agency use a different path. This field is used to pass the guest’s surname.


(Haken)(Haken)
ProfileInfo

Profile |

Profile  | Customer

Customer | PersonName | NamePrefix

string
StringLength1to16

0..

1

3

This field would be used to pass the guest’s NamePrefix (e.g. salutation).


(Haken)(Haken)
ProfileInfo |
Profile | Customer | PersonName | NameTitleStringLength1to16

0..1

This field would be used to pass the guest's title (e.g. Prince). 
(Fehler)(Haken)

Profile | Customer | PersonName | GivenName

string
StringLength1to64

0..

1

5

This field would be used to pass the guest’s GivenName.


(Haken)(Haken)
ProfileInfo |

Profile | Customer | PersonName | MiddleName

string
StringLength1to64

0..3

The second given name of the person name.


(Haken)(Haken)
ProfileInfo |

Profile | Customer |

Telephone

PersonName | NameSuffix

StringLength1to64

0..1

Information on a telephone number for the customer.

(Haken)(Haken)

The second last name of the person name (Spanish properties only)


(Haken)(Fehler)

Profile | Customer | Telephone


0..99

Information on a telephone number for the customer.


(Haken)(Haken)

@PhoneTechType

OTA_CodeType PTT

1

A numeric value

representing

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


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117817961" target="_blank">Phone Technology Type 
Phone Technology Type
(PTT)</a>


(Haken)(Haken)

@PhoneNumber

StringLength1to32

1

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


(Haken)(Haken)

@PhoneLocationType

OTA_CodeType PLT

0..1

A numeric value

representing

represents the type of

the

phone. Refer to the OTA code lists: Phone Location Type (PLT)

Phone Location Type


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117817958" target="_blank">Phone Location Type (PLT)</a>


(Haken)(Haken)

@FormattedInd

boolean

0..1

As country code and area code

are

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"
(Haken)(Haken)

@ShareMarketInd

YesNoType

0..1

Permission for sharing data for marketing purposes.

reference to @ShareAllOptOutInd (only possible in OnPrem) 

  • "
true
  • Yes"
  • "
false
  • No"
(Fehler)(Haken)

@Remark

string
StringLength1to128

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.


(Fehler)(Haken)

@DefaultInd

boolean

0..1

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

phone number

for the profile.

  • "true"
  • "false"
(Haken)(Haken)

Profile | Customer | Email


0..

5

99

This path is used to transmit the Customer details. Details of the company or Travel agency use a different path. This field would be used to pass the guest’s email address.


(Haken)(Haken)

@EmailType

OTA_CodeType EAT

0..1

A numeric value

representing

represents the type of email address. Refer to the OTA code lists: Email Address Type (EAT)

Email Address Type (EAT)(Haken)(Haken)


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117817963" target="_blank">Email Address Type (EAT)</a>


(Haken)(Haken)

@ShareMarketInd

YesNoType

0..

@ShareMarketInd

0..

1

Permission for sharing data for marketing purposes

reference to @ShareAllOptOutInd (only possible in OnPrem)

  • "Yes"
  • "No"
(Fehler)(Haken)

@DefaultInd

boolean

0..1

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

  • "true"
  • "false"
(Haken)(Haken)

@Remark


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"
(Haken)(Haken)

@Remark

StringLength1to128
string

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.


(Fehler)(Haken)
Profile | Customer | URL
0..5 Information on a URL for the customer.
(Haken)(Haken)
@ShareMarketIndYesNoType0..1

Permission for sharing data for marketing purposes 

reference

referred to @ShareAllOptOutInd

  • "Yes"
  • "No"
(Fehler)(Haken)
@DefaultIndboolean0..1A boolean value is used to indicate whether the URL is the primary URL for the profile.


  • "true"
  • "false"
(Haken)(Haken)

Profile | Customer | Address


0..

5

99

This path is used to transmit the Customer details. Details of the company or Travel agency use a different path. This field would be used to pass the guest’s mail address.


(Haken)(Haken)

@Type

OTA_CodeType CLT

1

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

Communication Location Type (CLT)


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117817965" target="_blank">Communication Location Type (CLT)</a>


(Haken)
(Haken)
(Haken)

@FormattedInd

boolean

0..1

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

  • "true"
  • "false"
(Haken)(Haken)

@DefaultInd

boolean

0..1

When true, indicates a default value should be used

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

  • "true"
  • "false"
(Haken)(Haken)

@ShareMarketInd

YesNoType

0..1

Permission for sharing data for marketing purposes.

  • "Yes"
  • "No"
(Fehler)(Haken)

@UseType

OTA_CodeType AUT

0..1

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

Address Use Type (AUT)(Haken)


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117817967" target="_blank">Address Use Type (AUT)</a>


(Haken)(Haken)
(Haken)

Profile | Customer | Address | AddressLine

string
StringLength1to255

0..5

This path is used to transmit the Customer details. Details of the company or Travel agency use a different path. This field would be used to pass the guest’s address. More than one line can be sent.


(Haken)(Haken)

Profile | Customer | Address | CityName

string
StringLength1to64

0..1

This path is used to transmit the Customer details. Details of the company or Travel agency use a different path. This field would be used to pass the guest’s city.City (e.g., Dublin), town or postal station (i.e., a postal service territory, often used in a military address).


(Haken)(Haken)

Profile | Customer | Address | StateProv


0..1

This path is used to transmit the Customer details. Details of the company or Travel agency use a different path. This field would be used to pass the guest’sState or Province name (e.g., Texas).


(Haken)(Haken)
@StateCode

0..1

(Haken)(Haken)Profile | Customer | Address | Countrystring
StateProvCodeType

0..1



(Haken)(Haken)

Profile | Customer | Address | PostalCode

string
StringLength1to16

0..1

This path is used to transmit the Customer details. Details of the company or Travel agency use a different path. This field would be used to pass the guest’s Postal / ZIP code.


(Haken)(Haken)

Profile | Customer | Address | CountryName


0..1

This path is used to transmit the Customer details. Details of the company or Travel agency use a different path. This field would be used to pass the guest’sCountry name (e.g., Ireland).


(Haken)(Haken)

@Code

ISO3166

0..1

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


(Haken)(Haken)

Profile | Customer | CitizenCountryName


0..

1

3

Name of the (self-professed) country that is claimed for citizenship.


(Haken)(Haken)

@Code

ISO3166

0..1

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


(Haken)(Haken)

@DefaultInd

boolean

0..1

When true, indicates a default value should be used.

  • "true"
  • "false"
(Haken)(Haken)
Profile
|
/ Customer
| Document
/ RelatedTraveler
0..
9Detailed document information for
99Identifies a traveler associated with the customer
(e.g.; driver license, passport, visa).
.(Warnung) Section is supported only on message OTA_HotelResNotifRQ (Warnung)(Fehler)(Haken)
(Haken)
@BirthDate
@DocIssueCountry
date0..1
Country where the document was issued.
Related Traveler date of birth
(Fehler)(Haken)
(Fehler)

@ExpireDate

Profile / Customer / RelatedTraveler / UniqueID
0..1
Indicates the ending date.
yyyy-mm-dd
Identifies the profile of the related traveler
(Fehler)(Haken)
(Haken)
@Type

@EffectiveDate

0..1

Indicates the starting date.
yyyy-mm-dd

(Haken)(Haken)

@BirthDate

0..1

Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.
yyyy-mm-dd

(Fehler)(Haken)

1A reference to the type of object defined by the UniqueID elementUnique ID Type (UIT)(Fehler)(Haken)
@ID
1A unique identifying value assigned by the creating system. Used as primary-key database reference.
(Fehler)(Haken)
Profile / Customer / RelatedTraveler / PersonName
@DocIssueLocation

0..1
Indicates the location where the document was issued
Person associated with the traveler.
(Fehler)(Haken)
(Haken)
Profile / Customer / RelatedTraveler / PersonName / NamePrefixStringLength1to16
@DocID
0..
1

Unique number assigned by authorities to document.

(Haken)(Haken)
3Salutation of honorificMr., Mrs., Ms,...(Fehler)(Haken)
Profile / Customer / RelatedTraveler / PersonName / GivenNameStringLength1to16
@DocType
0..
1

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

  • 1 = Visa
  • 2 = Passport
  • 3 = Military identification
  • 4 = Drivers license
  • 5 = National identity document
  • 6 = Vaccination certificate
(Haken)(Haken)
5Given name, first name or names
(Fehler)(Haken)
Profile / Customer / RelatedTraveler / PersonName / SurnameStringLength1to641Family name, last name
(Fehler)(Haken)
Profile / Customer / RelatedTraveler / PersonName / Document
0..1Document information for verification purposes
(Fehler)(Haken)
@DocIDStringLength1to320..1Unique number assigned by authorities to document
(Fehler)(Haken)
@DocType

Profile | Customer | CustLoyalty

0..5

Optional. This path enables the user to pass specific IDs linked to the guest profile.

(Haken)(Haken)@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.

(Haken)(Haken)
Indicates the type of documentDocument Type (DOC)(Fehler)(Haken)
Profile / Customer / RelatedTraveler / TPA_Extensions / GuestStayExtensions / StayInfo
@MembershipID

0..1
The membershipID attribute will indicate the actual number.


(Fehler)(Haken)
(Haken)
@Arrival
@RPH
dateTime0..1
A reference placeholder for this loyalty membership.
Arrival DateTime of the RelatedTraveler
(Fehler)(Haken)
(Haken)
@Departure
@LoyalLevel
dateTime0..1
Indicates special privileges in program assigned to individual.
Depature DateTime of the RelatedTraveler
(Fehler)(Haken)
@EffectiveDate
@RelationToPrimarystring0..1Indicates the
starting date of the program.
yyyy-mm-dd
relationship to the main guest of a reservation. 
(Fehler)(Haken)
@PrimaryInd
@ExpireDate
boolean0..1
Indicates the expiration date of the program.
yyyy-mm-dd
This indicates the primary guest on a reservation. In case of multiple guests on a reservation, the guest responsible for payment, etc. will be marked true.
  • "true"
  • "false"
(Fehler)(Haken)
@SignupDate

Profile | Customer | Document


0..

1

Indicates the customer’s sign-up date.
yyyy-mm-dd

(Fehler)(Haken)

99

Detailed document information for the customer (e.g.; driver's license, passport, visa).


(Haken)(Haken)

@DocIssueCountry

ISO3166
@AllianceLoyaltyLevelName

0..1

Name of the program including level

Country where the document was issued.


(Haken)(Haken)
@PrimaryLoyaltyIndicator

@ExpireDate

date

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"
(Fehler)(Haken)

Indicates the ending date.

yyyy-mm-dd(Haken)(Haken)

@EffectiveDate

date
@ShareMarketInd

0..1

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

  • "Yes"
  • "No"
(Fehler)(Haken)

Indicates the starting date.

yyyy-mm-dd(Haken)(Haken)

@DocIssueLocation

StringLength1to64
@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"
(Fehler)(Haken)

Indicates the location where the document was issued.


(Haken)(Haken)

@DocID

StringLength1to32
@Remark

0..1

A remark associated with the customer’s loyalty program.

onPrem:  only in "more communication mehtods"

Unique number assigned by authorities to document.


(Haken)(Haken)

@VendorCode

0..1

Name of the program including level.

(Haken)(Fehler) Profile | Customer | CustLoyalty | SubAccountBalance

@DocType

OTA_CodeType DOC

0..1

Used to specify a sub-account and its point balance associated with this loyalty account.

(Fehler)(Haken)

@Type

0..1

 Describes

Indicates the type of

sub account

document (e.g.

miles, points, vouchers, stays

; Passport, Driver’s License and national ID).

(Fehler)(Haken)


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820374" target="_blank">Document Type (DOC)</a>


(Haken)

@Balance

0..1

The current balance for this sub account.

(Fehler)
(Haken)

Profile | Customer |

EmployerInfo

CustLoyalty


0..

1

25

Optional. This path

contains information about the employer from the guest’s profile. It is used to pass the full name of the company if it is mentioned in the guest’s profile.

enables the user to pass specific IDs linked to the guest profile.


(Haken)(Haken)

@ProgramID

StringLength1to16
(Fehler)(Haken)@CompanyShortName

0..1

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

(Fehler)(Haken)

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.


(Haken)(Haken)

@MembershipID

StringLength1to32
@Department

0..1

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

(Fehler)(Haken)

The membershipID attribute will indicate the actual number.


(Haken)(Haken)

@RPH

RPH_Type
Profile | CompanyInfo

0..1

Detailed name information for the company

A reference placeholder for this loyalty membership.


(Haken)(Haken)
Profile | CompanyInfo | CompanyName

@LoyalLevel

StringLength1to16

0..1

Complete name information for the company.

(Haken)(Haken)

@CompanyShortName

0..1

Identifies the company’s short name.

(Fehler)(Haken)

@Department

0..1

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

(Haken)(Haken)

Indicates special privileges in the program assigned to individuals.


(Fehler)(Haken)

@EffectiveDate

date

1

Indicates the starting date of the program.

yyyy-mm-dd(Fehler)(Haken)

@ExpireDate

date

1

Indicates the expiration date of the program.

yyyy-mm-dd(Fehler)(Haken)

@SignupDate

date
Profile | CompanyInfo | ContactPerson

0..1

Information on a contact person for the customer.

(Haken)(Haken)

Indicates the customer’s sign-up date.

yyyy-mm-dd(Fehler)(Haken)

@AllianceLoyaltyLevelName

StringLength1to128
@Relation

0..1

Indicates the type

Name of

relationship with the person or company in the profile

the program including level


(Haken)(Haken)

@PrimaryLoyaltyIndicator

boolean
  • Booker (Person who is responsable for the Reservation)
  • InvoiceRecipient (Person who is responsable for the Invoice)
(Fehler)(Haken) Profile | CompanyInfo | ContactPerson | PersonName

0..

5

Detailed name information for the customer.

(Haken)(Haken)

Profile | CompanyInfo | ContactPerson | PersonName | NamePrefix

0..3

The Salutation for the name. This SHOULD be a value representing an individual (Mr., Mrs., Dr.) and not Mr. and Mrs.

(Haken)(Haken)

Profile | CompanyInfo | ContactPerson | PersonName | GivenName

0..5

Given name, first name or names.

(Haken)(Haken)

Profile | CompanyInfo | ContactPerson | PersonName | Surname

0..1

Family name

(Haken)(Haken) Profile | CompanyInfo | AddressInfo0..5Detailed information on an address for the company.(Haken)(Haken)@DefaultInd0..1When true, indicates a default value should be used.
  • "true"
  • "false
(Haken)(Haken)@FormattedInd0..1Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted.
  • "true"
  • "false
(Haken)(Haken)@Type1

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

  • 1 = "Home"
  • 2 = "Business"
  • 3 = "Other"
(Haken)(Haken)@UseType0..1

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

  • 3 = "Billing"
  • 5 = "Other"
  • 6 = "Contact"
  • 7 = "Physical
(Haken)(Haken)@ShareMarketInd0..1Permission for sharing data for marketing purposes.
  • "Yes"
  • "No"
(Fehler)(Haken)

Profile | CompanyInfo | AddressInfo | AddressLine

0..5

This path is used to transmit the details for a Company or Travel agency profile. IT is mandatory if a company or travel agency profile is passed. Address line is repeatable up to 5 times. The Type attribute is not needed here as a business address is implied.

(Haken)(Haken)

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"
(Fehler)(Haken)

@ShareMarketInd

YesNoType

0..1

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

  • "Yes"
  • "No"
(Fehler)(Haken)

@ShareSynchInd

NMTOKEN

0..1

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

  • "Yes"
  • "No"
(Fehler)(Haken)

@Remark

StringLength1to128

0..1

A remark associated with the customer’s loyalty program.

onPrem:  only in "more communication methods"


(Haken)(Haken)

@VendorCode

StringLength1to8

0..1

Name of the program including level.


(Haken)(Fehler)

Profile | Customer | CustLoyalty | SubAccountBalance


0..99

Used to specify a sub-account and its point balance associated with this loyalty account.


(Fehler)(Haken)

@Type

StringLength1to16

0..1

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


(Fehler)(Haken)

@Balance

integer

0..1

The current balance for this sub-account.


(Fehler)(Haken)

Profile | Customer | EmployerInfo


0..1

This path contains information about the employer from the guest’s profile. It is used to pass the full name of the company if it is mentioned in the guest’s profile.


(Fehler)(Haken)

@CompanyShortName

StringLength1to32

0..1

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


(Fehler)(Haken)

@Department

StringLength1to32

0..1

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


(Fehler)(Haken)

Profile | Customer | TPA_Extensions


0..n

Could be used to pass additional Profile data upon agreement between partners (specific Keys or codes, for instance).


(Fehler)(Haken)
Profile | Customer | TPA_Extensions | px:UserDefinedFieldExtensions | UserDefinedField

Profile | CompanyInfo | AddressInfo | CityName

0..1

This element is used to pass the Company or Travel Agency’s City.

(Haken)(Haken)

Profile | CompanyInfo | AddressInfo | StateProv

0..1

This element is used to pass the Company or Travel Agency’s State.

(Haken)(Haken)@StateCode

0..1

(Haken)(Haken)
Profile | CompanyInfo | AddressInfo | Country
@NameStringLength1to320..1UDF name value
(Haken)(Haken)
Profile | CompanyInfo | AddressInfo | PostalCode
@TypeStringLength1to320..1

This element is used to pass the Company or Travel Agency’s postal or ZIP code.

(Haken)(Haken)
UDF type 
(Haken)(Haken)

Profile | Customer | TPA_Extensions | px:ProfileInfoExtensions

_ProfileInfoExtensions
Profile | CompanyInfo | AddressInfo | CountryName

0..1

This element is used to pass the Company or Travel Agency’s Country.

(Haken)(Haken)

@Code

0..1

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

A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA).


HTML
<a href="https://confluence.protel.net/display/PIODOC/_ProfileInfoExtensions" target="_blank">_ProfileInfoExtensions</a>


(Haken)(Haken)

Profile | CompanyInfo

| TelephoneInfo


0..

nThis element is used to pass the Company or Travel Agency’s phone and numbers

1

Detailed name information for the company.


(Haken)(Haken)
@PhoneTechType

Profile | CompanyInfo | CompanyName


0..1

The PhoneTechType attribute indicates which type of number is transmitted.

  • 1 = "Phone"
  • 3 = "Fax"
  • 5 = "Mobile"
(Haken)(Haken)

@PhoneNumber

1

PhoneNumber contains the actual number as a string of max 32 characters and it is Mandatory

Complete name information for the company.


(Haken)(Haken)

@CompanyShortName

StringLength1to32

0..1

Identifies the company’s short name.


(Fehler)(Haken)

@Department

StringLength1to32

0..1

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


(Haken)(Haken)
@FormattedInd

Profile | CompanyInfo | ContactPerson


0..1

As country code and area code are 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"
(Haken)(Haken)

Information on a contact person for the customer.


(Haken)(Haken)
@RelationStringLength1to32
@DefaultInd
0..1

DefaultInd would indicate whether the phone number is the primary phone number for the profile.

  • "true"
  • "false"
(Haken)(Haken)@PhoneLocationType0..1

Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OTA Code List: Phone Location Type (PLT).

  • 6 = "Home"
  • 7 = "Office"
  • 10 = "Mobile"
(Haken)(Haken)@ShareMarketInd0..1A boolean value used to indicate whether the phone number is the primary phone number for the profile.
  • "Yes"
  • "No"
(Fehler)(Haken)@Remark0..1

A remark associated with the telephone number.

onPrem:  only in "more communication mehtods"

(Fehler)(Haken)

Profile | CompanyInfo | Email

0..1

This path is used to transmit the details for a Company or Travel agency profile. This element is used to pass the Company or Travel Agency’s email. The EmailType attribute is not needed here as it is clearly a business address.

(Haken)(Haken)

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

  • Booker (Person who is responsible for the Reservation)
  • InvoiceRecipient (Person who is responsible for the Invoice)
(Fehler)(Haken)

Profile | CompanyInfo | ContactPerson | PersonName


0..5

Detailed name information for the customer.


(Haken)(Haken)

Profile | CompanyInfo | ContactPerson | PersonName | NamePrefix

StringLength1to16

0..3

The Salutation for the name. This SHOULD be a value representing an individual (Mr., Mrs., Dr.) and not Mr. and Mrs.


(Haken)(Haken)

Profile | CompanyInfo | ContactPerson | PersonName | GivenName

StringLength1to64

0..5

Given name, first name, or names.


(Haken)(Haken)

Profile | CompanyInfo | ContactPerson | PersonName | Surname

StringLength1to64

0..1

Family name


(Haken)(Haken)
Profile | CompanyInfo | AddressInfo
0..5Detailed information on an address for the company.
(Haken)(Haken)

@Type

OTA_CodeType CLT

1

A numeric reference to the type of

@EmailType

0..1

A numeric value representing the type of email

address. Refer to the OTA code lists:

 Email Address

 Communication Location Type(

EAT

CLT).

  • 1 = "Personal"
  • 2 = "Business"
  • 7 = "Reservation Office"
(Haken)(Haken)@ShareMarketInd0..1Permission for sharing data for marketing purposes
  • "Yes"
  • "No"
(Fehler)(Haken)

@DefaultInd

0..1

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

(Haken)(Fehler)@Remark0..1

A remark associated with the email address.

onPrem:  only in "more communication mehtods"

(Fehler)(Haken) Profile | CompanyInfo | URL0..5Information on a URL for the Company or Travel Agency’s.(Haken)(Haken)@ShareMarketInd0..1Permission for sharing data for marketing purposes
  • "Yes"
  • "No"
(Fehler)(Fehler)

@DefaultInd

0..1

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

(Haken)(Haken)ContactPersonProfile | ContactPerson0..1Profile | ContactPerson | PersonName0..1Profile | ContactPerson | PersonName | NamePrefix0..1Profile | ContactPerson | PersonName | GivenName0..1Profile | ContactPerson | PersonName | SurName0..1Profile | ContactPerson | PersonName | NameTitle0..1 Profile | Comments0..1Comments related to the profile.(Haken)(Haken) Profile | Comments | Comment1..nComment details.(Haken)(Haken)@Name0..1The value “Customer_Comment” is used for Comments saved in the customer’s profile. The value “Restaurant_Comment” is used for Comments saved in the customer’s profile relevant to the restaurant (On Premise Only)(Haken)(Haken) Profile | Comments | Comment | Text0..1Formatted text content. Provides text and indicates whether it is formatted or not.(Haken)(Haken)@TextFormat0..1"PlainText"(Haken)(Haken)

Profile | TPA_Extensions | px:ProfileInfoExtensions

0..1

A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA).(Haken)(Haken)

Profile | TPA_Extensions | px:ProfileInfoExtensions | px:ContactDetails

0..1

 Contact Information
Additional Email Address, Telephone Number, etc.
(Haken)(Fehler)

Profile | TPA_Extensions | px:ProfileInfoExtensions | px:ContactDetails | AdditionalInfo | px:Entry

0..n

 Contact Information(Haken)(Fehler)

@DefaultInd

0..1

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

  • true
  • false
(Haken)(Fehler)@ID0..1Internal Reference(Haken)(Fehler)@ID_Context0..1

Used to identify the source of the identifier. For both outbound (from protelIO) and inbound (to protelIO) request messages, this must carry the string value
"protelIO"

(Haken)(Fehler)@DisplaySequence0..1Display sequence(Haken)(Fehler)@Type0..1The type of the additional Contact Information
  • CONTACTTYPE
(Haken)(Fehler) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:AddressTypes0..1Additional Address Information(Haken)(Fehler) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:AddressType0..1(Haken)(Fehler)

@DefaultInd

0..1

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

  • true
  • false
(Haken)(Fehler)@ID0..1Internal Reference(Haken)(Fehler)@ID_Context0..1

Used to identify the source of the identifier. For both outbound (from protelIO) and inbound (to protelIO) request messages, this must carry the string value
"protelIO"

(Haken)(Fehler)@DisplaySequence0..1Display sequence(Haken)(Fehler)@Type0..1The type of the additional address Information
  • ADDRESSTYPE
(Haken)(Fehler) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:PersonInfos0..1Additional Person Information(Haken)(Fehler) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:PersonInfos | px:Language0..1

The language code for which the name data is represented. While this value is optional, it is HIGHLY RECOMMENDED that it be used.

(Haken)(Fehler)


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117817965" target="_blank">Communication Location Type (CLT)</a>


(Haken)(Haken)

@FormattedInd

boolean

0..1

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

  • "true"
  • "false"
(Haken)(Haken)

@DefaultInd

boolean

0..1

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

  • "true"
  • "false
(Haken)(Haken)

@ShareMarketInd

YesNoType

0..1

Permission for sharing data for marketing purposes.

  • "Yes"
  • "No"
(Fehler)(Haken)

@UseType

OTA_CodeType AUT

0..1

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


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117817967" target="_blank">Address Use Type (AUT)</a>


(Haken)(Haken)

Profile | CompanyInfo | AddressInfo | AddressLine

StringLength1to255

0..5

This path is used to transmit the details for a Company or Travel agency profile. IT is mandatory if a company or travel agency profile is passed. Address line is repeatable up to 5 times. The Type attribute is not needed here as a business address is implied.


(Haken)(Haken)

Profile | CompanyInfo | AddressInfo | CityName

StringLength1to64

0..1

This element is used to pass the Company or Travel Agency’s City.


(Haken)(Haken)

Profile | CompanyInfo | AddressInfo | StateProv


0..1

This element is used to pass the Company or Travel Agency’s State.


(Haken)(Haken)
@StateCodeStateProvCodeType0..1

(Haken)(Haken)

Profile | CompanyInfo | AddressInfo | PostalCode

StringLength1to16

0..1

This element is used to pass the Company or Travel Agency’s postal or ZIP code.


(Haken)(Haken)

Profile | CompanyInfo | AddressInfo | CountryName


0..1

This element is used to pass the Company or Travel Agency’s Country.


(Haken)(Haken)

@Code

ISO3166

0..1

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


(Haken)(Haken)

Profile | CompanyInfo | TelephoneInfo


0..n

This element is used to pass the Company or Travel Agency’s phone and numbers.


(Haken)(Haken)

@PhoneTechType

OTA_CodeType PTT

1

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


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117817961" target="_blank">Phone Technology Type (PTT)</a>


(Haken)(Haken)

@PhoneNumber

StringLength1to32

1

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


(Haken)(Haken)

@PhoneLocationType

OTA_CodeType PLT

0..1

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


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117817958" target="_blank">Phone Location Type (PLT)</a>


(Haken)(Haken)

@FormattedInd

boolean

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"

(Haken)(Haken)

@ShareMarketInd

YesNoType

0..1

Permission for sharing data for marketing purposes.

reference to @ShareAllOptOutInd (only possible in OnPrem) 

  • "true"
  • "false"

(Fehler)(Haken)

@Remark

StringLength1to128

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.


(Fehler)(Haken)

@DefaultInd

boolean

0..1

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


(Haken)(Haken)

Profile | CompanyInfo | Email


0..1

This path is used to transmit the details for a Company or Travel agency profile. This element is used to pass the Company or Travel Agency’s email. The EmailType attribute is not needed here as it is clearly a business address.


(Haken)(Haken)

@EmailType

OTA_CodeType EAT

0..1

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


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117817963" target="_blank">Email Address Type (EAT)</a>


(Haken)(Haken)

@ShareMarketInd

YesNoType

0..1

Permission for sharing data for marketing purposes

reference to @ShareAllOptOutInd (only possible in OnPrem)

  • "Yes"
  • "No"

(Fehler)(Haken)

@DefaultInd

boolean

0..1

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


(Haken)(Haken)

@Remark

StringLength1to128

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.


(Fehler)(Haken)
Profile | CompanyInfo | URL
0..nInformation on a URL for the Company or Travel Agencies.
(Haken)(Haken)
@ShareMarketIndYesNoType0..1

Permission for sharing data for marketing purposes referred to @ShareAllOptOutInd

  • "Yes"
  • "No"

(Fehler)(Haken)
@DefaultIndboolean0..1A boolean value is used to indicate whether the URL is the primary for the profile.
(Haken)(Haken)
Profile  | TPA_Extensions

0..n

Could be used to pass additional Profile data upon agreement between partners (specific Keys or codes, for instance).For all non-private Profiles, the TPA Extensions are displayed in the root Element(Haken)(Haken)
Profile | TPA_Extensions | px:UserDefinedFieldExtensions | UserDefinedField
0..1Profile User defined filed information.
(Haken)(Haken)
@NameStringLength1to320..1UDF name value
(Haken)(Haken)
@TypeStringLength1to320..1UDF type 
@DefaultInd0..1A boolean value used to indicate whether the phone number is the primary phone number for the profile.
  • true
  • false
(Haken)(Fehler) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:PersonInfos | px:Vipcodes0..1

VIP Codes of the guest.

(Haken)(Haken) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:PersonInfos | px:Vipcodes | px:Code1..nA string reference representing a Vip code of the guest.(Haken)(Haken)@DefaultInd0..1A boolean value used to indicate whether the vip code is the primary vip code for the profile.
  • true
  • false
(Haken)(Haken)@DisplaySequence0..1Display sequence(Haken)(Haken)@ID0..1Internal reference(Haken)(Haken)@ID_Context0..1Used to identify the source of the identifier.
"protelIO"(Haken)(Haken)@Type0..1Type of the code
"VIPCODE"(Haken)(Haken) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:PersonInfos | px:MarketingCodes0..1

Marketing Codes of the guest.

(Haken)(Haken) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:PersonInfos | px:MarketingCodes | px:Code1..nA string reference representing a Marketing code of the guest.(Haken)(Haken)@DefaultInd0..1A boolean value used to indicate whether the marketing code is the primary marketing code for the profile.
  • true
  • false
(Haken)(Haken)@DisplaySequence0..1Display sequence(Haken)(Haken)@ID0..1Internal reference(Haken)(Haken)@ID_Context0..1Used to identify the source of the identifier.
"protelIO"(Haken)(Haken)@Type0..1Type of the code
"MARKETINGCODE"(Haken)(Haken) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:PersonInfos | px:Keywords0..1

A string reference representing the Keywords of the guest.

(Haken)(Fehler) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:PersonInfos | px:Keywords | px:Code1..nA string reference representing a key word of the guest.(Haken)(Fehler)@DefaultInd0..1A boolean value used to indicate whether the phone number is the primary phone number for the profile.
  • true
  • false
(Haken)(Fehler)@DisplaySequence0..1Display sequence(Haken)(Fehler)@ID0..1Internal reference(Haken)(Fehler)@ID_Context0..1Used to identify the source of the identifier.
"protelIO"(Haken)(Fehler)@Type0..1Type of the code
"KEYWORD"(Haken)(Fehler) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:Salutation0..1The Saluation which is used in the profile.(Haken)(Fehler)

@DefaultInd

0..1

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

  • true
  • false
(Haken)(Fehler)@ID0..1Internal Reference(Haken)(Fehler)@ID_Context0..1

Used to identify the source of the identifier. For both outbound (from protelIO) and inbound (to protelIO) request messages, this must carry the string value
"protelIO"

(Haken)(Fehler)@DisplaySequence0..1Display sequence(Haken)(Fehler)@Type

0..1

The type of the Salution Information
  • SALUTATION
(Haken)(Fehler) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:StatisticalInfos0..1(Haken)(Fehler) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:AccountingInfos0..1(Haken)(Fehler) Profile | TPA_Extensions | px:ProfileInfoExtensions | px:LogEntries0..1(Haken)(Fehler)

Profile | TPA_Extensions | px:ProfileInfoExtensions | px:Memberships

0..1This path enables to add additional information to specific IDs linked to the guest profile.

(Haken)(Haken)

Profile | TPA_Extensions | px:ProfileInfoExtensions

| px:Memberships | px:Membership

_ProfileInfoExtensions

0..

nThis path enables to add additional information to specific IDs linked to the guest profile.(Fehler)(Haken)

1

A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA).


HTML
<a href="https://confluence.protel.net/display/PIODOC/_ProfileInfoExtensions" target="_blank">_ProfileInfoExtensions</a>


(Haken)(Haken)
Profile | Comments

@ID

0..1

Internal Reference

(Fehler)(Haken)

@RPH

0..1

Internal Reference

(Fehler)(Haken)@Type

0..1

The type of the Membership Information

  • GUEST_MEMBER_CARD_DEFINITION
(Fehler)(Haken)

@CardHolderName

0..1

Name of the Membership card

(Fehler)(Haken)@EnrollmentAt
A collection of comments.
(Haken)(Haken)
Profile | Comments | Comment
1..nComments related to the profile.
(Haken)(Haken)
@NameStringLength1to640..1

Location of the Enrollment

(Fehler)(Haken)@EnrollmentCodes
The value “Customer_Comment” is used for Comments saved in the customer’s profile. The value “Restaurant_Comment” is used for Comments saved in the customer’s profile relevant to the restaurant (On Premise Only)
(Haken)(Haken)
Profile | Comments | Comment | Text
0..1

Internal Code of the Location of the Enrollment

(Fehler)(Haken)@EnrollmentSource
Formatted text content. Provides text and indicates whether it is formatted or not.
(Haken)(Haken)
@TextFormatPlainText0..1
Source of

Indicates the

Location

format of text used in the

Enrollment

description.

(Fehler)

(Haken)

@InactivationDate

0..1

Inactive Date of the Membership

(Fehler)
(Haken)
Profile | PrefCollections
0..1A collection of preferences
(Fehler)(Haken)
Profile |
 PrefCollections  
 PrefCollections | PrefCollection
1..nAggregation of customer needs
(Fehler)(Haken)
Profile 
Profile | PrefCollections | PrefCollection | HotelPref
1..nA set of preferences for hotel stay
(Fehler)(Haken)
Profile
Profile | PrefCollections | PrefCollection | HotelPref | BedTypePref
0..1Indicates preferences for the size and features of hotel bed types.
(Fehler)(Haken)
@BedTypeOTA_CodeType BED0..1
Indicates the hotel bed type requested. Refer to OpenTravel Code List Bed Type (BED). 
Indicates the hotel bed type requested. Refer to OpenTravel Code List Bed Type (BED).


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820381" target="_blank">Bed Type (BED)</a>


(Fehler)(Haken)
Profile
Profile | PrefCollections | PrefCollection | HotelPref | RoomAmenityPref
0..1Indicates preferences for hotel room amenities.
(Fehler)(Haken)
@RoomAmenityOTA_CodeType RMA0..1
Identifes
Identify the types of
room amenities offered by the property. Refer to OpenTravel Code List Room Amenity Type (RMA). 
room amenities offered by the property. Refer to OpenTravel Code List Room Amenity Type (RMA).


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117819035" target="_blank">Room Amenity Type (RMA)</a>


(Fehler)(Haken)
Profile
Profile | PrefCollections | PrefCollection | HotelPref | PhysChallFeaturePref
0..1Indicates preferences for the type of features required to meet the needs of persons with physical challenges, disabilities, etc.
(Fehler)(Haken)
@PhysChallFeatureTypeOTA_CodeType PHY0..1Identifies the types of features the
hotel offers to service physically challenged guests. Refer to OpenTravel Code List Disability Feature Code (PHY). 
hotel offers to service physically challenged guests. Refer to OpenTravel Code List Disability Feature Code (PHY).


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820383" target="_blank">Disability Feature Code (PHY)</a>


(Fehler)(Haken)
Profile
Profile | PrefCollections | PrefCollection | HotelPref | PropertyAmenityPref
0..1Indicates preferences for hotel property amenities.
(Fehler)(Haken)
@PropertyAmenityTypeOTA_CodeType HAC0..1Identifies the amenities offered by the hotel
. Refer to OpenTravel Code List Hotel Amenity Code (HAC). 
. Refer to OpenTravel Code List Hotel Amenity Code (HAC).


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820385" target="_blank">Hotel Amenity Code (HAC)</a>


(Fehler)(Haken)
Profile
Profile | PrefCollections | PrefCollection | HotelPref | RoomLocationPref
0..1Indicates preferences for hotel room locations.
(Fehler)(Haken)
@RoomLocationTypeOTA_CodeType RLT0..1Identifies the location of the room within the property. Refer to OpenTravel Code List Room Location Type (RLT).


HTML
<a href="https://confluence.protel.net/pages/viewpage.action?pageId=117820389" target="_blank">Room Location Type (RLT)</a>


(Fehler)(Haken)