...
HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | UniqueID
...
0..9
...
Used to allow additional IDs for matching purposes.
...
@Type
...
1
...
Numeric reference to the type of object defined by the @ID attribute. Refer to the OTA code lists: Unique ID Type (UIT).
...
1 = "Profile of type private"
4 = "Profile of type company"
5 = "Profile of type travel agency"
7 = "Profile of type source"
9 = "Profile of type group"
...
1 = "Profile of type private"
4 = "Profile of type company"
5 = "Profile of type travel agency"
7 = "Profile of type source"
9 = "Profile of type group"
...
...
...
@ID
...
1
...
The unique profile ID from the PMS.
...
...
...
@ID_Context
...
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.
...
The travel sector the company is associated with, such as air, car and hotel. Refer to OpenTravel Code List Travel Sector (TVS).
...
3 = "Hotel"
...
Identifies the context of the identifying code, such as DUNS, IATA or internal code, etc
...
HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | Profile
...
1
...
Root element for profile content
...
@ProfileType
...
1
...
Numeric reference to the type of profile such as guest, company, agent etc. Refer to the OTA Code Lists: Profile Type (PRT).
- 1 = "Customer"
- 3 = "Company"
- 4 = "Travel Agent"
- 5 = "Source (Broker)
- 6 = "Group"
...
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"
- 4 = "Active"
Not supported:
- 2 = "Anonymised"
- 5 = "Inactive"
...
Supported:
- 4 = "Active"
Not supported:
- 1 = "Marked for Deletion"
- 2 = "Anonymised"
- 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"
...
@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.
...
Profile | Customer
...
0..1
...
Contains basic data on the customer’s identity, location, relationships, finances, memberships, etc.
...
@VIP_Indicator
...
0..1
...
A boolean value used to flag a very important person.
- "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
- Femal
- Unknown
...
Profile | Customer | PersonName
...
0..5
...
Detailed name information for the customer.
...
Profile | Customer | PersonName | Surname | Surname
...
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.
...
Profile | Customer | PersonName | NamePrefix
...
0..1
...
This field would be used to pass the guest’s NamePrefix (e.g. salutation).
...
Profile | Customer | PersonName | GivenName
...
0..1
...
This field would be used to pass the guest’s GivenName.
...
Profile | Customer | PersonName | MiddleName
...
0..3
...
The second given name of the person name.
...
Profile | Customer | Telephone
...
0..1
...
Information on a telephone number for the customer.
...
@PhoneTechType
...
1
...
A numeric value representing the type of technology associated with this telephone number. Refer to OTA Code List: Phone Technology Type (PTT).
- 1 = "Phone"
- 3 = "Fax"
- 5 = "Mobile"
...
@PhoneNumber
...
1
...
Contains the actual number as a string of max 32 characters and it is Mandatory.
...
@PhoneLocationType
...
0..1
...
A numeric value representing the type of the phone. Refer to the OTA code lists: Phone Location Type (PLT)
- 6 = "Home"
- 7 = "Office"
- 10 = "Mobile"
...
@FormattedInd
...
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"
...
@ShareMarketInd
...
0..1
...
Permission for sharing data for marketing purposes.
reference to @ShareAllOptOutInd (only possible in OnPrem)
- "true"
- "false"
...
@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 used to indicate whether the phone number is the primary phone number for the profile.
- "true"
- "false"
...
Profile | Customer | Email
...
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 email address.
...
@EmailType
...
0..1
...
A numeric value representing the type of email address. Refer to the OTA code lists: Email Address Type (EAT)
- 1 = "Home"
- 2 = "Business"
- 3 = "Other"
...
@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.
- "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.
...
Permission for sharing data for marketing purposes reference to @ShareAllOptOutInd
- "Yes"
- "No"
...
- "true"
- "false"
...
Profile | Customer | Address
...
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 mail address.
...
@Type
...
1
...
A numeric reference to the type of address. Refer to the OTA code lists: Communication Location Type(CLT).
- 1 = "Home"
- 2 = "Business"
- 3 = "Other"
...
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
...
When true, indicates a default value should be used.
- "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).
- 5 = "Other"
- 6 = "Contact"
- 7 = "Physical
...
Profile | Customer | Address | AddressLine
...
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.
...
Profile | Customer | Address | CityName
...
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).
...
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).
...
0..1
...
Profile | Customer | Address | PostalCode
...
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.
...
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).
...
@Code
...
0..1
...
A 2 character country code as defined in ISO 3166 alpha-2
...
Profile | Customer | CitizenCountryName
...
0..1
...
Name of the (self-professed) country that is claimed for citizenship.
...
@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"
...
Profile | Customer | Document
...
0..9
...
Detailed document information for the customer (e.g.; driver license, passport, visa).
...
@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
...
@BirthDate
...
0..1
...
Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.
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).
- 1 = Visa
- 2 = Passport
- 3 = Military identification
- 4 = Drivers license
- 5 = National identity document
- 6 = Vaccination certificate
...
Profile | Customer | CustLoyalty
...
0..5
...
Optional. This path enables the user to pass specific IDs linked to the guest profile.
...
@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
...
0..1
...
Indicates the starting date of the program.
yyyy-mm-dd
...
@ExpireDate
...
0..1
...
Indicates the expiration date of the program.
yyyy-mm-dd
...
@SignupDate
...
0..1
...
Indicates the customer’s sign-up date.
yyyy-mm-dd
...
@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"
...
@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.
...
Profile | Customer | CustLoyalty | SubAccountBalance
...
0..1
...
Used to specify a sub-account and its point balance associated with this loyalty account.
...
@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.
...
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.
...
@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
...
Profile | CompanyInfo
...
0..1
...
Detailed name information for the company.
...
Profile | CompanyInfo | CompanyName
...
0..1
...
Complete name information for the company.
...
@CompanyShortName
...
0..1
...
Identifies the company’s short name.
...
@Department
...
0..1
...
The department name or ID with which the company contact is associated.
...
Profile | CompanyInfo | ContactPerson
...
0..1
...
Information on a contact person for the customer.
...
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)
...
Profile | CompanyInfo | ContactPerson | PersonName
...
0..5
...
Detailed name information for the customer.
...
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.
...
Profile | CompanyInfo | ContactPerson | PersonName | GivenName
...
0..5
...
Given name, first name or names.
...
Profile | CompanyInfo | ContactPerson | PersonName | Surname
...
0..1
...
Family name
...
- "true"
- "false
...
- "true"
- "false
...
A numeric reference to the type of address. Refer to the OTA code lists: Communication Location Type (CLT).
- 1 = "Home"
- 2 = "Business"
- 3 = "Other"
...
pAir: Recognises 1="Home" or 2="Business"
onPrem: a maximum of two addresses are imported
...
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
...
- "Yes"
- "No"
...
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.
...
Profile | CompanyInfo | AddressInfo | CityName
...
0..1
...
This element is used to pass the Company or Travel Agency’s City.
...
Profile | CompanyInfo | AddressInfo | StateProv
...
0..1
...
This element is used to pass the Company or Travel Agency’s State.
...
Profile | CompanyInfo | AddressInfo | PostalCode
...
0..1
...
This element is used to pass the Company or Travel Agency’s postal or ZIP code.
...
Profile | CompanyInfo | AddressInfo | CountryName
...
0..1
...
This element is used to pass the Company or Travel Agency’s Country.
...
@Code
...
0..1
...
A 2 character country code as defined in ISO 3166 alpha-2
...
Profile | CompanyInfo | TelephoneInfo
...
0..n
...
This element is used to pass the Company or Travel Agency’s phone and numbers.
...
@PhoneTechType
...
0..1
...
The PhoneTechType attribute indicates which type of number is transmitted.
- 1 = "Phone"
- 3 = "Fax"
- 5 = "Mobile"
...
@PhoneNumber
...
1
...
PhoneNumber contains the actual number as a string of max 32 characters and it is Mandatory.
...
@FormattedInd
...
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"
...
@DefaultInd
...
0..1
...
DefaultInd would indicate whether the phone number is the primary phone number for the profile.
- "true"
- "false"
...
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"
...
- "Yes"
- "No"
...
A remark associated with the telephone number.
onPrem: only in "more communication mehtods"
...
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.
...
@EmailType
...
0..1
...
A numeric value representing the type of email address. Refer to the OTA code lists: Email Address Type (EAT).
- 1 = "Personal"
- 2 = "Business"
- 7 = "Reservation Office"
...
- "Yes"
- "No"
...
@DefaultInd
...
0..1
...
DefaultInd is Optional and would indicate whether the email is the primary email for the profile.
...
A remark associated with the email address.
onPrem: only in "more communication mehtods"
...
- "Yes"
- "No"
...
@DefaultInd
...
0..1
...
DefaultInd is Optional and would indicate whether the email is the primary email for the profile.
...
onPrem: All comments are added to the field "Remarks visible to all hotels" within the guest profile. There is no differentiation between Customer_Comment and Restaurant_Comment on importing.
pAir: All comments added to field Preferences in the Preferences Tab
...
Profile | TPA_Extensions
...
0..n
...
Could be used to pass additional Profile data upon agreement between partners (specific Keys or codes, for instance).
...
Profile | TPA_Extensions | Salutation
...
Salutation from the Guests profile.
...
@Value
...
0..1
...
Example: "Dear Mr. Jones"
...
Profile | TPA_Extensions | Twitter
...
0..1
...
Twitter Account of the profile
...
@TwitterAccount
...
0..1
...
Profile | TPA_Extensions | SearchName
...
0..1
...
Custom Search Name from the Guest Profile
...
@Value
...
0..1
...
Profile | TPA_Extensions | Nationality
...
0..1
...
Nationality of Guest
...
@Value
...
0..1
...
Profile | TPA_Extensions | Traces | Trace
...
0..1
...
PMS department-level trace messages.
...
@TraceDate
...
0..1
...
Trace scheduled date
...
@TraceTime
...
0..1
...
Trace Scheduled Time
...
@TraceDepartment
...
0..1
...
Department Trace was defined to action the trace
...
@TraceText
...
0..1
...
Trace Comment, information relating to the trace action required
...
Profile | TPA_Extensions | Optinouts | Optinout
...
0..1
...
@OptinoutEvent
...
0..1
...
Event can be Advertisement, Reservation, Invoice.
...
@OptinoutType
...
0..1
...
Type can be Mail, Letter, Phone, TextMessage (SMS)
...
@OptinoutStatus
...
0..1
...
If Yes, then client has agreed to be contacted via the form defined in @OptinOutType in relation to the @OptinoutEvent
If No, then the client has declined to bebe contacted via the form defined in @OptinOutType in relation to the @OptinoutEvent
...
Profile | TPA_Extensions | CustomerPreferences
...
0..1
...
Guest Preferences from the profile
...
@Value
...
0..1
...
Example: "Vegetarian"
...
@Code
...
0..1
...
Short code for the Customer preference
Example: "VEG"
...
Profile | TPA_Extensions | RoomPreferences
...
0..1
...
Room Preferences from the profile
...
@Value
...
0..1
...
Example: "King Bed"
...
@Code
...
0..1
...
Short code for the Customer preference
Example: "KB"
...
Profile | TPA_Extensions | px:ProfileInfoExtensions
...
0..1
...
Profile | TPA_Extensions | px:ProfileInfoExtensions | px:ContactDetails
...
0..1
...
Profile | TPA_Extensions | px:ProfileInfoExtensions | px:ContactDetails | AdditionalInfo | px:Entry
...
0..n
...
@DefaultInd
...
0..1
...
A boolean value used to indicate whether the phone number is the primary phone number for the profile.
- true
- false
...
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"
...
- CONTACTTYPE
...
@DefaultInd
...
0..1
...
A boolean value used to indicate whether the phone number is the primary phone number for the profile.
- true
- false
...
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"
...
- ADDRESSTYPE
...
The language code for which the name data is represented. While this value is optional, it is HIGHLY RECOMMENDED that it be used.
...
- true
- false
...
VIP Codes of the guest.
...
- true
- false
...
Marketing Codes of the guest.
...
- true
- false
...
A string reference representing the Keywords of the guest.
...
- true
- false
...
@DefaultInd
...
A boolean value used to indicate whether the phone number is the primary phone number for the profile.
- true
- false
...
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"
...
0..1
...
- SALUTATION
...
Profile | TPA_Extensions | px:ProfileInfoExtensions | px:Memberships
...
Profile | TPA_Extensions | px:ProfileInfoExtensions | px:Memberships | px:Membership
...
0..n
...
@ID
...
0..1
...
Internal Reference
...
@RPH
...
0..1
...
Internal Reference
...
@Type
...
0..1
...
The type of the Membership Information
- GUEST_MEMBER_CARD_DEFINITION
...
@CardHolderName
...
0..1
...
Name of the Membership card
...
@EnrollmentAt
...
0..1
...
Location of the Enrollment
...
@EnrollmentCodes
...
0..1
...
Internal Code of the Location of the Enrollment
...
@EnrollmentSource
...
0..1
...
Source of the Location of the Enrollment
...
@InactivationDate
...
0..1
...
Inactive Date of the Membership
...